@airweave/sdk 0.1.27 → 0.1.34
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 +15 -0
- package/Client.js +45 -20
- package/README.md +7 -11
- package/api/resources/apiKeys/client/Client.d.ts +131 -0
- package/api/resources/apiKeys/client/Client.js +391 -0
- package/api/resources/apiKeys/client/index.d.ts +1 -0
- package/api/resources/apiKeys/client/index.js +17 -0
- package/{dist/api/types → api/resources/apiKeys/client/requests}/ApiKeyCreate.d.ts +2 -1
- package/api/resources/{sync/client/requests/GetSyncJobSyncJobJobIdGetRequest.d.ts → apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts} +3 -3
- package/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +11 -0
- package/api/resources/apiKeys/client/requests/index.d.ts +3 -0
- package/api/resources/apiKeys/client/requests/index.js +2 -0
- package/api/resources/apiKeys/index.d.ts +1 -0
- package/api/resources/apiKeys/index.js +17 -0
- package/api/resources/chat/client/Client.d.ts +209 -0
- package/api/resources/chat/client/Client.js +669 -0
- package/api/resources/chat/client/index.d.ts +1 -0
- package/api/resources/chat/client/index.js +17 -0
- package/{dist/api/types → api/resources/chat/client/requests}/ChatCreate.d.ts +5 -1
- package/api/{types → resources/chat/client/requests}/ChatMessageCreate.d.ts +4 -1
- package/api/{types → resources/chat/client/requests}/ChatUpdate.d.ts +2 -1
- package/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +11 -0
- package/api/resources/chat/client/requests/index.d.ts +4 -0
- package/api/resources/chat/client/requests/index.js +2 -0
- package/api/resources/chat/index.d.ts +1 -0
- package/api/resources/chat/index.js +17 -0
- package/api/resources/connections/client/Client.d.ts +26 -25
- package/api/resources/connections/client/Client.js +88 -84
- package/api/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/api/resources/connections/client/requests/index.d.ts +1 -0
- package/api/resources/cursorDevelopment/client/Client.d.ts +78 -0
- package/api/resources/cursorDevelopment/client/Client.js +218 -0
- package/api/resources/cursorDevelopment/client/index.d.ts +1 -0
- package/api/resources/cursorDevelopment/client/index.js +2 -0
- package/api/resources/cursorDevelopment/index.d.ts +1 -0
- package/api/resources/cursorDevelopment/index.js +17 -0
- package/api/resources/dag/client/Client.js +4 -4
- package/api/resources/destinations/client/Client.js +2 -2
- package/api/resources/embeddingModels/client/Client.js +2 -2
- package/api/resources/entities/client/Client.d.ts +14 -0
- package/api/resources/entities/client/Client.js +78 -7
- package/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +12 -0
- package/api/resources/entities/client/requests/index.d.ts +1 -0
- package/api/resources/health/client/Client.d.ts +41 -0
- package/api/resources/health/client/Client.js +118 -0
- package/api/resources/health/client/index.d.ts +1 -0
- package/api/resources/health/client/index.js +2 -0
- package/api/resources/health/index.d.ts +1 -0
- package/api/resources/health/index.js +17 -0
- package/api/resources/index.d.ts +8 -0
- package/api/resources/index.js +9 -1
- package/api/resources/search/client/Client.d.ts +55 -0
- package/api/resources/search/client/Client.js +147 -0
- package/api/resources/search/client/index.d.ts +1 -0
- package/api/resources/search/client/index.js +17 -0
- package/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +20 -0
- package/api/resources/search/client/requests/index.d.ts +1 -0
- package/api/resources/search/client/requests/index.js +2 -0
- package/api/resources/search/index.d.ts +1 -0
- package/api/resources/search/index.js +17 -0
- package/api/resources/sources/client/Client.js +2 -2
- package/api/resources/sync/client/Client.d.ts +26 -5
- package/api/resources/sync/client/Client.js +100 -21
- package/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +11 -0
- package/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js +5 -0
- package/api/resources/sync/client/requests/index.d.ts +1 -1
- package/api/resources/transformers/client/Client.js +3 -3
- package/api/resources/users/client/Client.js +1 -1
- package/api/resources/whiteLabels/client/Client.js +8 -8
- package/api/types/EntityDefinition.d.ts +1 -3
- package/api/types/SyncJob.d.ts +2 -0
- package/api/types/index.d.ts +0 -4
- package/api/types/index.js +0 -4
- package/dist/Client.d.ts +15 -0
- package/dist/Client.js +45 -20
- package/dist/api/resources/apiKeys/client/Client.d.ts +131 -0
- package/dist/api/resources/apiKeys/client/Client.js +391 -0
- package/dist/api/resources/apiKeys/client/index.d.ts +1 -0
- package/dist/api/resources/apiKeys/client/index.js +17 -0
- package/{api/types → dist/api/resources/apiKeys/client/requests}/ApiKeyCreate.d.ts +2 -1
- package/dist/api/resources/apiKeys/client/requests/ApiKeyCreate.js +5 -0
- package/dist/api/resources/{sync/client/requests/GetSyncJobSyncJobJobIdGetRequest.d.ts → apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts} +3 -3
- package/dist/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js +5 -0
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +11 -0
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js +5 -0
- package/dist/api/resources/apiKeys/client/requests/index.d.ts +3 -0
- package/dist/api/resources/apiKeys/client/requests/index.js +2 -0
- package/dist/api/resources/apiKeys/index.d.ts +1 -0
- package/dist/api/resources/apiKeys/index.js +17 -0
- package/dist/api/resources/chat/client/Client.d.ts +209 -0
- package/dist/api/resources/chat/client/Client.js +669 -0
- package/dist/api/resources/chat/client/index.d.ts +1 -0
- package/dist/api/resources/chat/client/index.js +17 -0
- package/{api/types → dist/api/resources/chat/client/requests}/ChatCreate.d.ts +5 -1
- package/dist/api/resources/chat/client/requests/ChatCreate.js +5 -0
- package/dist/api/{types → resources/chat/client/requests}/ChatMessageCreate.d.ts +4 -1
- package/dist/api/resources/chat/client/requests/ChatMessageCreate.js +5 -0
- package/dist/api/{types → resources/chat/client/requests}/ChatUpdate.d.ts +2 -1
- package/dist/api/resources/chat/client/requests/ChatUpdate.js +5 -0
- package/dist/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +11 -0
- package/dist/api/resources/chat/client/requests/ListChatsChatGetRequest.js +5 -0
- package/dist/api/resources/chat/client/requests/index.d.ts +4 -0
- package/dist/api/resources/chat/client/requests/index.js +2 -0
- package/dist/api/resources/chat/index.d.ts +1 -0
- package/dist/api/resources/chat/index.js +17 -0
- package/dist/api/resources/connections/client/Client.d.ts +26 -25
- package/dist/api/resources/connections/client/Client.js +88 -84
- package/dist/api/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/dist/api/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +5 -0
- package/dist/api/resources/connections/client/requests/index.d.ts +1 -0
- package/dist/api/resources/cursorDevelopment/client/Client.d.ts +78 -0
- package/dist/api/resources/cursorDevelopment/client/Client.js +218 -0
- package/dist/api/resources/cursorDevelopment/client/index.d.ts +1 -0
- package/dist/api/resources/cursorDevelopment/client/index.js +2 -0
- package/dist/api/resources/cursorDevelopment/index.d.ts +1 -0
- package/dist/api/resources/cursorDevelopment/index.js +17 -0
- package/dist/api/resources/dag/client/Client.js +4 -4
- package/dist/api/resources/destinations/client/Client.js +2 -2
- package/dist/api/resources/embeddingModels/client/Client.js +2 -2
- package/dist/api/resources/entities/client/Client.d.ts +14 -0
- package/dist/api/resources/entities/client/Client.js +78 -7
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +12 -0
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js +5 -0
- package/dist/api/resources/entities/client/requests/index.d.ts +1 -0
- package/dist/api/resources/health/client/Client.d.ts +41 -0
- package/dist/api/resources/health/client/Client.js +118 -0
- package/dist/api/resources/health/client/index.d.ts +1 -0
- package/dist/api/resources/health/client/index.js +2 -0
- package/dist/api/resources/health/index.d.ts +1 -0
- package/dist/api/resources/health/index.js +17 -0
- package/dist/api/resources/index.d.ts +8 -0
- package/dist/api/resources/index.js +9 -1
- package/dist/api/resources/search/client/Client.d.ts +55 -0
- package/dist/api/resources/search/client/Client.js +147 -0
- package/dist/api/resources/search/client/index.d.ts +1 -0
- package/dist/api/resources/search/client/index.js +17 -0
- package/dist/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +20 -0
- package/dist/api/resources/search/client/requests/SearchSearchGetRequest.js +5 -0
- package/dist/api/resources/search/client/requests/index.d.ts +1 -0
- package/dist/api/resources/search/client/requests/index.js +2 -0
- package/dist/api/resources/search/index.d.ts +1 -0
- package/dist/api/resources/search/index.js +17 -0
- package/dist/api/resources/sources/client/Client.js +2 -2
- package/dist/api/resources/sync/client/Client.d.ts +26 -5
- package/dist/api/resources/sync/client/Client.js +100 -21
- package/dist/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +11 -0
- package/dist/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js +5 -0
- package/dist/api/resources/sync/client/requests/index.d.ts +1 -1
- package/dist/api/resources/transformers/client/Client.js +3 -3
- package/dist/api/resources/users/client/Client.js +1 -1
- package/dist/api/resources/whiteLabels/client/Client.js +8 -8
- package/dist/api/types/EntityDefinition.d.ts +1 -3
- package/dist/api/types/SyncJob.d.ts +2 -0
- package/dist/api/types/index.d.ts +0 -4
- package/dist/api/types/index.js +0 -4
- package/dist/serialization/resources/apiKeys/client/index.d.ts +2 -0
- package/dist/serialization/resources/apiKeys/client/index.js +41 -0
- package/dist/serialization/resources/apiKeys/client/readApiKeys.d.ts +11 -0
- package/dist/serialization/resources/apiKeys/client/readApiKeys.js +42 -0
- package/dist/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +12 -0
- package/dist/serialization/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +1 -1
- package/dist/serialization/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/apiKeys/client/requests/index.js +5 -0
- package/dist/serialization/resources/apiKeys/index.d.ts +1 -0
- package/dist/serialization/resources/apiKeys/index.js +17 -0
- package/dist/serialization/resources/chat/client/index.d.ts +3 -0
- package/dist/serialization/resources/chat/client/index.js +42 -0
- package/dist/serialization/resources/chat/client/listChats.d.ts +11 -0
- package/dist/serialization/resources/chat/client/listChats.js +42 -0
- package/dist/serialization/resources/chat/client/openaiKeySet.d.ts +9 -0
- package/dist/serialization/resources/chat/client/openaiKeySet.js +41 -0
- package/{serialization/types → dist/serialization/resources/chat/client/requests}/ChatCreate.d.ts +4 -4
- package/{serialization/types → dist/serialization/resources/chat/client/requests}/ChatCreate.js +1 -1
- package/dist/serialization/resources/chat/client/requests/ChatMessageCreate.d.ts +13 -0
- package/dist/serialization/{types → resources/chat/client/requests}/ChatMessageCreate.js +1 -1
- package/{serialization/types → dist/serialization/resources/chat/client/requests}/ChatUpdate.d.ts +4 -4
- package/dist/serialization/{types → resources/chat/client/requests}/ChatUpdate.js +1 -1
- package/dist/serialization/resources/chat/client/requests/index.d.ts +3 -0
- package/dist/serialization/resources/chat/client/requests/index.js +9 -0
- package/dist/serialization/resources/chat/index.d.ts +1 -0
- package/dist/serialization/resources/chat/index.js +17 -0
- package/dist/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/dist/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +44 -0
- package/dist/serialization/resources/connections/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/connections/client/requests/index.js +3 -1
- package/dist/serialization/resources/cursorDevelopment/client/checkConnectionStatus.d.ts +11 -0
- package/dist/serialization/resources/cursorDevelopment/client/checkConnectionStatus.js +42 -0
- package/dist/serialization/resources/cursorDevelopment/client/index.d.ts +1 -0
- package/dist/serialization/resources/cursorDevelopment/client/index.js +37 -0
- package/dist/serialization/resources/cursorDevelopment/index.d.ts +1 -0
- package/dist/serialization/resources/cursorDevelopment/index.js +17 -0
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +11 -0
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +42 -0
- package/dist/serialization/resources/entities/client/index.d.ts +1 -0
- package/dist/serialization/resources/entities/client/index.js +2 -1
- package/dist/serialization/resources/health/client/healthCheck.d.ts +9 -0
- package/dist/serialization/resources/health/client/healthCheck.js +41 -0
- package/dist/serialization/resources/health/client/index.d.ts +1 -0
- package/dist/serialization/resources/health/client/index.js +37 -0
- package/dist/serialization/resources/health/index.d.ts +1 -0
- package/dist/serialization/resources/health/index.js +17 -0
- package/dist/serialization/resources/index.d.ts +7 -0
- package/dist/serialization/resources/index.js +8 -1
- package/dist/serialization/resources/search/client/index.d.ts +1 -0
- package/dist/serialization/resources/search/client/index.js +37 -0
- package/dist/serialization/resources/search/client/search.d.ts +9 -0
- package/dist/serialization/resources/search/client/search.js +41 -0
- package/dist/serialization/resources/search/index.d.ts +1 -0
- package/dist/serialization/resources/search/index.js +17 -0
- package/dist/serialization/resources/sync/client/index.d.ts +1 -0
- package/dist/serialization/resources/sync/client/index.js +2 -1
- package/dist/serialization/resources/sync/client/listAllJobs.d.ts +11 -0
- package/dist/serialization/resources/sync/client/listAllJobs.js +42 -0
- package/dist/serialization/types/EntityDefinition.d.ts +1 -3
- package/dist/serialization/types/EntityDefinition.js +1 -3
- package/dist/serialization/types/SyncJob.d.ts +1 -0
- package/dist/serialization/types/SyncJob.js +1 -0
- package/dist/serialization/types/index.d.ts +0 -4
- package/dist/serialization/types/index.js +0 -4
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +1777 -441
- package/serialization/resources/apiKeys/client/index.d.ts +2 -0
- package/serialization/resources/apiKeys/client/index.js +41 -0
- package/serialization/resources/apiKeys/client/readApiKeys.d.ts +11 -0
- package/serialization/resources/apiKeys/client/readApiKeys.js +42 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +12 -0
- package/serialization/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +1 -1
- package/serialization/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/serialization/resources/apiKeys/client/requests/index.js +5 -0
- package/serialization/resources/apiKeys/index.d.ts +1 -0
- package/serialization/resources/apiKeys/index.js +17 -0
- package/serialization/resources/chat/client/index.d.ts +3 -0
- package/serialization/resources/chat/client/index.js +42 -0
- package/serialization/resources/chat/client/listChats.d.ts +11 -0
- package/serialization/resources/chat/client/listChats.js +42 -0
- package/serialization/resources/chat/client/openaiKeySet.d.ts +9 -0
- package/serialization/resources/chat/client/openaiKeySet.js +41 -0
- package/{dist/serialization/types → serialization/resources/chat/client/requests}/ChatCreate.d.ts +4 -4
- package/{dist/serialization/types → serialization/resources/chat/client/requests}/ChatCreate.js +1 -1
- package/serialization/resources/chat/client/requests/ChatMessageCreate.d.ts +13 -0
- package/serialization/{types → resources/chat/client/requests}/ChatMessageCreate.js +1 -1
- package/{dist/serialization/types → serialization/resources/chat/client/requests}/ChatUpdate.d.ts +4 -4
- package/serialization/{types → resources/chat/client/requests}/ChatUpdate.js +1 -1
- package/serialization/resources/chat/client/requests/index.d.ts +3 -0
- package/serialization/resources/chat/client/requests/index.js +9 -0
- package/serialization/resources/chat/index.d.ts +1 -0
- package/serialization/resources/chat/index.js +17 -0
- package/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +44 -0
- package/serialization/resources/connections/client/requests/index.d.ts +1 -0
- package/serialization/resources/connections/client/requests/index.js +3 -1
- package/serialization/resources/cursorDevelopment/client/checkConnectionStatus.d.ts +11 -0
- package/serialization/resources/cursorDevelopment/client/checkConnectionStatus.js +42 -0
- package/serialization/resources/cursorDevelopment/client/index.d.ts +1 -0
- package/serialization/resources/cursorDevelopment/client/index.js +37 -0
- package/serialization/resources/cursorDevelopment/index.d.ts +1 -0
- package/serialization/resources/cursorDevelopment/index.js +17 -0
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +11 -0
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +42 -0
- package/serialization/resources/entities/client/index.d.ts +1 -0
- package/serialization/resources/entities/client/index.js +2 -1
- package/serialization/resources/health/client/healthCheck.d.ts +9 -0
- package/serialization/resources/health/client/healthCheck.js +41 -0
- package/serialization/resources/health/client/index.d.ts +1 -0
- package/serialization/resources/health/client/index.js +37 -0
- package/serialization/resources/health/index.d.ts +1 -0
- package/serialization/resources/health/index.js +17 -0
- package/serialization/resources/index.d.ts +7 -0
- package/serialization/resources/index.js +8 -1
- package/serialization/resources/search/client/index.d.ts +1 -0
- package/serialization/resources/search/client/index.js +37 -0
- package/serialization/resources/search/client/search.d.ts +9 -0
- package/serialization/resources/search/client/search.js +41 -0
- package/serialization/resources/search/index.d.ts +1 -0
- package/serialization/resources/search/index.js +17 -0
- package/serialization/resources/sync/client/index.d.ts +1 -0
- package/serialization/resources/sync/client/index.js +2 -1
- package/serialization/resources/sync/client/listAllJobs.d.ts +11 -0
- package/serialization/resources/sync/client/listAllJobs.js +42 -0
- package/serialization/types/EntityDefinition.d.ts +1 -3
- package/serialization/types/EntityDefinition.js +1 -3
- package/serialization/types/SyncJob.d.ts +1 -0
- package/serialization/types/SyncJob.js +1 -0
- package/serialization/types/index.d.ts +0 -4
- package/serialization/types/index.js +0 -4
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/dist/serialization/types/ApiKeyCreate.d.ts +0 -12
- package/dist/serialization/types/ChatMessageCreate.d.ts +0 -13
- package/serialization/types/ApiKeyCreate.d.ts +0 -12
- package/serialization/types/ChatMessageCreate.d.ts +0 -13
- /package/api/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +0 -0
- /package/api/resources/{sync/client/requests/GetSyncJobSyncJobJobIdGetRequest.js → apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js} +0 -0
- /package/api/{types/ChatCreate.js → resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js} +0 -0
- /package/{dist/api/types → api/resources/chat/client/requests}/ChatCreate.js +0 -0
- /package/api/{types → resources/chat/client/requests}/ChatMessageCreate.js +0 -0
- /package/api/{types → resources/chat/client/requests}/ChatUpdate.js +0 -0
- /package/{dist/api/resources/sync/client/requests/GetSyncJobSyncJobJobIdGetRequest.js → api/resources/chat/client/requests/ListChatsChatGetRequest.js} +0 -0
- /package/{dist/api/types/ApiKeyCreate.js → api/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js} +0 -0
- /package/{dist/api/types/ChatMessageCreate.js → api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js} +0 -0
- /package/{dist/api/types/ChatUpdate.js → api/resources/search/client/requests/SearchSearchGetRequest.js} +0 -0
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Health
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.health.<a href="/src/api/resources/health/client/Client.ts">healthCheck</a>() -> Record<string, string></code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,15 +14,11 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
## Args:
|
|
20
|
-
|
|
21
|
-
current_user (User): The current user.
|
|
17
|
+
Check if the API is healthy.
|
|
22
18
|
|
|
23
19
|
## Returns:
|
|
24
20
|
|
|
25
|
-
|
|
21
|
+
dict: A dictionary containing the status of the API.
|
|
26
22
|
|
|
27
23
|
</dd>
|
|
28
24
|
</dl>
|
|
@@ -38,7 +34,7 @@ Get current user.
|
|
|
38
34
|
<dd>
|
|
39
35
|
|
|
40
36
|
```typescript
|
|
41
|
-
await client.
|
|
37
|
+
await client.health.healthCheck();
|
|
42
38
|
```
|
|
43
39
|
|
|
44
40
|
</dd>
|
|
@@ -54,7 +50,7 @@ await client.users.readUser();
|
|
|
54
50
|
<dl>
|
|
55
51
|
<dd>
|
|
56
52
|
|
|
57
|
-
**requestOptions:** `
|
|
53
|
+
**requestOptions:** `Health.RequestOptions`
|
|
58
54
|
|
|
59
55
|
</dd>
|
|
60
56
|
</dl>
|
|
@@ -65,9 +61,9 @@ await client.users.readUser();
|
|
|
65
61
|
</dl>
|
|
66
62
|
</details>
|
|
67
63
|
|
|
68
|
-
##
|
|
64
|
+
## ApiKeys
|
|
69
65
|
|
|
70
|
-
<details><summary><code>client.
|
|
66
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKeys</a>({ ...params }) -> AirweaveSDK.ApiKey[]</code></summary>
|
|
71
67
|
<dl>
|
|
72
68
|
<dd>
|
|
73
69
|
|
|
@@ -79,17 +75,18 @@ await client.users.readUser();
|
|
|
79
75
|
<dl>
|
|
80
76
|
<dd>
|
|
81
77
|
|
|
82
|
-
|
|
78
|
+
Retrieve all API keys for the current user.
|
|
83
79
|
|
|
84
80
|
## Args:
|
|
85
81
|
|
|
86
82
|
db (AsyncSession): The database session.
|
|
87
|
-
|
|
83
|
+
skip (int): Number of records to skip for pagination.
|
|
84
|
+
limit (int): Maximum number of records to return.
|
|
88
85
|
user (schemas.User): The current user.
|
|
89
86
|
|
|
90
87
|
## Returns:
|
|
91
88
|
|
|
92
|
-
schemas.
|
|
89
|
+
List[schemas.APIKey]: A list of API keys.
|
|
93
90
|
|
|
94
91
|
</dd>
|
|
95
92
|
</dl>
|
|
@@ -105,7 +102,7 @@ Get source by id.
|
|
|
105
102
|
<dd>
|
|
106
103
|
|
|
107
104
|
```typescript
|
|
108
|
-
await client.
|
|
105
|
+
await client.apiKeys.readApiKeys();
|
|
109
106
|
```
|
|
110
107
|
|
|
111
108
|
</dd>
|
|
@@ -121,7 +118,7 @@ await client.sources.readSource("short_name");
|
|
|
121
118
|
<dl>
|
|
122
119
|
<dd>
|
|
123
120
|
|
|
124
|
-
**
|
|
121
|
+
**request:** `AirweaveSDK.ReadApiKeysApiKeysGetRequest`
|
|
125
122
|
|
|
126
123
|
</dd>
|
|
127
124
|
</dl>
|
|
@@ -129,7 +126,7 @@ await client.sources.readSource("short_name");
|
|
|
129
126
|
<dl>
|
|
130
127
|
<dd>
|
|
131
128
|
|
|
132
|
-
**requestOptions:** `
|
|
129
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
133
130
|
|
|
134
131
|
</dd>
|
|
135
132
|
</dl>
|
|
@@ -140,7 +137,7 @@ await client.sources.readSource("short_name");
|
|
|
140
137
|
</dl>
|
|
141
138
|
</details>
|
|
142
139
|
|
|
143
|
-
<details><summary><code>client.
|
|
140
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">createApiKey</a>({ ...params }) -> AirweaveSDK.ApiKeyWithPlainKey</code></summary>
|
|
144
141
|
<dl>
|
|
145
142
|
<dd>
|
|
146
143
|
|
|
@@ -152,16 +149,20 @@ await client.sources.readSource("short_name");
|
|
|
152
149
|
<dl>
|
|
153
150
|
<dd>
|
|
154
151
|
|
|
155
|
-
|
|
152
|
+
Create a new API key for the current user.
|
|
153
|
+
|
|
154
|
+
Returns a temporary plain key for the user to store securely.
|
|
155
|
+
This is not stored in the database.
|
|
156
156
|
|
|
157
157
|
## Args:
|
|
158
158
|
|
|
159
|
-
db: The database session
|
|
160
|
-
|
|
159
|
+
db (AsyncSession): The database session.
|
|
160
|
+
api_key_in (schemas.APIKeyCreate): The API key creation data.
|
|
161
|
+
user (schemas.User): The current user.
|
|
161
162
|
|
|
162
163
|
## Returns:
|
|
163
164
|
|
|
164
|
-
|
|
165
|
+
schemas.APIKeyWithPlainKey: The created API key object, including the key.
|
|
165
166
|
|
|
166
167
|
</dd>
|
|
167
168
|
</dl>
|
|
@@ -177,7 +178,7 @@ Get all sources for the current user.
|
|
|
177
178
|
<dd>
|
|
178
179
|
|
|
179
180
|
```typescript
|
|
180
|
-
await client.
|
|
181
|
+
await client.apiKeys.createApiKey();
|
|
181
182
|
```
|
|
182
183
|
|
|
183
184
|
</dd>
|
|
@@ -193,7 +194,15 @@ await client.sources.readSources();
|
|
|
193
194
|
<dl>
|
|
194
195
|
<dd>
|
|
195
196
|
|
|
196
|
-
**
|
|
197
|
+
**request:** `AirweaveSDK.ApiKeyCreate`
|
|
198
|
+
|
|
199
|
+
</dd>
|
|
200
|
+
</dl>
|
|
201
|
+
|
|
202
|
+
<dl>
|
|
203
|
+
<dd>
|
|
204
|
+
|
|
205
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
197
206
|
|
|
198
207
|
</dd>
|
|
199
208
|
</dl>
|
|
@@ -204,9 +213,7 @@ await client.sources.readSources();
|
|
|
204
213
|
</dl>
|
|
205
214
|
</details>
|
|
206
215
|
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>() -> AirweaveSDK.Destination[]</code></summary>
|
|
216
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">deleteApiKey</a>({ ...params }) -> AirweaveSDK.ApiKey</code></summary>
|
|
210
217
|
<dl>
|
|
211
218
|
<dd>
|
|
212
219
|
|
|
@@ -218,16 +225,21 @@ await client.sources.readSources();
|
|
|
218
225
|
<dl>
|
|
219
226
|
<dd>
|
|
220
227
|
|
|
221
|
-
|
|
228
|
+
Delete an API key.
|
|
222
229
|
|
|
223
230
|
## Args:
|
|
224
231
|
|
|
225
|
-
db: The database session
|
|
226
|
-
|
|
232
|
+
db (AsyncSession): The database session.
|
|
233
|
+
id (UUID): The ID of the API key.
|
|
234
|
+
user (schemas.User): The current user.
|
|
227
235
|
|
|
228
236
|
## Returns:
|
|
229
237
|
|
|
230
|
-
|
|
238
|
+
schemas.APIKey: The revoked API key object.
|
|
239
|
+
|
|
240
|
+
## Raises:
|
|
241
|
+
|
|
242
|
+
HTTPException: If the API key is not found.
|
|
231
243
|
|
|
232
244
|
</dd>
|
|
233
245
|
</dl>
|
|
@@ -243,7 +255,9 @@ Get all available destinations.
|
|
|
243
255
|
<dd>
|
|
244
256
|
|
|
245
257
|
```typescript
|
|
246
|
-
await client.
|
|
258
|
+
await client.apiKeys.deleteApiKey({
|
|
259
|
+
id: "id",
|
|
260
|
+
});
|
|
247
261
|
```
|
|
248
262
|
|
|
249
263
|
</dd>
|
|
@@ -259,7 +273,15 @@ await client.destinations.listDestinations();
|
|
|
259
273
|
<dl>
|
|
260
274
|
<dd>
|
|
261
275
|
|
|
262
|
-
**
|
|
276
|
+
**request:** `AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest`
|
|
277
|
+
|
|
278
|
+
</dd>
|
|
279
|
+
</dl>
|
|
280
|
+
|
|
281
|
+
<dl>
|
|
282
|
+
<dd>
|
|
283
|
+
|
|
284
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
263
285
|
|
|
264
286
|
</dd>
|
|
265
287
|
</dl>
|
|
@@ -270,7 +292,7 @@ await client.destinations.listDestinations();
|
|
|
270
292
|
</dl>
|
|
271
293
|
</details>
|
|
272
294
|
|
|
273
|
-
<details><summary><code>client.
|
|
295
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKey</a>(id) -> AirweaveSDK.ApiKey</code></summary>
|
|
274
296
|
<dl>
|
|
275
297
|
<dd>
|
|
276
298
|
|
|
@@ -282,17 +304,21 @@ await client.destinations.listDestinations();
|
|
|
282
304
|
<dl>
|
|
283
305
|
<dd>
|
|
284
306
|
|
|
285
|
-
|
|
307
|
+
Retrieve an API key by ID.
|
|
286
308
|
|
|
287
309
|
## Args:
|
|
288
310
|
|
|
289
|
-
db: The database session
|
|
290
|
-
|
|
291
|
-
user: The current user
|
|
311
|
+
db (AsyncSession): The database session.
|
|
312
|
+
id (UUID): The ID of the API key.
|
|
313
|
+
user (schemas.User): The current user.
|
|
292
314
|
|
|
293
315
|
## Returns:
|
|
294
316
|
|
|
295
|
-
|
|
317
|
+
schemas.APIKey: The API key object.
|
|
318
|
+
|
|
319
|
+
## Raises:
|
|
320
|
+
|
|
321
|
+
HTTPException: If the API key is not found.
|
|
296
322
|
|
|
297
323
|
</dd>
|
|
298
324
|
</dl>
|
|
@@ -308,7 +334,7 @@ Get destination by short name.
|
|
|
308
334
|
<dd>
|
|
309
335
|
|
|
310
336
|
```typescript
|
|
311
|
-
await client.
|
|
337
|
+
await client.apiKeys.readApiKey("id");
|
|
312
338
|
```
|
|
313
339
|
|
|
314
340
|
</dd>
|
|
@@ -324,7 +350,7 @@ await client.destinations.readDestination("short_name");
|
|
|
324
350
|
<dl>
|
|
325
351
|
<dd>
|
|
326
352
|
|
|
327
|
-
**
|
|
353
|
+
**id:** `string`
|
|
328
354
|
|
|
329
355
|
</dd>
|
|
330
356
|
</dl>
|
|
@@ -332,7 +358,7 @@ await client.destinations.readDestination("short_name");
|
|
|
332
358
|
<dl>
|
|
333
359
|
<dd>
|
|
334
360
|
|
|
335
|
-
**requestOptions:** `
|
|
361
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
336
362
|
|
|
337
363
|
</dd>
|
|
338
364
|
</dl>
|
|
@@ -343,9 +369,9 @@ await client.destinations.readDestination("short_name");
|
|
|
343
369
|
</dl>
|
|
344
370
|
</details>
|
|
345
371
|
|
|
346
|
-
##
|
|
372
|
+
## Users
|
|
347
373
|
|
|
348
|
-
<details><summary><code>client.
|
|
374
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">readUser</a>() -> AirweaveSDK.User</code></summary>
|
|
349
375
|
<dl>
|
|
350
376
|
<dd>
|
|
351
377
|
|
|
@@ -357,17 +383,15 @@ await client.destinations.readDestination("short_name");
|
|
|
357
383
|
<dl>
|
|
358
384
|
<dd>
|
|
359
385
|
|
|
360
|
-
Get
|
|
386
|
+
Get current user.
|
|
361
387
|
|
|
362
388
|
## Args:
|
|
363
389
|
|
|
364
|
-
|
|
365
|
-
short_name (str): The short name of the embedding model.
|
|
366
|
-
user (schemas.User): The current user.
|
|
390
|
+
current_user (User): The current user.
|
|
367
391
|
|
|
368
392
|
## Returns:
|
|
369
393
|
|
|
370
|
-
schemas.
|
|
394
|
+
schemas.User: The user object.
|
|
371
395
|
|
|
372
396
|
</dd>
|
|
373
397
|
</dl>
|
|
@@ -383,7 +407,7 @@ Get embedding model by id.
|
|
|
383
407
|
<dd>
|
|
384
408
|
|
|
385
409
|
```typescript
|
|
386
|
-
await client.
|
|
410
|
+
await client.users.readUser();
|
|
387
411
|
```
|
|
388
412
|
|
|
389
413
|
</dd>
|
|
@@ -399,15 +423,7 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
399
423
|
<dl>
|
|
400
424
|
<dd>
|
|
401
425
|
|
|
402
|
-
**
|
|
403
|
-
|
|
404
|
-
</dd>
|
|
405
|
-
</dl>
|
|
406
|
-
|
|
407
|
-
<dl>
|
|
408
|
-
<dd>
|
|
409
|
-
|
|
410
|
-
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
426
|
+
**requestOptions:** `Users.RequestOptions`
|
|
411
427
|
|
|
412
428
|
</dd>
|
|
413
429
|
</dl>
|
|
@@ -418,7 +434,9 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
418
434
|
</dl>
|
|
419
435
|
</details>
|
|
420
436
|
|
|
421
|
-
|
|
437
|
+
## Sources
|
|
438
|
+
|
|
439
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithConfigFields</code></summary>
|
|
422
440
|
<dl>
|
|
423
441
|
<dd>
|
|
424
442
|
|
|
@@ -430,16 +448,17 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
430
448
|
<dl>
|
|
431
449
|
<dd>
|
|
432
450
|
|
|
433
|
-
Get
|
|
451
|
+
Get source by id.
|
|
434
452
|
|
|
435
453
|
## Args:
|
|
436
454
|
|
|
437
455
|
db (AsyncSession): The database session.
|
|
456
|
+
short_name (str): The short name of the source.
|
|
438
457
|
user (schemas.User): The current user.
|
|
439
458
|
|
|
440
459
|
## Returns:
|
|
441
460
|
|
|
442
|
-
|
|
461
|
+
schemas.Source: The source object.
|
|
443
462
|
|
|
444
463
|
</dd>
|
|
445
464
|
</dl>
|
|
@@ -455,7 +474,7 @@ Get all embedding models.
|
|
|
455
474
|
<dd>
|
|
456
475
|
|
|
457
476
|
```typescript
|
|
458
|
-
await client.
|
|
477
|
+
await client.sources.readSource("short_name");
|
|
459
478
|
```
|
|
460
479
|
|
|
461
480
|
</dd>
|
|
@@ -471,7 +490,15 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
471
490
|
<dl>
|
|
472
491
|
<dd>
|
|
473
492
|
|
|
474
|
-
**
|
|
493
|
+
**shortName:** `string`
|
|
494
|
+
|
|
495
|
+
</dd>
|
|
496
|
+
</dl>
|
|
497
|
+
|
|
498
|
+
<dl>
|
|
499
|
+
<dd>
|
|
500
|
+
|
|
501
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
475
502
|
|
|
476
503
|
</dd>
|
|
477
504
|
</dl>
|
|
@@ -482,9 +509,7 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
482
509
|
</dl>
|
|
483
510
|
</details>
|
|
484
511
|
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
512
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
|
|
488
513
|
<dl>
|
|
489
514
|
<dd>
|
|
490
515
|
|
|
@@ -496,17 +521,16 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
496
521
|
<dl>
|
|
497
522
|
<dd>
|
|
498
523
|
|
|
499
|
-
Get
|
|
524
|
+
Get all sources for the current user.
|
|
500
525
|
|
|
501
526
|
## Args:
|
|
502
527
|
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
user: The current user.
|
|
528
|
+
db: The database session
|
|
529
|
+
user: The current user
|
|
506
530
|
|
|
507
531
|
## Returns:
|
|
508
532
|
|
|
509
|
-
schemas.
|
|
533
|
+
list[schemas.Source]: The list of sources.
|
|
510
534
|
|
|
511
535
|
</dd>
|
|
512
536
|
</dl>
|
|
@@ -522,7 +546,7 @@ Get a specific connection.
|
|
|
522
546
|
<dd>
|
|
523
547
|
|
|
524
548
|
```typescript
|
|
525
|
-
await client.
|
|
549
|
+
await client.sources.readSources();
|
|
526
550
|
```
|
|
527
551
|
|
|
528
552
|
</dd>
|
|
@@ -538,15 +562,7 @@ await client.connections.getConnection("connection_id");
|
|
|
538
562
|
<dl>
|
|
539
563
|
<dd>
|
|
540
564
|
|
|
541
|
-
**
|
|
542
|
-
|
|
543
|
-
</dd>
|
|
544
|
-
</dl>
|
|
545
|
-
|
|
546
|
-
<dl>
|
|
547
|
-
<dd>
|
|
548
|
-
|
|
549
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
565
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
550
566
|
|
|
551
567
|
</dd>
|
|
552
568
|
</dl>
|
|
@@ -557,7 +573,9 @@ await client.connections.getConnection("connection_id");
|
|
|
557
573
|
</dl>
|
|
558
574
|
</details>
|
|
559
575
|
|
|
560
|
-
|
|
576
|
+
## Destinations
|
|
577
|
+
|
|
578
|
+
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>() -> AirweaveSDK.Destination[]</code></summary>
|
|
561
579
|
<dl>
|
|
562
580
|
<dd>
|
|
563
581
|
|
|
@@ -569,16 +587,16 @@ await client.connections.getConnection("connection_id");
|
|
|
569
587
|
<dl>
|
|
570
588
|
<dd>
|
|
571
589
|
|
|
572
|
-
Get all
|
|
590
|
+
Get all available destinations.
|
|
573
591
|
|
|
574
592
|
## Args:
|
|
575
593
|
|
|
576
|
-
db: The database session
|
|
577
|
-
user: The current user
|
|
594
|
+
db: The database session
|
|
595
|
+
user: The current user
|
|
578
596
|
|
|
579
597
|
## Returns:
|
|
580
598
|
|
|
581
|
-
|
|
599
|
+
List[schemas.Destination]: A list of destinations
|
|
582
600
|
|
|
583
601
|
</dd>
|
|
584
602
|
</dl>
|
|
@@ -594,7 +612,7 @@ Get all active connections for the current user across all integration types.
|
|
|
594
612
|
<dd>
|
|
595
613
|
|
|
596
614
|
```typescript
|
|
597
|
-
await client.
|
|
615
|
+
await client.destinations.listDestinations();
|
|
598
616
|
```
|
|
599
617
|
|
|
600
618
|
</dd>
|
|
@@ -610,7 +628,7 @@ await client.connections.listAllConnectedIntegrations();
|
|
|
610
628
|
<dl>
|
|
611
629
|
<dd>
|
|
612
630
|
|
|
613
|
-
**requestOptions:** `
|
|
631
|
+
**requestOptions:** `Destinations.RequestOptions`
|
|
614
632
|
|
|
615
633
|
</dd>
|
|
616
634
|
</dl>
|
|
@@ -621,7 +639,7 @@ await client.connections.listAllConnectedIntegrations();
|
|
|
621
639
|
</dl>
|
|
622
640
|
</details>
|
|
623
641
|
|
|
624
|
-
<details><summary><code>client.
|
|
642
|
+
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">readDestination</a>(shortName) -> AirweaveSDK.DestinationWithConfigFields</code></summary>
|
|
625
643
|
<dl>
|
|
626
644
|
<dd>
|
|
627
645
|
|
|
@@ -633,17 +651,17 @@ await client.connections.listAllConnectedIntegrations();
|
|
|
633
651
|
<dl>
|
|
634
652
|
<dd>
|
|
635
653
|
|
|
636
|
-
Get
|
|
654
|
+
Get destination by short name.
|
|
637
655
|
|
|
638
656
|
## Args:
|
|
639
657
|
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
user
|
|
658
|
+
db: The database session
|
|
659
|
+
short_name: The short name of the destination
|
|
660
|
+
user: The current user
|
|
643
661
|
|
|
644
662
|
## Returns:
|
|
645
663
|
|
|
646
|
-
|
|
664
|
+
destination (schemas.Destination): The destination
|
|
647
665
|
|
|
648
666
|
</dd>
|
|
649
667
|
</dl>
|
|
@@ -659,7 +677,7 @@ Get all integrations of specified type connected to the current user.
|
|
|
659
677
|
<dd>
|
|
660
678
|
|
|
661
679
|
```typescript
|
|
662
|
-
await client.
|
|
680
|
+
await client.destinations.readDestination("short_name");
|
|
663
681
|
```
|
|
664
682
|
|
|
665
683
|
</dd>
|
|
@@ -675,7 +693,7 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
675
693
|
<dl>
|
|
676
694
|
<dd>
|
|
677
695
|
|
|
678
|
-
**
|
|
696
|
+
**shortName:** `string`
|
|
679
697
|
|
|
680
698
|
</dd>
|
|
681
699
|
</dl>
|
|
@@ -683,7 +701,7 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
683
701
|
<dl>
|
|
684
702
|
<dd>
|
|
685
703
|
|
|
686
|
-
**requestOptions:** `
|
|
704
|
+
**requestOptions:** `Destinations.RequestOptions`
|
|
687
705
|
|
|
688
706
|
</dd>
|
|
689
707
|
</dl>
|
|
@@ -694,7 +712,9 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
694
712
|
</dl>
|
|
695
713
|
</details>
|
|
696
714
|
|
|
697
|
-
|
|
715
|
+
## EmbeddingModels
|
|
716
|
+
|
|
717
|
+
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
|
|
698
718
|
<dl>
|
|
699
719
|
<dd>
|
|
700
720
|
|
|
@@ -706,29 +726,17 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
706
726
|
<dl>
|
|
707
727
|
<dd>
|
|
708
728
|
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
Expects a POST body with:
|
|
712
|
-
|
|
713
|
-
```json
|
|
714
|
-
{
|
|
715
|
-
"name": "required connection name",
|
|
716
|
-
... other config fields specific to the integration type ...
|
|
717
|
-
}
|
|
718
|
-
```
|
|
729
|
+
Get embedding model by id.
|
|
719
730
|
|
|
720
731
|
## Args:
|
|
721
732
|
|
|
722
|
-
db: The database session.
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
name: The name of the connection.
|
|
726
|
-
config_fields: The config fields for the integration.
|
|
727
|
-
user: The current user.
|
|
733
|
+
db (AsyncSession): The database session.
|
|
734
|
+
short_name (str): The short name of the embedding model.
|
|
735
|
+
user (schemas.User): The current user.
|
|
728
736
|
|
|
729
737
|
## Returns:
|
|
730
738
|
|
|
731
|
-
schemas.
|
|
739
|
+
schemas.EmbeddingModel: The embedding model object.
|
|
732
740
|
|
|
733
741
|
</dd>
|
|
734
742
|
</dl>
|
|
@@ -744,11 +752,7 @@ Expects a POST body with:
|
|
|
744
752
|
<dd>
|
|
745
753
|
|
|
746
754
|
```typescript
|
|
747
|
-
await client.
|
|
748
|
-
configFields: {
|
|
749
|
-
key: "value",
|
|
750
|
-
},
|
|
751
|
-
});
|
|
755
|
+
await client.embeddingModels.readEmbeddingModel("short_name");
|
|
752
756
|
```
|
|
753
757
|
|
|
754
758
|
</dd>
|
|
@@ -764,14 +768,6 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
764
768
|
<dl>
|
|
765
769
|
<dd>
|
|
766
770
|
|
|
767
|
-
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
768
|
-
|
|
769
|
-
</dd>
|
|
770
|
-
</dl>
|
|
771
|
-
|
|
772
|
-
<dl>
|
|
773
|
-
<dd>
|
|
774
|
-
|
|
775
771
|
**shortName:** `string`
|
|
776
772
|
|
|
777
773
|
</dd>
|
|
@@ -780,15 +776,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
780
776
|
<dl>
|
|
781
777
|
<dd>
|
|
782
778
|
|
|
783
|
-
**
|
|
784
|
-
|
|
785
|
-
</dd>
|
|
786
|
-
</dl>
|
|
787
|
-
|
|
788
|
-
<dl>
|
|
789
|
-
<dd>
|
|
790
|
-
|
|
791
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
779
|
+
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
792
780
|
|
|
793
781
|
</dd>
|
|
794
782
|
</dl>
|
|
@@ -799,7 +787,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
799
787
|
</dl>
|
|
800
788
|
</details>
|
|
801
789
|
|
|
802
|
-
<details><summary><code>client.
|
|
790
|
+
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModels</a>() -> AirweaveSDK.EmbeddingModel[]</code></summary>
|
|
803
791
|
<dl>
|
|
804
792
|
<dd>
|
|
805
793
|
|
|
@@ -811,17 +799,16 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
811
799
|
<dl>
|
|
812
800
|
<dd>
|
|
813
801
|
|
|
814
|
-
Get
|
|
802
|
+
Get all embedding models.
|
|
815
803
|
|
|
816
804
|
## Args:
|
|
817
805
|
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
user (schemas.User): The current user
|
|
806
|
+
db (AsyncSession): The database session.
|
|
807
|
+
user (schemas.User): The current user.
|
|
821
808
|
|
|
822
809
|
## Returns:
|
|
823
810
|
|
|
824
|
-
|
|
811
|
+
list[schemas.EmbeddingModel]: The list of embedding models.
|
|
825
812
|
|
|
826
813
|
</dd>
|
|
827
814
|
</dl>
|
|
@@ -837,7 +824,7 @@ Get the credentials for a connection.
|
|
|
837
824
|
<dd>
|
|
838
825
|
|
|
839
826
|
```typescript
|
|
840
|
-
await client.
|
|
827
|
+
await client.embeddingModels.readEmbeddingModels();
|
|
841
828
|
```
|
|
842
829
|
|
|
843
830
|
</dd>
|
|
@@ -853,15 +840,7 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
853
840
|
<dl>
|
|
854
841
|
<dd>
|
|
855
842
|
|
|
856
|
-
**
|
|
857
|
-
|
|
858
|
-
</dd>
|
|
859
|
-
</dl>
|
|
860
|
-
|
|
861
|
-
<dl>
|
|
862
|
-
<dd>
|
|
863
|
-
|
|
864
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
843
|
+
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
865
844
|
|
|
866
845
|
</dd>
|
|
867
846
|
</dl>
|
|
@@ -872,7 +851,9 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
872
851
|
</dl>
|
|
873
852
|
</details>
|
|
874
853
|
|
|
875
|
-
|
|
854
|
+
## Connections
|
|
855
|
+
|
|
856
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
876
857
|
<dl>
|
|
877
858
|
<dd>
|
|
878
859
|
|
|
@@ -884,19 +865,1093 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
884
865
|
<dl>
|
|
885
866
|
<dd>
|
|
886
867
|
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
Deletes the connection and integration credential.
|
|
868
|
+
Get a specific connection.
|
|
890
869
|
|
|
891
870
|
## Args:
|
|
892
871
|
|
|
893
|
-
|
|
894
|
-
|
|
872
|
+
connection_id: The ID of the connection to get.
|
|
873
|
+
db: The database session.
|
|
874
|
+
user: The current user.
|
|
875
|
+
|
|
876
|
+
## Returns:
|
|
877
|
+
|
|
878
|
+
schemas.Connection: The connection.
|
|
879
|
+
|
|
880
|
+
</dd>
|
|
881
|
+
</dl>
|
|
882
|
+
</dd>
|
|
883
|
+
</dl>
|
|
884
|
+
|
|
885
|
+
#### 🔌 Usage
|
|
886
|
+
|
|
887
|
+
<dl>
|
|
888
|
+
<dd>
|
|
889
|
+
|
|
890
|
+
<dl>
|
|
891
|
+
<dd>
|
|
892
|
+
|
|
893
|
+
```typescript
|
|
894
|
+
await client.connections.getConnection("connection_id");
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
</dd>
|
|
898
|
+
</dl>
|
|
899
|
+
</dd>
|
|
900
|
+
</dl>
|
|
901
|
+
|
|
902
|
+
#### ⚙️ Parameters
|
|
903
|
+
|
|
904
|
+
<dl>
|
|
905
|
+
<dd>
|
|
906
|
+
|
|
907
|
+
<dl>
|
|
908
|
+
<dd>
|
|
909
|
+
|
|
910
|
+
**connectionId:** `string`
|
|
911
|
+
|
|
912
|
+
</dd>
|
|
913
|
+
</dl>
|
|
914
|
+
|
|
915
|
+
<dl>
|
|
916
|
+
<dd>
|
|
917
|
+
|
|
918
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
919
|
+
|
|
920
|
+
</dd>
|
|
921
|
+
</dl>
|
|
922
|
+
</dd>
|
|
923
|
+
</dl>
|
|
924
|
+
|
|
925
|
+
</dd>
|
|
926
|
+
</dl>
|
|
927
|
+
</details>
|
|
928
|
+
|
|
929
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
|
|
930
|
+
<dl>
|
|
931
|
+
<dd>
|
|
932
|
+
|
|
933
|
+
#### 📝 Description
|
|
934
|
+
|
|
935
|
+
<dl>
|
|
936
|
+
<dd>
|
|
937
|
+
|
|
938
|
+
<dl>
|
|
939
|
+
<dd>
|
|
940
|
+
|
|
941
|
+
Get all active connections for the current user across all integration types.
|
|
942
|
+
|
|
943
|
+
## Args:
|
|
944
|
+
|
|
945
|
+
db: The database session.
|
|
946
|
+
user: The current user.
|
|
947
|
+
|
|
948
|
+
## Returns:
|
|
949
|
+
|
|
950
|
+
list[schemas.Connection]: The list of connections.
|
|
951
|
+
|
|
952
|
+
</dd>
|
|
953
|
+
</dl>
|
|
954
|
+
</dd>
|
|
955
|
+
</dl>
|
|
956
|
+
|
|
957
|
+
#### 🔌 Usage
|
|
958
|
+
|
|
959
|
+
<dl>
|
|
960
|
+
<dd>
|
|
961
|
+
|
|
962
|
+
<dl>
|
|
963
|
+
<dd>
|
|
964
|
+
|
|
965
|
+
```typescript
|
|
966
|
+
await client.connections.listAllConnectedIntegrations();
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
</dd>
|
|
970
|
+
</dl>
|
|
971
|
+
</dd>
|
|
972
|
+
</dl>
|
|
973
|
+
|
|
974
|
+
#### ⚙️ Parameters
|
|
975
|
+
|
|
976
|
+
<dl>
|
|
977
|
+
<dd>
|
|
978
|
+
|
|
979
|
+
<dl>
|
|
980
|
+
<dd>
|
|
981
|
+
|
|
982
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
983
|
+
|
|
984
|
+
</dd>
|
|
985
|
+
</dl>
|
|
986
|
+
</dd>
|
|
987
|
+
</dl>
|
|
988
|
+
|
|
989
|
+
</dd>
|
|
990
|
+
</dl>
|
|
991
|
+
</details>
|
|
992
|
+
|
|
993
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listConnectedIntegrations</a>(integrationType) -> AirweaveSDK.Connection[]</code></summary>
|
|
994
|
+
<dl>
|
|
995
|
+
<dd>
|
|
996
|
+
|
|
997
|
+
#### 📝 Description
|
|
998
|
+
|
|
999
|
+
<dl>
|
|
1000
|
+
<dd>
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
Get all integrations of specified type connected to the current user.
|
|
1006
|
+
|
|
1007
|
+
## Args:
|
|
1008
|
+
|
|
1009
|
+
integration_type (IntegrationType): The type of integration to get connections for.
|
|
1010
|
+
db (AsyncSession): The database session.
|
|
1011
|
+
user (schemas.User): The current user.
|
|
1012
|
+
|
|
1013
|
+
## Returns:
|
|
1014
|
+
|
|
1015
|
+
list[schemas.Connection]: The list of connections.
|
|
1016
|
+
|
|
1017
|
+
</dd>
|
|
1018
|
+
</dl>
|
|
1019
|
+
</dd>
|
|
1020
|
+
</dl>
|
|
1021
|
+
|
|
1022
|
+
#### 🔌 Usage
|
|
1023
|
+
|
|
1024
|
+
<dl>
|
|
1025
|
+
<dd>
|
|
1026
|
+
|
|
1027
|
+
<dl>
|
|
1028
|
+
<dd>
|
|
1029
|
+
|
|
1030
|
+
```typescript
|
|
1031
|
+
await client.connections.listConnectedIntegrations("source");
|
|
1032
|
+
```
|
|
1033
|
+
|
|
1034
|
+
</dd>
|
|
1035
|
+
</dl>
|
|
1036
|
+
</dd>
|
|
1037
|
+
</dl>
|
|
1038
|
+
|
|
1039
|
+
#### ⚙️ Parameters
|
|
1040
|
+
|
|
1041
|
+
<dl>
|
|
1042
|
+
<dd>
|
|
1043
|
+
|
|
1044
|
+
<dl>
|
|
1045
|
+
<dd>
|
|
1046
|
+
|
|
1047
|
+
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
1048
|
+
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
|
|
1052
|
+
<dl>
|
|
1053
|
+
<dd>
|
|
1054
|
+
|
|
1055
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1056
|
+
|
|
1057
|
+
</dd>
|
|
1058
|
+
</dl>
|
|
1059
|
+
</dd>
|
|
1060
|
+
</dl>
|
|
1061
|
+
|
|
1062
|
+
</dd>
|
|
1063
|
+
</dl>
|
|
1064
|
+
</details>
|
|
1065
|
+
|
|
1066
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">connectIntegration</a>(integrationType, shortName, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1067
|
+
<dl>
|
|
1068
|
+
<dd>
|
|
1069
|
+
|
|
1070
|
+
#### 📝 Description
|
|
1071
|
+
|
|
1072
|
+
<dl>
|
|
1073
|
+
<dd>
|
|
1074
|
+
|
|
1075
|
+
<dl>
|
|
1076
|
+
<dd>
|
|
1077
|
+
|
|
1078
|
+
Connect to a source, destination, or embedding model.
|
|
1079
|
+
|
|
1080
|
+
Expects a POST body with:
|
|
1081
|
+
|
|
1082
|
+
```json
|
|
1083
|
+
{
|
|
1084
|
+
"name": "required connection name",
|
|
1085
|
+
... other config fields specific to the integration type ...
|
|
1086
|
+
}
|
|
1087
|
+
```
|
|
1088
|
+
|
|
1089
|
+
## Args:
|
|
1090
|
+
|
|
1091
|
+
db: The database session.
|
|
1092
|
+
integration_type: The type of integration to connect to.
|
|
1093
|
+
short_name: The short name of the integration to connect to.
|
|
1094
|
+
name: The name of the connection.
|
|
1095
|
+
config_fields: The config fields for the integration.
|
|
1096
|
+
user: The current user.
|
|
1097
|
+
|
|
1098
|
+
## Returns:
|
|
1099
|
+
|
|
1100
|
+
schemas.Connection: The connection.
|
|
1101
|
+
|
|
1102
|
+
</dd>
|
|
1103
|
+
</dl>
|
|
1104
|
+
</dd>
|
|
1105
|
+
</dl>
|
|
1106
|
+
|
|
1107
|
+
#### 🔌 Usage
|
|
1108
|
+
|
|
1109
|
+
<dl>
|
|
1110
|
+
<dd>
|
|
1111
|
+
|
|
1112
|
+
<dl>
|
|
1113
|
+
<dd>
|
|
1114
|
+
|
|
1115
|
+
```typescript
|
|
1116
|
+
await client.connections.connectIntegration("source", "short_name", {
|
|
1117
|
+
configFields: {
|
|
1118
|
+
key: "value",
|
|
1119
|
+
},
|
|
1120
|
+
});
|
|
1121
|
+
```
|
|
1122
|
+
|
|
1123
|
+
</dd>
|
|
1124
|
+
</dl>
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
|
|
1128
|
+
#### ⚙️ Parameters
|
|
1129
|
+
|
|
1130
|
+
<dl>
|
|
1131
|
+
<dd>
|
|
1132
|
+
|
|
1133
|
+
<dl>
|
|
1134
|
+
<dd>
|
|
1135
|
+
|
|
1136
|
+
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
1137
|
+
|
|
1138
|
+
</dd>
|
|
1139
|
+
</dl>
|
|
1140
|
+
|
|
1141
|
+
<dl>
|
|
1142
|
+
<dd>
|
|
1143
|
+
|
|
1144
|
+
**shortName:** `string`
|
|
1145
|
+
|
|
1146
|
+
</dd>
|
|
1147
|
+
</dl>
|
|
1148
|
+
|
|
1149
|
+
<dl>
|
|
1150
|
+
<dd>
|
|
1151
|
+
|
|
1152
|
+
**request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
|
|
1153
|
+
|
|
1154
|
+
</dd>
|
|
1155
|
+
</dl>
|
|
1156
|
+
|
|
1157
|
+
<dl>
|
|
1158
|
+
<dd>
|
|
1159
|
+
|
|
1160
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1161
|
+
|
|
1162
|
+
</dd>
|
|
1163
|
+
</dl>
|
|
1164
|
+
</dd>
|
|
1165
|
+
</dl>
|
|
1166
|
+
|
|
1167
|
+
</dd>
|
|
1168
|
+
</dl>
|
|
1169
|
+
</details>
|
|
1170
|
+
|
|
1171
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnectionCredentials</a>(connectionId) -> Record<string, unknown></code></summary>
|
|
1172
|
+
<dl>
|
|
1173
|
+
<dd>
|
|
1174
|
+
|
|
1175
|
+
#### 📝 Description
|
|
1176
|
+
|
|
1177
|
+
<dl>
|
|
1178
|
+
<dd>
|
|
1179
|
+
|
|
1180
|
+
<dl>
|
|
1181
|
+
<dd>
|
|
1182
|
+
|
|
1183
|
+
Get the credentials for a connection.
|
|
1184
|
+
|
|
1185
|
+
## Args:
|
|
1186
|
+
|
|
1187
|
+
connection_id (UUID): The ID of the connection to get credentials for
|
|
1188
|
+
db (AsyncSession): The database session
|
|
1189
|
+
user (schemas.User): The current user
|
|
1190
|
+
|
|
1191
|
+
## Returns:
|
|
1192
|
+
|
|
1193
|
+
decrypted_credentials (dict): The credentials for the connection
|
|
1194
|
+
|
|
1195
|
+
</dd>
|
|
1196
|
+
</dl>
|
|
1197
|
+
</dd>
|
|
1198
|
+
</dl>
|
|
1199
|
+
|
|
1200
|
+
#### 🔌 Usage
|
|
1201
|
+
|
|
1202
|
+
<dl>
|
|
1203
|
+
<dd>
|
|
1204
|
+
|
|
1205
|
+
<dl>
|
|
1206
|
+
<dd>
|
|
1207
|
+
|
|
1208
|
+
```typescript
|
|
1209
|
+
await client.connections.getConnectionCredentials("connection_id");
|
|
1210
|
+
```
|
|
1211
|
+
|
|
1212
|
+
</dd>
|
|
1213
|
+
</dl>
|
|
1214
|
+
</dd>
|
|
1215
|
+
</dl>
|
|
1216
|
+
|
|
1217
|
+
#### ⚙️ Parameters
|
|
1218
|
+
|
|
1219
|
+
<dl>
|
|
1220
|
+
<dd>
|
|
1221
|
+
|
|
1222
|
+
<dl>
|
|
1223
|
+
<dd>
|
|
1224
|
+
|
|
1225
|
+
**connectionId:** `string`
|
|
1226
|
+
|
|
1227
|
+
</dd>
|
|
1228
|
+
</dl>
|
|
1229
|
+
|
|
1230
|
+
<dl>
|
|
1231
|
+
<dd>
|
|
1232
|
+
|
|
1233
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1234
|
+
|
|
1235
|
+
</dd>
|
|
1236
|
+
</dl>
|
|
1237
|
+
</dd>
|
|
1238
|
+
</dl>
|
|
1239
|
+
|
|
1240
|
+
</dd>
|
|
1241
|
+
</dl>
|
|
1242
|
+
</details>
|
|
1243
|
+
|
|
1244
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">deleteConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1245
|
+
<dl>
|
|
1246
|
+
<dd>
|
|
1247
|
+
|
|
1248
|
+
#### 📝 Description
|
|
1249
|
+
|
|
1250
|
+
<dl>
|
|
1251
|
+
<dd>
|
|
1252
|
+
|
|
1253
|
+
<dl>
|
|
1254
|
+
<dd>
|
|
1255
|
+
|
|
1256
|
+
Delete a connection.
|
|
1257
|
+
|
|
1258
|
+
Deletes the connection and integration credential.
|
|
1259
|
+
|
|
1260
|
+
## Args:
|
|
1261
|
+
|
|
1262
|
+
db (AsyncSession): The database session
|
|
1263
|
+
connection_id (UUID): The ID of the connection to delete
|
|
1264
|
+
user (schemas.User): The current user
|
|
1265
|
+
|
|
1266
|
+
## Returns:
|
|
1267
|
+
|
|
1268
|
+
connection (schemas.Connection): The deleted connection
|
|
1269
|
+
|
|
1270
|
+
</dd>
|
|
1271
|
+
</dl>
|
|
1272
|
+
</dd>
|
|
1273
|
+
</dl>
|
|
1274
|
+
|
|
1275
|
+
#### 🔌 Usage
|
|
1276
|
+
|
|
1277
|
+
<dl>
|
|
1278
|
+
<dd>
|
|
1279
|
+
|
|
1280
|
+
<dl>
|
|
1281
|
+
<dd>
|
|
1282
|
+
|
|
1283
|
+
```typescript
|
|
1284
|
+
await client.connections.deleteConnection("connection_id");
|
|
1285
|
+
```
|
|
1286
|
+
|
|
1287
|
+
</dd>
|
|
1288
|
+
</dl>
|
|
1289
|
+
</dd>
|
|
1290
|
+
</dl>
|
|
1291
|
+
|
|
1292
|
+
#### ⚙️ Parameters
|
|
1293
|
+
|
|
1294
|
+
<dl>
|
|
1295
|
+
<dd>
|
|
1296
|
+
|
|
1297
|
+
<dl>
|
|
1298
|
+
<dd>
|
|
1299
|
+
|
|
1300
|
+
**connectionId:** `string`
|
|
1301
|
+
|
|
1302
|
+
</dd>
|
|
1303
|
+
</dl>
|
|
1304
|
+
|
|
1305
|
+
<dl>
|
|
1306
|
+
<dd>
|
|
1307
|
+
|
|
1308
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1309
|
+
|
|
1310
|
+
</dd>
|
|
1311
|
+
</dl>
|
|
1312
|
+
</dd>
|
|
1313
|
+
</dl>
|
|
1314
|
+
|
|
1315
|
+
</dd>
|
|
1316
|
+
</dl>
|
|
1317
|
+
</details>
|
|
1318
|
+
|
|
1319
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectSourceConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1320
|
+
<dl>
|
|
1321
|
+
<dd>
|
|
1322
|
+
|
|
1323
|
+
#### 📝 Description
|
|
1324
|
+
|
|
1325
|
+
<dl>
|
|
1326
|
+
<dd>
|
|
1327
|
+
|
|
1328
|
+
<dl>
|
|
1329
|
+
<dd>
|
|
1330
|
+
|
|
1331
|
+
Disconnect from a source connection.
|
|
1332
|
+
|
|
1333
|
+
## Args:
|
|
1334
|
+
|
|
1335
|
+
db (AsyncSession): The database session
|
|
1336
|
+
connection_id (UUID): The ID of the connection to disconnect
|
|
895
1337
|
user (schemas.User): The current user
|
|
896
1338
|
|
|
897
1339
|
## Returns:
|
|
898
1340
|
|
|
899
|
-
connection (schemas.Connection): The
|
|
1341
|
+
connection (schemas.Connection): The disconnected connection
|
|
1342
|
+
|
|
1343
|
+
</dd>
|
|
1344
|
+
</dl>
|
|
1345
|
+
</dd>
|
|
1346
|
+
</dl>
|
|
1347
|
+
|
|
1348
|
+
#### 🔌 Usage
|
|
1349
|
+
|
|
1350
|
+
<dl>
|
|
1351
|
+
<dd>
|
|
1352
|
+
|
|
1353
|
+
<dl>
|
|
1354
|
+
<dd>
|
|
1355
|
+
|
|
1356
|
+
```typescript
|
|
1357
|
+
await client.connections.disconnectSourceConnection("connection_id");
|
|
1358
|
+
```
|
|
1359
|
+
|
|
1360
|
+
</dd>
|
|
1361
|
+
</dl>
|
|
1362
|
+
</dd>
|
|
1363
|
+
</dl>
|
|
1364
|
+
|
|
1365
|
+
#### ⚙️ Parameters
|
|
1366
|
+
|
|
1367
|
+
<dl>
|
|
1368
|
+
<dd>
|
|
1369
|
+
|
|
1370
|
+
<dl>
|
|
1371
|
+
<dd>
|
|
1372
|
+
|
|
1373
|
+
**connectionId:** `string`
|
|
1374
|
+
|
|
1375
|
+
</dd>
|
|
1376
|
+
</dl>
|
|
1377
|
+
|
|
1378
|
+
<dl>
|
|
1379
|
+
<dd>
|
|
1380
|
+
|
|
1381
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1382
|
+
|
|
1383
|
+
</dd>
|
|
1384
|
+
</dl>
|
|
1385
|
+
</dd>
|
|
1386
|
+
</dl>
|
|
1387
|
+
|
|
1388
|
+
</dd>
|
|
1389
|
+
</dl>
|
|
1390
|
+
</details>
|
|
1391
|
+
|
|
1392
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2AuthUrl</a>({ ...params }) -> string</code></summary>
|
|
1393
|
+
<dl>
|
|
1394
|
+
<dd>
|
|
1395
|
+
|
|
1396
|
+
#### 📝 Description
|
|
1397
|
+
|
|
1398
|
+
<dl>
|
|
1399
|
+
<dd>
|
|
1400
|
+
|
|
1401
|
+
<dl>
|
|
1402
|
+
<dd>
|
|
1403
|
+
|
|
1404
|
+
Get the OAuth2 authorization URL for a source.
|
|
1405
|
+
|
|
1406
|
+
## Args:
|
|
1407
|
+
|
|
1408
|
+
short_name: The short name of the source
|
|
1409
|
+
|
|
1410
|
+
</dd>
|
|
1411
|
+
</dl>
|
|
1412
|
+
</dd>
|
|
1413
|
+
</dl>
|
|
1414
|
+
|
|
1415
|
+
#### 🔌 Usage
|
|
1416
|
+
|
|
1417
|
+
<dl>
|
|
1418
|
+
<dd>
|
|
1419
|
+
|
|
1420
|
+
<dl>
|
|
1421
|
+
<dd>
|
|
1422
|
+
|
|
1423
|
+
```typescript
|
|
1424
|
+
await client.connections.getOauth2AuthUrl({
|
|
1425
|
+
shortName: "short_name",
|
|
1426
|
+
});
|
|
1427
|
+
```
|
|
1428
|
+
|
|
1429
|
+
</dd>
|
|
1430
|
+
</dl>
|
|
1431
|
+
</dd>
|
|
1432
|
+
</dl>
|
|
1433
|
+
|
|
1434
|
+
#### ⚙️ Parameters
|
|
1435
|
+
|
|
1436
|
+
<dl>
|
|
1437
|
+
<dd>
|
|
1438
|
+
|
|
1439
|
+
<dl>
|
|
1440
|
+
<dd>
|
|
1441
|
+
|
|
1442
|
+
**request:** `AirweaveSDK.GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest`
|
|
1443
|
+
|
|
1444
|
+
</dd>
|
|
1445
|
+
</dl>
|
|
1446
|
+
|
|
1447
|
+
<dl>
|
|
1448
|
+
<dd>
|
|
1449
|
+
|
|
1450
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1451
|
+
|
|
1452
|
+
</dd>
|
|
1453
|
+
</dl>
|
|
1454
|
+
</dd>
|
|
1455
|
+
</dl>
|
|
1456
|
+
|
|
1457
|
+
</dd>
|
|
1458
|
+
</dl>
|
|
1459
|
+
</details>
|
|
1460
|
+
|
|
1461
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2Code</a>({ ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1462
|
+
<dl>
|
|
1463
|
+
<dd>
|
|
1464
|
+
|
|
1465
|
+
#### 📝 Description
|
|
1466
|
+
|
|
1467
|
+
<dl>
|
|
1468
|
+
<dd>
|
|
1469
|
+
|
|
1470
|
+
<dl>
|
|
1471
|
+
<dd>
|
|
1472
|
+
|
|
1473
|
+
Send the OAuth2 authorization code for a source.
|
|
1474
|
+
|
|
1475
|
+
This will:
|
|
1476
|
+
|
|
1477
|
+
1. Get the OAuth2 settings for the source
|
|
1478
|
+
2. Exchange the authorization code for a token
|
|
1479
|
+
3. Create an integration credential with the token
|
|
1480
|
+
|
|
1481
|
+
## Args:
|
|
1482
|
+
|
|
1483
|
+
db: The database session
|
|
1484
|
+
short_name: The short name of the source
|
|
1485
|
+
code: The authorization code
|
|
1486
|
+
user: The current user
|
|
1487
|
+
|
|
1488
|
+
## Returns:
|
|
1489
|
+
|
|
1490
|
+
connection (schemas.Connection): The created connection
|
|
1491
|
+
|
|
1492
|
+
</dd>
|
|
1493
|
+
</dl>
|
|
1494
|
+
</dd>
|
|
1495
|
+
</dl>
|
|
1496
|
+
|
|
1497
|
+
#### 🔌 Usage
|
|
1498
|
+
|
|
1499
|
+
<dl>
|
|
1500
|
+
<dd>
|
|
1501
|
+
|
|
1502
|
+
<dl>
|
|
1503
|
+
<dd>
|
|
1504
|
+
|
|
1505
|
+
```typescript
|
|
1506
|
+
await client.connections.sendOauth2Code({
|
|
1507
|
+
shortName: "short_name",
|
|
1508
|
+
code: "code",
|
|
1509
|
+
});
|
|
1510
|
+
```
|
|
1511
|
+
|
|
1512
|
+
</dd>
|
|
1513
|
+
</dl>
|
|
1514
|
+
</dd>
|
|
1515
|
+
</dl>
|
|
1516
|
+
|
|
1517
|
+
#### ⚙️ Parameters
|
|
1518
|
+
|
|
1519
|
+
<dl>
|
|
1520
|
+
<dd>
|
|
1521
|
+
|
|
1522
|
+
<dl>
|
|
1523
|
+
<dd>
|
|
1524
|
+
|
|
1525
|
+
**request:** `AirweaveSDK.BodySendOauth2CodeConnectionsOauth2SourceCodePost`
|
|
1526
|
+
|
|
1527
|
+
</dd>
|
|
1528
|
+
</dl>
|
|
1529
|
+
|
|
1530
|
+
<dl>
|
|
1531
|
+
<dd>
|
|
1532
|
+
|
|
1533
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1534
|
+
|
|
1535
|
+
</dd>
|
|
1536
|
+
</dl>
|
|
1537
|
+
</dd>
|
|
1538
|
+
</dl>
|
|
1539
|
+
|
|
1540
|
+
</dd>
|
|
1541
|
+
</dl>
|
|
1542
|
+
</details>
|
|
1543
|
+
|
|
1544
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2WhiteLabelCode</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1545
|
+
<dl>
|
|
1546
|
+
<dd>
|
|
1547
|
+
|
|
1548
|
+
#### 📝 Description
|
|
1549
|
+
|
|
1550
|
+
<dl>
|
|
1551
|
+
<dd>
|
|
1552
|
+
|
|
1553
|
+
<dl>
|
|
1554
|
+
<dd>
|
|
1555
|
+
|
|
1556
|
+
Exchange the OAuth2 authorization code for a white label integration.
|
|
1557
|
+
|
|
1558
|
+
## Args:
|
|
1559
|
+
|
|
1560
|
+
db: The database session
|
|
1561
|
+
white_label_id: The ID of the white label integration
|
|
1562
|
+
code: The authorization code
|
|
1563
|
+
user: The current user
|
|
1564
|
+
background_tasks: The background tasks
|
|
1565
|
+
|
|
1566
|
+
## Returns:
|
|
1567
|
+
|
|
1568
|
+
connection (schemas.Connection): The created connection
|
|
1569
|
+
|
|
1570
|
+
</dd>
|
|
1571
|
+
</dl>
|
|
1572
|
+
</dd>
|
|
1573
|
+
</dl>
|
|
1574
|
+
|
|
1575
|
+
#### 🔌 Usage
|
|
1576
|
+
|
|
1577
|
+
<dl>
|
|
1578
|
+
<dd>
|
|
1579
|
+
|
|
1580
|
+
<dl>
|
|
1581
|
+
<dd>
|
|
1582
|
+
|
|
1583
|
+
```typescript
|
|
1584
|
+
await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
1585
|
+
```
|
|
1586
|
+
|
|
1587
|
+
</dd>
|
|
1588
|
+
</dl>
|
|
1589
|
+
</dd>
|
|
1590
|
+
</dl>
|
|
1591
|
+
|
|
1592
|
+
#### ⚙️ Parameters
|
|
1593
|
+
|
|
1594
|
+
<dl>
|
|
1595
|
+
<dd>
|
|
1596
|
+
|
|
1597
|
+
<dl>
|
|
1598
|
+
<dd>
|
|
1599
|
+
|
|
1600
|
+
**whiteLabelId:** `string`
|
|
1601
|
+
|
|
1602
|
+
</dd>
|
|
1603
|
+
</dl>
|
|
1604
|
+
|
|
1605
|
+
<dl>
|
|
1606
|
+
<dd>
|
|
1607
|
+
|
|
1608
|
+
**request:** `string`
|
|
1609
|
+
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
|
|
1613
|
+
<dl>
|
|
1614
|
+
<dd>
|
|
1615
|
+
|
|
1616
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1617
|
+
|
|
1618
|
+
</dd>
|
|
1619
|
+
</dl>
|
|
1620
|
+
</dd>
|
|
1621
|
+
</dl>
|
|
1622
|
+
|
|
1623
|
+
</dd>
|
|
1624
|
+
</dl>
|
|
1625
|
+
</details>
|
|
1626
|
+
|
|
1627
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2WhiteLabelAuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
1628
|
+
<dl>
|
|
1629
|
+
<dd>
|
|
1630
|
+
|
|
1631
|
+
#### 📝 Description
|
|
1632
|
+
|
|
1633
|
+
<dl>
|
|
1634
|
+
<dd>
|
|
1635
|
+
|
|
1636
|
+
<dl>
|
|
1637
|
+
<dd>
|
|
1638
|
+
|
|
1639
|
+
Get the OAuth2 authorization URL for a white label integration.
|
|
1640
|
+
|
|
1641
|
+
## Args:
|
|
1642
|
+
|
|
1643
|
+
db: The database session
|
|
1644
|
+
white_label_id: The ID of the white label integration
|
|
1645
|
+
user: The current user
|
|
1646
|
+
|
|
1647
|
+
## Returns:
|
|
1648
|
+
|
|
1649
|
+
str: The OAuth2 authorization URL
|
|
1650
|
+
|
|
1651
|
+
</dd>
|
|
1652
|
+
</dl>
|
|
1653
|
+
</dd>
|
|
1654
|
+
</dl>
|
|
1655
|
+
|
|
1656
|
+
#### 🔌 Usage
|
|
1657
|
+
|
|
1658
|
+
<dl>
|
|
1659
|
+
<dd>
|
|
1660
|
+
|
|
1661
|
+
<dl>
|
|
1662
|
+
<dd>
|
|
1663
|
+
|
|
1664
|
+
```typescript
|
|
1665
|
+
await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
1666
|
+
```
|
|
1667
|
+
|
|
1668
|
+
</dd>
|
|
1669
|
+
</dl>
|
|
1670
|
+
</dd>
|
|
1671
|
+
</dl>
|
|
1672
|
+
|
|
1673
|
+
#### ⚙️ Parameters
|
|
1674
|
+
|
|
1675
|
+
<dl>
|
|
1676
|
+
<dd>
|
|
1677
|
+
|
|
1678
|
+
<dl>
|
|
1679
|
+
<dd>
|
|
1680
|
+
|
|
1681
|
+
**whiteLabelId:** `string`
|
|
1682
|
+
|
|
1683
|
+
</dd>
|
|
1684
|
+
</dl>
|
|
1685
|
+
|
|
1686
|
+
<dl>
|
|
1687
|
+
<dd>
|
|
1688
|
+
|
|
1689
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1690
|
+
|
|
1691
|
+
</dd>
|
|
1692
|
+
</dl>
|
|
1693
|
+
</dd>
|
|
1694
|
+
</dl>
|
|
1695
|
+
|
|
1696
|
+
</dd>
|
|
1697
|
+
</dl>
|
|
1698
|
+
</details>
|
|
1699
|
+
|
|
1700
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">connectSlackWithToken</a>({ ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1701
|
+
<dl>
|
|
1702
|
+
<dd>
|
|
1703
|
+
|
|
1704
|
+
#### 📝 Description
|
|
1705
|
+
|
|
1706
|
+
<dl>
|
|
1707
|
+
<dd>
|
|
1708
|
+
|
|
1709
|
+
<dl>
|
|
1710
|
+
<dd>
|
|
1711
|
+
|
|
1712
|
+
Connect to Slack using a direct API token (for local development only).
|
|
1713
|
+
|
|
1714
|
+
## Args:
|
|
1715
|
+
|
|
1716
|
+
db: The database session.
|
|
1717
|
+
token: The Slack API token.
|
|
1718
|
+
name: The name of the connection.
|
|
1719
|
+
user: The current user.
|
|
1720
|
+
|
|
1721
|
+
## Returns:
|
|
1722
|
+
|
|
1723
|
+
schemas.Connection: The connection.
|
|
1724
|
+
|
|
1725
|
+
</dd>
|
|
1726
|
+
</dl>
|
|
1727
|
+
</dd>
|
|
1728
|
+
</dl>
|
|
1729
|
+
|
|
1730
|
+
#### 🔌 Usage
|
|
1731
|
+
|
|
1732
|
+
<dl>
|
|
1733
|
+
<dd>
|
|
1734
|
+
|
|
1735
|
+
<dl>
|
|
1736
|
+
<dd>
|
|
1737
|
+
|
|
1738
|
+
```typescript
|
|
1739
|
+
await client.connections.connectSlackWithToken({
|
|
1740
|
+
token: "token",
|
|
1741
|
+
});
|
|
1742
|
+
```
|
|
1743
|
+
|
|
1744
|
+
</dd>
|
|
1745
|
+
</dl>
|
|
1746
|
+
</dd>
|
|
1747
|
+
</dl>
|
|
1748
|
+
|
|
1749
|
+
#### ⚙️ Parameters
|
|
1750
|
+
|
|
1751
|
+
<dl>
|
|
1752
|
+
<dd>
|
|
1753
|
+
|
|
1754
|
+
<dl>
|
|
1755
|
+
<dd>
|
|
1756
|
+
|
|
1757
|
+
**request:** `AirweaveSDK.BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost`
|
|
1758
|
+
|
|
1759
|
+
</dd>
|
|
1760
|
+
</dl>
|
|
1761
|
+
|
|
1762
|
+
<dl>
|
|
1763
|
+
<dd>
|
|
1764
|
+
|
|
1765
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1766
|
+
|
|
1767
|
+
</dd>
|
|
1768
|
+
</dl>
|
|
1769
|
+
</dd>
|
|
1770
|
+
</dl>
|
|
1771
|
+
|
|
1772
|
+
</dd>
|
|
1773
|
+
</dl>
|
|
1774
|
+
</details>
|
|
1775
|
+
|
|
1776
|
+
## Sync
|
|
1777
|
+
|
|
1778
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1779
|
+
<dl>
|
|
1780
|
+
<dd>
|
|
1781
|
+
|
|
1782
|
+
#### 📝 Description
|
|
1783
|
+
|
|
1784
|
+
<dl>
|
|
1785
|
+
<dd>
|
|
1786
|
+
|
|
1787
|
+
<dl>
|
|
1788
|
+
<dd>
|
|
1789
|
+
|
|
1790
|
+
List all syncs for the current user.
|
|
1791
|
+
|
|
1792
|
+
## Args:
|
|
1793
|
+
|
|
1794
|
+
db: The database session
|
|
1795
|
+
skip: The number of syncs to skip
|
|
1796
|
+
limit: The number of syncs to return
|
|
1797
|
+
with_source_connection: Whether to include the source connection in the response
|
|
1798
|
+
user: The current user
|
|
1799
|
+
|
|
1800
|
+
## Returns:
|
|
1801
|
+
|
|
1802
|
+
list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
|
|
1803
|
+
|
|
1804
|
+
</dd>
|
|
1805
|
+
</dl>
|
|
1806
|
+
</dd>
|
|
1807
|
+
</dl>
|
|
1808
|
+
|
|
1809
|
+
#### 🔌 Usage
|
|
1810
|
+
|
|
1811
|
+
<dl>
|
|
1812
|
+
<dd>
|
|
1813
|
+
|
|
1814
|
+
<dl>
|
|
1815
|
+
<dd>
|
|
1816
|
+
|
|
1817
|
+
```typescript
|
|
1818
|
+
await client.sync.listSyncs();
|
|
1819
|
+
```
|
|
1820
|
+
|
|
1821
|
+
</dd>
|
|
1822
|
+
</dl>
|
|
1823
|
+
</dd>
|
|
1824
|
+
</dl>
|
|
1825
|
+
|
|
1826
|
+
#### ⚙️ Parameters
|
|
1827
|
+
|
|
1828
|
+
<dl>
|
|
1829
|
+
<dd>
|
|
1830
|
+
|
|
1831
|
+
<dl>
|
|
1832
|
+
<dd>
|
|
1833
|
+
|
|
1834
|
+
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1835
|
+
|
|
1836
|
+
</dd>
|
|
1837
|
+
</dl>
|
|
1838
|
+
|
|
1839
|
+
<dl>
|
|
1840
|
+
<dd>
|
|
1841
|
+
|
|
1842
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1843
|
+
|
|
1844
|
+
</dd>
|
|
1845
|
+
</dl>
|
|
1846
|
+
</dd>
|
|
1847
|
+
</dl>
|
|
1848
|
+
|
|
1849
|
+
</dd>
|
|
1850
|
+
</dl>
|
|
1851
|
+
</details>
|
|
1852
|
+
|
|
1853
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">createSync</a>({ ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1854
|
+
<dl>
|
|
1855
|
+
<dd>
|
|
1856
|
+
|
|
1857
|
+
#### 📝 Description
|
|
1858
|
+
|
|
1859
|
+
<dl>
|
|
1860
|
+
<dd>
|
|
1861
|
+
|
|
1862
|
+
<dl>
|
|
1863
|
+
<dd>
|
|
1864
|
+
|
|
1865
|
+
Create a new sync configuration.
|
|
1866
|
+
|
|
1867
|
+
## Args:
|
|
1868
|
+
|
|
1869
|
+
db: The database session
|
|
1870
|
+
sync_in: The sync to create
|
|
1871
|
+
user: The current user
|
|
1872
|
+
background_tasks: The background tasks
|
|
1873
|
+
|
|
1874
|
+
## Returns:
|
|
1875
|
+
|
|
1876
|
+
sync (schemas.Sync): The created sync
|
|
1877
|
+
|
|
1878
|
+
</dd>
|
|
1879
|
+
</dl>
|
|
1880
|
+
</dd>
|
|
1881
|
+
</dl>
|
|
1882
|
+
|
|
1883
|
+
#### 🔌 Usage
|
|
1884
|
+
|
|
1885
|
+
<dl>
|
|
1886
|
+
<dd>
|
|
1887
|
+
|
|
1888
|
+
<dl>
|
|
1889
|
+
<dd>
|
|
1890
|
+
|
|
1891
|
+
```typescript
|
|
1892
|
+
await client.sync.createSync({
|
|
1893
|
+
name: "name",
|
|
1894
|
+
sourceConnectionId: "source_connection_id",
|
|
1895
|
+
destinationConnectionIds: ["destination_connection_ids"],
|
|
1896
|
+
});
|
|
1897
|
+
```
|
|
1898
|
+
|
|
1899
|
+
</dd>
|
|
1900
|
+
</dl>
|
|
1901
|
+
</dd>
|
|
1902
|
+
</dl>
|
|
1903
|
+
|
|
1904
|
+
#### ⚙️ Parameters
|
|
1905
|
+
|
|
1906
|
+
<dl>
|
|
1907
|
+
<dd>
|
|
1908
|
+
|
|
1909
|
+
<dl>
|
|
1910
|
+
<dd>
|
|
1911
|
+
|
|
1912
|
+
**request:** `AirweaveSDK.SyncCreate`
|
|
1913
|
+
|
|
1914
|
+
</dd>
|
|
1915
|
+
</dl>
|
|
1916
|
+
|
|
1917
|
+
<dl>
|
|
1918
|
+
<dd>
|
|
1919
|
+
|
|
1920
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1921
|
+
|
|
1922
|
+
</dd>
|
|
1923
|
+
</dl>
|
|
1924
|
+
</dd>
|
|
1925
|
+
</dl>
|
|
1926
|
+
|
|
1927
|
+
</dd>
|
|
1928
|
+
</dl>
|
|
1929
|
+
</details>
|
|
1930
|
+
|
|
1931
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listAllJobs</a>({ ...params }) -> AirweaveSDK.SyncJob[]</code></summary>
|
|
1932
|
+
<dl>
|
|
1933
|
+
<dd>
|
|
1934
|
+
|
|
1935
|
+
#### 📝 Description
|
|
1936
|
+
|
|
1937
|
+
<dl>
|
|
1938
|
+
<dd>
|
|
1939
|
+
|
|
1940
|
+
<dl>
|
|
1941
|
+
<dd>
|
|
1942
|
+
|
|
1943
|
+
List all sync jobs across all syncs.
|
|
1944
|
+
|
|
1945
|
+
## Args:
|
|
1946
|
+
|
|
1947
|
+
db: The database session
|
|
1948
|
+
skip: The number of jobs to skip
|
|
1949
|
+
limit: The number of jobs to return
|
|
1950
|
+
user: The current user
|
|
1951
|
+
|
|
1952
|
+
## Returns:
|
|
1953
|
+
|
|
1954
|
+
list[schemas.SyncJob]: A list of all sync jobs
|
|
900
1955
|
|
|
901
1956
|
</dd>
|
|
902
1957
|
</dl>
|
|
@@ -912,7 +1967,7 @@ Deletes the connection and integration credential.
|
|
|
912
1967
|
<dd>
|
|
913
1968
|
|
|
914
1969
|
```typescript
|
|
915
|
-
await client.
|
|
1970
|
+
await client.sync.listAllJobs();
|
|
916
1971
|
```
|
|
917
1972
|
|
|
918
1973
|
</dd>
|
|
@@ -928,7 +1983,7 @@ await client.connections.deleteConnection("connection_id");
|
|
|
928
1983
|
<dl>
|
|
929
1984
|
<dd>
|
|
930
1985
|
|
|
931
|
-
**
|
|
1986
|
+
**request:** `AirweaveSDK.ListAllJobsSyncJobsGetRequest`
|
|
932
1987
|
|
|
933
1988
|
</dd>
|
|
934
1989
|
</dl>
|
|
@@ -936,7 +1991,7 @@ await client.connections.deleteConnection("connection_id");
|
|
|
936
1991
|
<dl>
|
|
937
1992
|
<dd>
|
|
938
1993
|
|
|
939
|
-
**requestOptions:** `
|
|
1994
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
940
1995
|
|
|
941
1996
|
</dd>
|
|
942
1997
|
</dl>
|
|
@@ -947,7 +2002,7 @@ await client.connections.deleteConnection("connection_id");
|
|
|
947
2002
|
</dl>
|
|
948
2003
|
</details>
|
|
949
2004
|
|
|
950
|
-
<details><summary><code>client.
|
|
2005
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
|
|
951
2006
|
<dl>
|
|
952
2007
|
<dd>
|
|
953
2008
|
|
|
@@ -959,17 +2014,17 @@ await client.connections.deleteConnection("connection_id");
|
|
|
959
2014
|
<dl>
|
|
960
2015
|
<dd>
|
|
961
2016
|
|
|
962
|
-
|
|
2017
|
+
Get a specific sync by ID.
|
|
963
2018
|
|
|
964
2019
|
## Args:
|
|
965
2020
|
|
|
966
|
-
db
|
|
967
|
-
|
|
968
|
-
user
|
|
2021
|
+
db: The database session
|
|
2022
|
+
sync_id: The ID of the sync to get
|
|
2023
|
+
user: The current user
|
|
969
2024
|
|
|
970
2025
|
## Returns:
|
|
971
2026
|
|
|
972
|
-
|
|
2027
|
+
sync (schemas.Sync): The sync
|
|
973
2028
|
|
|
974
2029
|
</dd>
|
|
975
2030
|
</dl>
|
|
@@ -985,7 +2040,7 @@ Disconnect from a source connection.
|
|
|
985
2040
|
<dd>
|
|
986
2041
|
|
|
987
2042
|
```typescript
|
|
988
|
-
await client.
|
|
2043
|
+
await client.sync.getSync("sync_id");
|
|
989
2044
|
```
|
|
990
2045
|
|
|
991
2046
|
</dd>
|
|
@@ -1001,7 +2056,7 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1001
2056
|
<dl>
|
|
1002
2057
|
<dd>
|
|
1003
2058
|
|
|
1004
|
-
**
|
|
2059
|
+
**syncId:** `string`
|
|
1005
2060
|
|
|
1006
2061
|
</dd>
|
|
1007
2062
|
</dl>
|
|
@@ -1009,7 +2064,7 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1009
2064
|
<dl>
|
|
1010
2065
|
<dd>
|
|
1011
2066
|
|
|
1012
|
-
**requestOptions:** `
|
|
2067
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1013
2068
|
|
|
1014
2069
|
</dd>
|
|
1015
2070
|
</dl>
|
|
@@ -1020,7 +2075,7 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1020
2075
|
</dl>
|
|
1021
2076
|
</details>
|
|
1022
2077
|
|
|
1023
|
-
<details><summary><code>client.
|
|
2078
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">deleteSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1024
2079
|
<dl>
|
|
1025
2080
|
<dd>
|
|
1026
2081
|
|
|
@@ -1032,17 +2087,18 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1032
2087
|
<dl>
|
|
1033
2088
|
<dd>
|
|
1034
2089
|
|
|
1035
|
-
|
|
2090
|
+
Delete a sync configuration and optionally its associated data.
|
|
1036
2091
|
|
|
1037
2092
|
## Args:
|
|
1038
2093
|
|
|
1039
|
-
db
|
|
1040
|
-
|
|
1041
|
-
|
|
2094
|
+
db: The database session
|
|
2095
|
+
sync_id: The ID of the sync to delete
|
|
2096
|
+
delete_data: Whether to delete the data associated with the sync
|
|
2097
|
+
user: The current user
|
|
1042
2098
|
|
|
1043
2099
|
## Returns:
|
|
1044
2100
|
|
|
1045
|
-
|
|
2101
|
+
sync (schemas.Sync): The deleted sync
|
|
1046
2102
|
|
|
1047
2103
|
</dd>
|
|
1048
2104
|
</dl>
|
|
@@ -1058,7 +2114,7 @@ Disconnect from a destination connection.
|
|
|
1058
2114
|
<dd>
|
|
1059
2115
|
|
|
1060
2116
|
```typescript
|
|
1061
|
-
await client.
|
|
2117
|
+
await client.sync.deleteSync("sync_id");
|
|
1062
2118
|
```
|
|
1063
2119
|
|
|
1064
2120
|
</dd>
|
|
@@ -1074,7 +2130,7 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1074
2130
|
<dl>
|
|
1075
2131
|
<dd>
|
|
1076
2132
|
|
|
1077
|
-
**
|
|
2133
|
+
**syncId:** `string`
|
|
1078
2134
|
|
|
1079
2135
|
</dd>
|
|
1080
2136
|
</dl>
|
|
@@ -1082,7 +2138,15 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1082
2138
|
<dl>
|
|
1083
2139
|
<dd>
|
|
1084
2140
|
|
|
1085
|
-
**
|
|
2141
|
+
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
2142
|
+
|
|
2143
|
+
</dd>
|
|
2144
|
+
</dl>
|
|
2145
|
+
|
|
2146
|
+
<dl>
|
|
2147
|
+
<dd>
|
|
2148
|
+
|
|
2149
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1086
2150
|
|
|
1087
2151
|
</dd>
|
|
1088
2152
|
</dl>
|
|
@@ -1093,7 +2157,7 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1093
2157
|
</dl>
|
|
1094
2158
|
</details>
|
|
1095
2159
|
|
|
1096
|
-
<details><summary><code>client.
|
|
2160
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">updateSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1097
2161
|
<dl>
|
|
1098
2162
|
<dd>
|
|
1099
2163
|
|
|
@@ -1105,14 +2169,19 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1105
2169
|
<dl>
|
|
1106
2170
|
<dd>
|
|
1107
2171
|
|
|
1108
|
-
|
|
2172
|
+
Update a sync configuration.
|
|
1109
2173
|
|
|
1110
2174
|
## Args:
|
|
1111
2175
|
|
|
1112
2176
|
db: The database session
|
|
1113
|
-
|
|
2177
|
+
sync_id: The ID of the sync to update
|
|
2178
|
+
sync_update: The sync update data
|
|
1114
2179
|
user: The current user
|
|
1115
2180
|
|
|
2181
|
+
## Returns:
|
|
2182
|
+
|
|
2183
|
+
sync (schemas.Sync): The updated sync
|
|
2184
|
+
|
|
1116
2185
|
</dd>
|
|
1117
2186
|
</dl>
|
|
1118
2187
|
</dd>
|
|
@@ -1127,9 +2196,7 @@ Get the OAuth2 authorization URL for a source.
|
|
|
1127
2196
|
<dd>
|
|
1128
2197
|
|
|
1129
2198
|
```typescript
|
|
1130
|
-
await client.
|
|
1131
|
-
shortName: "short_name",
|
|
1132
|
-
});
|
|
2199
|
+
await client.sync.updateSync("sync_id");
|
|
1133
2200
|
```
|
|
1134
2201
|
|
|
1135
2202
|
</dd>
|
|
@@ -1145,7 +2212,7 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1145
2212
|
<dl>
|
|
1146
2213
|
<dd>
|
|
1147
2214
|
|
|
1148
|
-
**
|
|
2215
|
+
**syncId:** `string`
|
|
1149
2216
|
|
|
1150
2217
|
</dd>
|
|
1151
2218
|
</dl>
|
|
@@ -1153,7 +2220,15 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1153
2220
|
<dl>
|
|
1154
2221
|
<dd>
|
|
1155
2222
|
|
|
1156
|
-
**
|
|
2223
|
+
**request:** `AirweaveSDK.SyncUpdate`
|
|
2224
|
+
|
|
2225
|
+
</dd>
|
|
2226
|
+
</dl>
|
|
2227
|
+
|
|
2228
|
+
<dl>
|
|
2229
|
+
<dd>
|
|
2230
|
+
|
|
2231
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1157
2232
|
|
|
1158
2233
|
</dd>
|
|
1159
2234
|
</dl>
|
|
@@ -1164,7 +2239,7 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1164
2239
|
</dl>
|
|
1165
2240
|
</details>
|
|
1166
2241
|
|
|
1167
|
-
<details><summary><code>client.
|
|
2242
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">runSync</a>(syncId) -> AirweaveSDK.SyncJob</code></summary>
|
|
1168
2243
|
<dl>
|
|
1169
2244
|
<dd>
|
|
1170
2245
|
|
|
@@ -1176,24 +2251,91 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1176
2251
|
<dl>
|
|
1177
2252
|
<dd>
|
|
1178
2253
|
|
|
1179
|
-
|
|
2254
|
+
Trigger a sync run.
|
|
1180
2255
|
|
|
1181
|
-
|
|
2256
|
+
## Args:
|
|
1182
2257
|
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
2258
|
+
db: The database session
|
|
2259
|
+
sync_id: The ID of the sync to run
|
|
2260
|
+
user: The current user
|
|
2261
|
+
background_tasks: The background tasks
|
|
2262
|
+
|
|
2263
|
+
## Returns:
|
|
2264
|
+
|
|
2265
|
+
sync_job (schemas.SyncJob): The sync job
|
|
2266
|
+
|
|
2267
|
+
</dd>
|
|
2268
|
+
</dl>
|
|
2269
|
+
</dd>
|
|
2270
|
+
</dl>
|
|
2271
|
+
|
|
2272
|
+
#### 🔌 Usage
|
|
2273
|
+
|
|
2274
|
+
<dl>
|
|
2275
|
+
<dd>
|
|
2276
|
+
|
|
2277
|
+
<dl>
|
|
2278
|
+
<dd>
|
|
2279
|
+
|
|
2280
|
+
```typescript
|
|
2281
|
+
await client.sync.runSync("sync_id");
|
|
2282
|
+
```
|
|
2283
|
+
|
|
2284
|
+
</dd>
|
|
2285
|
+
</dl>
|
|
2286
|
+
</dd>
|
|
2287
|
+
</dl>
|
|
2288
|
+
|
|
2289
|
+
#### ⚙️ Parameters
|
|
2290
|
+
|
|
2291
|
+
<dl>
|
|
2292
|
+
<dd>
|
|
2293
|
+
|
|
2294
|
+
<dl>
|
|
2295
|
+
<dd>
|
|
2296
|
+
|
|
2297
|
+
**syncId:** `string`
|
|
2298
|
+
|
|
2299
|
+
</dd>
|
|
2300
|
+
</dl>
|
|
2301
|
+
|
|
2302
|
+
<dl>
|
|
2303
|
+
<dd>
|
|
2304
|
+
|
|
2305
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2306
|
+
|
|
2307
|
+
</dd>
|
|
2308
|
+
</dl>
|
|
2309
|
+
</dd>
|
|
2310
|
+
</dl>
|
|
2311
|
+
|
|
2312
|
+
</dd>
|
|
2313
|
+
</dl>
|
|
2314
|
+
</details>
|
|
2315
|
+
|
|
2316
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncJobs</a>(syncId) -> AirweaveSDK.SyncJob[]</code></summary>
|
|
2317
|
+
<dl>
|
|
2318
|
+
<dd>
|
|
2319
|
+
|
|
2320
|
+
#### 📝 Description
|
|
2321
|
+
|
|
2322
|
+
<dl>
|
|
2323
|
+
<dd>
|
|
2324
|
+
|
|
2325
|
+
<dl>
|
|
2326
|
+
<dd>
|
|
2327
|
+
|
|
2328
|
+
List all jobs for a specific sync.
|
|
1186
2329
|
|
|
1187
2330
|
## Args:
|
|
1188
2331
|
|
|
1189
2332
|
db: The database session
|
|
1190
|
-
|
|
1191
|
-
code: The authorization code
|
|
2333
|
+
sync_id: The ID of the sync to list jobs for
|
|
1192
2334
|
user: The current user
|
|
1193
2335
|
|
|
1194
2336
|
## Returns:
|
|
1195
2337
|
|
|
1196
|
-
|
|
2338
|
+
list[schemas.SyncJob]: A list of sync jobs
|
|
1197
2339
|
|
|
1198
2340
|
</dd>
|
|
1199
2341
|
</dl>
|
|
@@ -1209,10 +2351,7 @@ This will:
|
|
|
1209
2351
|
<dd>
|
|
1210
2352
|
|
|
1211
2353
|
```typescript
|
|
1212
|
-
await client.
|
|
1213
|
-
shortName: "short_name",
|
|
1214
|
-
code: "code",
|
|
1215
|
-
});
|
|
2354
|
+
await client.sync.listSyncJobs("sync_id");
|
|
1216
2355
|
```
|
|
1217
2356
|
|
|
1218
2357
|
</dd>
|
|
@@ -1228,7 +2367,7 @@ await client.connections.sendOauth2Code({
|
|
|
1228
2367
|
<dl>
|
|
1229
2368
|
<dd>
|
|
1230
2369
|
|
|
1231
|
-
**
|
|
2370
|
+
**syncId:** `string`
|
|
1232
2371
|
|
|
1233
2372
|
</dd>
|
|
1234
2373
|
</dl>
|
|
@@ -1236,7 +2375,7 @@ await client.connections.sendOauth2Code({
|
|
|
1236
2375
|
<dl>
|
|
1237
2376
|
<dd>
|
|
1238
2377
|
|
|
1239
|
-
**requestOptions:** `
|
|
2378
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1240
2379
|
|
|
1241
2380
|
</dd>
|
|
1242
2381
|
</dl>
|
|
@@ -1247,7 +2386,7 @@ await client.connections.sendOauth2Code({
|
|
|
1247
2386
|
</dl>
|
|
1248
2387
|
</details>
|
|
1249
2388
|
|
|
1250
|
-
<details><summary><code>client.
|
|
2389
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncJob</a>(syncId, jobId) -> AirweaveSDK.SyncJob</code></summary>
|
|
1251
2390
|
<dl>
|
|
1252
2391
|
<dd>
|
|
1253
2392
|
|
|
@@ -1259,19 +2398,18 @@ await client.connections.sendOauth2Code({
|
|
|
1259
2398
|
<dl>
|
|
1260
2399
|
<dd>
|
|
1261
2400
|
|
|
1262
|
-
|
|
2401
|
+
Get details of a specific sync job.
|
|
1263
2402
|
|
|
1264
2403
|
## Args:
|
|
1265
2404
|
|
|
1266
2405
|
db: The database session
|
|
1267
|
-
|
|
1268
|
-
|
|
2406
|
+
sync_id: The ID of the sync to list jobs for
|
|
2407
|
+
job_id: The ID of the job to get
|
|
1269
2408
|
user: The current user
|
|
1270
|
-
background_tasks: The background tasks
|
|
1271
2409
|
|
|
1272
2410
|
## Returns:
|
|
1273
2411
|
|
|
1274
|
-
|
|
2412
|
+
sync_job (schemas.SyncJob): The sync job
|
|
1275
2413
|
|
|
1276
2414
|
</dd>
|
|
1277
2415
|
</dl>
|
|
@@ -1287,7 +2425,7 @@ Exchange the OAuth2 authorization code for a white label integration.
|
|
|
1287
2425
|
<dd>
|
|
1288
2426
|
|
|
1289
2427
|
```typescript
|
|
1290
|
-
await client.
|
|
2428
|
+
await client.sync.getSyncJob("sync_id", "job_id");
|
|
1291
2429
|
```
|
|
1292
2430
|
|
|
1293
2431
|
</dd>
|
|
@@ -1303,7 +2441,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1303
2441
|
<dl>
|
|
1304
2442
|
<dd>
|
|
1305
2443
|
|
|
1306
|
-
**
|
|
2444
|
+
**syncId:** `string`
|
|
1307
2445
|
|
|
1308
2446
|
</dd>
|
|
1309
2447
|
</dl>
|
|
@@ -1311,7 +2449,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1311
2449
|
<dl>
|
|
1312
2450
|
<dd>
|
|
1313
2451
|
|
|
1314
|
-
**
|
|
2452
|
+
**jobId:** `string`
|
|
1315
2453
|
|
|
1316
2454
|
</dd>
|
|
1317
2455
|
</dl>
|
|
@@ -1319,7 +2457,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1319
2457
|
<dl>
|
|
1320
2458
|
<dd>
|
|
1321
2459
|
|
|
1322
|
-
**requestOptions:** `
|
|
2460
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1323
2461
|
|
|
1324
2462
|
</dd>
|
|
1325
2463
|
</dl>
|
|
@@ -1330,7 +2468,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1330
2468
|
</dl>
|
|
1331
2469
|
</details>
|
|
1332
2470
|
|
|
1333
|
-
<details><summary><code>client.
|
|
2471
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">subscribeSyncJob</a>(jobId) -> unknown</code></summary>
|
|
1334
2472
|
<dl>
|
|
1335
2473
|
<dd>
|
|
1336
2474
|
|
|
@@ -1342,17 +2480,16 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1342
2480
|
<dl>
|
|
1343
2481
|
<dd>
|
|
1344
2482
|
|
|
1345
|
-
|
|
2483
|
+
Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
1346
2484
|
|
|
1347
2485
|
## Args:
|
|
1348
2486
|
|
|
1349
|
-
|
|
1350
|
-
white_label_id: The ID of the white label integration
|
|
2487
|
+
job_id: The ID of the job to subscribe to
|
|
1351
2488
|
user: The current user
|
|
1352
2489
|
|
|
1353
2490
|
## Returns:
|
|
1354
2491
|
|
|
1355
|
-
|
|
2492
|
+
StreamingResponse: The streaming response
|
|
1356
2493
|
|
|
1357
2494
|
</dd>
|
|
1358
2495
|
</dl>
|
|
@@ -1368,7 +2505,7 @@ Get the OAuth2 authorization URL for a white label integration.
|
|
|
1368
2505
|
<dd>
|
|
1369
2506
|
|
|
1370
2507
|
```typescript
|
|
1371
|
-
await client.
|
|
2508
|
+
await client.sync.subscribeSyncJob("job_id");
|
|
1372
2509
|
```
|
|
1373
2510
|
|
|
1374
2511
|
</dd>
|
|
@@ -1384,7 +2521,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
|
1384
2521
|
<dl>
|
|
1385
2522
|
<dd>
|
|
1386
2523
|
|
|
1387
|
-
**
|
|
2524
|
+
**jobId:** `string`
|
|
1388
2525
|
|
|
1389
2526
|
</dd>
|
|
1390
2527
|
</dl>
|
|
@@ -1392,7 +2529,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
|
1392
2529
|
<dl>
|
|
1393
2530
|
<dd>
|
|
1394
2531
|
|
|
1395
|
-
**requestOptions:** `
|
|
2532
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1396
2533
|
|
|
1397
2534
|
</dd>
|
|
1398
2535
|
</dl>
|
|
@@ -1403,9 +2540,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
|
1403
2540
|
</dl>
|
|
1404
2541
|
</details>
|
|
1405
2542
|
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
2543
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
1409
2544
|
<dl>
|
|
1410
2545
|
<dd>
|
|
1411
2546
|
|
|
@@ -1417,19 +2552,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
|
1417
2552
|
<dl>
|
|
1418
2553
|
<dd>
|
|
1419
2554
|
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
## Args:
|
|
1423
|
-
|
|
1424
|
-
db: The database session
|
|
1425
|
-
skip: The number of syncs to skip
|
|
1426
|
-
limit: The number of syncs to return
|
|
1427
|
-
with_source_connection: Whether to include the source connection in the response
|
|
1428
|
-
user: The current user
|
|
1429
|
-
|
|
1430
|
-
## Returns:
|
|
1431
|
-
|
|
1432
|
-
list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
|
|
2555
|
+
Get the DAG for a specific sync.
|
|
1433
2556
|
|
|
1434
2557
|
</dd>
|
|
1435
2558
|
</dl>
|
|
@@ -1445,7 +2568,7 @@ List all syncs for the current user.
|
|
|
1445
2568
|
<dd>
|
|
1446
2569
|
|
|
1447
2570
|
```typescript
|
|
1448
|
-
await client.sync.
|
|
2571
|
+
await client.sync.getSyncDag("sync_id");
|
|
1449
2572
|
```
|
|
1450
2573
|
|
|
1451
2574
|
</dd>
|
|
@@ -1461,7 +2584,7 @@ await client.sync.listSyncs();
|
|
|
1461
2584
|
<dl>
|
|
1462
2585
|
<dd>
|
|
1463
2586
|
|
|
1464
|
-
**
|
|
2587
|
+
**syncId:** `string`
|
|
1465
2588
|
|
|
1466
2589
|
</dd>
|
|
1467
2590
|
</dl>
|
|
@@ -1480,7 +2603,9 @@ await client.sync.listSyncs();
|
|
|
1480
2603
|
</dl>
|
|
1481
2604
|
</details>
|
|
1482
2605
|
|
|
1483
|
-
|
|
2606
|
+
## Search
|
|
2607
|
+
|
|
2608
|
+
<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
|
|
1484
2609
|
<dl>
|
|
1485
2610
|
<dd>
|
|
1486
2611
|
|
|
@@ -1492,18 +2617,18 @@ await client.sync.listSyncs();
|
|
|
1492
2617
|
<dl>
|
|
1493
2618
|
<dd>
|
|
1494
2619
|
|
|
1495
|
-
|
|
2620
|
+
Search for documents within a specific sync.
|
|
1496
2621
|
|
|
1497
2622
|
## Args:
|
|
1498
2623
|
|
|
1499
2624
|
db: The database session
|
|
1500
|
-
|
|
2625
|
+
sync_id: The ID of the sync to search within
|
|
2626
|
+
query: The search query text
|
|
1501
2627
|
user: The current user
|
|
1502
|
-
background_tasks: The background tasks
|
|
1503
2628
|
|
|
1504
2629
|
## Returns:
|
|
1505
2630
|
|
|
1506
|
-
|
|
2631
|
+
list[dict]: A list of search results
|
|
1507
2632
|
|
|
1508
2633
|
</dd>
|
|
1509
2634
|
</dl>
|
|
@@ -1519,10 +2644,9 @@ Create a new sync configuration.
|
|
|
1519
2644
|
<dd>
|
|
1520
2645
|
|
|
1521
2646
|
```typescript
|
|
1522
|
-
await client.
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
destinationConnectionIds: ["destination_connection_ids"],
|
|
2647
|
+
await client.search.search({
|
|
2648
|
+
syncId: "sync_id",
|
|
2649
|
+
query: "query",
|
|
1526
2650
|
});
|
|
1527
2651
|
```
|
|
1528
2652
|
|
|
@@ -1539,7 +2663,7 @@ await client.sync.createSync({
|
|
|
1539
2663
|
<dl>
|
|
1540
2664
|
<dd>
|
|
1541
2665
|
|
|
1542
|
-
**request:** `AirweaveSDK.
|
|
2666
|
+
**request:** `AirweaveSDK.SearchSearchGetRequest`
|
|
1543
2667
|
|
|
1544
2668
|
</dd>
|
|
1545
2669
|
</dl>
|
|
@@ -1547,7 +2671,7 @@ await client.sync.createSync({
|
|
|
1547
2671
|
<dl>
|
|
1548
2672
|
<dd>
|
|
1549
2673
|
|
|
1550
|
-
**requestOptions:** `
|
|
2674
|
+
**requestOptions:** `Search.RequestOptions`
|
|
1551
2675
|
|
|
1552
2676
|
</dd>
|
|
1553
2677
|
</dl>
|
|
@@ -1558,7 +2682,9 @@ await client.sync.createSync({
|
|
|
1558
2682
|
</dl>
|
|
1559
2683
|
</details>
|
|
1560
2684
|
|
|
1561
|
-
|
|
2685
|
+
## WhiteLabels
|
|
2686
|
+
|
|
2687
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
1562
2688
|
<dl>
|
|
1563
2689
|
<dd>
|
|
1564
2690
|
|
|
@@ -1570,17 +2696,16 @@ await client.sync.createSync({
|
|
|
1570
2696
|
<dl>
|
|
1571
2697
|
<dd>
|
|
1572
2698
|
|
|
1573
|
-
|
|
2699
|
+
List all white labels for the current user's organization.
|
|
1574
2700
|
|
|
1575
2701
|
## Args:
|
|
1576
2702
|
|
|
1577
2703
|
db: The database session
|
|
1578
|
-
|
|
1579
|
-
user: The current user
|
|
2704
|
+
current_user: The current user
|
|
1580
2705
|
|
|
1581
2706
|
## Returns:
|
|
1582
2707
|
|
|
1583
|
-
|
|
2708
|
+
list[schemas.WhiteLabel]: A list of white labels
|
|
1584
2709
|
|
|
1585
2710
|
</dd>
|
|
1586
2711
|
</dl>
|
|
@@ -1596,7 +2721,7 @@ Get a specific sync by ID.
|
|
|
1596
2721
|
<dd>
|
|
1597
2722
|
|
|
1598
2723
|
```typescript
|
|
1599
|
-
await client.
|
|
2724
|
+
await client.whiteLabels.listWhiteLabels();
|
|
1600
2725
|
```
|
|
1601
2726
|
|
|
1602
2727
|
</dd>
|
|
@@ -1612,15 +2737,7 @@ await client.sync.getSync("sync_id");
|
|
|
1612
2737
|
<dl>
|
|
1613
2738
|
<dd>
|
|
1614
2739
|
|
|
1615
|
-
**
|
|
1616
|
-
|
|
1617
|
-
</dd>
|
|
1618
|
-
</dl>
|
|
1619
|
-
|
|
1620
|
-
<dl>
|
|
1621
|
-
<dd>
|
|
1622
|
-
|
|
1623
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2740
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1624
2741
|
|
|
1625
2742
|
</dd>
|
|
1626
2743
|
</dl>
|
|
@@ -1631,7 +2748,7 @@ await client.sync.getSync("sync_id");
|
|
|
1631
2748
|
</dl>
|
|
1632
2749
|
</details>
|
|
1633
2750
|
|
|
1634
|
-
<details><summary><code>client.
|
|
2751
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1635
2752
|
<dl>
|
|
1636
2753
|
<dd>
|
|
1637
2754
|
|
|
@@ -1643,18 +2760,17 @@ await client.sync.getSync("sync_id");
|
|
|
1643
2760
|
<dl>
|
|
1644
2761
|
<dd>
|
|
1645
2762
|
|
|
1646
|
-
|
|
2763
|
+
Create new white label integration.
|
|
1647
2764
|
|
|
1648
2765
|
## Args:
|
|
1649
2766
|
|
|
1650
2767
|
db: The database session
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
user: The current user
|
|
2768
|
+
current_user: The current user
|
|
2769
|
+
white_label_in: The white label to create
|
|
1654
2770
|
|
|
1655
2771
|
## Returns:
|
|
1656
2772
|
|
|
1657
|
-
|
|
2773
|
+
white_label (schemas.WhiteLabel): The created white label
|
|
1658
2774
|
|
|
1659
2775
|
</dd>
|
|
1660
2776
|
</dl>
|
|
@@ -1670,7 +2786,13 @@ Delete a sync configuration and optionally its associated data.
|
|
|
1670
2786
|
<dd>
|
|
1671
2787
|
|
|
1672
2788
|
```typescript
|
|
1673
|
-
await client.
|
|
2789
|
+
await client.whiteLabels.createWhiteLabel({
|
|
2790
|
+
name: "name",
|
|
2791
|
+
sourceShortName: "source_short_name",
|
|
2792
|
+
redirectUrl: "redirect_url",
|
|
2793
|
+
clientId: "client_id",
|
|
2794
|
+
clientSecret: "client_secret",
|
|
2795
|
+
});
|
|
1674
2796
|
```
|
|
1675
2797
|
|
|
1676
2798
|
</dd>
|
|
@@ -1686,15 +2808,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1686
2808
|
<dl>
|
|
1687
2809
|
<dd>
|
|
1688
2810
|
|
|
1689
|
-
**
|
|
1690
|
-
|
|
1691
|
-
</dd>
|
|
1692
|
-
</dl>
|
|
1693
|
-
|
|
1694
|
-
<dl>
|
|
1695
|
-
<dd>
|
|
1696
|
-
|
|
1697
|
-
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
2811
|
+
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
1698
2812
|
|
|
1699
2813
|
</dd>
|
|
1700
2814
|
</dl>
|
|
@@ -1702,7 +2816,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1702
2816
|
<dl>
|
|
1703
2817
|
<dd>
|
|
1704
2818
|
|
|
1705
|
-
**requestOptions:** `
|
|
2819
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1706
2820
|
|
|
1707
2821
|
</dd>
|
|
1708
2822
|
</dl>
|
|
@@ -1713,7 +2827,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1713
2827
|
</dl>
|
|
1714
2828
|
</details>
|
|
1715
2829
|
|
|
1716
|
-
<details><summary><code>client.
|
|
2830
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1717
2831
|
<dl>
|
|
1718
2832
|
<dd>
|
|
1719
2833
|
|
|
@@ -1725,18 +2839,17 @@ await client.sync.deleteSync("sync_id");
|
|
|
1725
2839
|
<dl>
|
|
1726
2840
|
<dd>
|
|
1727
2841
|
|
|
1728
|
-
|
|
2842
|
+
Get a specific white label integration.
|
|
1729
2843
|
|
|
1730
2844
|
## Args:
|
|
1731
2845
|
|
|
1732
2846
|
db: The database session
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
user: The current user
|
|
2847
|
+
white_label_id: The ID of the white label to get
|
|
2848
|
+
current_user: The current user
|
|
1736
2849
|
|
|
1737
2850
|
## Returns:
|
|
1738
2851
|
|
|
1739
|
-
|
|
2852
|
+
white_label (schemas.WhiteLabel): The white label
|
|
1740
2853
|
|
|
1741
2854
|
</dd>
|
|
1742
2855
|
</dl>
|
|
@@ -1752,7 +2865,7 @@ Update a sync configuration.
|
|
|
1752
2865
|
<dd>
|
|
1753
2866
|
|
|
1754
2867
|
```typescript
|
|
1755
|
-
await client.
|
|
2868
|
+
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
1756
2869
|
```
|
|
1757
2870
|
|
|
1758
2871
|
</dd>
|
|
@@ -1768,15 +2881,7 @@ await client.sync.updateSync("sync_id");
|
|
|
1768
2881
|
<dl>
|
|
1769
2882
|
<dd>
|
|
1770
2883
|
|
|
1771
|
-
**
|
|
1772
|
-
|
|
1773
|
-
</dd>
|
|
1774
|
-
</dl>
|
|
1775
|
-
|
|
1776
|
-
<dl>
|
|
1777
|
-
<dd>
|
|
1778
|
-
|
|
1779
|
-
**request:** `AirweaveSDK.SyncUpdate`
|
|
2884
|
+
**whiteLabelId:** `string`
|
|
1780
2885
|
|
|
1781
2886
|
</dd>
|
|
1782
2887
|
</dl>
|
|
@@ -1784,7 +2889,7 @@ await client.sync.updateSync("sync_id");
|
|
|
1784
2889
|
<dl>
|
|
1785
2890
|
<dd>
|
|
1786
2891
|
|
|
1787
|
-
**requestOptions:** `
|
|
2892
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1788
2893
|
|
|
1789
2894
|
</dd>
|
|
1790
2895
|
</dl>
|
|
@@ -1795,7 +2900,7 @@ await client.sync.updateSync("sync_id");
|
|
|
1795
2900
|
</dl>
|
|
1796
2901
|
</details>
|
|
1797
2902
|
|
|
1798
|
-
<details><summary><code>client.
|
|
2903
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1799
2904
|
<dl>
|
|
1800
2905
|
<dd>
|
|
1801
2906
|
|
|
@@ -1807,18 +2912,18 @@ await client.sync.updateSync("sync_id");
|
|
|
1807
2912
|
<dl>
|
|
1808
2913
|
<dd>
|
|
1809
2914
|
|
|
1810
|
-
|
|
2915
|
+
Update a white label integration.
|
|
1811
2916
|
|
|
1812
2917
|
## Args:
|
|
1813
2918
|
|
|
1814
2919
|
db: The database session
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
2920
|
+
current_user: The current user
|
|
2921
|
+
white_label_id: The ID of the white label to update
|
|
2922
|
+
white_label_in: The white label to update
|
|
1818
2923
|
|
|
1819
2924
|
## Returns:
|
|
1820
2925
|
|
|
1821
|
-
|
|
2926
|
+
white_label (schemas.WhiteLabel): The updated white label
|
|
1822
2927
|
|
|
1823
2928
|
</dd>
|
|
1824
2929
|
</dl>
|
|
@@ -1834,7 +2939,7 @@ Trigger a sync run.
|
|
|
1834
2939
|
<dd>
|
|
1835
2940
|
|
|
1836
2941
|
```typescript
|
|
1837
|
-
await client.
|
|
2942
|
+
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
1838
2943
|
```
|
|
1839
2944
|
|
|
1840
2945
|
</dd>
|
|
@@ -1850,7 +2955,7 @@ await client.sync.runSync("sync_id");
|
|
|
1850
2955
|
<dl>
|
|
1851
2956
|
<dd>
|
|
1852
2957
|
|
|
1853
|
-
**
|
|
2958
|
+
**whiteLabelId:** `string`
|
|
1854
2959
|
|
|
1855
2960
|
</dd>
|
|
1856
2961
|
</dl>
|
|
@@ -1858,7 +2963,15 @@ await client.sync.runSync("sync_id");
|
|
|
1858
2963
|
<dl>
|
|
1859
2964
|
<dd>
|
|
1860
2965
|
|
|
1861
|
-
**
|
|
2966
|
+
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
2967
|
+
|
|
2968
|
+
</dd>
|
|
2969
|
+
</dl>
|
|
2970
|
+
|
|
2971
|
+
<dl>
|
|
2972
|
+
<dd>
|
|
2973
|
+
|
|
2974
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1862
2975
|
|
|
1863
2976
|
</dd>
|
|
1864
2977
|
</dl>
|
|
@@ -1869,7 +2982,7 @@ await client.sync.runSync("sync_id");
|
|
|
1869
2982
|
</dl>
|
|
1870
2983
|
</details>
|
|
1871
2984
|
|
|
1872
|
-
<details><summary><code>client.
|
|
2985
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1873
2986
|
<dl>
|
|
1874
2987
|
<dd>
|
|
1875
2988
|
|
|
@@ -1881,17 +2994,17 @@ await client.sync.runSync("sync_id");
|
|
|
1881
2994
|
<dl>
|
|
1882
2995
|
<dd>
|
|
1883
2996
|
|
|
1884
|
-
|
|
2997
|
+
Delete a white label integration.
|
|
1885
2998
|
|
|
1886
2999
|
## Args:
|
|
1887
3000
|
|
|
1888
3001
|
db: The database session
|
|
1889
|
-
|
|
1890
|
-
|
|
3002
|
+
current_user: The current user
|
|
3003
|
+
white_label_id: The ID of the white label to delete
|
|
1891
3004
|
|
|
1892
3005
|
## Returns:
|
|
1893
3006
|
|
|
1894
|
-
|
|
3007
|
+
white_label (schemas.WhiteLabel): The deleted white label
|
|
1895
3008
|
|
|
1896
3009
|
</dd>
|
|
1897
3010
|
</dl>
|
|
@@ -1907,7 +3020,7 @@ List all jobs for a specific sync.
|
|
|
1907
3020
|
<dd>
|
|
1908
3021
|
|
|
1909
3022
|
```typescript
|
|
1910
|
-
await client.
|
|
3023
|
+
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
1911
3024
|
```
|
|
1912
3025
|
|
|
1913
3026
|
</dd>
|
|
@@ -1923,7 +3036,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
1923
3036
|
<dl>
|
|
1924
3037
|
<dd>
|
|
1925
3038
|
|
|
1926
|
-
**
|
|
3039
|
+
**whiteLabelId:** `string`
|
|
1927
3040
|
|
|
1928
3041
|
</dd>
|
|
1929
3042
|
</dl>
|
|
@@ -1931,7 +3044,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
1931
3044
|
<dl>
|
|
1932
3045
|
<dd>
|
|
1933
3046
|
|
|
1934
|
-
**requestOptions:** `
|
|
3047
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1935
3048
|
|
|
1936
3049
|
</dd>
|
|
1937
3050
|
</dl>
|
|
@@ -1942,7 +3055,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
1942
3055
|
</dl>
|
|
1943
3056
|
</details>
|
|
1944
3057
|
|
|
1945
|
-
<details><summary><code>client.
|
|
3058
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
1946
3059
|
<dl>
|
|
1947
3060
|
<dd>
|
|
1948
3061
|
|
|
@@ -1954,18 +3067,17 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
1954
3067
|
<dl>
|
|
1955
3068
|
<dd>
|
|
1956
3069
|
|
|
1957
|
-
|
|
3070
|
+
Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
1958
3071
|
|
|
1959
3072
|
## Args:
|
|
1960
3073
|
|
|
1961
3074
|
db: The database session
|
|
1962
|
-
|
|
1963
|
-
job_id: The ID of the job to get
|
|
3075
|
+
white_label_id: The ID of the white label to get the auth URL for
|
|
1964
3076
|
user: The current user
|
|
1965
3077
|
|
|
1966
3078
|
## Returns:
|
|
1967
3079
|
|
|
1968
|
-
|
|
3080
|
+
str: The OAuth2 authorization URL
|
|
1969
3081
|
|
|
1970
3082
|
</dd>
|
|
1971
3083
|
</dl>
|
|
@@ -1981,9 +3093,7 @@ Get details of a specific sync job.
|
|
|
1981
3093
|
<dd>
|
|
1982
3094
|
|
|
1983
3095
|
```typescript
|
|
1984
|
-
await client.
|
|
1985
|
-
syncId: "sync_id",
|
|
1986
|
-
});
|
|
3096
|
+
await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
1987
3097
|
```
|
|
1988
3098
|
|
|
1989
3099
|
</dd>
|
|
@@ -1999,15 +3109,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
1999
3109
|
<dl>
|
|
2000
3110
|
<dd>
|
|
2001
3111
|
|
|
2002
|
-
**
|
|
2003
|
-
|
|
2004
|
-
</dd>
|
|
2005
|
-
</dl>
|
|
2006
|
-
|
|
2007
|
-
<dl>
|
|
2008
|
-
<dd>
|
|
2009
|
-
|
|
2010
|
-
**request:** `AirweaveSDK.GetSyncJobSyncJobJobIdGetRequest`
|
|
3112
|
+
**whiteLabelId:** `string`
|
|
2011
3113
|
|
|
2012
3114
|
</dd>
|
|
2013
3115
|
</dl>
|
|
@@ -2015,7 +3117,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2015
3117
|
<dl>
|
|
2016
3118
|
<dd>
|
|
2017
3119
|
|
|
2018
|
-
**requestOptions:** `
|
|
3120
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2019
3121
|
|
|
2020
3122
|
</dd>
|
|
2021
3123
|
</dl>
|
|
@@ -2026,7 +3128,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2026
3128
|
</dl>
|
|
2027
3129
|
</details>
|
|
2028
3130
|
|
|
2029
|
-
<details><summary><code>client.
|
|
3131
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
2030
3132
|
<dl>
|
|
2031
3133
|
<dd>
|
|
2032
3134
|
|
|
@@ -2038,16 +3140,18 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2038
3140
|
<dl>
|
|
2039
3141
|
<dd>
|
|
2040
3142
|
|
|
2041
|
-
|
|
3143
|
+
Exchange OAuth2 code for tokens and create connection.
|
|
2042
3144
|
|
|
2043
3145
|
## Args:
|
|
2044
3146
|
|
|
2045
|
-
|
|
3147
|
+
white_label_id: The ID of the white label to exchange the code for
|
|
3148
|
+
code: The OAuth2 code
|
|
3149
|
+
db: The database session
|
|
2046
3150
|
user: The current user
|
|
2047
3151
|
|
|
2048
3152
|
## Returns:
|
|
2049
3153
|
|
|
2050
|
-
|
|
3154
|
+
connection (schemas.Connection): The created connection
|
|
2051
3155
|
|
|
2052
3156
|
</dd>
|
|
2053
3157
|
</dl>
|
|
@@ -2063,7 +3167,7 @@ Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
|
2063
3167
|
<dd>
|
|
2064
3168
|
|
|
2065
3169
|
```typescript
|
|
2066
|
-
await client.
|
|
3170
|
+
await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string");
|
|
2067
3171
|
```
|
|
2068
3172
|
|
|
2069
3173
|
</dd>
|
|
@@ -2079,7 +3183,7 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2079
3183
|
<dl>
|
|
2080
3184
|
<dd>
|
|
2081
3185
|
|
|
2082
|
-
**
|
|
3186
|
+
**whiteLabelId:** `string`
|
|
2083
3187
|
|
|
2084
3188
|
</dd>
|
|
2085
3189
|
</dl>
|
|
@@ -2087,7 +3191,15 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2087
3191
|
<dl>
|
|
2088
3192
|
<dd>
|
|
2089
3193
|
|
|
2090
|
-
**
|
|
3194
|
+
**request:** `string`
|
|
3195
|
+
|
|
3196
|
+
</dd>
|
|
3197
|
+
</dl>
|
|
3198
|
+
|
|
3199
|
+
<dl>
|
|
3200
|
+
<dd>
|
|
3201
|
+
|
|
3202
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2091
3203
|
|
|
2092
3204
|
</dd>
|
|
2093
3205
|
</dl>
|
|
@@ -2098,7 +3210,7 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2098
3210
|
</dl>
|
|
2099
3211
|
</details>
|
|
2100
3212
|
|
|
2101
|
-
<details><summary><code>client.
|
|
3213
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
2102
3214
|
<dl>
|
|
2103
3215
|
<dd>
|
|
2104
3216
|
|
|
@@ -2110,7 +3222,17 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2110
3222
|
<dl>
|
|
2111
3223
|
<dd>
|
|
2112
3224
|
|
|
2113
|
-
|
|
3225
|
+
List all syncs for a specific white label.
|
|
3226
|
+
|
|
3227
|
+
## Args:
|
|
3228
|
+
|
|
3229
|
+
white_label_id: The ID of the white label to list syncs for
|
|
3230
|
+
db: The database session
|
|
3231
|
+
current_user: The current user
|
|
3232
|
+
|
|
3233
|
+
## Returns:
|
|
3234
|
+
|
|
3235
|
+
list[schemas.Sync]: A list of syncs
|
|
2114
3236
|
|
|
2115
3237
|
</dd>
|
|
2116
3238
|
</dl>
|
|
@@ -2126,7 +3248,7 @@ Get the DAG for a specific sync.
|
|
|
2126
3248
|
<dd>
|
|
2127
3249
|
|
|
2128
3250
|
```typescript
|
|
2129
|
-
await client.
|
|
3251
|
+
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
2130
3252
|
```
|
|
2131
3253
|
|
|
2132
3254
|
</dd>
|
|
@@ -2142,7 +3264,7 @@ await client.sync.getSyncDag("sync_id");
|
|
|
2142
3264
|
<dl>
|
|
2143
3265
|
<dd>
|
|
2144
3266
|
|
|
2145
|
-
**
|
|
3267
|
+
**whiteLabelId:** `string`
|
|
2146
3268
|
|
|
2147
3269
|
</dd>
|
|
2148
3270
|
</dl>
|
|
@@ -2150,7 +3272,7 @@ await client.sync.getSyncDag("sync_id");
|
|
|
2150
3272
|
<dl>
|
|
2151
3273
|
<dd>
|
|
2152
3274
|
|
|
2153
|
-
**requestOptions:** `
|
|
3275
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2154
3276
|
|
|
2155
3277
|
</dd>
|
|
2156
3278
|
</dl>
|
|
@@ -2161,9 +3283,9 @@ await client.sync.getSyncDag("sync_id");
|
|
|
2161
3283
|
</dl>
|
|
2162
3284
|
</details>
|
|
2163
3285
|
|
|
2164
|
-
##
|
|
3286
|
+
## Chat
|
|
2165
3287
|
|
|
2166
|
-
<details><summary><code>client.
|
|
3288
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">openaiKeySet</a>() -> boolean</code></summary>
|
|
2167
3289
|
<dl>
|
|
2168
3290
|
<dd>
|
|
2169
3291
|
|
|
@@ -2175,16 +3297,16 @@ await client.sync.getSyncDag("sync_id");
|
|
|
2175
3297
|
<dl>
|
|
2176
3298
|
<dd>
|
|
2177
3299
|
|
|
2178
|
-
|
|
3300
|
+
Check if the OpenAI API key is set for the current user.
|
|
2179
3301
|
|
|
2180
3302
|
## Args:
|
|
2181
3303
|
|
|
2182
|
-
db: The database session
|
|
2183
|
-
|
|
3304
|
+
db: The database session.
|
|
3305
|
+
user: The current user.
|
|
2184
3306
|
|
|
2185
3307
|
## Returns:
|
|
2186
3308
|
|
|
2187
|
-
|
|
3309
|
+
bool: True if the OpenAI API key is set, False otherwise.
|
|
2188
3310
|
|
|
2189
3311
|
</dd>
|
|
2190
3312
|
</dl>
|
|
@@ -2200,7 +3322,7 @@ List all white labels for the current user's organization.
|
|
|
2200
3322
|
<dd>
|
|
2201
3323
|
|
|
2202
3324
|
```typescript
|
|
2203
|
-
await client.
|
|
3325
|
+
await client.chat.openaiKeySet();
|
|
2204
3326
|
```
|
|
2205
3327
|
|
|
2206
3328
|
</dd>
|
|
@@ -2216,7 +3338,7 @@ await client.whiteLabels.listWhiteLabels();
|
|
|
2216
3338
|
<dl>
|
|
2217
3339
|
<dd>
|
|
2218
3340
|
|
|
2219
|
-
**requestOptions:** `
|
|
3341
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2220
3342
|
|
|
2221
3343
|
</dd>
|
|
2222
3344
|
</dl>
|
|
@@ -2227,7 +3349,7 @@ await client.whiteLabels.listWhiteLabels();
|
|
|
2227
3349
|
</dl>
|
|
2228
3350
|
</details>
|
|
2229
3351
|
|
|
2230
|
-
<details><summary><code>client.
|
|
3352
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">listChats</a>({ ...params }) -> AirweaveSDK.Chat[]</code></summary>
|
|
2231
3353
|
<dl>
|
|
2232
3354
|
<dd>
|
|
2233
3355
|
|
|
@@ -2239,17 +3361,18 @@ await client.whiteLabels.listWhiteLabels();
|
|
|
2239
3361
|
<dl>
|
|
2240
3362
|
<dd>
|
|
2241
3363
|
|
|
2242
|
-
|
|
3364
|
+
List all chats for the current user.
|
|
2243
3365
|
|
|
2244
3366
|
## Args:
|
|
2245
3367
|
|
|
2246
|
-
db: The database session
|
|
2247
|
-
|
|
2248
|
-
|
|
3368
|
+
db: The database session.
|
|
3369
|
+
skip: The number of chats to skip.
|
|
3370
|
+
limit: The number of chats to return.
|
|
3371
|
+
user: The current user.
|
|
2249
3372
|
|
|
2250
3373
|
## Returns:
|
|
2251
3374
|
|
|
2252
|
-
|
|
3375
|
+
list[schemas.Chat]: The list of chats.
|
|
2253
3376
|
|
|
2254
3377
|
</dd>
|
|
2255
3378
|
</dl>
|
|
@@ -2265,13 +3388,7 @@ Create new white label integration.
|
|
|
2265
3388
|
<dd>
|
|
2266
3389
|
|
|
2267
3390
|
```typescript
|
|
2268
|
-
await client.
|
|
2269
|
-
name: "name",
|
|
2270
|
-
sourceShortName: "source_short_name",
|
|
2271
|
-
redirectUrl: "redirect_url",
|
|
2272
|
-
clientId: "client_id",
|
|
2273
|
-
clientSecret: "client_secret",
|
|
2274
|
-
});
|
|
3391
|
+
await client.chat.listChats();
|
|
2275
3392
|
```
|
|
2276
3393
|
|
|
2277
3394
|
</dd>
|
|
@@ -2287,7 +3404,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2287
3404
|
<dl>
|
|
2288
3405
|
<dd>
|
|
2289
3406
|
|
|
2290
|
-
**request:** `AirweaveSDK.
|
|
3407
|
+
**request:** `AirweaveSDK.ListChatsChatGetRequest`
|
|
2291
3408
|
|
|
2292
3409
|
</dd>
|
|
2293
3410
|
</dl>
|
|
@@ -2295,7 +3412,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2295
3412
|
<dl>
|
|
2296
3413
|
<dd>
|
|
2297
3414
|
|
|
2298
|
-
**requestOptions:** `
|
|
3415
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2299
3416
|
|
|
2300
3417
|
</dd>
|
|
2301
3418
|
</dl>
|
|
@@ -2306,7 +3423,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2306
3423
|
</dl>
|
|
2307
3424
|
</details>
|
|
2308
3425
|
|
|
2309
|
-
<details><summary><code>client.
|
|
3426
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">createChat</a>({ ...params }) -> AirweaveSDK.Chat</code></summary>
|
|
2310
3427
|
<dl>
|
|
2311
3428
|
<dd>
|
|
2312
3429
|
|
|
@@ -2318,17 +3435,17 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2318
3435
|
<dl>
|
|
2319
3436
|
<dd>
|
|
2320
3437
|
|
|
2321
|
-
|
|
3438
|
+
Create a new chat.
|
|
2322
3439
|
|
|
2323
3440
|
## Args:
|
|
2324
3441
|
|
|
2325
|
-
db: The database session
|
|
2326
|
-
|
|
2327
|
-
|
|
3442
|
+
db: The database session.
|
|
3443
|
+
chat_in: The chat creation data.
|
|
3444
|
+
user: The current user.
|
|
2328
3445
|
|
|
2329
3446
|
## Returns:
|
|
2330
3447
|
|
|
2331
|
-
|
|
3448
|
+
schemas.Chat: The created chat.
|
|
2332
3449
|
|
|
2333
3450
|
</dd>
|
|
2334
3451
|
</dl>
|
|
@@ -2344,7 +3461,10 @@ Get a specific white label integration.
|
|
|
2344
3461
|
<dd>
|
|
2345
3462
|
|
|
2346
3463
|
```typescript
|
|
2347
|
-
await client.
|
|
3464
|
+
await client.chat.createChat({
|
|
3465
|
+
name: "name",
|
|
3466
|
+
syncId: "sync_id",
|
|
3467
|
+
});
|
|
2348
3468
|
```
|
|
2349
3469
|
|
|
2350
3470
|
</dd>
|
|
@@ -2360,7 +3480,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2360
3480
|
<dl>
|
|
2361
3481
|
<dd>
|
|
2362
3482
|
|
|
2363
|
-
**
|
|
3483
|
+
**request:** `AirweaveSDK.ChatCreate`
|
|
2364
3484
|
|
|
2365
3485
|
</dd>
|
|
2366
3486
|
</dl>
|
|
@@ -2368,7 +3488,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2368
3488
|
<dl>
|
|
2369
3489
|
<dd>
|
|
2370
3490
|
|
|
2371
|
-
**requestOptions:** `
|
|
3491
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2372
3492
|
|
|
2373
3493
|
</dd>
|
|
2374
3494
|
</dl>
|
|
@@ -2379,7 +3499,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2379
3499
|
</dl>
|
|
2380
3500
|
</details>
|
|
2381
3501
|
|
|
2382
|
-
<details><summary><code>client.
|
|
3502
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">getChat</a>(chatId) -> AirweaveSDK.Chat</code></summary>
|
|
2383
3503
|
<dl>
|
|
2384
3504
|
<dd>
|
|
2385
3505
|
|
|
@@ -2391,18 +3511,17 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2391
3511
|
<dl>
|
|
2392
3512
|
<dd>
|
|
2393
3513
|
|
|
2394
|
-
|
|
3514
|
+
Get a specific chat by ID.
|
|
2395
3515
|
|
|
2396
3516
|
## Args:
|
|
2397
3517
|
|
|
2398
|
-
db: The database session
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
white_label_in: The white label to update
|
|
3518
|
+
db: The database session.
|
|
3519
|
+
chat_id: The ID of the chat to get.
|
|
3520
|
+
user: The current user.
|
|
2402
3521
|
|
|
2403
3522
|
## Returns:
|
|
2404
3523
|
|
|
2405
|
-
|
|
3524
|
+
schemas.Chat: The chat.
|
|
2406
3525
|
|
|
2407
3526
|
</dd>
|
|
2408
3527
|
</dl>
|
|
@@ -2418,7 +3537,7 @@ Update a white label integration.
|
|
|
2418
3537
|
<dd>
|
|
2419
3538
|
|
|
2420
3539
|
```typescript
|
|
2421
|
-
await client.
|
|
3540
|
+
await client.chat.getChat("chat_id");
|
|
2422
3541
|
```
|
|
2423
3542
|
|
|
2424
3543
|
</dd>
|
|
@@ -2429,20 +3548,12 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2429
3548
|
#### ⚙️ Parameters
|
|
2430
3549
|
|
|
2431
3550
|
<dl>
|
|
2432
|
-
<dd>
|
|
2433
|
-
|
|
2434
|
-
<dl>
|
|
2435
|
-
<dd>
|
|
2436
|
-
|
|
2437
|
-
**whiteLabelId:** `string`
|
|
2438
|
-
|
|
2439
|
-
</dd>
|
|
2440
|
-
</dl>
|
|
3551
|
+
<dd>
|
|
2441
3552
|
|
|
2442
3553
|
<dl>
|
|
2443
3554
|
<dd>
|
|
2444
3555
|
|
|
2445
|
-
**
|
|
3556
|
+
**chatId:** `string`
|
|
2446
3557
|
|
|
2447
3558
|
</dd>
|
|
2448
3559
|
</dl>
|
|
@@ -2450,7 +3561,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2450
3561
|
<dl>
|
|
2451
3562
|
<dd>
|
|
2452
3563
|
|
|
2453
|
-
**requestOptions:** `
|
|
3564
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2454
3565
|
|
|
2455
3566
|
</dd>
|
|
2456
3567
|
</dl>
|
|
@@ -2461,7 +3572,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2461
3572
|
</dl>
|
|
2462
3573
|
</details>
|
|
2463
3574
|
|
|
2464
|
-
<details><summary><code>client.
|
|
3575
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">updateChat</a>(chatId, { ...params }) -> AirweaveSDK.Chat</code></summary>
|
|
2465
3576
|
<dl>
|
|
2466
3577
|
<dd>
|
|
2467
3578
|
|
|
@@ -2473,17 +3584,18 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2473
3584
|
<dl>
|
|
2474
3585
|
<dd>
|
|
2475
3586
|
|
|
2476
|
-
|
|
3587
|
+
Update a chat.
|
|
2477
3588
|
|
|
2478
3589
|
## Args:
|
|
2479
3590
|
|
|
2480
|
-
db: The database session
|
|
2481
|
-
|
|
2482
|
-
|
|
3591
|
+
db: The database session.
|
|
3592
|
+
chat_id: The ID of the chat to update.
|
|
3593
|
+
chat_in: The chat update data.
|
|
3594
|
+
user: The current user.
|
|
2483
3595
|
|
|
2484
3596
|
## Returns:
|
|
2485
3597
|
|
|
2486
|
-
|
|
3598
|
+
schemas.Chat: The updated chat.
|
|
2487
3599
|
|
|
2488
3600
|
</dd>
|
|
2489
3601
|
</dl>
|
|
@@ -2499,7 +3611,7 @@ Delete a white label integration.
|
|
|
2499
3611
|
<dd>
|
|
2500
3612
|
|
|
2501
3613
|
```typescript
|
|
2502
|
-
await client.
|
|
3614
|
+
await client.chat.updateChat("chat_id");
|
|
2503
3615
|
```
|
|
2504
3616
|
|
|
2505
3617
|
</dd>
|
|
@@ -2515,7 +3627,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2515
3627
|
<dl>
|
|
2516
3628
|
<dd>
|
|
2517
3629
|
|
|
2518
|
-
**
|
|
3630
|
+
**chatId:** `string`
|
|
2519
3631
|
|
|
2520
3632
|
</dd>
|
|
2521
3633
|
</dl>
|
|
@@ -2523,7 +3635,15 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2523
3635
|
<dl>
|
|
2524
3636
|
<dd>
|
|
2525
3637
|
|
|
2526
|
-
**
|
|
3638
|
+
**request:** `AirweaveSDK.ChatUpdate`
|
|
3639
|
+
|
|
3640
|
+
</dd>
|
|
3641
|
+
</dl>
|
|
3642
|
+
|
|
3643
|
+
<dl>
|
|
3644
|
+
<dd>
|
|
3645
|
+
|
|
3646
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2527
3647
|
|
|
2528
3648
|
</dd>
|
|
2529
3649
|
</dl>
|
|
@@ -2534,7 +3654,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2534
3654
|
</dl>
|
|
2535
3655
|
</details>
|
|
2536
3656
|
|
|
2537
|
-
<details><summary><code>client.
|
|
3657
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">deleteChat</a>(chatId) -> void</code></summary>
|
|
2538
3658
|
<dl>
|
|
2539
3659
|
<dd>
|
|
2540
3660
|
|
|
@@ -2546,17 +3666,13 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2546
3666
|
<dl>
|
|
2547
3667
|
<dd>
|
|
2548
3668
|
|
|
2549
|
-
|
|
3669
|
+
Archive a chat.
|
|
2550
3670
|
|
|
2551
3671
|
## Args:
|
|
2552
3672
|
|
|
2553
|
-
db: The database session
|
|
2554
|
-
|
|
2555
|
-
user: The current user
|
|
2556
|
-
|
|
2557
|
-
## Returns:
|
|
2558
|
-
|
|
2559
|
-
str: The OAuth2 authorization URL
|
|
3673
|
+
db: The database session.
|
|
3674
|
+
chat_id: The ID of the chat to archive.
|
|
3675
|
+
user: The current user.
|
|
2560
3676
|
|
|
2561
3677
|
</dd>
|
|
2562
3678
|
</dl>
|
|
@@ -2572,7 +3688,7 @@ Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
|
2572
3688
|
<dd>
|
|
2573
3689
|
|
|
2574
3690
|
```typescript
|
|
2575
|
-
await client.
|
|
3691
|
+
await client.chat.deleteChat("chat_id");
|
|
2576
3692
|
```
|
|
2577
3693
|
|
|
2578
3694
|
</dd>
|
|
@@ -2588,7 +3704,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2588
3704
|
<dl>
|
|
2589
3705
|
<dd>
|
|
2590
3706
|
|
|
2591
|
-
**
|
|
3707
|
+
**chatId:** `string`
|
|
2592
3708
|
|
|
2593
3709
|
</dd>
|
|
2594
3710
|
</dl>
|
|
@@ -2596,7 +3712,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2596
3712
|
<dl>
|
|
2597
3713
|
<dd>
|
|
2598
3714
|
|
|
2599
|
-
**requestOptions:** `
|
|
3715
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2600
3716
|
|
|
2601
3717
|
</dd>
|
|
2602
3718
|
</dl>
|
|
@@ -2607,7 +3723,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2607
3723
|
</dl>
|
|
2608
3724
|
</details>
|
|
2609
3725
|
|
|
2610
|
-
<details><summary><code>client.
|
|
3726
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">sendMessage</a>(chatId, { ...params }) -> AirweaveSDK.ChatMessage</code></summary>
|
|
2611
3727
|
<dl>
|
|
2612
3728
|
<dd>
|
|
2613
3729
|
|
|
@@ -2619,18 +3735,18 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2619
3735
|
<dl>
|
|
2620
3736
|
<dd>
|
|
2621
3737
|
|
|
2622
|
-
|
|
3738
|
+
Send a message to a chat.
|
|
2623
3739
|
|
|
2624
3740
|
## Args:
|
|
2625
3741
|
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
user: The current user
|
|
3742
|
+
db: The database session.
|
|
3743
|
+
chat_id: The ID of the chat to send the message to.
|
|
3744
|
+
message: The message to send.
|
|
3745
|
+
user: The current user.
|
|
2630
3746
|
|
|
2631
3747
|
## Returns:
|
|
2632
3748
|
|
|
2633
|
-
|
|
3749
|
+
schemas.ChatMessage: The sent message.
|
|
2634
3750
|
|
|
2635
3751
|
</dd>
|
|
2636
3752
|
</dl>
|
|
@@ -2646,7 +3762,9 @@ Exchange OAuth2 code for tokens and create connection.
|
|
|
2646
3762
|
<dd>
|
|
2647
3763
|
|
|
2648
3764
|
```typescript
|
|
2649
|
-
await client.
|
|
3765
|
+
await client.chat.sendMessage("chat_id", {
|
|
3766
|
+
content: "content",
|
|
3767
|
+
});
|
|
2650
3768
|
```
|
|
2651
3769
|
|
|
2652
3770
|
</dd>
|
|
@@ -2662,7 +3780,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2662
3780
|
<dl>
|
|
2663
3781
|
<dd>
|
|
2664
3782
|
|
|
2665
|
-
**
|
|
3783
|
+
**chatId:** `string`
|
|
2666
3784
|
|
|
2667
3785
|
</dd>
|
|
2668
3786
|
</dl>
|
|
@@ -2670,7 +3788,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2670
3788
|
<dl>
|
|
2671
3789
|
<dd>
|
|
2672
3790
|
|
|
2673
|
-
**request:** `
|
|
3791
|
+
**request:** `AirweaveSDK.ChatMessageCreate`
|
|
2674
3792
|
|
|
2675
3793
|
</dd>
|
|
2676
3794
|
</dl>
|
|
@@ -2678,7 +3796,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2678
3796
|
<dl>
|
|
2679
3797
|
<dd>
|
|
2680
3798
|
|
|
2681
|
-
**requestOptions:** `
|
|
3799
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2682
3800
|
|
|
2683
3801
|
</dd>
|
|
2684
3802
|
</dl>
|
|
@@ -2689,7 +3807,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2689
3807
|
</dl>
|
|
2690
3808
|
</details>
|
|
2691
3809
|
|
|
2692
|
-
<details><summary><code>client.
|
|
3810
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">streamChatResponse</a>(chatId) -> void</code></summary>
|
|
2693
3811
|
<dl>
|
|
2694
3812
|
<dd>
|
|
2695
3813
|
|
|
@@ -2701,17 +3819,17 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2701
3819
|
<dl>
|
|
2702
3820
|
<dd>
|
|
2703
3821
|
|
|
2704
|
-
|
|
3822
|
+
Stream an AI response for a chat message.
|
|
2705
3823
|
|
|
2706
3824
|
## Args:
|
|
2707
3825
|
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
3826
|
+
db: The database session.
|
|
3827
|
+
chat_id: The ID of the chat to stream the response for.
|
|
3828
|
+
user: The current user.
|
|
2711
3829
|
|
|
2712
3830
|
## Returns:
|
|
2713
3831
|
|
|
2714
|
-
|
|
3832
|
+
StreamingResponse: The streaming response.
|
|
2715
3833
|
|
|
2716
3834
|
</dd>
|
|
2717
3835
|
</dl>
|
|
@@ -2727,7 +3845,7 @@ List all syncs for a specific white label.
|
|
|
2727
3845
|
<dd>
|
|
2728
3846
|
|
|
2729
3847
|
```typescript
|
|
2730
|
-
await client.
|
|
3848
|
+
await client.chat.streamChatResponse("chat_id");
|
|
2731
3849
|
```
|
|
2732
3850
|
|
|
2733
3851
|
</dd>
|
|
@@ -2743,7 +3861,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
|
2743
3861
|
<dl>
|
|
2744
3862
|
<dd>
|
|
2745
3863
|
|
|
2746
|
-
**
|
|
3864
|
+
**chatId:** `string`
|
|
2747
3865
|
|
|
2748
3866
|
</dd>
|
|
2749
3867
|
</dl>
|
|
@@ -2751,7 +3869,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
|
2751
3869
|
<dl>
|
|
2752
3870
|
<dd>
|
|
2753
3871
|
|
|
2754
|
-
**requestOptions:** `
|
|
3872
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2755
3873
|
|
|
2756
3874
|
</dd>
|
|
2757
3875
|
</dl>
|
|
@@ -3523,6 +4641,71 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
|
3523
4641
|
</dl>
|
|
3524
4642
|
</details>
|
|
3525
4643
|
|
|
4644
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsBySourceShortName</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
4645
|
+
<dl>
|
|
4646
|
+
<dd>
|
|
4647
|
+
|
|
4648
|
+
#### 📝 Description
|
|
4649
|
+
|
|
4650
|
+
<dl>
|
|
4651
|
+
<dd>
|
|
4652
|
+
|
|
4653
|
+
<dl>
|
|
4654
|
+
<dd>
|
|
4655
|
+
|
|
4656
|
+
Get all entity definitions for a given source.
|
|
4657
|
+
|
|
4658
|
+
</dd>
|
|
4659
|
+
</dl>
|
|
4660
|
+
</dd>
|
|
4661
|
+
</dl>
|
|
4662
|
+
|
|
4663
|
+
#### 🔌 Usage
|
|
4664
|
+
|
|
4665
|
+
<dl>
|
|
4666
|
+
<dd>
|
|
4667
|
+
|
|
4668
|
+
<dl>
|
|
4669
|
+
<dd>
|
|
4670
|
+
|
|
4671
|
+
```typescript
|
|
4672
|
+
await client.entities.getEntityDefinitionsBySourceShortName({
|
|
4673
|
+
sourceShortName: "source_short_name",
|
|
4674
|
+
});
|
|
4675
|
+
```
|
|
4676
|
+
|
|
4677
|
+
</dd>
|
|
4678
|
+
</dl>
|
|
4679
|
+
</dd>
|
|
4680
|
+
</dl>
|
|
4681
|
+
|
|
4682
|
+
#### ⚙️ Parameters
|
|
4683
|
+
|
|
4684
|
+
<dl>
|
|
4685
|
+
<dd>
|
|
4686
|
+
|
|
4687
|
+
<dl>
|
|
4688
|
+
<dd>
|
|
4689
|
+
|
|
4690
|
+
**request:** `AirweaveSDK.GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest`
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
<dl>
|
|
4696
|
+
<dd>
|
|
4697
|
+
|
|
4698
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
4699
|
+
|
|
4700
|
+
</dd>
|
|
4701
|
+
</dl>
|
|
4702
|
+
</dd>
|
|
4703
|
+
</dl>
|
|
4704
|
+
|
|
4705
|
+
</dd>
|
|
4706
|
+
</dl>
|
|
4707
|
+
</details>
|
|
4708
|
+
|
|
3526
4709
|
## Transformers
|
|
3527
4710
|
|
|
3528
4711
|
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>() -> AirweaveSDK.Transformer[]</code></summary>
|
|
@@ -3725,3 +4908,156 @@ await client.transformers.updateTransformer("transformer_id", {
|
|
|
3725
4908
|
</dd>
|
|
3726
4909
|
</dl>
|
|
3727
4910
|
</details>
|
|
4911
|
+
|
|
4912
|
+
## CursorDevelopment
|
|
4913
|
+
|
|
4914
|
+
<details><summary><code>client.cursorDevelopment.<a href="/src/api/resources/cursorDevelopment/client/Client.ts">checkConnectionStatus</a>(shortName) -> AirweaveSDK.Connection[]</code></summary>
|
|
4915
|
+
<dl>
|
|
4916
|
+
<dd>
|
|
4917
|
+
|
|
4918
|
+
#### 📝 Description
|
|
4919
|
+
|
|
4920
|
+
<dl>
|
|
4921
|
+
<dd>
|
|
4922
|
+
|
|
4923
|
+
<dl>
|
|
4924
|
+
<dd>
|
|
4925
|
+
|
|
4926
|
+
Check if a source connection exists for the given short_name.
|
|
4927
|
+
|
|
4928
|
+
## Args:
|
|
4929
|
+
|
|
4930
|
+
db: The database session
|
|
4931
|
+
short_name: The short name of the source to check
|
|
4932
|
+
user: The admin user
|
|
4933
|
+
|
|
4934
|
+
## Returns:
|
|
4935
|
+
|
|
4936
|
+
List[schemas.Connection]: List of source connections for the given short_name
|
|
4937
|
+
|
|
4938
|
+
</dd>
|
|
4939
|
+
</dl>
|
|
4940
|
+
</dd>
|
|
4941
|
+
</dl>
|
|
4942
|
+
|
|
4943
|
+
#### 🔌 Usage
|
|
4944
|
+
|
|
4945
|
+
<dl>
|
|
4946
|
+
<dd>
|
|
4947
|
+
|
|
4948
|
+
<dl>
|
|
4949
|
+
<dd>
|
|
4950
|
+
|
|
4951
|
+
```typescript
|
|
4952
|
+
await client.cursorDevelopment.checkConnectionStatus("short_name");
|
|
4953
|
+
```
|
|
4954
|
+
|
|
4955
|
+
</dd>
|
|
4956
|
+
</dl>
|
|
4957
|
+
</dd>
|
|
4958
|
+
</dl>
|
|
4959
|
+
|
|
4960
|
+
#### ⚙️ Parameters
|
|
4961
|
+
|
|
4962
|
+
<dl>
|
|
4963
|
+
<dd>
|
|
4964
|
+
|
|
4965
|
+
<dl>
|
|
4966
|
+
<dd>
|
|
4967
|
+
|
|
4968
|
+
**shortName:** `string`
|
|
4969
|
+
|
|
4970
|
+
</dd>
|
|
4971
|
+
</dl>
|
|
4972
|
+
|
|
4973
|
+
<dl>
|
|
4974
|
+
<dd>
|
|
4975
|
+
|
|
4976
|
+
**requestOptions:** `CursorDevelopment.RequestOptions`
|
|
4977
|
+
|
|
4978
|
+
</dd>
|
|
4979
|
+
</dl>
|
|
4980
|
+
</dd>
|
|
4981
|
+
</dl>
|
|
4982
|
+
|
|
4983
|
+
</dd>
|
|
4984
|
+
</dl>
|
|
4985
|
+
</details>
|
|
4986
|
+
|
|
4987
|
+
<details><summary><code>client.cursorDevelopment.<a href="/src/api/resources/cursorDevelopment/client/Client.ts">testSync</a>(shortName) -> AirweaveSDK.SyncJob</code></summary>
|
|
4988
|
+
<dl>
|
|
4989
|
+
<dd>
|
|
4990
|
+
|
|
4991
|
+
#### 📝 Description
|
|
4992
|
+
|
|
4993
|
+
<dl>
|
|
4994
|
+
<dd>
|
|
4995
|
+
|
|
4996
|
+
<dl>
|
|
4997
|
+
<dd>
|
|
4998
|
+
|
|
4999
|
+
Run a sync for a specific source by short_name.
|
|
5000
|
+
|
|
5001
|
+
This endpoint is used for testing source integrations during development.
|
|
5002
|
+
It finds the first available source connection for the given short_name and
|
|
5003
|
+
runs a sync on it.
|
|
5004
|
+
|
|
5005
|
+
## Args:
|
|
5006
|
+
|
|
5007
|
+
db: The database session
|
|
5008
|
+
short_name: The short name of the source to sync
|
|
5009
|
+
background_tasks: The background tasks
|
|
5010
|
+
user: The admin user
|
|
5011
|
+
|
|
5012
|
+
## Returns:
|
|
5013
|
+
|
|
5014
|
+
schemas.SyncJob: The created sync job
|
|
5015
|
+
|
|
5016
|
+
</dd>
|
|
5017
|
+
</dl>
|
|
5018
|
+
</dd>
|
|
5019
|
+
</dl>
|
|
5020
|
+
|
|
5021
|
+
#### 🔌 Usage
|
|
5022
|
+
|
|
5023
|
+
<dl>
|
|
5024
|
+
<dd>
|
|
5025
|
+
|
|
5026
|
+
<dl>
|
|
5027
|
+
<dd>
|
|
5028
|
+
|
|
5029
|
+
```typescript
|
|
5030
|
+
await client.cursorDevelopment.testSync("short_name");
|
|
5031
|
+
```
|
|
5032
|
+
|
|
5033
|
+
</dd>
|
|
5034
|
+
</dl>
|
|
5035
|
+
</dd>
|
|
5036
|
+
</dl>
|
|
5037
|
+
|
|
5038
|
+
#### ⚙️ Parameters
|
|
5039
|
+
|
|
5040
|
+
<dl>
|
|
5041
|
+
<dd>
|
|
5042
|
+
|
|
5043
|
+
<dl>
|
|
5044
|
+
<dd>
|
|
5045
|
+
|
|
5046
|
+
**shortName:** `string`
|
|
5047
|
+
|
|
5048
|
+
</dd>
|
|
5049
|
+
</dl>
|
|
5050
|
+
|
|
5051
|
+
<dl>
|
|
5052
|
+
<dd>
|
|
5053
|
+
|
|
5054
|
+
**requestOptions:** `CursorDevelopment.RequestOptions`
|
|
5055
|
+
|
|
5056
|
+
</dd>
|
|
5057
|
+
</dl>
|
|
5058
|
+
</dd>
|
|
5059
|
+
</dl>
|
|
5060
|
+
|
|
5061
|
+
</dd>
|
|
5062
|
+
</dl>
|
|
5063
|
+
</details>
|