@airweave/sdk 0.1.34 → 0.1.35
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 +8 -37
- package/Client.js +13 -63
- package/README.md +10 -8
- package/api/index.d.ts +1 -1
- package/api/index.js +1 -1
- package/api/resources/collections/client/Client.d.ts +112 -0
- package/api/resources/collections/client/Client.js +430 -0
- package/api/resources/collections/client/requests/CollectionCreate.d.ts +15 -0
- package/api/resources/collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.d.ts +10 -0
- package/api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.d.ts +11 -0
- package/api/resources/collections/client/requests/index.d.ts +3 -0
- package/api/resources/connections/client/Client.d.ts +3 -251
- package/api/resources/connections/client/Client.js +7 -796
- package/api/resources/connections/client/index.d.ts +1 -1
- package/api/resources/connections/client/index.js +0 -15
- package/api/resources/index.d.ts +4 -22
- package/api/resources/index.js +5 -23
- package/api/resources/sourceConnections/client/Client.d.ts +191 -0
- package/api/resources/sourceConnections/client/Client.js +625 -0
- package/api/resources/sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.d.ts +10 -0
- package/api/resources/sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts +10 -0
- package/api/resources/sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.d.ts +15 -0
- package/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +17 -0
- package/api/resources/sourceConnections/client/requests/index.d.ts +4 -0
- package/api/resources/sources/client/Client.d.ts +4 -2
- package/api/resources/sources/client/Client.js +11 -6
- package/api/resources/whiteLabels/client/Client.d.ts +3 -47
- package/api/resources/whiteLabels/client/Client.js +20 -170
- package/api/types/ApiKey.d.ts +3 -3
- package/api/types/ApiKeyCreate.d.ts +10 -0
- package/api/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +7 -0
- package/api/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +7 -0
- package/api/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +8 -0
- package/api/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +9 -0
- package/api/types/ChatCreate.d.ts +14 -0
- package/api/types/ChatMessageCreate.d.ts +10 -0
- package/api/types/ChatUpdate.d.ts +12 -0
- package/api/types/Collection.d.ts +19 -0
- package/api/types/CollectionStatus.d.ts +13 -0
- package/api/types/CollectionStatus.js +12 -0
- package/api/types/CollectionUpdate.d.ts +10 -0
- package/api/types/ConfigValues.d.ts +9 -0
- package/api/types/DestinationWithAuthenticationFields.d.ts +23 -0
- package/api/types/EmbeddingModelWithAuthenticationFields.d.ts +21 -0
- package/api/types/EntityCount.d.ts +9 -0
- package/api/types/EntityDefinitionCreate.d.ts +16 -0
- package/api/types/EntityDefinitionUpdate.d.ts +16 -0
- package/api/types/EntityRelationCreate.d.ts +12 -0
- package/api/types/EntityRelationUpdate.d.ts +12 -0
- package/api/types/Organization.d.ts +13 -0
- package/api/types/ResponseType.d.ts +11 -0
- package/api/types/ResponseType.js +10 -0
- package/api/types/SearchResponse.d.ts +13 -0
- package/api/types/SearchStatus.d.ts +12 -0
- package/api/types/SearchStatus.js +11 -0
- package/api/types/SourceConnection.d.ts +31 -0
- package/api/types/SourceConnectionAuthFields.d.ts +5 -0
- package/api/types/SourceConnectionCreate.d.ts +21 -0
- package/api/types/SourceConnectionJob.d.ts +30 -0
- package/api/types/SourceConnectionListItem.d.ts +21 -0
- package/api/types/SourceConnectionStatus.d.ts +12 -0
- package/api/types/SourceConnectionStatus.js +11 -0
- package/api/types/SourceWithAuthenticationFields.d.ts +23 -0
- package/api/types/SyncCreate.d.ts +21 -0
- package/api/types/SyncDagCreate.d.ts +14 -0
- package/api/types/SyncDagUpdate.d.ts +14 -0
- package/api/types/SyncJob.d.ts +6 -4
- package/api/types/SyncUpdate.d.ts +16 -0
- package/api/types/TransformerCreate.d.ts +15 -0
- package/api/types/TransformerUpdate.d.ts +15 -0
- package/api/types/User.d.ts +1 -1
- package/api/types/UserCreate.d.ts +11 -0
- package/api/types/index.d.ts +39 -4
- package/api/types/index.js +39 -4
- package/core/auth/BasicAuth.d.ts +8 -0
- package/core/auth/BasicAuth.js +26 -0
- package/core/auth/BearerToken.d.ts +5 -0
- package/core/auth/BearerToken.js +15 -0
- package/core/auth/index.d.ts +2 -0
- package/core/auth/index.js +7 -0
- package/core/index.d.ts +1 -0
- package/core/index.js +1 -0
- package/dist/Client.d.ts +8 -37
- package/dist/Client.js +13 -63
- package/dist/api/index.d.ts +1 -1
- package/dist/api/index.js +1 -1
- package/dist/api/resources/collections/client/Client.d.ts +112 -0
- package/dist/api/resources/collections/client/Client.js +430 -0
- package/dist/api/resources/collections/client/requests/CollectionCreate.d.ts +15 -0
- package/dist/api/resources/collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.d.ts +10 -0
- package/dist/api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.d.ts +11 -0
- package/dist/api/resources/collections/client/requests/index.d.ts +3 -0
- package/dist/api/resources/connections/client/Client.d.ts +3 -251
- package/dist/api/resources/connections/client/Client.js +7 -796
- package/dist/api/resources/connections/client/index.d.ts +1 -1
- package/dist/api/resources/connections/client/index.js +0 -15
- package/dist/api/resources/index.d.ts +4 -22
- package/dist/api/resources/index.js +5 -23
- package/dist/api/resources/sourceConnections/client/Client.d.ts +191 -0
- package/dist/api/resources/sourceConnections/client/Client.js +625 -0
- package/dist/api/resources/sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.d.ts +10 -0
- package/dist/api/resources/sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts +10 -0
- package/dist/api/resources/sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.d.ts +15 -0
- package/dist/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +17 -0
- package/dist/api/resources/sourceConnections/client/requests/index.d.ts +4 -0
- package/dist/api/resources/sources/client/Client.d.ts +4 -2
- package/dist/api/resources/sources/client/Client.js +11 -6
- package/dist/api/resources/whiteLabels/client/Client.d.ts +3 -47
- package/dist/api/resources/whiteLabels/client/Client.js +20 -170
- package/dist/api/types/ApiKey.d.ts +3 -3
- package/dist/api/types/ApiKeyCreate.d.ts +10 -0
- package/dist/api/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +7 -0
- package/dist/api/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +7 -0
- package/dist/api/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +8 -0
- package/dist/api/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +9 -0
- package/dist/api/types/ChatCreate.d.ts +14 -0
- package/dist/api/types/ChatMessageCreate.d.ts +10 -0
- package/dist/api/types/ChatUpdate.d.ts +12 -0
- package/dist/api/types/Collection.d.ts +19 -0
- package/dist/api/types/CollectionStatus.d.ts +13 -0
- package/dist/api/types/CollectionStatus.js +12 -0
- package/dist/api/types/CollectionUpdate.d.ts +10 -0
- package/dist/api/types/ConfigValues.d.ts +9 -0
- package/dist/api/types/DestinationWithAuthenticationFields.d.ts +23 -0
- package/dist/api/types/EmbeddingModelWithAuthenticationFields.d.ts +21 -0
- package/dist/api/types/EntityCount.d.ts +9 -0
- package/dist/api/types/EntityDefinitionCreate.d.ts +16 -0
- package/dist/api/types/EntityDefinitionUpdate.d.ts +16 -0
- package/dist/api/types/EntityRelationCreate.d.ts +12 -0
- package/dist/api/types/EntityRelationUpdate.d.ts +12 -0
- package/dist/api/types/EntityRelationUpdate.js +5 -0
- package/dist/api/types/Organization.d.ts +13 -0
- package/dist/api/types/Organization.js +5 -0
- package/dist/api/types/ResponseType.d.ts +11 -0
- package/dist/api/types/ResponseType.js +10 -0
- package/dist/api/types/SearchResponse.d.ts +13 -0
- package/dist/api/types/SearchResponse.js +5 -0
- package/dist/api/types/SearchStatus.d.ts +12 -0
- package/dist/api/types/SearchStatus.js +11 -0
- package/dist/api/types/SourceConnection.d.ts +31 -0
- package/dist/api/types/SourceConnection.js +5 -0
- package/dist/api/types/SourceConnectionAuthFields.d.ts +5 -0
- package/dist/api/types/SourceConnectionAuthFields.js +5 -0
- package/dist/api/types/SourceConnectionCreate.d.ts +21 -0
- package/dist/api/types/SourceConnectionCreate.js +5 -0
- package/dist/api/types/SourceConnectionJob.d.ts +30 -0
- package/dist/api/types/SourceConnectionJob.js +5 -0
- package/dist/api/types/SourceConnectionListItem.d.ts +21 -0
- package/dist/api/types/SourceConnectionListItem.js +5 -0
- package/dist/api/types/SourceConnectionStatus.d.ts +12 -0
- package/dist/api/types/SourceConnectionStatus.js +11 -0
- package/dist/api/types/SourceWithAuthenticationFields.d.ts +23 -0
- package/dist/api/types/SourceWithAuthenticationFields.js +5 -0
- package/dist/api/types/SyncCreate.d.ts +21 -0
- package/dist/api/types/SyncCreate.js +5 -0
- package/dist/api/types/SyncDagCreate.d.ts +14 -0
- package/dist/api/types/SyncDagCreate.js +5 -0
- package/dist/api/types/SyncDagUpdate.d.ts +14 -0
- package/dist/api/types/SyncDagUpdate.js +5 -0
- package/dist/api/types/SyncJob.d.ts +6 -4
- package/dist/api/types/SyncUpdate.d.ts +16 -0
- package/dist/api/types/SyncUpdate.js +5 -0
- package/dist/api/types/TransformerCreate.d.ts +15 -0
- package/dist/api/types/TransformerCreate.js +5 -0
- package/dist/api/types/TransformerUpdate.d.ts +15 -0
- package/dist/api/types/TransformerUpdate.js +5 -0
- package/dist/api/types/User.d.ts +1 -1
- package/dist/api/types/UserCreate.d.ts +11 -0
- package/dist/api/types/UserCreate.js +5 -0
- package/dist/api/types/index.d.ts +39 -4
- package/dist/api/types/index.js +39 -4
- package/dist/core/auth/BasicAuth.d.ts +8 -0
- package/dist/core/auth/BasicAuth.js +26 -0
- package/dist/core/auth/BearerToken.d.ts +5 -0
- package/dist/core/auth/BearerToken.js +15 -0
- package/dist/core/auth/index.d.ts +2 -0
- package/dist/core/auth/index.js +7 -0
- package/dist/core/index.d.ts +1 -0
- package/dist/core/index.js +1 -0
- package/dist/serialization/index.d.ts +1 -1
- package/dist/serialization/index.js +1 -1
- package/dist/serialization/resources/collections/client/index.d.ts +3 -0
- package/dist/serialization/resources/collections/client/index.js +42 -0
- package/dist/serialization/resources/collections/client/listCollections.d.ts +11 -0
- package/dist/serialization/resources/collections/client/listCollections.js +42 -0
- package/dist/serialization/resources/collections/client/refreshAllSourceConnections.d.ts +11 -0
- package/dist/serialization/resources/collections/client/refreshAllSourceConnections.js +42 -0
- package/dist/serialization/resources/collections/client/requests/CollectionCreate.d.ts +13 -0
- package/dist/serialization/resources/collections/client/requests/CollectionCreate.js +44 -0
- package/dist/serialization/resources/collections/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/collections/client/requests/index.js +5 -0
- package/dist/serialization/resources/connections/client/index.d.ts +0 -6
- package/dist/serialization/resources/connections/client/index.js +1 -10
- package/dist/serialization/resources/index.d.ts +4 -20
- package/dist/serialization/resources/index.js +5 -21
- package/dist/serialization/resources/sourceConnections/client/index.d.ts +3 -0
- package/dist/serialization/resources/sourceConnections/client/index.js +42 -0
- package/dist/serialization/resources/sourceConnections/client/listSourceConnectionJobs.d.ts +11 -0
- package/dist/serialization/resources/sourceConnections/client/listSourceConnectionJobs.js +42 -0
- package/dist/serialization/resources/sourceConnections/client/listSourceConnections.d.ts +11 -0
- package/dist/serialization/resources/sourceConnections/client/listSourceConnections.js +42 -0
- package/dist/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +18 -0
- package/dist/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.js +49 -0
- package/dist/serialization/resources/sourceConnections/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/sourceConnections/client/requests/index.js +5 -0
- package/dist/serialization/resources/whiteLabels/client/index.d.ts +0 -2
- package/dist/serialization/resources/whiteLabels/client/index.js +1 -3
- package/dist/serialization/types/ApiKey.d.ts +2 -2
- package/dist/serialization/types/ApiKey.js +2 -2
- package/dist/serialization/types/ApiKeyCreate.d.ts +12 -0
- package/dist/serialization/types/ApiKeyCreate.js +43 -0
- package/dist/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +13 -0
- package/dist/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +44 -0
- package/dist/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/dist/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +44 -0
- package/dist/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +14 -0
- package/dist/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js +45 -0
- package/dist/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +15 -0
- package/dist/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +46 -0
- package/dist/serialization/types/ChatCreate.d.ts +17 -0
- package/dist/serialization/types/ChatCreate.js +48 -0
- package/dist/serialization/types/ChatMessageCreate.d.ts +13 -0
- package/dist/serialization/types/ChatMessageCreate.js +44 -0
- package/dist/serialization/types/ChatUpdate.d.ts +15 -0
- package/dist/serialization/types/ChatUpdate.js +46 -0
- package/dist/serialization/types/Collection.d.ts +21 -0
- package/dist/serialization/types/Collection.js +52 -0
- package/dist/serialization/types/CollectionStatus.d.ts +10 -0
- package/dist/serialization/types/CollectionStatus.js +41 -0
- package/dist/serialization/types/CollectionUpdate.d.ts +12 -0
- package/dist/serialization/types/CollectionUpdate.js +43 -0
- package/dist/serialization/types/ConfigValues.d.ts +10 -0
- package/dist/serialization/types/ConfigValues.js +41 -0
- package/dist/serialization/types/DestinationWithAuthenticationFields.d.ts +27 -0
- package/dist/serialization/types/DestinationWithAuthenticationFields.js +58 -0
- package/dist/serialization/types/EmbeddingModelWithAuthenticationFields.d.ts +25 -0
- package/dist/serialization/types/EmbeddingModelWithAuthenticationFields.js +56 -0
- package/dist/serialization/types/EntityCount.d.ts +12 -0
- package/dist/serialization/types/EntityCount.js +43 -0
- package/dist/serialization/types/EntityDefinitionCreate.d.ts +20 -0
- package/dist/serialization/types/EntityDefinitionCreate.js +51 -0
- package/dist/serialization/types/EntityDefinitionCreateEntitySchema.d.ts +10 -0
- package/dist/serialization/types/EntityDefinitionCreateEntitySchema.js +44 -0
- package/dist/serialization/types/EntityDefinitionUpdate.d.ts +20 -0
- package/dist/serialization/types/EntityDefinitionUpdate.js +51 -0
- package/dist/serialization/types/EntityDefinitionUpdateEntitySchema.d.ts +10 -0
- package/dist/serialization/types/EntityDefinitionUpdateEntitySchema.js +44 -0
- package/dist/serialization/types/EntityRelationCreate.d.ts +15 -0
- package/dist/serialization/types/EntityRelationCreate.js +46 -0
- package/dist/serialization/types/EntityRelationUpdate.d.ts +15 -0
- package/dist/serialization/types/EntityRelationUpdate.js +46 -0
- package/dist/serialization/types/Organization.d.ts +16 -0
- package/dist/serialization/types/Organization.js +47 -0
- package/dist/serialization/types/ResponseType.d.ts +10 -0
- package/dist/serialization/types/ResponseType.js +41 -0
- package/dist/serialization/types/SearchResponse.d.ts +17 -0
- package/dist/serialization/types/SearchResponse.js +48 -0
- package/dist/serialization/types/SearchStatus.d.ts +10 -0
- package/dist/serialization/types/SearchStatus.js +41 -0
- package/dist/serialization/types/SourceConnection.d.ts +36 -0
- package/dist/serialization/types/SourceConnection.js +67 -0
- package/dist/serialization/types/SourceConnectionAuthFields.d.ts +11 -0
- package/dist/serialization/types/SourceConnectionAuthFields.js +42 -0
- package/dist/serialization/types/SourceConnectionCreate.d.ts +20 -0
- package/dist/serialization/types/SourceConnectionCreate.js +51 -0
- package/dist/serialization/types/SourceConnectionJob.d.ts +30 -0
- package/dist/serialization/types/SourceConnectionJob.js +61 -0
- package/dist/serialization/types/SourceConnectionListItem.d.ts +21 -0
- package/dist/serialization/types/SourceConnectionListItem.js +52 -0
- package/dist/serialization/types/SourceConnectionStatus.d.ts +10 -0
- package/dist/serialization/types/SourceConnectionStatus.js +41 -0
- package/dist/serialization/types/SourceWithAuthenticationFields.d.ts +27 -0
- package/dist/serialization/types/SourceWithAuthenticationFields.js +58 -0
- package/dist/serialization/types/SyncCreate.d.ts +24 -0
- package/dist/serialization/types/SyncCreate.js +55 -0
- package/dist/serialization/types/SyncDagCreate.d.ts +18 -0
- package/dist/serialization/types/SyncDagCreate.js +49 -0
- package/dist/serialization/types/SyncDagUpdate.d.ts +18 -0
- package/dist/serialization/types/SyncDagUpdate.js +49 -0
- package/dist/serialization/types/SyncJob.d.ts +6 -4
- package/dist/serialization/types/SyncJob.js +6 -4
- package/dist/serialization/types/SyncUpdate.d.ts +19 -0
- package/dist/serialization/types/SyncUpdate.js +50 -0
- package/dist/serialization/types/TransformerCreate.d.ts +18 -0
- package/dist/serialization/types/TransformerCreate.js +49 -0
- package/dist/serialization/types/TransformerUpdate.d.ts +18 -0
- package/dist/serialization/types/TransformerUpdate.js +49 -0
- package/dist/serialization/types/User.d.ts +1 -1
- package/dist/serialization/types/User.js +1 -1
- package/dist/serialization/types/UserCreate.d.ts +14 -0
- package/dist/serialization/types/UserCreate.js +45 -0
- package/dist/serialization/types/index.d.ts +39 -4
- package/dist/serialization/types/index.js +39 -4
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +3 -2
- package/reference.md +329 -3781
- package/serialization/index.d.ts +1 -1
- package/serialization/index.js +1 -1
- package/serialization/resources/collections/client/index.d.ts +3 -0
- package/serialization/resources/collections/client/index.js +42 -0
- package/serialization/resources/collections/client/listCollections.d.ts +11 -0
- package/serialization/resources/collections/client/listCollections.js +42 -0
- package/serialization/resources/collections/client/refreshAllSourceConnections.d.ts +11 -0
- package/serialization/resources/collections/client/refreshAllSourceConnections.js +42 -0
- package/serialization/resources/collections/client/requests/CollectionCreate.d.ts +13 -0
- package/serialization/resources/collections/client/requests/CollectionCreate.js +44 -0
- package/serialization/resources/collections/client/requests/index.d.ts +1 -0
- package/serialization/resources/collections/client/requests/index.js +5 -0
- package/serialization/resources/connections/client/index.d.ts +0 -6
- package/serialization/resources/connections/client/index.js +1 -10
- package/serialization/resources/index.d.ts +4 -20
- package/serialization/resources/index.js +5 -21
- package/serialization/resources/sourceConnections/client/index.d.ts +3 -0
- package/serialization/resources/sourceConnections/client/index.js +42 -0
- package/serialization/resources/sourceConnections/client/listSourceConnectionJobs.d.ts +11 -0
- package/serialization/resources/sourceConnections/client/listSourceConnectionJobs.js +42 -0
- package/serialization/resources/sourceConnections/client/listSourceConnections.d.ts +11 -0
- package/serialization/resources/sourceConnections/client/listSourceConnections.js +42 -0
- package/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +18 -0
- package/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.js +49 -0
- package/serialization/resources/sourceConnections/client/requests/index.d.ts +1 -0
- package/serialization/resources/sourceConnections/client/requests/index.js +5 -0
- package/serialization/resources/whiteLabels/client/index.d.ts +0 -2
- package/serialization/resources/whiteLabels/client/index.js +1 -3
- package/serialization/types/ApiKey.d.ts +2 -2
- package/serialization/types/ApiKey.js +2 -2
- package/serialization/types/ApiKeyCreate.d.ts +12 -0
- package/serialization/types/ApiKeyCreate.js +43 -0
- package/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +13 -0
- package/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +44 -0
- package/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +44 -0
- package/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +14 -0
- package/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js +45 -0
- package/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +15 -0
- package/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +46 -0
- package/serialization/types/ChatCreate.d.ts +17 -0
- package/serialization/types/ChatCreate.js +48 -0
- package/serialization/types/ChatMessageCreate.d.ts +13 -0
- package/serialization/types/ChatMessageCreate.js +44 -0
- package/serialization/types/ChatUpdate.d.ts +15 -0
- package/serialization/types/ChatUpdate.js +46 -0
- package/serialization/types/Collection.d.ts +21 -0
- package/serialization/types/Collection.js +52 -0
- package/serialization/types/CollectionStatus.d.ts +10 -0
- package/serialization/types/CollectionStatus.js +41 -0
- package/serialization/types/CollectionUpdate.d.ts +12 -0
- package/serialization/types/CollectionUpdate.js +43 -0
- package/serialization/types/ConfigValues.d.ts +10 -0
- package/serialization/types/ConfigValues.js +41 -0
- package/serialization/types/DestinationWithAuthenticationFields.d.ts +27 -0
- package/serialization/types/DestinationWithAuthenticationFields.js +58 -0
- package/serialization/types/EmbeddingModelWithAuthenticationFields.d.ts +25 -0
- package/serialization/types/EmbeddingModelWithAuthenticationFields.js +56 -0
- package/serialization/types/EntityCount.d.ts +12 -0
- package/serialization/types/EntityCount.js +43 -0
- package/serialization/types/EntityDefinitionCreate.d.ts +20 -0
- package/serialization/types/EntityDefinitionCreate.js +51 -0
- package/serialization/types/EntityDefinitionCreateEntitySchema.d.ts +10 -0
- package/serialization/types/EntityDefinitionCreateEntitySchema.js +44 -0
- package/serialization/types/EntityDefinitionUpdate.d.ts +20 -0
- package/serialization/types/EntityDefinitionUpdate.js +51 -0
- package/serialization/types/EntityDefinitionUpdateEntitySchema.d.ts +10 -0
- package/serialization/types/EntityDefinitionUpdateEntitySchema.js +44 -0
- package/serialization/types/EntityRelationCreate.d.ts +15 -0
- package/serialization/types/EntityRelationCreate.js +46 -0
- package/serialization/types/EntityRelationUpdate.d.ts +15 -0
- package/serialization/types/EntityRelationUpdate.js +46 -0
- package/serialization/types/Organization.d.ts +16 -0
- package/serialization/types/Organization.js +47 -0
- package/serialization/types/ResponseType.d.ts +10 -0
- package/serialization/types/ResponseType.js +41 -0
- package/serialization/types/SearchResponse.d.ts +17 -0
- package/serialization/types/SearchResponse.js +48 -0
- package/serialization/types/SearchStatus.d.ts +10 -0
- package/serialization/types/SearchStatus.js +41 -0
- package/serialization/types/SourceConnection.d.ts +36 -0
- package/serialization/types/SourceConnection.js +67 -0
- package/serialization/types/SourceConnectionAuthFields.d.ts +11 -0
- package/serialization/types/SourceConnectionAuthFields.js +42 -0
- package/serialization/types/SourceConnectionCreate.d.ts +20 -0
- package/serialization/types/SourceConnectionCreate.js +51 -0
- package/serialization/types/SourceConnectionJob.d.ts +30 -0
- package/serialization/types/SourceConnectionJob.js +61 -0
- package/serialization/types/SourceConnectionListItem.d.ts +21 -0
- package/serialization/types/SourceConnectionListItem.js +52 -0
- package/serialization/types/SourceConnectionStatus.d.ts +10 -0
- package/serialization/types/SourceConnectionStatus.js +41 -0
- package/serialization/types/SourceWithAuthenticationFields.d.ts +27 -0
- package/serialization/types/SourceWithAuthenticationFields.js +58 -0
- package/serialization/types/SyncCreate.d.ts +24 -0
- package/serialization/types/SyncCreate.js +55 -0
- package/serialization/types/SyncDagCreate.d.ts +18 -0
- package/serialization/types/SyncDagCreate.js +49 -0
- package/serialization/types/SyncDagUpdate.d.ts +18 -0
- package/serialization/types/SyncDagUpdate.js +49 -0
- package/serialization/types/SyncJob.d.ts +6 -4
- package/serialization/types/SyncJob.js +6 -4
- package/serialization/types/SyncUpdate.d.ts +19 -0
- package/serialization/types/SyncUpdate.js +50 -0
- package/serialization/types/TransformerCreate.d.ts +18 -0
- package/serialization/types/TransformerCreate.js +49 -0
- package/serialization/types/TransformerUpdate.d.ts +18 -0
- package/serialization/types/TransformerUpdate.js +49 -0
- package/serialization/types/User.d.ts +1 -1
- package/serialization/types/User.js +1 -1
- package/serialization/types/UserCreate.d.ts +14 -0
- package/serialization/types/UserCreate.js +45 -0
- package/serialization/types/index.d.ts +39 -4
- package/serialization/types/index.js +39 -4
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/apiKeys/client/Client.d.ts +0 -131
- package/api/resources/apiKeys/client/Client.js +0 -391
- package/api/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +0 -10
- package/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts +0 -12
- package/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +0 -11
- package/api/resources/apiKeys/client/requests/index.d.ts +0 -3
- package/api/resources/chat/client/Client.d.ts +0 -209
- package/api/resources/chat/client/Client.js +0 -669
- package/api/resources/chat/client/requests/ChatCreate.d.ts +0 -18
- package/api/resources/chat/client/requests/ChatMessageCreate.d.ts +0 -13
- package/api/resources/chat/client/requests/ChatUpdate.d.ts +0 -13
- package/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +0 -11
- package/api/resources/chat/client/requests/index.d.ts +0 -4
- package/api/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -15
- package/api/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +0 -13
- package/api/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -14
- package/api/resources/connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/index.d.ts +0 -4
- package/api/resources/cursorDevelopment/client/Client.d.ts +0 -78
- package/api/resources/cursorDevelopment/client/Client.js +0 -218
- package/api/resources/cursorDevelopment/client/index.d.ts +0 -1
- package/api/resources/dag/client/Client.d.ts +0 -95
- package/api/resources/dag/client/Client.js +0 -347
- package/api/resources/dag/client/requests/InitializeDagDagInitGetRequest.d.ts +0 -12
- package/api/resources/dag/client/requests/SyncDagCreate.d.ts +0 -26
- package/api/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
- package/api/resources/dag/client/requests/index.d.ts +0 -3
- package/api/resources/dag/client/requests/index.js +0 -2
- package/api/resources/destinations/client/Client.d.ts +0 -71
- package/api/resources/destinations/client/Client.js +0 -211
- package/api/resources/destinations/client/index.d.ts +0 -1
- package/api/resources/destinations/client/index.js +0 -2
- package/api/resources/embeddingModels/client/Client.d.ts +0 -71
- package/api/resources/embeddingModels/client/Client.js +0 -211
- package/api/resources/embeddingModels/client/index.d.ts +0 -1
- package/api/resources/embeddingModels/client/index.js +0 -2
- package/api/resources/entities/client/Client.d.ts +0 -155
- package/api/resources/entities/client/Client.js +0 -624
- package/api/resources/entities/client/requests/EntityDefinitionCreate.d.ts +0 -23
- package/api/resources/entities/client/requests/EntityDefinitionUpdate.d.ts +0 -23
- package/api/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -17
- package/api/resources/entities/client/requests/EntityRelationUpdate.d.ts +0 -17
- package/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -12
- package/api/resources/entities/client/requests/index.d.ts +0 -5
- package/api/resources/entities/client/requests/index.js +0 -2
- package/api/resources/entities/index.d.ts +0 -2
- package/api/resources/entities/index.js +0 -18
- package/api/resources/entities/types/index.d.ts +0 -2
- package/api/resources/entities/types/index.js +0 -18
- package/api/resources/health/client/Client.d.ts +0 -41
- package/api/resources/health/client/Client.js +0 -118
- package/api/resources/health/client/index.d.ts +0 -1
- package/api/resources/health/client/index.js +0 -2
- package/api/resources/search/client/Client.d.ts +0 -55
- package/api/resources/search/client/Client.js +0 -147
- package/api/resources/search/client/index.d.ts +0 -1
- package/api/resources/search/client/index.js +0 -17
- package/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +0 -20
- package/api/resources/search/client/requests/index.d.ts +0 -1
- package/api/resources/search/client/requests/index.js +0 -2
- package/api/resources/sync/client/Client.d.ts +0 -275
- package/api/resources/sync/client/Client.js +0 -916
- package/api/resources/sync/client/index.d.ts +0 -1
- package/api/resources/sync/client/index.js +0 -17
- package/api/resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts +0 -10
- package/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +0 -11
- package/api/resources/sync/client/requests/ListSyncsSyncGetRequest.d.ts +0 -12
- package/api/resources/sync/client/requests/SyncCreate.d.ts +0 -26
- package/api/resources/sync/client/requests/SyncUpdate.d.ts +0 -17
- package/api/resources/sync/client/requests/index.d.ts +0 -5
- package/api/resources/sync/client/requests/index.js +0 -2
- package/api/resources/sync/index.d.ts +0 -2
- package/api/resources/sync/index.js +0 -18
- package/api/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -5
- package/api/resources/sync/types/index.d.ts +0 -1
- package/api/resources/sync/types/index.js +0 -17
- package/api/resources/transformers/client/Client.d.ts +0 -77
- package/api/resources/transformers/client/Client.js +0 -272
- package/api/resources/transformers/client/index.d.ts +0 -1
- package/api/resources/transformers/client/index.js +0 -17
- package/api/resources/transformers/client/requests/TransformerCreate.d.ts +0 -22
- package/api/resources/transformers/client/requests/TransformerUpdate.d.ts +0 -22
- package/api/resources/transformers/client/requests/index.d.ts +0 -2
- package/api/resources/transformers/client/requests/index.js +0 -2
- package/api/resources/transformers/index.d.ts +0 -1
- package/api/resources/transformers/index.js +0 -17
- package/api/resources/users/client/Client.d.ts +0 -48
- package/api/resources/users/client/Client.js +0 -135
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/index.js +0 -2
- package/api/resources/users/index.d.ts +0 -1
- package/api/resources/users/index.js +0 -17
- package/api/types/ApiKeyWithPlainKey.d.ts +0 -18
- package/api/types/DestinationWithConfigFields.d.ts +0 -23
- package/api/types/EmbeddingModelWithConfigFields.d.ts +0 -21
- package/api/types/SourceWithConfigFields.d.ts +0 -23
- package/dist/api/resources/apiKeys/client/Client.d.ts +0 -131
- package/dist/api/resources/apiKeys/client/Client.js +0 -391
- package/dist/api/resources/apiKeys/client/index.d.ts +0 -1
- package/dist/api/resources/apiKeys/client/index.js +0 -17
- package/dist/api/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +0 -10
- package/dist/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts +0 -12
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +0 -11
- package/dist/api/resources/apiKeys/client/requests/index.d.ts +0 -3
- package/dist/api/resources/apiKeys/client/requests/index.js +0 -2
- package/dist/api/resources/apiKeys/index.d.ts +0 -1
- package/dist/api/resources/apiKeys/index.js +0 -17
- package/dist/api/resources/chat/client/Client.d.ts +0 -209
- package/dist/api/resources/chat/client/Client.js +0 -669
- package/dist/api/resources/chat/client/index.d.ts +0 -1
- package/dist/api/resources/chat/client/index.js +0 -17
- package/dist/api/resources/chat/client/requests/ChatCreate.d.ts +0 -18
- package/dist/api/resources/chat/client/requests/ChatMessageCreate.d.ts +0 -13
- package/dist/api/resources/chat/client/requests/ChatUpdate.d.ts +0 -13
- package/dist/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +0 -11
- package/dist/api/resources/chat/client/requests/index.d.ts +0 -4
- package/dist/api/resources/chat/client/requests/index.js +0 -2
- package/dist/api/resources/chat/index.d.ts +0 -1
- package/dist/api/resources/chat/index.js +0 -17
- package/dist/api/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -15
- package/dist/api/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +0 -13
- package/dist/api/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -14
- package/dist/api/resources/connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/index.d.ts +0 -4
- package/dist/api/resources/connections/client/requests/index.js +0 -2
- package/dist/api/resources/cursorDevelopment/client/Client.d.ts +0 -78
- package/dist/api/resources/cursorDevelopment/client/Client.js +0 -218
- package/dist/api/resources/cursorDevelopment/client/index.d.ts +0 -1
- package/dist/api/resources/cursorDevelopment/client/index.js +0 -2
- package/dist/api/resources/cursorDevelopment/index.d.ts +0 -1
- package/dist/api/resources/cursorDevelopment/index.js +0 -17
- package/dist/api/resources/dag/client/Client.d.ts +0 -95
- package/dist/api/resources/dag/client/Client.js +0 -347
- package/dist/api/resources/dag/client/index.d.ts +0 -1
- package/dist/api/resources/dag/client/index.js +0 -17
- package/dist/api/resources/dag/client/requests/InitializeDagDagInitGetRequest.d.ts +0 -12
- package/dist/api/resources/dag/client/requests/SyncDagCreate.d.ts +0 -26
- package/dist/api/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
- package/dist/api/resources/dag/client/requests/index.d.ts +0 -3
- package/dist/api/resources/dag/client/requests/index.js +0 -2
- package/dist/api/resources/dag/index.d.ts +0 -1
- package/dist/api/resources/dag/index.js +0 -17
- package/dist/api/resources/destinations/client/Client.d.ts +0 -71
- package/dist/api/resources/destinations/client/Client.js +0 -211
- package/dist/api/resources/destinations/client/index.d.ts +0 -1
- package/dist/api/resources/destinations/client/index.js +0 -2
- package/dist/api/resources/destinations/index.d.ts +0 -1
- package/dist/api/resources/destinations/index.js +0 -17
- package/dist/api/resources/embeddingModels/client/Client.d.ts +0 -71
- package/dist/api/resources/embeddingModels/client/Client.js +0 -211
- package/dist/api/resources/embeddingModels/client/index.d.ts +0 -1
- package/dist/api/resources/embeddingModels/client/index.js +0 -2
- package/dist/api/resources/embeddingModels/index.d.ts +0 -1
- package/dist/api/resources/embeddingModels/index.js +0 -17
- package/dist/api/resources/entities/client/Client.d.ts +0 -155
- package/dist/api/resources/entities/client/Client.js +0 -624
- package/dist/api/resources/entities/client/index.d.ts +0 -1
- package/dist/api/resources/entities/client/index.js +0 -17
- package/dist/api/resources/entities/client/requests/EntityDefinitionCreate.d.ts +0 -23
- package/dist/api/resources/entities/client/requests/EntityDefinitionUpdate.d.ts +0 -23
- package/dist/api/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -17
- package/dist/api/resources/entities/client/requests/EntityRelationUpdate.d.ts +0 -17
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -12
- package/dist/api/resources/entities/client/requests/index.d.ts +0 -5
- package/dist/api/resources/entities/client/requests/index.js +0 -2
- package/dist/api/resources/entities/index.d.ts +0 -2
- package/dist/api/resources/entities/index.js +0 -18
- package/dist/api/resources/entities/types/index.d.ts +0 -2
- package/dist/api/resources/entities/types/index.js +0 -18
- package/dist/api/resources/health/client/Client.d.ts +0 -41
- package/dist/api/resources/health/client/Client.js +0 -118
- package/dist/api/resources/health/client/index.d.ts +0 -1
- package/dist/api/resources/health/client/index.js +0 -2
- package/dist/api/resources/health/index.d.ts +0 -1
- package/dist/api/resources/health/index.js +0 -17
- package/dist/api/resources/search/client/Client.d.ts +0 -55
- package/dist/api/resources/search/client/Client.js +0 -147
- package/dist/api/resources/search/client/index.d.ts +0 -1
- package/dist/api/resources/search/client/index.js +0 -17
- package/dist/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +0 -20
- package/dist/api/resources/search/client/requests/index.d.ts +0 -1
- package/dist/api/resources/search/client/requests/index.js +0 -2
- package/dist/api/resources/search/index.d.ts +0 -1
- package/dist/api/resources/search/index.js +0 -17
- package/dist/api/resources/sync/client/Client.d.ts +0 -275
- package/dist/api/resources/sync/client/Client.js +0 -916
- package/dist/api/resources/sync/client/index.d.ts +0 -1
- package/dist/api/resources/sync/client/index.js +0 -17
- package/dist/api/resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts +0 -10
- package/dist/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +0 -11
- package/dist/api/resources/sync/client/requests/ListSyncsSyncGetRequest.d.ts +0 -12
- package/dist/api/resources/sync/client/requests/SyncCreate.d.ts +0 -26
- package/dist/api/resources/sync/client/requests/SyncUpdate.d.ts +0 -17
- package/dist/api/resources/sync/client/requests/index.d.ts +0 -5
- package/dist/api/resources/sync/client/requests/index.js +0 -2
- package/dist/api/resources/sync/index.d.ts +0 -2
- package/dist/api/resources/sync/index.js +0 -18
- package/dist/api/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -5
- package/dist/api/resources/sync/types/index.d.ts +0 -1
- package/dist/api/resources/sync/types/index.js +0 -17
- package/dist/api/resources/transformers/client/Client.d.ts +0 -77
- package/dist/api/resources/transformers/client/Client.js +0 -272
- package/dist/api/resources/transformers/client/index.d.ts +0 -1
- package/dist/api/resources/transformers/client/index.js +0 -17
- package/dist/api/resources/transformers/client/requests/TransformerCreate.d.ts +0 -22
- package/dist/api/resources/transformers/client/requests/TransformerUpdate.d.ts +0 -22
- package/dist/api/resources/transformers/client/requests/index.d.ts +0 -2
- package/dist/api/resources/transformers/client/requests/index.js +0 -2
- package/dist/api/resources/transformers/index.d.ts +0 -1
- package/dist/api/resources/transformers/index.js +0 -17
- package/dist/api/resources/users/client/Client.d.ts +0 -48
- package/dist/api/resources/users/client/Client.js +0 -135
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/index.js +0 -2
- package/dist/api/resources/users/index.d.ts +0 -1
- package/dist/api/resources/users/index.js +0 -17
- package/dist/api/types/ApiKeyWithPlainKey.d.ts +0 -18
- package/dist/api/types/DestinationWithConfigFields.d.ts +0 -23
- package/dist/api/types/EmbeddingModelWithConfigFields.d.ts +0 -21
- package/dist/api/types/SourceWithConfigFields.d.ts +0 -23
- package/dist/serialization/resources/apiKeys/client/index.d.ts +0 -2
- package/dist/serialization/resources/apiKeys/client/index.js +0 -41
- package/dist/serialization/resources/apiKeys/client/readApiKeys.d.ts +0 -11
- package/dist/serialization/resources/apiKeys/client/readApiKeys.js +0 -42
- package/dist/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +0 -12
- package/dist/serialization/resources/apiKeys/client/requests/ApiKeyCreate.js +0 -43
- package/dist/serialization/resources/apiKeys/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/apiKeys/client/requests/index.js +0 -5
- package/dist/serialization/resources/apiKeys/index.d.ts +0 -1
- package/dist/serialization/resources/apiKeys/index.js +0 -17
- package/dist/serialization/resources/chat/client/index.d.ts +0 -3
- package/dist/serialization/resources/chat/client/index.js +0 -42
- package/dist/serialization/resources/chat/client/listChats.d.ts +0 -11
- package/dist/serialization/resources/chat/client/listChats.js +0 -42
- package/dist/serialization/resources/chat/client/openaiKeySet.d.ts +0 -9
- package/dist/serialization/resources/chat/client/openaiKeySet.js +0 -41
- package/dist/serialization/resources/chat/client/requests/ChatCreate.d.ts +0 -17
- package/dist/serialization/resources/chat/client/requests/ChatCreate.js +0 -48
- package/dist/serialization/resources/chat/client/requests/ChatMessageCreate.d.ts +0 -13
- package/dist/serialization/resources/chat/client/requests/ChatMessageCreate.js +0 -44
- package/dist/serialization/resources/chat/client/requests/ChatUpdate.d.ts +0 -15
- package/dist/serialization/resources/chat/client/requests/ChatUpdate.js +0 -46
- package/dist/serialization/resources/chat/client/requests/index.d.ts +0 -3
- package/dist/serialization/resources/chat/client/requests/index.js +0 -9
- package/dist/serialization/resources/chat/index.d.ts +0 -1
- package/dist/serialization/resources/chat/index.js +0 -17
- package/dist/serialization/resources/connections/client/getConnectionCredentials.d.ts +0 -9
- package/dist/serialization/resources/connections/client/getConnectionCredentials.js +0 -41
- package/dist/serialization/resources/connections/client/getOauth2AuthUrl.d.ts +0 -9
- package/dist/serialization/resources/connections/client/getOauth2AuthUrl.js +0 -41
- package/dist/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.d.ts +0 -9
- package/dist/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.js +0 -41
- package/dist/serialization/resources/connections/client/listConnectedIntegrations.d.ts +0 -11
- package/dist/serialization/resources/connections/client/listConnectedIntegrations.js +0 -42
- package/dist/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -13
- package/dist/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +0 -44
- package/dist/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +0 -13
- package/dist/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +0 -44
- package/dist/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -13
- package/dist/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +0 -44
- package/dist/serialization/resources/connections/client/requests/index.d.ts +0 -3
- package/dist/serialization/resources/connections/client/requests/index.js +0 -9
- package/dist/serialization/resources/connections/client/sendOauth2WhiteLabelCode.d.ts +0 -9
- package/dist/serialization/resources/connections/client/sendOauth2WhiteLabelCode.js +0 -41
- package/dist/serialization/resources/cursorDevelopment/client/checkConnectionStatus.d.ts +0 -11
- package/dist/serialization/resources/cursorDevelopment/client/checkConnectionStatus.js +0 -42
- package/dist/serialization/resources/cursorDevelopment/client/index.d.ts +0 -1
- package/dist/serialization/resources/cursorDevelopment/client/index.js +0 -37
- package/dist/serialization/resources/cursorDevelopment/index.d.ts +0 -1
- package/dist/serialization/resources/cursorDevelopment/index.js +0 -17
- package/dist/serialization/resources/dag/client/index.d.ts +0 -1
- package/dist/serialization/resources/dag/client/index.js +0 -17
- package/dist/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +0 -18
- package/dist/serialization/resources/dag/client/requests/SyncDagCreate.js +0 -49
- package/dist/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
- package/dist/serialization/resources/dag/client/requests/SyncDagUpdate.js +0 -49
- package/dist/serialization/resources/dag/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/dag/client/requests/index.js +0 -7
- package/dist/serialization/resources/dag/index.d.ts +0 -1
- package/dist/serialization/resources/dag/index.js +0 -17
- package/dist/serialization/resources/destinations/client/index.d.ts +0 -1
- package/dist/serialization/resources/destinations/client/index.js +0 -37
- package/dist/serialization/resources/destinations/client/listDestinations.d.ts +0 -11
- package/dist/serialization/resources/destinations/client/listDestinations.js +0 -42
- package/dist/serialization/resources/destinations/index.d.ts +0 -1
- package/dist/serialization/resources/destinations/index.js +0 -17
- package/dist/serialization/resources/embeddingModels/client/index.d.ts +0 -1
- package/dist/serialization/resources/embeddingModels/client/index.js +0 -37
- package/dist/serialization/resources/embeddingModels/client/readEmbeddingModels.d.ts +0 -11
- package/dist/serialization/resources/embeddingModels/client/readEmbeddingModels.js +0 -42
- package/dist/serialization/resources/embeddingModels/index.d.ts +0 -1
- package/dist/serialization/resources/embeddingModels/index.js +0 -17
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +0 -11
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
- package/dist/serialization/resources/entities/client/index.d.ts +0 -5
- package/dist/serialization/resources/entities/client/index.js +0 -44
- package/dist/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
- package/dist/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
- package/dist/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
- package/dist/serialization/resources/entities/client/listEntityRelations.js +0 -42
- package/dist/serialization/resources/entities/client/requests/EntityDefinitionCreate.d.ts +0 -20
- package/dist/serialization/resources/entities/client/requests/EntityDefinitionCreate.js +0 -51
- package/dist/serialization/resources/entities/client/requests/EntityDefinitionUpdate.d.ts +0 -20
- package/dist/serialization/resources/entities/client/requests/EntityDefinitionUpdate.js +0 -51
- package/dist/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -15
- package/dist/serialization/resources/entities/client/requests/EntityRelationCreate.js +0 -46
- package/dist/serialization/resources/entities/client/requests/EntityRelationUpdate.d.ts +0 -15
- package/dist/serialization/resources/entities/client/requests/EntityRelationUpdate.js +0 -46
- package/dist/serialization/resources/entities/client/requests/index.d.ts +0 -4
- package/dist/serialization/resources/entities/client/requests/index.js +0 -11
- package/dist/serialization/resources/entities/index.d.ts +0 -2
- package/dist/serialization/resources/entities/index.js +0 -18
- package/dist/serialization/resources/entities/types/EntityDefinitionCreateEntitySchema.d.ts +0 -10
- package/dist/serialization/resources/entities/types/EntityDefinitionCreateEntitySchema.js +0 -44
- package/dist/serialization/resources/entities/types/EntityDefinitionUpdateEntitySchema.d.ts +0 -10
- package/dist/serialization/resources/entities/types/EntityDefinitionUpdateEntitySchema.js +0 -44
- package/dist/serialization/resources/entities/types/index.d.ts +0 -2
- package/dist/serialization/resources/entities/types/index.js +0 -18
- package/dist/serialization/resources/health/client/healthCheck.d.ts +0 -9
- package/dist/serialization/resources/health/client/healthCheck.js +0 -41
- package/dist/serialization/resources/health/client/index.d.ts +0 -1
- package/dist/serialization/resources/health/client/index.js +0 -37
- package/dist/serialization/resources/health/index.d.ts +0 -1
- package/dist/serialization/resources/health/index.js +0 -17
- package/dist/serialization/resources/search/client/index.d.ts +0 -1
- package/dist/serialization/resources/search/client/index.js +0 -37
- package/dist/serialization/resources/search/client/search.d.ts +0 -9
- package/dist/serialization/resources/search/client/search.js +0 -41
- package/dist/serialization/resources/search/index.d.ts +0 -1
- package/dist/serialization/resources/search/index.js +0 -17
- package/dist/serialization/resources/sync/client/index.d.ts +0 -3
- package/dist/serialization/resources/sync/client/index.js +0 -42
- package/dist/serialization/resources/sync/client/listAllJobs.d.ts +0 -11
- package/dist/serialization/resources/sync/client/listAllJobs.js +0 -42
- package/dist/serialization/resources/sync/client/listSyncJobs.d.ts +0 -11
- package/dist/serialization/resources/sync/client/listSyncJobs.js +0 -42
- package/dist/serialization/resources/sync/client/requests/SyncCreate.d.ts +0 -24
- package/dist/serialization/resources/sync/client/requests/SyncCreate.js +0 -55
- package/dist/serialization/resources/sync/client/requests/SyncUpdate.d.ts +0 -19
- package/dist/serialization/resources/sync/client/requests/SyncUpdate.js +0 -50
- package/dist/serialization/resources/sync/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/sync/client/requests/index.js +0 -7
- package/dist/serialization/resources/sync/index.d.ts +0 -2
- package/dist/serialization/resources/sync/index.js +0 -18
- package/dist/serialization/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -12
- package/dist/serialization/resources/sync/types/ListSyncsSyncGetResponse.js +0 -46
- package/dist/serialization/resources/sync/types/index.d.ts +0 -1
- package/dist/serialization/resources/sync/types/index.js +0 -17
- package/dist/serialization/resources/transformers/client/index.d.ts +0 -2
- package/dist/serialization/resources/transformers/client/index.js +0 -41
- package/dist/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
- package/dist/serialization/resources/transformers/client/listTransformers.js +0 -42
- package/dist/serialization/resources/transformers/client/requests/TransformerCreate.d.ts +0 -18
- package/dist/serialization/resources/transformers/client/requests/TransformerCreate.js +0 -49
- package/dist/serialization/resources/transformers/client/requests/TransformerUpdate.d.ts +0 -18
- package/dist/serialization/resources/transformers/client/requests/TransformerUpdate.js +0 -49
- package/dist/serialization/resources/transformers/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/transformers/client/requests/index.js +0 -7
- package/dist/serialization/resources/transformers/index.d.ts +0 -1
- package/dist/serialization/resources/transformers/index.js +0 -17
- package/dist/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.d.ts +0 -9
- package/dist/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.js +0 -41
- package/dist/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.d.ts +0 -9
- package/dist/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.js +0 -41
- package/dist/serialization/types/ApiKeyWithPlainKey.d.ts +0 -21
- package/dist/serialization/types/ApiKeyWithPlainKey.js +0 -52
- package/dist/serialization/types/DestinationWithConfigFields.d.ts +0 -27
- package/dist/serialization/types/DestinationWithConfigFields.js +0 -58
- package/dist/serialization/types/EmbeddingModelWithConfigFields.d.ts +0 -25
- package/dist/serialization/types/EmbeddingModelWithConfigFields.js +0 -56
- package/dist/serialization/types/SourceWithConfigFields.d.ts +0 -27
- package/dist/serialization/types/SourceWithConfigFields.js +0 -58
- package/serialization/resources/apiKeys/client/index.d.ts +0 -2
- package/serialization/resources/apiKeys/client/index.js +0 -41
- package/serialization/resources/apiKeys/client/readApiKeys.d.ts +0 -11
- package/serialization/resources/apiKeys/client/readApiKeys.js +0 -42
- package/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +0 -12
- package/serialization/resources/apiKeys/client/requests/ApiKeyCreate.js +0 -43
- package/serialization/resources/apiKeys/client/requests/index.d.ts +0 -1
- package/serialization/resources/apiKeys/client/requests/index.js +0 -5
- package/serialization/resources/apiKeys/index.d.ts +0 -1
- package/serialization/resources/apiKeys/index.js +0 -17
- package/serialization/resources/chat/client/index.d.ts +0 -3
- package/serialization/resources/chat/client/index.js +0 -42
- package/serialization/resources/chat/client/listChats.d.ts +0 -11
- package/serialization/resources/chat/client/listChats.js +0 -42
- package/serialization/resources/chat/client/openaiKeySet.d.ts +0 -9
- package/serialization/resources/chat/client/openaiKeySet.js +0 -41
- package/serialization/resources/chat/client/requests/ChatCreate.d.ts +0 -17
- package/serialization/resources/chat/client/requests/ChatCreate.js +0 -48
- package/serialization/resources/chat/client/requests/ChatMessageCreate.d.ts +0 -13
- package/serialization/resources/chat/client/requests/ChatMessageCreate.js +0 -44
- package/serialization/resources/chat/client/requests/ChatUpdate.d.ts +0 -15
- package/serialization/resources/chat/client/requests/ChatUpdate.js +0 -46
- package/serialization/resources/chat/client/requests/index.d.ts +0 -3
- package/serialization/resources/chat/client/requests/index.js +0 -9
- package/serialization/resources/chat/index.d.ts +0 -1
- package/serialization/resources/chat/index.js +0 -17
- package/serialization/resources/connections/client/getConnectionCredentials.d.ts +0 -9
- package/serialization/resources/connections/client/getConnectionCredentials.js +0 -41
- package/serialization/resources/connections/client/getOauth2AuthUrl.d.ts +0 -9
- package/serialization/resources/connections/client/getOauth2AuthUrl.js +0 -41
- package/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.d.ts +0 -9
- package/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.js +0 -41
- package/serialization/resources/connections/client/listConnectedIntegrations.d.ts +0 -11
- package/serialization/resources/connections/client/listConnectedIntegrations.js +0 -42
- package/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -13
- package/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +0 -44
- package/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +0 -13
- package/serialization/resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +0 -44
- package/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -13
- package/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +0 -44
- package/serialization/resources/connections/client/requests/index.d.ts +0 -3
- package/serialization/resources/connections/client/requests/index.js +0 -9
- package/serialization/resources/connections/client/sendOauth2WhiteLabelCode.d.ts +0 -9
- package/serialization/resources/connections/client/sendOauth2WhiteLabelCode.js +0 -41
- package/serialization/resources/cursorDevelopment/client/checkConnectionStatus.d.ts +0 -11
- package/serialization/resources/cursorDevelopment/client/checkConnectionStatus.js +0 -42
- package/serialization/resources/cursorDevelopment/client/index.d.ts +0 -1
- package/serialization/resources/cursorDevelopment/client/index.js +0 -37
- package/serialization/resources/cursorDevelopment/index.d.ts +0 -1
- package/serialization/resources/cursorDevelopment/index.js +0 -17
- package/serialization/resources/dag/client/index.d.ts +0 -1
- package/serialization/resources/dag/client/index.js +0 -17
- package/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +0 -18
- package/serialization/resources/dag/client/requests/SyncDagCreate.js +0 -49
- package/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
- package/serialization/resources/dag/client/requests/SyncDagUpdate.js +0 -49
- package/serialization/resources/dag/client/requests/index.d.ts +0 -2
- package/serialization/resources/dag/client/requests/index.js +0 -7
- package/serialization/resources/dag/index.d.ts +0 -1
- package/serialization/resources/dag/index.js +0 -17
- package/serialization/resources/destinations/client/index.d.ts +0 -1
- package/serialization/resources/destinations/client/index.js +0 -37
- package/serialization/resources/destinations/client/listDestinations.d.ts +0 -11
- package/serialization/resources/destinations/client/listDestinations.js +0 -42
- package/serialization/resources/destinations/index.d.ts +0 -1
- package/serialization/resources/destinations/index.js +0 -17
- package/serialization/resources/embeddingModels/client/index.d.ts +0 -1
- package/serialization/resources/embeddingModels/client/index.js +0 -37
- package/serialization/resources/embeddingModels/client/readEmbeddingModels.d.ts +0 -11
- package/serialization/resources/embeddingModels/client/readEmbeddingModels.js +0 -42
- package/serialization/resources/embeddingModels/index.d.ts +0 -1
- package/serialization/resources/embeddingModels/index.js +0 -17
- package/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
- package/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +0 -11
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
- package/serialization/resources/entities/client/index.d.ts +0 -5
- package/serialization/resources/entities/client/index.js +0 -44
- package/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
- package/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
- package/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
- package/serialization/resources/entities/client/listEntityRelations.js +0 -42
- package/serialization/resources/entities/client/requests/EntityDefinitionCreate.d.ts +0 -20
- package/serialization/resources/entities/client/requests/EntityDefinitionCreate.js +0 -51
- package/serialization/resources/entities/client/requests/EntityDefinitionUpdate.d.ts +0 -20
- package/serialization/resources/entities/client/requests/EntityDefinitionUpdate.js +0 -51
- package/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -15
- package/serialization/resources/entities/client/requests/EntityRelationCreate.js +0 -46
- package/serialization/resources/entities/client/requests/EntityRelationUpdate.d.ts +0 -15
- package/serialization/resources/entities/client/requests/EntityRelationUpdate.js +0 -46
- package/serialization/resources/entities/client/requests/index.d.ts +0 -4
- package/serialization/resources/entities/client/requests/index.js +0 -11
- package/serialization/resources/entities/index.d.ts +0 -2
- package/serialization/resources/entities/index.js +0 -18
- package/serialization/resources/entities/types/EntityDefinitionCreateEntitySchema.d.ts +0 -10
- package/serialization/resources/entities/types/EntityDefinitionCreateEntitySchema.js +0 -44
- package/serialization/resources/entities/types/EntityDefinitionUpdateEntitySchema.d.ts +0 -10
- package/serialization/resources/entities/types/EntityDefinitionUpdateEntitySchema.js +0 -44
- package/serialization/resources/entities/types/index.d.ts +0 -2
- package/serialization/resources/entities/types/index.js +0 -18
- package/serialization/resources/health/client/healthCheck.d.ts +0 -9
- package/serialization/resources/health/client/healthCheck.js +0 -41
- package/serialization/resources/health/client/index.d.ts +0 -1
- package/serialization/resources/health/client/index.js +0 -37
- package/serialization/resources/health/index.d.ts +0 -1
- package/serialization/resources/health/index.js +0 -17
- package/serialization/resources/search/client/index.d.ts +0 -1
- package/serialization/resources/search/client/index.js +0 -37
- package/serialization/resources/search/client/search.d.ts +0 -9
- package/serialization/resources/search/client/search.js +0 -41
- package/serialization/resources/search/index.d.ts +0 -1
- package/serialization/resources/search/index.js +0 -17
- package/serialization/resources/sync/client/index.d.ts +0 -3
- package/serialization/resources/sync/client/index.js +0 -42
- package/serialization/resources/sync/client/listAllJobs.d.ts +0 -11
- package/serialization/resources/sync/client/listAllJobs.js +0 -42
- package/serialization/resources/sync/client/listSyncJobs.d.ts +0 -11
- package/serialization/resources/sync/client/listSyncJobs.js +0 -42
- package/serialization/resources/sync/client/requests/SyncCreate.d.ts +0 -24
- package/serialization/resources/sync/client/requests/SyncCreate.js +0 -55
- package/serialization/resources/sync/client/requests/SyncUpdate.d.ts +0 -19
- package/serialization/resources/sync/client/requests/SyncUpdate.js +0 -50
- package/serialization/resources/sync/client/requests/index.d.ts +0 -2
- package/serialization/resources/sync/client/requests/index.js +0 -7
- package/serialization/resources/sync/index.d.ts +0 -2
- package/serialization/resources/sync/index.js +0 -18
- package/serialization/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -12
- package/serialization/resources/sync/types/ListSyncsSyncGetResponse.js +0 -46
- package/serialization/resources/sync/types/index.d.ts +0 -1
- package/serialization/resources/sync/types/index.js +0 -17
- package/serialization/resources/transformers/client/index.d.ts +0 -2
- package/serialization/resources/transformers/client/index.js +0 -41
- package/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
- package/serialization/resources/transformers/client/listTransformers.js +0 -42
- package/serialization/resources/transformers/client/requests/TransformerCreate.d.ts +0 -18
- package/serialization/resources/transformers/client/requests/TransformerCreate.js +0 -49
- package/serialization/resources/transformers/client/requests/TransformerUpdate.d.ts +0 -18
- package/serialization/resources/transformers/client/requests/TransformerUpdate.js +0 -49
- package/serialization/resources/transformers/client/requests/index.d.ts +0 -2
- package/serialization/resources/transformers/client/requests/index.js +0 -7
- package/serialization/resources/transformers/index.d.ts +0 -1
- package/serialization/resources/transformers/index.js +0 -17
- package/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.d.ts +0 -9
- package/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.js +0 -41
- package/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.d.ts +0 -9
- package/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.js +0 -41
- package/serialization/types/ApiKeyWithPlainKey.d.ts +0 -21
- package/serialization/types/ApiKeyWithPlainKey.js +0 -52
- package/serialization/types/DestinationWithConfigFields.d.ts +0 -27
- package/serialization/types/DestinationWithConfigFields.js +0 -58
- package/serialization/types/EmbeddingModelWithConfigFields.d.ts +0 -25
- package/serialization/types/EmbeddingModelWithConfigFields.js +0 -56
- package/serialization/types/SourceWithConfigFields.d.ts +0 -27
- package/serialization/types/SourceWithConfigFields.js +0 -58
- /package/api/resources/{apiKeys → collections}/client/index.d.ts +0 -0
- /package/api/resources/{apiKeys → collections}/client/index.js +0 -0
- /package/api/resources/{apiKeys/client/requests/ApiKeyCreate.js → collections/client/requests/CollectionCreate.js} +0 -0
- /package/api/resources/{apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js → collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.js} +0 -0
- /package/api/resources/{apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js → collections/client/requests/ListCollectionsCollectionsGetRequest.js} +0 -0
- /package/api/resources/{apiKeys → collections}/client/requests/index.js +0 -0
- /package/api/resources/{apiKeys → collections}/index.d.ts +0 -0
- /package/api/resources/{apiKeys → collections}/index.js +0 -0
- /package/api/resources/{chat → sourceConnections}/client/index.d.ts +0 -0
- /package/api/resources/{chat → sourceConnections}/client/index.js +0 -0
- /package/api/resources/{chat/client/requests/ChatCreate.js → sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.js} +0 -0
- /package/api/resources/{chat/client/requests/ChatMessageCreate.js → sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
- /package/api/resources/{chat/client/requests/ChatUpdate.js → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.js} +0 -0
- /package/api/resources/{chat/client/requests/ListChatsChatGetRequest.js → sourceConnections/client/requests/SourceConnectionUpdate.js} +0 -0
- /package/api/resources/{chat → sourceConnections}/client/requests/index.js +0 -0
- /package/api/resources/{chat → sourceConnections}/index.d.ts +0 -0
- /package/api/resources/{chat → sourceConnections}/index.js +0 -0
- /package/{dist/api/resources/apiKeys/client/requests → api/types}/ApiKeyCreate.js +0 -0
- /package/api/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +0 -0
- /package/api/{resources/connections/client/requests → types}/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +0 -0
- /package/api/{resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js → types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js} +0 -0
- /package/{dist/api/resources/connections/client/requests → api/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +0 -0
- /package/{dist/api/resources/chat/client/requests → api/types}/ChatCreate.js +0 -0
- /package/{dist/api/resources/chat/client/requests → api/types}/ChatMessageCreate.js +0 -0
- /package/{dist/api/resources/chat/client/requests → api/types}/ChatUpdate.js +0 -0
- /package/api/{resources/connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.js → types/Collection.js} +0 -0
- /package/api/{resources/dag/client/requests/InitializeDagDagInitGetRequest.js → types/CollectionUpdate.js} +0 -0
- /package/api/{resources/dag/client/requests/SyncDagCreate.js → types/ConfigValues.js} +0 -0
- /package/api/{resources/dag/client/requests/SyncDagUpdate.js → types/DestinationWithAuthenticationFields.js} +0 -0
- /package/api/{resources/entities/client/requests/EntityDefinitionCreate.js → types/EmbeddingModelWithAuthenticationFields.js} +0 -0
- /package/api/{resources/entities/client/requests/EntityDefinitionUpdate.js → types/EntityCount.js} +0 -0
- /package/{dist/api/resources/entities/client/requests → api/types}/EntityDefinitionCreate.js +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +0 -0
- /package/{dist/api/resources/entities/client/requests → api/types}/EntityDefinitionUpdate.js +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.d.ts +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.js +0 -0
- /package/api/{resources/entities/client/requests → types}/EntityRelationCreate.js +0 -0
- /package/api/{resources/entities/client/requests → types}/EntityRelationUpdate.js +0 -0
- /package/api/{resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → types/Organization.js} +0 -0
- /package/api/{resources/search/client/requests/SearchSearchGetRequest.js → types/SearchResponse.js} +0 -0
- /package/api/{resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.js → types/SourceConnection.js} +0 -0
- /package/api/{resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js → types/SourceConnectionAuthFields.js} +0 -0
- /package/api/{resources/sync/client/requests/ListSyncsSyncGetRequest.js → types/SourceConnectionCreate.js} +0 -0
- /package/api/{resources/sync/client/requests/SyncCreate.js → types/SourceConnectionJob.js} +0 -0
- /package/api/{resources/sync/client/requests/SyncUpdate.js → types/SourceConnectionListItem.js} +0 -0
- /package/api/{resources/sync/types/ListSyncsSyncGetResponse.js → types/SourceWithAuthenticationFields.js} +0 -0
- /package/{dist/api/resources/sync/client/requests → api/types}/SyncCreate.js +0 -0
- /package/{dist/api/resources/dag/client/requests → api/types}/SyncDagCreate.js +0 -0
- /package/{dist/api/resources/dag/client/requests → api/types}/SyncDagUpdate.js +0 -0
- /package/{dist/api/resources/sync/client/requests → api/types}/SyncUpdate.js +0 -0
- /package/api/{resources/transformers/client/requests → types}/TransformerCreate.js +0 -0
- /package/api/{resources/transformers/client/requests → types}/TransformerUpdate.js +0 -0
- /package/api/types/{ApiKeyWithPlainKey.js → UserCreate.js} +0 -0
- /package/{api/resources/dag → dist/api/resources/collections}/client/index.d.ts +0 -0
- /package/{api/resources/dag → dist/api/resources/collections}/client/index.js +0 -0
- /package/{api/types/DestinationWithConfigFields.js → dist/api/resources/collections/client/requests/CollectionCreate.js} +0 -0
- /package/{api/types/EmbeddingModelWithConfigFields.js → dist/api/resources/collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.js} +0 -0
- /package/{api/types/SourceWithConfigFields.js → dist/api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.js} +0 -0
- /package/{api/resources/connections → dist/api/resources/collections}/client/requests/index.js +0 -0
- /package/{api/resources/cursorDevelopment → dist/api/resources/collections}/index.d.ts +0 -0
- /package/{api/resources/cursorDevelopment → dist/api/resources/collections}/index.js +0 -0
- /package/{api/resources/entities → dist/api/resources/sourceConnections}/client/index.d.ts +0 -0
- /package/{api/resources/entities → dist/api/resources/sourceConnections}/client/index.js +0 -0
- /package/dist/api/resources/{apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js → sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.js} +0 -0
- /package/dist/api/resources/{apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js → sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
- /package/dist/api/resources/{chat/client/requests/ListChatsChatGetRequest.js → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.js} +0 -0
- /package/dist/api/resources/{connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js → sourceConnections/client/requests/SourceConnectionUpdate.js} +0 -0
- /package/{api/resources/cursorDevelopment/client → dist/api/resources/sourceConnections/client/requests}/index.js +0 -0
- /package/{api/resources/dag → dist/api/resources/sourceConnections}/index.d.ts +0 -0
- /package/{api/resources/dag → dist/api/resources/sourceConnections}/index.js +0 -0
- /package/dist/api/{resources/connections/client/requests/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js → types/ApiKeyCreate.js} +0 -0
- /package/dist/api/{resources/connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.js → types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js} +0 -0
- /package/dist/api/{resources/dag/client/requests/InitializeDagDagInitGetRequest.js → types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js} +0 -0
- /package/dist/api/{resources/entities/client/requests/EntityRelationCreate.js → types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js} +0 -0
- /package/dist/api/{resources/entities/client/requests/EntityRelationUpdate.js → types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js} +0 -0
- /package/dist/api/{resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → types/ChatCreate.js} +0 -0
- /package/dist/api/{resources/entities/types/EntityDefinitionCreateEntitySchema.js → types/ChatMessageCreate.js} +0 -0
- /package/dist/api/{resources/entities/types/EntityDefinitionUpdateEntitySchema.js → types/ChatUpdate.js} +0 -0
- /package/dist/api/{resources/search/client/requests/SearchSearchGetRequest.js → types/Collection.js} +0 -0
- /package/dist/api/{resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.js → types/CollectionUpdate.js} +0 -0
- /package/dist/api/{resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js → types/ConfigValues.js} +0 -0
- /package/dist/api/{resources/sync/client/requests/ListSyncsSyncGetRequest.js → types/DestinationWithAuthenticationFields.js} +0 -0
- /package/dist/api/{resources/sync/types/ListSyncsSyncGetResponse.js → types/EmbeddingModelWithAuthenticationFields.js} +0 -0
- /package/dist/api/{resources/transformers/client/requests/TransformerCreate.js → types/EntityCount.js} +0 -0
- /package/dist/api/{resources/transformers/client/requests/TransformerUpdate.js → types/EntityDefinitionCreate.js} +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/dist/api/types/{ApiKeyWithPlainKey.js → EntityDefinitionCreateEntitySchema.js} +0 -0
- /package/dist/api/types/{DestinationWithConfigFields.js → EntityDefinitionUpdate.js} +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.d.ts +0 -0
- /package/dist/api/types/{EmbeddingModelWithConfigFields.js → EntityDefinitionUpdateEntitySchema.js} +0 -0
- /package/dist/api/types/{SourceWithConfigFields.js → EntityRelationCreate.js} +0 -0
- /package/{api/resources/destinations → dist/serialization/resources/collections}/index.d.ts +0 -0
- /package/{api/resources/destinations → dist/serialization/resources/collections}/index.js +0 -0
- /package/{api/resources/embeddingModels → dist/serialization/resources/sourceConnections}/index.d.ts +0 -0
- /package/{api/resources/embeddingModels → dist/serialization/resources/sourceConnections}/index.js +0 -0
- /package/{api/resources/health → serialization/resources/collections}/index.d.ts +0 -0
- /package/{api/resources/health → serialization/resources/collections}/index.js +0 -0
- /package/{api/resources/search → serialization/resources/sourceConnections}/index.d.ts +0 -0
- /package/{api/resources/search → serialization/resources/sourceConnections}/index.js +0 -0
package/reference.md
CHANGED
|
@@ -1,69 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
<details><summary><code>client.health.<a href="/src/api/resources/health/client/Client.ts">healthCheck</a>() -> Record<string, string></code></summary>
|
|
6
|
-
<dl>
|
|
7
|
-
<dd>
|
|
8
|
-
|
|
9
|
-
#### 📝 Description
|
|
10
|
-
|
|
11
|
-
<dl>
|
|
12
|
-
<dd>
|
|
13
|
-
|
|
14
|
-
<dl>
|
|
15
|
-
<dd>
|
|
16
|
-
|
|
17
|
-
Check if the API is healthy.
|
|
18
|
-
|
|
19
|
-
## Returns:
|
|
20
|
-
|
|
21
|
-
dict: A dictionary containing the status of the API.
|
|
22
|
-
|
|
23
|
-
</dd>
|
|
24
|
-
</dl>
|
|
25
|
-
</dd>
|
|
26
|
-
</dl>
|
|
27
|
-
|
|
28
|
-
#### 🔌 Usage
|
|
29
|
-
|
|
30
|
-
<dl>
|
|
31
|
-
<dd>
|
|
32
|
-
|
|
33
|
-
<dl>
|
|
34
|
-
<dd>
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
await client.health.healthCheck();
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
</dd>
|
|
41
|
-
</dl>
|
|
42
|
-
</dd>
|
|
43
|
-
</dl>
|
|
44
|
-
|
|
45
|
-
#### ⚙️ Parameters
|
|
46
|
-
|
|
47
|
-
<dl>
|
|
48
|
-
<dd>
|
|
49
|
-
|
|
50
|
-
<dl>
|
|
51
|
-
<dd>
|
|
52
|
-
|
|
53
|
-
**requestOptions:** `Health.RequestOptions`
|
|
54
|
-
|
|
55
|
-
</dd>
|
|
56
|
-
</dl>
|
|
57
|
-
</dd>
|
|
58
|
-
</dl>
|
|
59
|
-
|
|
60
|
-
</dd>
|
|
61
|
-
</dl>
|
|
62
|
-
</details>
|
|
63
|
-
|
|
64
|
-
## ApiKeys
|
|
3
|
+
## Sources
|
|
65
4
|
|
|
66
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithAuthenticationFields</code></summary>
|
|
67
6
|
<dl>
|
|
68
7
|
<dd>
|
|
69
8
|
|
|
@@ -75,18 +14,17 @@ await client.health.healthCheck();
|
|
|
75
14
|
<dl>
|
|
76
15
|
<dd>
|
|
77
16
|
|
|
78
|
-
|
|
17
|
+
Get source by id.
|
|
79
18
|
|
|
80
19
|
## Args:
|
|
81
20
|
|
|
82
21
|
db (AsyncSession): The database session.
|
|
83
|
-
|
|
84
|
-
limit (int): Maximum number of records to return.
|
|
22
|
+
short_name (str): The short name of the source.
|
|
85
23
|
user (schemas.User): The current user.
|
|
86
24
|
|
|
87
25
|
## Returns:
|
|
88
26
|
|
|
89
|
-
|
|
27
|
+
schemas.Source: The source object.
|
|
90
28
|
|
|
91
29
|
</dd>
|
|
92
30
|
</dl>
|
|
@@ -102,7 +40,7 @@ Retrieve all API keys for the current user.
|
|
|
102
40
|
<dd>
|
|
103
41
|
|
|
104
42
|
```typescript
|
|
105
|
-
await client.
|
|
43
|
+
await client.sources.readSource("short_name");
|
|
106
44
|
```
|
|
107
45
|
|
|
108
46
|
</dd>
|
|
@@ -118,7 +56,7 @@ await client.apiKeys.readApiKeys();
|
|
|
118
56
|
<dl>
|
|
119
57
|
<dd>
|
|
120
58
|
|
|
121
|
-
**
|
|
59
|
+
**shortName:** `string`
|
|
122
60
|
|
|
123
61
|
</dd>
|
|
124
62
|
</dl>
|
|
@@ -126,7 +64,7 @@ await client.apiKeys.readApiKeys();
|
|
|
126
64
|
<dl>
|
|
127
65
|
<dd>
|
|
128
66
|
|
|
129
|
-
**requestOptions:** `
|
|
67
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
130
68
|
|
|
131
69
|
</dd>
|
|
132
70
|
</dl>
|
|
@@ -137,7 +75,7 @@ await client.apiKeys.readApiKeys();
|
|
|
137
75
|
</dl>
|
|
138
76
|
</details>
|
|
139
77
|
|
|
140
|
-
<details><summary><code>client.
|
|
78
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
|
|
141
79
|
<dl>
|
|
142
80
|
<dd>
|
|
143
81
|
|
|
@@ -149,20 +87,16 @@ await client.apiKeys.readApiKeys();
|
|
|
149
87
|
<dl>
|
|
150
88
|
<dd>
|
|
151
89
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
Returns a temporary plain key for the user to store securely.
|
|
155
|
-
This is not stored in the database.
|
|
90
|
+
Get all sources for the current user.
|
|
156
91
|
|
|
157
92
|
## Args:
|
|
158
93
|
|
|
159
|
-
db
|
|
160
|
-
|
|
161
|
-
user (schemas.User): The current user.
|
|
94
|
+
db: The database session
|
|
95
|
+
user: The current user
|
|
162
96
|
|
|
163
97
|
## Returns:
|
|
164
98
|
|
|
165
|
-
schemas.
|
|
99
|
+
list[schemas.Source]: The list of sources.
|
|
166
100
|
|
|
167
101
|
</dd>
|
|
168
102
|
</dl>
|
|
@@ -178,7 +112,7 @@ This is not stored in the database.
|
|
|
178
112
|
<dd>
|
|
179
113
|
|
|
180
114
|
```typescript
|
|
181
|
-
await client.
|
|
115
|
+
await client.sources.readSources();
|
|
182
116
|
```
|
|
183
117
|
|
|
184
118
|
</dd>
|
|
@@ -194,15 +128,7 @@ await client.apiKeys.createApiKey();
|
|
|
194
128
|
<dl>
|
|
195
129
|
<dd>
|
|
196
130
|
|
|
197
|
-
**
|
|
198
|
-
|
|
199
|
-
</dd>
|
|
200
|
-
</dl>
|
|
201
|
-
|
|
202
|
-
<dl>
|
|
203
|
-
<dd>
|
|
204
|
-
|
|
205
|
-
**requestOptions:** `ApiKeys.RequestOptions`
|
|
131
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
206
132
|
|
|
207
133
|
</dd>
|
|
208
134
|
</dl>
|
|
@@ -213,86 +139,9 @@ await client.apiKeys.createApiKey();
|
|
|
213
139
|
</dl>
|
|
214
140
|
</details>
|
|
215
141
|
|
|
216
|
-
|
|
217
|
-
<dl>
|
|
218
|
-
<dd>
|
|
219
|
-
|
|
220
|
-
#### 📝 Description
|
|
221
|
-
|
|
222
|
-
<dl>
|
|
223
|
-
<dd>
|
|
224
|
-
|
|
225
|
-
<dl>
|
|
226
|
-
<dd>
|
|
227
|
-
|
|
228
|
-
Delete an API key.
|
|
229
|
-
|
|
230
|
-
## Args:
|
|
231
|
-
|
|
232
|
-
db (AsyncSession): The database session.
|
|
233
|
-
id (UUID): The ID of the API key.
|
|
234
|
-
user (schemas.User): The current user.
|
|
235
|
-
|
|
236
|
-
## Returns:
|
|
237
|
-
|
|
238
|
-
schemas.APIKey: The revoked API key object.
|
|
239
|
-
|
|
240
|
-
## Raises:
|
|
241
|
-
|
|
242
|
-
HTTPException: If the API key is not found.
|
|
243
|
-
|
|
244
|
-
</dd>
|
|
245
|
-
</dl>
|
|
246
|
-
</dd>
|
|
247
|
-
</dl>
|
|
248
|
-
|
|
249
|
-
#### 🔌 Usage
|
|
250
|
-
|
|
251
|
-
<dl>
|
|
252
|
-
<dd>
|
|
253
|
-
|
|
254
|
-
<dl>
|
|
255
|
-
<dd>
|
|
256
|
-
|
|
257
|
-
```typescript
|
|
258
|
-
await client.apiKeys.deleteApiKey({
|
|
259
|
-
id: "id",
|
|
260
|
-
});
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
</dd>
|
|
264
|
-
</dl>
|
|
265
|
-
</dd>
|
|
266
|
-
</dl>
|
|
267
|
-
|
|
268
|
-
#### ⚙️ Parameters
|
|
269
|
-
|
|
270
|
-
<dl>
|
|
271
|
-
<dd>
|
|
272
|
-
|
|
273
|
-
<dl>
|
|
274
|
-
<dd>
|
|
275
|
-
|
|
276
|
-
**request:** `AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest`
|
|
277
|
-
|
|
278
|
-
</dd>
|
|
279
|
-
</dl>
|
|
280
|
-
|
|
281
|
-
<dl>
|
|
282
|
-
<dd>
|
|
283
|
-
|
|
284
|
-
**requestOptions:** `ApiKeys.RequestOptions`
|
|
285
|
-
|
|
286
|
-
</dd>
|
|
287
|
-
</dl>
|
|
288
|
-
</dd>
|
|
289
|
-
</dl>
|
|
290
|
-
|
|
291
|
-
</dd>
|
|
292
|
-
</dl>
|
|
293
|
-
</details>
|
|
142
|
+
## Collections
|
|
294
143
|
|
|
295
|
-
<details><summary><code>client.
|
|
144
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">listCollections</a>({ ...params }) -> AirweaveSDK.Collection[]</code></summary>
|
|
296
145
|
<dl>
|
|
297
146
|
<dd>
|
|
298
147
|
|
|
@@ -304,21 +153,7 @@ await client.apiKeys.deleteApiKey({
|
|
|
304
153
|
<dl>
|
|
305
154
|
<dd>
|
|
306
155
|
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
## Args:
|
|
310
|
-
|
|
311
|
-
db (AsyncSession): The database session.
|
|
312
|
-
id (UUID): The ID of the API key.
|
|
313
|
-
user (schemas.User): The current user.
|
|
314
|
-
|
|
315
|
-
## Returns:
|
|
316
|
-
|
|
317
|
-
schemas.APIKey: The API key object.
|
|
318
|
-
|
|
319
|
-
## Raises:
|
|
320
|
-
|
|
321
|
-
HTTPException: If the API key is not found.
|
|
156
|
+
List all collections for the current user's organization.
|
|
322
157
|
|
|
323
158
|
</dd>
|
|
324
159
|
</dl>
|
|
@@ -334,7 +169,7 @@ Retrieve an API key by ID.
|
|
|
334
169
|
<dd>
|
|
335
170
|
|
|
336
171
|
```typescript
|
|
337
|
-
await client.
|
|
172
|
+
await client.collections.listCollections();
|
|
338
173
|
```
|
|
339
174
|
|
|
340
175
|
</dd>
|
|
@@ -350,80 +185,15 @@ await client.apiKeys.readApiKey("id");
|
|
|
350
185
|
<dl>
|
|
351
186
|
<dd>
|
|
352
187
|
|
|
353
|
-
**
|
|
354
|
-
|
|
355
|
-
</dd>
|
|
356
|
-
</dl>
|
|
357
|
-
|
|
358
|
-
<dl>
|
|
359
|
-
<dd>
|
|
360
|
-
|
|
361
|
-
**requestOptions:** `ApiKeys.RequestOptions`
|
|
362
|
-
|
|
363
|
-
</dd>
|
|
364
|
-
</dl>
|
|
365
|
-
</dd>
|
|
366
|
-
</dl>
|
|
367
|
-
|
|
368
|
-
</dd>
|
|
369
|
-
</dl>
|
|
370
|
-
</details>
|
|
371
|
-
|
|
372
|
-
## Users
|
|
373
|
-
|
|
374
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">readUser</a>() -> AirweaveSDK.User</code></summary>
|
|
375
|
-
<dl>
|
|
376
|
-
<dd>
|
|
377
|
-
|
|
378
|
-
#### 📝 Description
|
|
379
|
-
|
|
380
|
-
<dl>
|
|
381
|
-
<dd>
|
|
382
|
-
|
|
383
|
-
<dl>
|
|
384
|
-
<dd>
|
|
385
|
-
|
|
386
|
-
Get current user.
|
|
387
|
-
|
|
388
|
-
## Args:
|
|
389
|
-
|
|
390
|
-
current_user (User): The current user.
|
|
391
|
-
|
|
392
|
-
## Returns:
|
|
393
|
-
|
|
394
|
-
schemas.User: The user object.
|
|
395
|
-
|
|
396
|
-
</dd>
|
|
397
|
-
</dl>
|
|
398
|
-
</dd>
|
|
399
|
-
</dl>
|
|
400
|
-
|
|
401
|
-
#### 🔌 Usage
|
|
402
|
-
|
|
403
|
-
<dl>
|
|
404
|
-
<dd>
|
|
405
|
-
|
|
406
|
-
<dl>
|
|
407
|
-
<dd>
|
|
408
|
-
|
|
409
|
-
```typescript
|
|
410
|
-
await client.users.readUser();
|
|
411
|
-
```
|
|
188
|
+
**request:** `AirweaveSDK.ListCollectionsCollectionsGetRequest`
|
|
412
189
|
|
|
413
190
|
</dd>
|
|
414
191
|
</dl>
|
|
415
|
-
</dd>
|
|
416
|
-
</dl>
|
|
417
|
-
|
|
418
|
-
#### ⚙️ Parameters
|
|
419
192
|
|
|
420
193
|
<dl>
|
|
421
194
|
<dd>
|
|
422
195
|
|
|
423
|
-
|
|
424
|
-
<dd>
|
|
425
|
-
|
|
426
|
-
**requestOptions:** `Users.RequestOptions`
|
|
196
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
427
197
|
|
|
428
198
|
</dd>
|
|
429
199
|
</dl>
|
|
@@ -434,9 +204,7 @@ await client.users.readUser();
|
|
|
434
204
|
</dl>
|
|
435
205
|
</details>
|
|
436
206
|
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithConfigFields</code></summary>
|
|
207
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">createCollection</a>({ ...params }) -> AirweaveSDK.Collection</code></summary>
|
|
440
208
|
<dl>
|
|
441
209
|
<dd>
|
|
442
210
|
|
|
@@ -448,17 +216,7 @@ await client.users.readUser();
|
|
|
448
216
|
<dl>
|
|
449
217
|
<dd>
|
|
450
218
|
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
## Args:
|
|
454
|
-
|
|
455
|
-
db (AsyncSession): The database session.
|
|
456
|
-
short_name (str): The short name of the source.
|
|
457
|
-
user (schemas.User): The current user.
|
|
458
|
-
|
|
459
|
-
## Returns:
|
|
460
|
-
|
|
461
|
-
schemas.Source: The source object.
|
|
219
|
+
Create a new collection.
|
|
462
220
|
|
|
463
221
|
</dd>
|
|
464
222
|
</dl>
|
|
@@ -474,7 +232,9 @@ Get source by id.
|
|
|
474
232
|
<dd>
|
|
475
233
|
|
|
476
234
|
```typescript
|
|
477
|
-
await client.
|
|
235
|
+
await client.collections.createCollection({
|
|
236
|
+
name: "name",
|
|
237
|
+
});
|
|
478
238
|
```
|
|
479
239
|
|
|
480
240
|
</dd>
|
|
@@ -490,7 +250,7 @@ await client.sources.readSource("short_name");
|
|
|
490
250
|
<dl>
|
|
491
251
|
<dd>
|
|
492
252
|
|
|
493
|
-
**
|
|
253
|
+
**request:** `AirweaveSDK.CollectionCreate`
|
|
494
254
|
|
|
495
255
|
</dd>
|
|
496
256
|
</dl>
|
|
@@ -498,7 +258,7 @@ await client.sources.readSource("short_name");
|
|
|
498
258
|
<dl>
|
|
499
259
|
<dd>
|
|
500
260
|
|
|
501
|
-
**requestOptions:** `
|
|
261
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
502
262
|
|
|
503
263
|
</dd>
|
|
504
264
|
</dl>
|
|
@@ -509,3327 +269,19 @@ await client.sources.readSource("short_name");
|
|
|
509
269
|
</dl>
|
|
510
270
|
</details>
|
|
511
271
|
|
|
512
|
-
<details><summary><code>client.
|
|
272
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">getCollection</a>(readableId) -> AirweaveSDK.Collection</code></summary>
|
|
513
273
|
<dl>
|
|
514
274
|
<dd>
|
|
515
275
|
|
|
516
276
|
#### 📝 Description
|
|
517
277
|
|
|
518
|
-
<dl>
|
|
519
|
-
<dd>
|
|
520
|
-
|
|
521
|
-
<dl>
|
|
522
|
-
<dd>
|
|
523
|
-
|
|
524
|
-
Get all sources for the current user.
|
|
525
|
-
|
|
526
|
-
## Args:
|
|
527
|
-
|
|
528
|
-
db: The database session
|
|
529
|
-
user: The current user
|
|
530
|
-
|
|
531
|
-
## Returns:
|
|
532
|
-
|
|
533
|
-
list[schemas.Source]: The list of sources.
|
|
534
|
-
|
|
535
|
-
</dd>
|
|
536
|
-
</dl>
|
|
537
|
-
</dd>
|
|
538
|
-
</dl>
|
|
539
|
-
|
|
540
|
-
#### 🔌 Usage
|
|
541
|
-
|
|
542
|
-
<dl>
|
|
543
|
-
<dd>
|
|
544
|
-
|
|
545
|
-
<dl>
|
|
546
|
-
<dd>
|
|
547
|
-
|
|
548
|
-
```typescript
|
|
549
|
-
await client.sources.readSources();
|
|
550
|
-
```
|
|
551
|
-
|
|
552
|
-
</dd>
|
|
553
|
-
</dl>
|
|
554
|
-
</dd>
|
|
555
|
-
</dl>
|
|
556
|
-
|
|
557
|
-
#### ⚙️ Parameters
|
|
558
|
-
|
|
559
|
-
<dl>
|
|
560
|
-
<dd>
|
|
561
|
-
|
|
562
|
-
<dl>
|
|
563
|
-
<dd>
|
|
564
|
-
|
|
565
|
-
**requestOptions:** `Sources.RequestOptions`
|
|
566
|
-
|
|
567
|
-
</dd>
|
|
568
|
-
</dl>
|
|
569
|
-
</dd>
|
|
570
|
-
</dl>
|
|
571
|
-
|
|
572
|
-
</dd>
|
|
573
|
-
</dl>
|
|
574
|
-
</details>
|
|
575
|
-
|
|
576
|
-
## Destinations
|
|
577
|
-
|
|
578
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>() -> AirweaveSDK.Destination[]</code></summary>
|
|
579
|
-
<dl>
|
|
580
|
-
<dd>
|
|
581
|
-
|
|
582
|
-
#### 📝 Description
|
|
583
|
-
|
|
584
|
-
<dl>
|
|
585
|
-
<dd>
|
|
586
|
-
|
|
587
|
-
<dl>
|
|
588
|
-
<dd>
|
|
589
|
-
|
|
590
|
-
Get all available destinations.
|
|
591
|
-
|
|
592
|
-
## Args:
|
|
593
|
-
|
|
594
|
-
db: The database session
|
|
595
|
-
user: The current user
|
|
596
|
-
|
|
597
|
-
## Returns:
|
|
598
|
-
|
|
599
|
-
List[schemas.Destination]: A list of destinations
|
|
600
|
-
|
|
601
|
-
</dd>
|
|
602
|
-
</dl>
|
|
603
|
-
</dd>
|
|
604
|
-
</dl>
|
|
605
|
-
|
|
606
|
-
#### 🔌 Usage
|
|
607
|
-
|
|
608
|
-
<dl>
|
|
609
|
-
<dd>
|
|
610
|
-
|
|
611
|
-
<dl>
|
|
612
|
-
<dd>
|
|
613
|
-
|
|
614
|
-
```typescript
|
|
615
|
-
await client.destinations.listDestinations();
|
|
616
|
-
```
|
|
617
|
-
|
|
618
|
-
</dd>
|
|
619
|
-
</dl>
|
|
620
|
-
</dd>
|
|
621
|
-
</dl>
|
|
622
|
-
|
|
623
|
-
#### ⚙️ Parameters
|
|
624
|
-
|
|
625
|
-
<dl>
|
|
626
|
-
<dd>
|
|
627
|
-
|
|
628
|
-
<dl>
|
|
629
|
-
<dd>
|
|
630
|
-
|
|
631
|
-
**requestOptions:** `Destinations.RequestOptions`
|
|
632
|
-
|
|
633
|
-
</dd>
|
|
634
|
-
</dl>
|
|
635
|
-
</dd>
|
|
636
|
-
</dl>
|
|
637
|
-
|
|
638
|
-
</dd>
|
|
639
|
-
</dl>
|
|
640
|
-
</details>
|
|
641
|
-
|
|
642
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">readDestination</a>(shortName) -> AirweaveSDK.DestinationWithConfigFields</code></summary>
|
|
643
|
-
<dl>
|
|
644
|
-
<dd>
|
|
645
|
-
|
|
646
|
-
#### 📝 Description
|
|
647
|
-
|
|
648
|
-
<dl>
|
|
649
|
-
<dd>
|
|
650
|
-
|
|
651
|
-
<dl>
|
|
652
|
-
<dd>
|
|
653
|
-
|
|
654
|
-
Get destination by short name.
|
|
655
|
-
|
|
656
|
-
## Args:
|
|
657
|
-
|
|
658
|
-
db: The database session
|
|
659
|
-
short_name: The short name of the destination
|
|
660
|
-
user: The current user
|
|
661
|
-
|
|
662
|
-
## Returns:
|
|
663
|
-
|
|
664
|
-
destination (schemas.Destination): The destination
|
|
665
|
-
|
|
666
|
-
</dd>
|
|
667
|
-
</dl>
|
|
668
|
-
</dd>
|
|
669
|
-
</dl>
|
|
670
|
-
|
|
671
|
-
#### 🔌 Usage
|
|
672
|
-
|
|
673
|
-
<dl>
|
|
674
|
-
<dd>
|
|
675
|
-
|
|
676
|
-
<dl>
|
|
677
|
-
<dd>
|
|
678
|
-
|
|
679
|
-
```typescript
|
|
680
|
-
await client.destinations.readDestination("short_name");
|
|
681
|
-
```
|
|
682
|
-
|
|
683
|
-
</dd>
|
|
684
|
-
</dl>
|
|
685
|
-
</dd>
|
|
686
|
-
</dl>
|
|
687
|
-
|
|
688
|
-
#### ⚙️ Parameters
|
|
689
|
-
|
|
690
|
-
<dl>
|
|
691
|
-
<dd>
|
|
692
|
-
|
|
693
|
-
<dl>
|
|
694
|
-
<dd>
|
|
695
|
-
|
|
696
|
-
**shortName:** `string`
|
|
697
|
-
|
|
698
|
-
</dd>
|
|
699
|
-
</dl>
|
|
700
|
-
|
|
701
|
-
<dl>
|
|
702
|
-
<dd>
|
|
703
|
-
|
|
704
|
-
**requestOptions:** `Destinations.RequestOptions`
|
|
705
|
-
|
|
706
|
-
</dd>
|
|
707
|
-
</dl>
|
|
708
|
-
</dd>
|
|
709
|
-
</dl>
|
|
710
|
-
|
|
711
|
-
</dd>
|
|
712
|
-
</dl>
|
|
713
|
-
</details>
|
|
714
|
-
|
|
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>
|
|
718
|
-
<dl>
|
|
719
|
-
<dd>
|
|
720
|
-
|
|
721
|
-
#### 📝 Description
|
|
722
|
-
|
|
723
|
-
<dl>
|
|
724
|
-
<dd>
|
|
725
|
-
|
|
726
|
-
<dl>
|
|
727
|
-
<dd>
|
|
728
|
-
|
|
729
|
-
Get embedding model by id.
|
|
730
|
-
|
|
731
|
-
## Args:
|
|
732
|
-
|
|
733
|
-
db (AsyncSession): The database session.
|
|
734
|
-
short_name (str): The short name of the embedding model.
|
|
735
|
-
user (schemas.User): The current user.
|
|
736
|
-
|
|
737
|
-
## Returns:
|
|
738
|
-
|
|
739
|
-
schemas.EmbeddingModel: The embedding model object.
|
|
740
|
-
|
|
741
|
-
</dd>
|
|
742
|
-
</dl>
|
|
743
|
-
</dd>
|
|
744
|
-
</dl>
|
|
745
|
-
|
|
746
|
-
#### 🔌 Usage
|
|
747
|
-
|
|
748
|
-
<dl>
|
|
749
|
-
<dd>
|
|
750
|
-
|
|
751
|
-
<dl>
|
|
752
|
-
<dd>
|
|
753
|
-
|
|
754
|
-
```typescript
|
|
755
|
-
await client.embeddingModels.readEmbeddingModel("short_name");
|
|
756
|
-
```
|
|
757
|
-
|
|
758
|
-
</dd>
|
|
759
|
-
</dl>
|
|
760
|
-
</dd>
|
|
761
|
-
</dl>
|
|
762
|
-
|
|
763
|
-
#### ⚙️ Parameters
|
|
764
|
-
|
|
765
|
-
<dl>
|
|
766
|
-
<dd>
|
|
767
|
-
|
|
768
|
-
<dl>
|
|
769
|
-
<dd>
|
|
770
|
-
|
|
771
|
-
**shortName:** `string`
|
|
772
|
-
|
|
773
|
-
</dd>
|
|
774
|
-
</dl>
|
|
775
|
-
|
|
776
|
-
<dl>
|
|
777
|
-
<dd>
|
|
778
|
-
|
|
779
|
-
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
780
|
-
|
|
781
|
-
</dd>
|
|
782
|
-
</dl>
|
|
783
|
-
</dd>
|
|
784
|
-
</dl>
|
|
785
|
-
|
|
786
|
-
</dd>
|
|
787
|
-
</dl>
|
|
788
|
-
</details>
|
|
789
|
-
|
|
790
|
-
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModels</a>() -> AirweaveSDK.EmbeddingModel[]</code></summary>
|
|
791
|
-
<dl>
|
|
792
|
-
<dd>
|
|
793
|
-
|
|
794
|
-
#### 📝 Description
|
|
795
|
-
|
|
796
|
-
<dl>
|
|
797
|
-
<dd>
|
|
798
|
-
|
|
799
|
-
<dl>
|
|
800
|
-
<dd>
|
|
801
|
-
|
|
802
|
-
Get all embedding models.
|
|
803
|
-
|
|
804
|
-
## Args:
|
|
805
|
-
|
|
806
|
-
db (AsyncSession): The database session.
|
|
807
|
-
user (schemas.User): The current user.
|
|
808
|
-
|
|
809
|
-
## Returns:
|
|
810
|
-
|
|
811
|
-
list[schemas.EmbeddingModel]: The list of embedding models.
|
|
812
|
-
|
|
813
|
-
</dd>
|
|
814
|
-
</dl>
|
|
815
|
-
</dd>
|
|
816
|
-
</dl>
|
|
817
|
-
|
|
818
|
-
#### 🔌 Usage
|
|
819
|
-
|
|
820
|
-
<dl>
|
|
821
|
-
<dd>
|
|
822
|
-
|
|
823
|
-
<dl>
|
|
824
|
-
<dd>
|
|
825
|
-
|
|
826
|
-
```typescript
|
|
827
|
-
await client.embeddingModels.readEmbeddingModels();
|
|
828
|
-
```
|
|
829
|
-
|
|
830
|
-
</dd>
|
|
831
|
-
</dl>
|
|
832
|
-
</dd>
|
|
833
|
-
</dl>
|
|
834
|
-
|
|
835
|
-
#### ⚙️ Parameters
|
|
836
|
-
|
|
837
|
-
<dl>
|
|
838
|
-
<dd>
|
|
839
|
-
|
|
840
|
-
<dl>
|
|
841
|
-
<dd>
|
|
842
|
-
|
|
843
|
-
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
844
|
-
|
|
845
|
-
</dd>
|
|
846
|
-
</dl>
|
|
847
|
-
</dd>
|
|
848
|
-
</dl>
|
|
849
|
-
|
|
850
|
-
</dd>
|
|
851
|
-
</dl>
|
|
852
|
-
</details>
|
|
853
|
-
|
|
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>
|
|
857
|
-
<dl>
|
|
858
|
-
<dd>
|
|
859
|
-
|
|
860
|
-
#### 📝 Description
|
|
861
|
-
|
|
862
|
-
<dl>
|
|
863
|
-
<dd>
|
|
864
|
-
|
|
865
|
-
<dl>
|
|
866
|
-
<dd>
|
|
867
|
-
|
|
868
|
-
Get a specific connection.
|
|
869
|
-
|
|
870
|
-
## Args:
|
|
871
|
-
|
|
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
|
|
1337
|
-
user (schemas.User): The current user
|
|
1338
|
-
|
|
1339
|
-
## Returns:
|
|
1340
|
-
|
|
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
|
|
1955
|
-
|
|
1956
|
-
</dd>
|
|
1957
|
-
</dl>
|
|
1958
|
-
</dd>
|
|
1959
|
-
</dl>
|
|
1960
|
-
|
|
1961
|
-
#### 🔌 Usage
|
|
1962
|
-
|
|
1963
|
-
<dl>
|
|
1964
|
-
<dd>
|
|
1965
|
-
|
|
1966
|
-
<dl>
|
|
1967
|
-
<dd>
|
|
1968
|
-
|
|
1969
|
-
```typescript
|
|
1970
|
-
await client.sync.listAllJobs();
|
|
1971
|
-
```
|
|
1972
|
-
|
|
1973
|
-
</dd>
|
|
1974
|
-
</dl>
|
|
1975
|
-
</dd>
|
|
1976
|
-
</dl>
|
|
1977
|
-
|
|
1978
|
-
#### ⚙️ Parameters
|
|
1979
|
-
|
|
1980
|
-
<dl>
|
|
1981
|
-
<dd>
|
|
1982
|
-
|
|
1983
|
-
<dl>
|
|
1984
|
-
<dd>
|
|
1985
|
-
|
|
1986
|
-
**request:** `AirweaveSDK.ListAllJobsSyncJobsGetRequest`
|
|
1987
|
-
|
|
1988
|
-
</dd>
|
|
1989
|
-
</dl>
|
|
1990
|
-
|
|
1991
|
-
<dl>
|
|
1992
|
-
<dd>
|
|
1993
|
-
|
|
1994
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1995
|
-
|
|
1996
|
-
</dd>
|
|
1997
|
-
</dl>
|
|
1998
|
-
</dd>
|
|
1999
|
-
</dl>
|
|
2000
|
-
|
|
2001
|
-
</dd>
|
|
2002
|
-
</dl>
|
|
2003
|
-
</details>
|
|
2004
|
-
|
|
2005
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
|
|
2006
|
-
<dl>
|
|
2007
|
-
<dd>
|
|
2008
|
-
|
|
2009
|
-
#### 📝 Description
|
|
2010
|
-
|
|
2011
|
-
<dl>
|
|
2012
|
-
<dd>
|
|
2013
|
-
|
|
2014
|
-
<dl>
|
|
2015
|
-
<dd>
|
|
2016
|
-
|
|
2017
|
-
Get a specific sync by ID.
|
|
2018
|
-
|
|
2019
|
-
## Args:
|
|
2020
|
-
|
|
2021
|
-
db: The database session
|
|
2022
|
-
sync_id: The ID of the sync to get
|
|
2023
|
-
user: The current user
|
|
2024
|
-
|
|
2025
|
-
## Returns:
|
|
2026
|
-
|
|
2027
|
-
sync (schemas.Sync): The sync
|
|
2028
|
-
|
|
2029
|
-
</dd>
|
|
2030
|
-
</dl>
|
|
2031
|
-
</dd>
|
|
2032
|
-
</dl>
|
|
2033
|
-
|
|
2034
|
-
#### 🔌 Usage
|
|
2035
|
-
|
|
2036
|
-
<dl>
|
|
2037
|
-
<dd>
|
|
2038
|
-
|
|
2039
|
-
<dl>
|
|
2040
|
-
<dd>
|
|
2041
|
-
|
|
2042
|
-
```typescript
|
|
2043
|
-
await client.sync.getSync("sync_id");
|
|
2044
|
-
```
|
|
2045
|
-
|
|
2046
|
-
</dd>
|
|
2047
|
-
</dl>
|
|
2048
|
-
</dd>
|
|
2049
|
-
</dl>
|
|
2050
|
-
|
|
2051
|
-
#### ⚙️ Parameters
|
|
2052
|
-
|
|
2053
|
-
<dl>
|
|
2054
|
-
<dd>
|
|
2055
|
-
|
|
2056
|
-
<dl>
|
|
2057
|
-
<dd>
|
|
2058
|
-
|
|
2059
|
-
**syncId:** `string`
|
|
2060
|
-
|
|
2061
|
-
</dd>
|
|
2062
|
-
</dl>
|
|
2063
|
-
|
|
2064
|
-
<dl>
|
|
2065
|
-
<dd>
|
|
2066
|
-
|
|
2067
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2068
|
-
|
|
2069
|
-
</dd>
|
|
2070
|
-
</dl>
|
|
2071
|
-
</dd>
|
|
2072
|
-
</dl>
|
|
2073
|
-
|
|
2074
|
-
</dd>
|
|
2075
|
-
</dl>
|
|
2076
|
-
</details>
|
|
2077
|
-
|
|
2078
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">deleteSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
2079
|
-
<dl>
|
|
2080
|
-
<dd>
|
|
2081
|
-
|
|
2082
|
-
#### 📝 Description
|
|
2083
|
-
|
|
2084
|
-
<dl>
|
|
2085
|
-
<dd>
|
|
2086
|
-
|
|
2087
|
-
<dl>
|
|
2088
|
-
<dd>
|
|
2089
|
-
|
|
2090
|
-
Delete a sync configuration and optionally its associated data.
|
|
2091
|
-
|
|
2092
|
-
## Args:
|
|
2093
|
-
|
|
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
|
|
2098
|
-
|
|
2099
|
-
## Returns:
|
|
2100
|
-
|
|
2101
|
-
sync (schemas.Sync): The deleted sync
|
|
2102
|
-
|
|
2103
|
-
</dd>
|
|
2104
|
-
</dl>
|
|
2105
|
-
</dd>
|
|
2106
|
-
</dl>
|
|
2107
|
-
|
|
2108
|
-
#### 🔌 Usage
|
|
2109
|
-
|
|
2110
|
-
<dl>
|
|
2111
|
-
<dd>
|
|
2112
|
-
|
|
2113
|
-
<dl>
|
|
2114
|
-
<dd>
|
|
2115
|
-
|
|
2116
|
-
```typescript
|
|
2117
|
-
await client.sync.deleteSync("sync_id");
|
|
2118
|
-
```
|
|
2119
|
-
|
|
2120
|
-
</dd>
|
|
2121
|
-
</dl>
|
|
2122
|
-
</dd>
|
|
2123
|
-
</dl>
|
|
2124
|
-
|
|
2125
|
-
#### ⚙️ Parameters
|
|
2126
|
-
|
|
2127
|
-
<dl>
|
|
2128
|
-
<dd>
|
|
2129
|
-
|
|
2130
|
-
<dl>
|
|
2131
|
-
<dd>
|
|
2132
|
-
|
|
2133
|
-
**syncId:** `string`
|
|
2134
|
-
|
|
2135
|
-
</dd>
|
|
2136
|
-
</dl>
|
|
2137
|
-
|
|
2138
|
-
<dl>
|
|
2139
|
-
<dd>
|
|
2140
|
-
|
|
2141
|
-
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
2142
|
-
|
|
2143
|
-
</dd>
|
|
2144
|
-
</dl>
|
|
2145
|
-
|
|
2146
|
-
<dl>
|
|
2147
|
-
<dd>
|
|
2148
|
-
|
|
2149
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2150
|
-
|
|
2151
|
-
</dd>
|
|
2152
|
-
</dl>
|
|
2153
|
-
</dd>
|
|
2154
|
-
</dl>
|
|
2155
|
-
|
|
2156
|
-
</dd>
|
|
2157
|
-
</dl>
|
|
2158
|
-
</details>
|
|
2159
|
-
|
|
2160
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">updateSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
2161
|
-
<dl>
|
|
2162
|
-
<dd>
|
|
2163
|
-
|
|
2164
|
-
#### 📝 Description
|
|
2165
|
-
|
|
2166
|
-
<dl>
|
|
2167
|
-
<dd>
|
|
2168
|
-
|
|
2169
|
-
<dl>
|
|
2170
|
-
<dd>
|
|
2171
|
-
|
|
2172
|
-
Update a sync configuration.
|
|
2173
|
-
|
|
2174
|
-
## Args:
|
|
2175
|
-
|
|
2176
|
-
db: The database session
|
|
2177
|
-
sync_id: The ID of the sync to update
|
|
2178
|
-
sync_update: The sync update data
|
|
2179
|
-
user: The current user
|
|
2180
|
-
|
|
2181
|
-
## Returns:
|
|
2182
|
-
|
|
2183
|
-
sync (schemas.Sync): The updated sync
|
|
2184
|
-
|
|
2185
|
-
</dd>
|
|
2186
|
-
</dl>
|
|
2187
|
-
</dd>
|
|
2188
|
-
</dl>
|
|
2189
|
-
|
|
2190
|
-
#### 🔌 Usage
|
|
2191
|
-
|
|
2192
|
-
<dl>
|
|
2193
|
-
<dd>
|
|
2194
|
-
|
|
2195
|
-
<dl>
|
|
2196
|
-
<dd>
|
|
2197
|
-
|
|
2198
|
-
```typescript
|
|
2199
|
-
await client.sync.updateSync("sync_id");
|
|
2200
|
-
```
|
|
2201
|
-
|
|
2202
|
-
</dd>
|
|
2203
|
-
</dl>
|
|
2204
|
-
</dd>
|
|
2205
|
-
</dl>
|
|
2206
|
-
|
|
2207
|
-
#### ⚙️ Parameters
|
|
2208
|
-
|
|
2209
|
-
<dl>
|
|
2210
|
-
<dd>
|
|
2211
|
-
|
|
2212
|
-
<dl>
|
|
2213
|
-
<dd>
|
|
2214
|
-
|
|
2215
|
-
**syncId:** `string`
|
|
2216
|
-
|
|
2217
|
-
</dd>
|
|
2218
|
-
</dl>
|
|
2219
|
-
|
|
2220
|
-
<dl>
|
|
2221
|
-
<dd>
|
|
2222
|
-
|
|
2223
|
-
**request:** `AirweaveSDK.SyncUpdate`
|
|
2224
|
-
|
|
2225
|
-
</dd>
|
|
2226
|
-
</dl>
|
|
2227
|
-
|
|
2228
|
-
<dl>
|
|
2229
|
-
<dd>
|
|
2230
|
-
|
|
2231
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2232
|
-
|
|
2233
|
-
</dd>
|
|
2234
|
-
</dl>
|
|
2235
|
-
</dd>
|
|
2236
|
-
</dl>
|
|
2237
|
-
|
|
2238
|
-
</dd>
|
|
2239
|
-
</dl>
|
|
2240
|
-
</details>
|
|
2241
|
-
|
|
2242
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">runSync</a>(syncId) -> AirweaveSDK.SyncJob</code></summary>
|
|
2243
|
-
<dl>
|
|
2244
|
-
<dd>
|
|
2245
|
-
|
|
2246
|
-
#### 📝 Description
|
|
2247
|
-
|
|
2248
|
-
<dl>
|
|
2249
|
-
<dd>
|
|
2250
|
-
|
|
2251
|
-
<dl>
|
|
2252
|
-
<dd>
|
|
2253
|
-
|
|
2254
|
-
Trigger a sync run.
|
|
2255
|
-
|
|
2256
|
-
## Args:
|
|
2257
|
-
|
|
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.
|
|
2329
|
-
|
|
2330
|
-
## Args:
|
|
2331
|
-
|
|
2332
|
-
db: The database session
|
|
2333
|
-
sync_id: The ID of the sync to list jobs for
|
|
2334
|
-
user: The current user
|
|
2335
|
-
|
|
2336
|
-
## Returns:
|
|
2337
|
-
|
|
2338
|
-
list[schemas.SyncJob]: A list of sync jobs
|
|
2339
|
-
|
|
2340
|
-
</dd>
|
|
2341
|
-
</dl>
|
|
2342
|
-
</dd>
|
|
2343
|
-
</dl>
|
|
2344
|
-
|
|
2345
|
-
#### 🔌 Usage
|
|
2346
|
-
|
|
2347
|
-
<dl>
|
|
2348
|
-
<dd>
|
|
2349
|
-
|
|
2350
|
-
<dl>
|
|
2351
|
-
<dd>
|
|
2352
|
-
|
|
2353
|
-
```typescript
|
|
2354
|
-
await client.sync.listSyncJobs("sync_id");
|
|
2355
|
-
```
|
|
2356
|
-
|
|
2357
|
-
</dd>
|
|
2358
|
-
</dl>
|
|
2359
|
-
</dd>
|
|
2360
|
-
</dl>
|
|
2361
|
-
|
|
2362
|
-
#### ⚙️ Parameters
|
|
2363
|
-
|
|
2364
|
-
<dl>
|
|
2365
|
-
<dd>
|
|
2366
|
-
|
|
2367
|
-
<dl>
|
|
2368
|
-
<dd>
|
|
2369
|
-
|
|
2370
|
-
**syncId:** `string`
|
|
2371
|
-
|
|
2372
|
-
</dd>
|
|
2373
|
-
</dl>
|
|
2374
|
-
|
|
2375
|
-
<dl>
|
|
2376
|
-
<dd>
|
|
2377
|
-
|
|
2378
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2379
|
-
|
|
2380
|
-
</dd>
|
|
2381
|
-
</dl>
|
|
2382
|
-
</dd>
|
|
2383
|
-
</dl>
|
|
2384
|
-
|
|
2385
|
-
</dd>
|
|
2386
|
-
</dl>
|
|
2387
|
-
</details>
|
|
2388
|
-
|
|
2389
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncJob</a>(syncId, jobId) -> AirweaveSDK.SyncJob</code></summary>
|
|
2390
|
-
<dl>
|
|
2391
|
-
<dd>
|
|
2392
|
-
|
|
2393
|
-
#### 📝 Description
|
|
2394
|
-
|
|
2395
|
-
<dl>
|
|
2396
|
-
<dd>
|
|
2397
|
-
|
|
2398
|
-
<dl>
|
|
2399
|
-
<dd>
|
|
2400
|
-
|
|
2401
|
-
Get details of a specific sync job.
|
|
2402
|
-
|
|
2403
|
-
## Args:
|
|
2404
|
-
|
|
2405
|
-
db: The database session
|
|
2406
|
-
sync_id: The ID of the sync to list jobs for
|
|
2407
|
-
job_id: The ID of the job to get
|
|
2408
|
-
user: The current user
|
|
2409
|
-
|
|
2410
|
-
## Returns:
|
|
2411
|
-
|
|
2412
|
-
sync_job (schemas.SyncJob): The sync job
|
|
2413
|
-
|
|
2414
|
-
</dd>
|
|
2415
|
-
</dl>
|
|
2416
|
-
</dd>
|
|
2417
|
-
</dl>
|
|
2418
|
-
|
|
2419
|
-
#### 🔌 Usage
|
|
2420
|
-
|
|
2421
|
-
<dl>
|
|
2422
|
-
<dd>
|
|
2423
|
-
|
|
2424
|
-
<dl>
|
|
2425
|
-
<dd>
|
|
2426
|
-
|
|
2427
|
-
```typescript
|
|
2428
|
-
await client.sync.getSyncJob("sync_id", "job_id");
|
|
2429
|
-
```
|
|
2430
|
-
|
|
2431
|
-
</dd>
|
|
2432
|
-
</dl>
|
|
2433
|
-
</dd>
|
|
2434
|
-
</dl>
|
|
2435
|
-
|
|
2436
|
-
#### ⚙️ Parameters
|
|
2437
|
-
|
|
2438
|
-
<dl>
|
|
2439
|
-
<dd>
|
|
2440
|
-
|
|
2441
|
-
<dl>
|
|
2442
|
-
<dd>
|
|
2443
|
-
|
|
2444
|
-
**syncId:** `string`
|
|
2445
|
-
|
|
2446
|
-
</dd>
|
|
2447
|
-
</dl>
|
|
2448
|
-
|
|
2449
|
-
<dl>
|
|
2450
|
-
<dd>
|
|
2451
|
-
|
|
2452
|
-
**jobId:** `string`
|
|
2453
|
-
|
|
2454
|
-
</dd>
|
|
2455
|
-
</dl>
|
|
2456
|
-
|
|
2457
|
-
<dl>
|
|
2458
|
-
<dd>
|
|
2459
|
-
|
|
2460
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2461
|
-
|
|
2462
|
-
</dd>
|
|
2463
|
-
</dl>
|
|
2464
|
-
</dd>
|
|
2465
|
-
</dl>
|
|
2466
|
-
|
|
2467
|
-
</dd>
|
|
2468
|
-
</dl>
|
|
2469
|
-
</details>
|
|
2470
|
-
|
|
2471
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">subscribeSyncJob</a>(jobId) -> unknown</code></summary>
|
|
2472
|
-
<dl>
|
|
2473
|
-
<dd>
|
|
2474
|
-
|
|
2475
|
-
#### 📝 Description
|
|
2476
|
-
|
|
2477
|
-
<dl>
|
|
2478
|
-
<dd>
|
|
2479
|
-
|
|
2480
|
-
<dl>
|
|
2481
|
-
<dd>
|
|
2482
|
-
|
|
2483
|
-
Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
2484
|
-
|
|
2485
|
-
## Args:
|
|
2486
|
-
|
|
2487
|
-
job_id: The ID of the job to subscribe to
|
|
2488
|
-
user: The current user
|
|
2489
|
-
|
|
2490
|
-
## Returns:
|
|
2491
|
-
|
|
2492
|
-
StreamingResponse: The streaming response
|
|
2493
|
-
|
|
2494
|
-
</dd>
|
|
2495
|
-
</dl>
|
|
2496
|
-
</dd>
|
|
2497
|
-
</dl>
|
|
2498
|
-
|
|
2499
|
-
#### 🔌 Usage
|
|
2500
|
-
|
|
2501
|
-
<dl>
|
|
2502
|
-
<dd>
|
|
2503
|
-
|
|
2504
|
-
<dl>
|
|
2505
|
-
<dd>
|
|
2506
|
-
|
|
2507
|
-
```typescript
|
|
2508
|
-
await client.sync.subscribeSyncJob("job_id");
|
|
2509
|
-
```
|
|
2510
|
-
|
|
2511
|
-
</dd>
|
|
2512
|
-
</dl>
|
|
2513
|
-
</dd>
|
|
2514
|
-
</dl>
|
|
2515
|
-
|
|
2516
|
-
#### ⚙️ Parameters
|
|
2517
|
-
|
|
2518
|
-
<dl>
|
|
2519
|
-
<dd>
|
|
2520
|
-
|
|
2521
|
-
<dl>
|
|
2522
|
-
<dd>
|
|
2523
|
-
|
|
2524
|
-
**jobId:** `string`
|
|
2525
|
-
|
|
2526
|
-
</dd>
|
|
2527
|
-
</dl>
|
|
2528
|
-
|
|
2529
|
-
<dl>
|
|
2530
|
-
<dd>
|
|
2531
|
-
|
|
2532
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2533
|
-
|
|
2534
|
-
</dd>
|
|
2535
|
-
</dl>
|
|
2536
|
-
</dd>
|
|
2537
|
-
</dl>
|
|
2538
|
-
|
|
2539
|
-
</dd>
|
|
2540
|
-
</dl>
|
|
2541
|
-
</details>
|
|
2542
|
-
|
|
2543
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
2544
|
-
<dl>
|
|
2545
|
-
<dd>
|
|
2546
|
-
|
|
2547
|
-
#### 📝 Description
|
|
2548
|
-
|
|
2549
|
-
<dl>
|
|
2550
|
-
<dd>
|
|
2551
|
-
|
|
2552
|
-
<dl>
|
|
2553
|
-
<dd>
|
|
2554
|
-
|
|
2555
|
-
Get the DAG for a specific sync.
|
|
2556
|
-
|
|
2557
|
-
</dd>
|
|
2558
|
-
</dl>
|
|
2559
|
-
</dd>
|
|
2560
|
-
</dl>
|
|
2561
|
-
|
|
2562
|
-
#### 🔌 Usage
|
|
2563
|
-
|
|
2564
|
-
<dl>
|
|
2565
|
-
<dd>
|
|
2566
|
-
|
|
2567
|
-
<dl>
|
|
2568
|
-
<dd>
|
|
2569
|
-
|
|
2570
|
-
```typescript
|
|
2571
|
-
await client.sync.getSyncDag("sync_id");
|
|
2572
|
-
```
|
|
2573
|
-
|
|
2574
|
-
</dd>
|
|
2575
|
-
</dl>
|
|
2576
|
-
</dd>
|
|
2577
|
-
</dl>
|
|
2578
|
-
|
|
2579
|
-
#### ⚙️ Parameters
|
|
2580
|
-
|
|
2581
|
-
<dl>
|
|
2582
|
-
<dd>
|
|
2583
|
-
|
|
2584
|
-
<dl>
|
|
2585
|
-
<dd>
|
|
2586
|
-
|
|
2587
|
-
**syncId:** `string`
|
|
2588
|
-
|
|
2589
|
-
</dd>
|
|
2590
|
-
</dl>
|
|
2591
|
-
|
|
2592
|
-
<dl>
|
|
2593
|
-
<dd>
|
|
2594
|
-
|
|
2595
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2596
|
-
|
|
2597
|
-
</dd>
|
|
2598
|
-
</dl>
|
|
2599
|
-
</dd>
|
|
2600
|
-
</dl>
|
|
2601
|
-
|
|
2602
|
-
</dd>
|
|
2603
|
-
</dl>
|
|
2604
|
-
</details>
|
|
2605
|
-
|
|
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>
|
|
2609
|
-
<dl>
|
|
2610
|
-
<dd>
|
|
2611
|
-
|
|
2612
|
-
#### 📝 Description
|
|
2613
|
-
|
|
2614
|
-
<dl>
|
|
2615
|
-
<dd>
|
|
2616
|
-
|
|
2617
|
-
<dl>
|
|
2618
|
-
<dd>
|
|
2619
|
-
|
|
2620
|
-
Search for documents within a specific sync.
|
|
2621
|
-
|
|
2622
|
-
## Args:
|
|
2623
|
-
|
|
2624
|
-
db: The database session
|
|
2625
|
-
sync_id: The ID of the sync to search within
|
|
2626
|
-
query: The search query text
|
|
2627
|
-
user: The current user
|
|
2628
|
-
|
|
2629
|
-
## Returns:
|
|
2630
|
-
|
|
2631
|
-
list[dict]: A list of search results
|
|
2632
|
-
|
|
2633
|
-
</dd>
|
|
2634
|
-
</dl>
|
|
2635
|
-
</dd>
|
|
2636
|
-
</dl>
|
|
2637
|
-
|
|
2638
|
-
#### 🔌 Usage
|
|
2639
|
-
|
|
2640
|
-
<dl>
|
|
2641
|
-
<dd>
|
|
2642
|
-
|
|
2643
|
-
<dl>
|
|
2644
|
-
<dd>
|
|
2645
|
-
|
|
2646
|
-
```typescript
|
|
2647
|
-
await client.search.search({
|
|
2648
|
-
syncId: "sync_id",
|
|
2649
|
-
query: "query",
|
|
2650
|
-
});
|
|
2651
|
-
```
|
|
2652
|
-
|
|
2653
|
-
</dd>
|
|
2654
|
-
</dl>
|
|
2655
|
-
</dd>
|
|
2656
|
-
</dl>
|
|
2657
|
-
|
|
2658
|
-
#### ⚙️ Parameters
|
|
2659
|
-
|
|
2660
|
-
<dl>
|
|
2661
|
-
<dd>
|
|
2662
|
-
|
|
2663
|
-
<dl>
|
|
2664
|
-
<dd>
|
|
2665
|
-
|
|
2666
|
-
**request:** `AirweaveSDK.SearchSearchGetRequest`
|
|
2667
|
-
|
|
2668
|
-
</dd>
|
|
2669
|
-
</dl>
|
|
2670
|
-
|
|
2671
|
-
<dl>
|
|
2672
|
-
<dd>
|
|
2673
|
-
|
|
2674
|
-
**requestOptions:** `Search.RequestOptions`
|
|
2675
|
-
|
|
2676
|
-
</dd>
|
|
2677
|
-
</dl>
|
|
2678
|
-
</dd>
|
|
2679
|
-
</dl>
|
|
2680
|
-
|
|
2681
|
-
</dd>
|
|
2682
|
-
</dl>
|
|
2683
|
-
</details>
|
|
2684
|
-
|
|
2685
|
-
## WhiteLabels
|
|
2686
|
-
|
|
2687
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
2688
|
-
<dl>
|
|
2689
|
-
<dd>
|
|
2690
|
-
|
|
2691
|
-
#### 📝 Description
|
|
2692
|
-
|
|
2693
|
-
<dl>
|
|
2694
|
-
<dd>
|
|
2695
|
-
|
|
2696
|
-
<dl>
|
|
2697
|
-
<dd>
|
|
2698
|
-
|
|
2699
|
-
List all white labels for the current user's organization.
|
|
2700
|
-
|
|
2701
|
-
## Args:
|
|
2702
|
-
|
|
2703
|
-
db: The database session
|
|
2704
|
-
current_user: The current user
|
|
2705
|
-
|
|
2706
|
-
## Returns:
|
|
2707
|
-
|
|
2708
|
-
list[schemas.WhiteLabel]: A list of white labels
|
|
2709
|
-
|
|
2710
|
-
</dd>
|
|
2711
|
-
</dl>
|
|
2712
|
-
</dd>
|
|
2713
|
-
</dl>
|
|
2714
|
-
|
|
2715
|
-
#### 🔌 Usage
|
|
2716
|
-
|
|
2717
|
-
<dl>
|
|
2718
|
-
<dd>
|
|
2719
|
-
|
|
2720
|
-
<dl>
|
|
2721
|
-
<dd>
|
|
2722
|
-
|
|
2723
|
-
```typescript
|
|
2724
|
-
await client.whiteLabels.listWhiteLabels();
|
|
2725
|
-
```
|
|
2726
|
-
|
|
2727
|
-
</dd>
|
|
2728
|
-
</dl>
|
|
2729
|
-
</dd>
|
|
2730
|
-
</dl>
|
|
2731
|
-
|
|
2732
|
-
#### ⚙️ Parameters
|
|
2733
|
-
|
|
2734
|
-
<dl>
|
|
2735
|
-
<dd>
|
|
2736
|
-
|
|
2737
|
-
<dl>
|
|
2738
|
-
<dd>
|
|
2739
|
-
|
|
2740
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2741
|
-
|
|
2742
|
-
</dd>
|
|
2743
|
-
</dl>
|
|
2744
|
-
</dd>
|
|
2745
|
-
</dl>
|
|
2746
|
-
|
|
2747
|
-
</dd>
|
|
2748
|
-
</dl>
|
|
2749
|
-
</details>
|
|
2750
|
-
|
|
2751
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2752
|
-
<dl>
|
|
2753
|
-
<dd>
|
|
2754
|
-
|
|
2755
|
-
#### 📝 Description
|
|
2756
|
-
|
|
2757
|
-
<dl>
|
|
2758
|
-
<dd>
|
|
2759
|
-
|
|
2760
|
-
<dl>
|
|
2761
|
-
<dd>
|
|
2762
|
-
|
|
2763
|
-
Create new white label integration.
|
|
2764
|
-
|
|
2765
|
-
## Args:
|
|
2766
|
-
|
|
2767
|
-
db: The database session
|
|
2768
|
-
current_user: The current user
|
|
2769
|
-
white_label_in: The white label to create
|
|
2770
|
-
|
|
2771
|
-
## Returns:
|
|
2772
|
-
|
|
2773
|
-
white_label (schemas.WhiteLabel): The created white label
|
|
2774
|
-
|
|
2775
|
-
</dd>
|
|
2776
|
-
</dl>
|
|
2777
|
-
</dd>
|
|
2778
|
-
</dl>
|
|
2779
|
-
|
|
2780
|
-
#### 🔌 Usage
|
|
2781
|
-
|
|
2782
|
-
<dl>
|
|
2783
|
-
<dd>
|
|
2784
|
-
|
|
2785
|
-
<dl>
|
|
2786
|
-
<dd>
|
|
2787
|
-
|
|
2788
|
-
```typescript
|
|
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
|
-
});
|
|
2796
|
-
```
|
|
2797
|
-
|
|
2798
|
-
</dd>
|
|
2799
|
-
</dl>
|
|
2800
|
-
</dd>
|
|
2801
|
-
</dl>
|
|
2802
|
-
|
|
2803
|
-
#### ⚙️ Parameters
|
|
2804
|
-
|
|
2805
|
-
<dl>
|
|
2806
|
-
<dd>
|
|
2807
|
-
|
|
2808
|
-
<dl>
|
|
2809
|
-
<dd>
|
|
2810
|
-
|
|
2811
|
-
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
2812
|
-
|
|
2813
|
-
</dd>
|
|
2814
|
-
</dl>
|
|
2815
|
-
|
|
2816
|
-
<dl>
|
|
2817
|
-
<dd>
|
|
2818
|
-
|
|
2819
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2820
|
-
|
|
2821
|
-
</dd>
|
|
2822
|
-
</dl>
|
|
2823
|
-
</dd>
|
|
2824
|
-
</dl>
|
|
2825
|
-
|
|
2826
|
-
</dd>
|
|
2827
|
-
</dl>
|
|
2828
|
-
</details>
|
|
2829
|
-
|
|
2830
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2831
|
-
<dl>
|
|
2832
|
-
<dd>
|
|
2833
|
-
|
|
2834
|
-
#### 📝 Description
|
|
2835
|
-
|
|
2836
|
-
<dl>
|
|
2837
|
-
<dd>
|
|
2838
|
-
|
|
2839
|
-
<dl>
|
|
2840
|
-
<dd>
|
|
2841
|
-
|
|
2842
|
-
Get a specific white label integration.
|
|
2843
|
-
|
|
2844
|
-
## Args:
|
|
2845
|
-
|
|
2846
|
-
db: The database session
|
|
2847
|
-
white_label_id: The ID of the white label to get
|
|
2848
|
-
current_user: The current user
|
|
2849
|
-
|
|
2850
|
-
## Returns:
|
|
2851
|
-
|
|
2852
|
-
white_label (schemas.WhiteLabel): The white label
|
|
2853
|
-
|
|
2854
|
-
</dd>
|
|
2855
|
-
</dl>
|
|
2856
|
-
</dd>
|
|
2857
|
-
</dl>
|
|
2858
|
-
|
|
2859
|
-
#### 🔌 Usage
|
|
2860
|
-
|
|
2861
|
-
<dl>
|
|
2862
|
-
<dd>
|
|
2863
|
-
|
|
2864
|
-
<dl>
|
|
2865
|
-
<dd>
|
|
2866
|
-
|
|
2867
|
-
```typescript
|
|
2868
|
-
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
2869
|
-
```
|
|
2870
|
-
|
|
2871
|
-
</dd>
|
|
2872
|
-
</dl>
|
|
2873
|
-
</dd>
|
|
2874
|
-
</dl>
|
|
2875
|
-
|
|
2876
|
-
#### ⚙️ Parameters
|
|
2877
|
-
|
|
2878
|
-
<dl>
|
|
2879
|
-
<dd>
|
|
2880
|
-
|
|
2881
|
-
<dl>
|
|
2882
|
-
<dd>
|
|
2883
|
-
|
|
2884
|
-
**whiteLabelId:** `string`
|
|
2885
|
-
|
|
2886
|
-
</dd>
|
|
2887
|
-
</dl>
|
|
2888
|
-
|
|
2889
|
-
<dl>
|
|
2890
|
-
<dd>
|
|
2891
|
-
|
|
2892
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2893
|
-
|
|
2894
|
-
</dd>
|
|
2895
|
-
</dl>
|
|
2896
|
-
</dd>
|
|
2897
|
-
</dl>
|
|
2898
|
-
|
|
2899
|
-
</dd>
|
|
2900
|
-
</dl>
|
|
2901
|
-
</details>
|
|
2902
|
-
|
|
2903
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2904
|
-
<dl>
|
|
2905
|
-
<dd>
|
|
2906
|
-
|
|
2907
|
-
#### 📝 Description
|
|
2908
|
-
|
|
2909
|
-
<dl>
|
|
2910
|
-
<dd>
|
|
2911
|
-
|
|
2912
|
-
<dl>
|
|
2913
|
-
<dd>
|
|
2914
|
-
|
|
2915
|
-
Update a white label integration.
|
|
2916
|
-
|
|
2917
|
-
## Args:
|
|
2918
|
-
|
|
2919
|
-
db: The database session
|
|
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
|
|
2923
|
-
|
|
2924
|
-
## Returns:
|
|
2925
|
-
|
|
2926
|
-
white_label (schemas.WhiteLabel): The updated white label
|
|
2927
|
-
|
|
2928
|
-
</dd>
|
|
2929
|
-
</dl>
|
|
2930
|
-
</dd>
|
|
2931
|
-
</dl>
|
|
2932
|
-
|
|
2933
|
-
#### 🔌 Usage
|
|
2934
|
-
|
|
2935
|
-
<dl>
|
|
2936
|
-
<dd>
|
|
2937
|
-
|
|
2938
|
-
<dl>
|
|
2939
|
-
<dd>
|
|
2940
|
-
|
|
2941
|
-
```typescript
|
|
2942
|
-
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
2943
|
-
```
|
|
2944
|
-
|
|
2945
|
-
</dd>
|
|
2946
|
-
</dl>
|
|
2947
|
-
</dd>
|
|
2948
|
-
</dl>
|
|
2949
|
-
|
|
2950
|
-
#### ⚙️ Parameters
|
|
2951
|
-
|
|
2952
|
-
<dl>
|
|
2953
|
-
<dd>
|
|
2954
|
-
|
|
2955
|
-
<dl>
|
|
2956
|
-
<dd>
|
|
2957
|
-
|
|
2958
|
-
**whiteLabelId:** `string`
|
|
2959
|
-
|
|
2960
|
-
</dd>
|
|
2961
|
-
</dl>
|
|
2962
|
-
|
|
2963
|
-
<dl>
|
|
2964
|
-
<dd>
|
|
2965
|
-
|
|
2966
|
-
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
2967
|
-
|
|
2968
|
-
</dd>
|
|
2969
|
-
</dl>
|
|
2970
|
-
|
|
2971
|
-
<dl>
|
|
2972
|
-
<dd>
|
|
2973
|
-
|
|
2974
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2975
|
-
|
|
2976
|
-
</dd>
|
|
2977
|
-
</dl>
|
|
2978
|
-
</dd>
|
|
2979
|
-
</dl>
|
|
2980
|
-
|
|
2981
|
-
</dd>
|
|
2982
|
-
</dl>
|
|
2983
|
-
</details>
|
|
2984
|
-
|
|
2985
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2986
|
-
<dl>
|
|
2987
|
-
<dd>
|
|
2988
|
-
|
|
2989
|
-
#### 📝 Description
|
|
2990
|
-
|
|
2991
|
-
<dl>
|
|
2992
|
-
<dd>
|
|
2993
|
-
|
|
2994
|
-
<dl>
|
|
2995
|
-
<dd>
|
|
2996
|
-
|
|
2997
|
-
Delete a white label integration.
|
|
2998
|
-
|
|
2999
|
-
## Args:
|
|
3000
|
-
|
|
3001
|
-
db: The database session
|
|
3002
|
-
current_user: The current user
|
|
3003
|
-
white_label_id: The ID of the white label to delete
|
|
3004
|
-
|
|
3005
|
-
## Returns:
|
|
3006
|
-
|
|
3007
|
-
white_label (schemas.WhiteLabel): The deleted white label
|
|
3008
|
-
|
|
3009
|
-
</dd>
|
|
3010
|
-
</dl>
|
|
3011
|
-
</dd>
|
|
3012
|
-
</dl>
|
|
3013
|
-
|
|
3014
|
-
#### 🔌 Usage
|
|
3015
|
-
|
|
3016
|
-
<dl>
|
|
3017
|
-
<dd>
|
|
3018
|
-
|
|
3019
|
-
<dl>
|
|
3020
|
-
<dd>
|
|
3021
|
-
|
|
3022
|
-
```typescript
|
|
3023
|
-
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
3024
|
-
```
|
|
3025
|
-
|
|
3026
|
-
</dd>
|
|
3027
|
-
</dl>
|
|
3028
|
-
</dd>
|
|
3029
|
-
</dl>
|
|
3030
|
-
|
|
3031
|
-
#### ⚙️ Parameters
|
|
3032
|
-
|
|
3033
|
-
<dl>
|
|
3034
|
-
<dd>
|
|
3035
|
-
|
|
3036
|
-
<dl>
|
|
3037
|
-
<dd>
|
|
3038
|
-
|
|
3039
|
-
**whiteLabelId:** `string`
|
|
3040
|
-
|
|
3041
|
-
</dd>
|
|
3042
|
-
</dl>
|
|
3043
|
-
|
|
3044
|
-
<dl>
|
|
3045
|
-
<dd>
|
|
3046
|
-
|
|
3047
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3048
|
-
|
|
3049
|
-
</dd>
|
|
3050
|
-
</dl>
|
|
3051
|
-
</dd>
|
|
3052
|
-
</dl>
|
|
3053
|
-
|
|
3054
|
-
</dd>
|
|
3055
|
-
</dl>
|
|
3056
|
-
</details>
|
|
3057
|
-
|
|
3058
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
3059
|
-
<dl>
|
|
3060
|
-
<dd>
|
|
3061
|
-
|
|
3062
|
-
#### 📝 Description
|
|
3063
|
-
|
|
3064
|
-
<dl>
|
|
3065
|
-
<dd>
|
|
3066
|
-
|
|
3067
|
-
<dl>
|
|
3068
|
-
<dd>
|
|
3069
|
-
|
|
3070
|
-
Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
3071
|
-
|
|
3072
|
-
## Args:
|
|
3073
|
-
|
|
3074
|
-
db: The database session
|
|
3075
|
-
white_label_id: The ID of the white label to get the auth URL for
|
|
3076
|
-
user: The current user
|
|
3077
|
-
|
|
3078
|
-
## Returns:
|
|
3079
|
-
|
|
3080
|
-
str: The OAuth2 authorization URL
|
|
3081
|
-
|
|
3082
|
-
</dd>
|
|
3083
|
-
</dl>
|
|
3084
|
-
</dd>
|
|
3085
|
-
</dl>
|
|
3086
|
-
|
|
3087
|
-
#### 🔌 Usage
|
|
3088
|
-
|
|
3089
|
-
<dl>
|
|
3090
|
-
<dd>
|
|
3091
|
-
|
|
3092
|
-
<dl>
|
|
3093
|
-
<dd>
|
|
3094
|
-
|
|
3095
|
-
```typescript
|
|
3096
|
-
await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
3097
|
-
```
|
|
3098
|
-
|
|
3099
|
-
</dd>
|
|
3100
|
-
</dl>
|
|
3101
|
-
</dd>
|
|
3102
|
-
</dl>
|
|
3103
|
-
|
|
3104
|
-
#### ⚙️ Parameters
|
|
3105
|
-
|
|
3106
|
-
<dl>
|
|
3107
|
-
<dd>
|
|
3108
|
-
|
|
3109
|
-
<dl>
|
|
3110
|
-
<dd>
|
|
3111
|
-
|
|
3112
|
-
**whiteLabelId:** `string`
|
|
3113
|
-
|
|
3114
|
-
</dd>
|
|
3115
|
-
</dl>
|
|
3116
|
-
|
|
3117
|
-
<dl>
|
|
3118
|
-
<dd>
|
|
3119
|
-
|
|
3120
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3121
|
-
|
|
3122
|
-
</dd>
|
|
3123
|
-
</dl>
|
|
3124
|
-
</dd>
|
|
3125
|
-
</dl>
|
|
3126
|
-
|
|
3127
|
-
</dd>
|
|
3128
|
-
</dl>
|
|
3129
|
-
</details>
|
|
3130
|
-
|
|
3131
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
3132
|
-
<dl>
|
|
3133
|
-
<dd>
|
|
3134
|
-
|
|
3135
|
-
#### 📝 Description
|
|
3136
|
-
|
|
3137
|
-
<dl>
|
|
3138
|
-
<dd>
|
|
3139
|
-
|
|
3140
|
-
<dl>
|
|
3141
|
-
<dd>
|
|
3142
|
-
|
|
3143
|
-
Exchange OAuth2 code for tokens and create connection.
|
|
3144
|
-
|
|
3145
|
-
## Args:
|
|
3146
|
-
|
|
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
|
|
3150
|
-
user: The current user
|
|
3151
|
-
|
|
3152
|
-
## Returns:
|
|
3153
|
-
|
|
3154
|
-
connection (schemas.Connection): The created connection
|
|
3155
|
-
|
|
3156
|
-
</dd>
|
|
3157
|
-
</dl>
|
|
3158
|
-
</dd>
|
|
3159
|
-
</dl>
|
|
3160
|
-
|
|
3161
|
-
#### 🔌 Usage
|
|
3162
|
-
|
|
3163
|
-
<dl>
|
|
3164
|
-
<dd>
|
|
3165
|
-
|
|
3166
|
-
<dl>
|
|
3167
|
-
<dd>
|
|
3168
|
-
|
|
3169
|
-
```typescript
|
|
3170
|
-
await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string");
|
|
3171
|
-
```
|
|
3172
|
-
|
|
3173
|
-
</dd>
|
|
3174
|
-
</dl>
|
|
3175
|
-
</dd>
|
|
3176
|
-
</dl>
|
|
3177
|
-
|
|
3178
|
-
#### ⚙️ Parameters
|
|
3179
|
-
|
|
3180
|
-
<dl>
|
|
3181
|
-
<dd>
|
|
3182
|
-
|
|
3183
|
-
<dl>
|
|
3184
|
-
<dd>
|
|
3185
|
-
|
|
3186
|
-
**whiteLabelId:** `string`
|
|
3187
|
-
|
|
3188
|
-
</dd>
|
|
3189
|
-
</dl>
|
|
3190
|
-
|
|
3191
|
-
<dl>
|
|
3192
|
-
<dd>
|
|
3193
|
-
|
|
3194
|
-
**request:** `string`
|
|
3195
|
-
|
|
3196
|
-
</dd>
|
|
3197
|
-
</dl>
|
|
3198
|
-
|
|
3199
|
-
<dl>
|
|
3200
|
-
<dd>
|
|
3201
|
-
|
|
3202
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3203
|
-
|
|
3204
|
-
</dd>
|
|
3205
|
-
</dl>
|
|
3206
|
-
</dd>
|
|
3207
|
-
</dl>
|
|
3208
|
-
|
|
3209
|
-
</dd>
|
|
3210
|
-
</dl>
|
|
3211
|
-
</details>
|
|
3212
|
-
|
|
3213
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
3214
|
-
<dl>
|
|
3215
|
-
<dd>
|
|
3216
|
-
|
|
3217
|
-
#### 📝 Description
|
|
3218
|
-
|
|
3219
|
-
<dl>
|
|
3220
|
-
<dd>
|
|
3221
|
-
|
|
3222
|
-
<dl>
|
|
3223
|
-
<dd>
|
|
3224
|
-
|
|
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
|
|
3236
|
-
|
|
3237
|
-
</dd>
|
|
3238
|
-
</dl>
|
|
3239
|
-
</dd>
|
|
3240
|
-
</dl>
|
|
3241
|
-
|
|
3242
|
-
#### 🔌 Usage
|
|
3243
|
-
|
|
3244
|
-
<dl>
|
|
3245
|
-
<dd>
|
|
3246
|
-
|
|
3247
|
-
<dl>
|
|
3248
|
-
<dd>
|
|
3249
|
-
|
|
3250
|
-
```typescript
|
|
3251
|
-
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
3252
|
-
```
|
|
3253
|
-
|
|
3254
|
-
</dd>
|
|
3255
|
-
</dl>
|
|
3256
|
-
</dd>
|
|
3257
|
-
</dl>
|
|
3258
|
-
|
|
3259
|
-
#### ⚙️ Parameters
|
|
3260
|
-
|
|
3261
|
-
<dl>
|
|
3262
|
-
<dd>
|
|
3263
|
-
|
|
3264
|
-
<dl>
|
|
3265
|
-
<dd>
|
|
3266
|
-
|
|
3267
|
-
**whiteLabelId:** `string`
|
|
3268
|
-
|
|
3269
|
-
</dd>
|
|
3270
|
-
</dl>
|
|
3271
|
-
|
|
3272
|
-
<dl>
|
|
3273
|
-
<dd>
|
|
3274
|
-
|
|
3275
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3276
|
-
|
|
3277
|
-
</dd>
|
|
3278
|
-
</dl>
|
|
3279
|
-
</dd>
|
|
3280
|
-
</dl>
|
|
3281
|
-
|
|
3282
|
-
</dd>
|
|
3283
|
-
</dl>
|
|
3284
|
-
</details>
|
|
3285
|
-
|
|
3286
|
-
## Chat
|
|
3287
|
-
|
|
3288
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">openaiKeySet</a>() -> boolean</code></summary>
|
|
3289
|
-
<dl>
|
|
3290
|
-
<dd>
|
|
3291
|
-
|
|
3292
|
-
#### 📝 Description
|
|
3293
|
-
|
|
3294
|
-
<dl>
|
|
3295
|
-
<dd>
|
|
3296
|
-
|
|
3297
|
-
<dl>
|
|
3298
|
-
<dd>
|
|
3299
|
-
|
|
3300
|
-
Check if the OpenAI API key is set for the current user.
|
|
3301
|
-
|
|
3302
|
-
## Args:
|
|
3303
|
-
|
|
3304
|
-
db: The database session.
|
|
3305
|
-
user: The current user.
|
|
3306
|
-
|
|
3307
|
-
## Returns:
|
|
3308
|
-
|
|
3309
|
-
bool: True if the OpenAI API key is set, False otherwise.
|
|
3310
|
-
|
|
3311
|
-
</dd>
|
|
3312
|
-
</dl>
|
|
3313
|
-
</dd>
|
|
3314
|
-
</dl>
|
|
3315
|
-
|
|
3316
|
-
#### 🔌 Usage
|
|
3317
|
-
|
|
3318
|
-
<dl>
|
|
3319
|
-
<dd>
|
|
3320
|
-
|
|
3321
|
-
<dl>
|
|
3322
|
-
<dd>
|
|
3323
|
-
|
|
3324
|
-
```typescript
|
|
3325
|
-
await client.chat.openaiKeySet();
|
|
3326
|
-
```
|
|
3327
|
-
|
|
3328
|
-
</dd>
|
|
3329
|
-
</dl>
|
|
3330
|
-
</dd>
|
|
3331
|
-
</dl>
|
|
3332
|
-
|
|
3333
|
-
#### ⚙️ Parameters
|
|
3334
|
-
|
|
3335
|
-
<dl>
|
|
3336
|
-
<dd>
|
|
3337
|
-
|
|
3338
|
-
<dl>
|
|
3339
|
-
<dd>
|
|
3340
|
-
|
|
3341
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3342
|
-
|
|
3343
|
-
</dd>
|
|
3344
|
-
</dl>
|
|
3345
|
-
</dd>
|
|
3346
|
-
</dl>
|
|
3347
|
-
|
|
3348
|
-
</dd>
|
|
3349
|
-
</dl>
|
|
3350
|
-
</details>
|
|
3351
|
-
|
|
3352
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">listChats</a>({ ...params }) -> AirweaveSDK.Chat[]</code></summary>
|
|
3353
|
-
<dl>
|
|
3354
|
-
<dd>
|
|
3355
|
-
|
|
3356
|
-
#### 📝 Description
|
|
3357
|
-
|
|
3358
|
-
<dl>
|
|
3359
|
-
<dd>
|
|
3360
|
-
|
|
3361
|
-
<dl>
|
|
3362
|
-
<dd>
|
|
3363
|
-
|
|
3364
|
-
List all chats for the current user.
|
|
3365
|
-
|
|
3366
|
-
## Args:
|
|
3367
|
-
|
|
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.
|
|
3372
|
-
|
|
3373
|
-
## Returns:
|
|
3374
|
-
|
|
3375
|
-
list[schemas.Chat]: The list of chats.
|
|
3376
|
-
|
|
3377
|
-
</dd>
|
|
3378
|
-
</dl>
|
|
3379
|
-
</dd>
|
|
3380
|
-
</dl>
|
|
3381
|
-
|
|
3382
|
-
#### 🔌 Usage
|
|
3383
|
-
|
|
3384
|
-
<dl>
|
|
3385
|
-
<dd>
|
|
3386
|
-
|
|
3387
|
-
<dl>
|
|
3388
|
-
<dd>
|
|
3389
|
-
|
|
3390
|
-
```typescript
|
|
3391
|
-
await client.chat.listChats();
|
|
3392
|
-
```
|
|
3393
|
-
|
|
3394
|
-
</dd>
|
|
3395
|
-
</dl>
|
|
3396
|
-
</dd>
|
|
3397
|
-
</dl>
|
|
3398
|
-
|
|
3399
|
-
#### ⚙️ Parameters
|
|
3400
|
-
|
|
3401
|
-
<dl>
|
|
3402
|
-
<dd>
|
|
3403
|
-
|
|
3404
|
-
<dl>
|
|
3405
|
-
<dd>
|
|
3406
|
-
|
|
3407
|
-
**request:** `AirweaveSDK.ListChatsChatGetRequest`
|
|
3408
|
-
|
|
3409
|
-
</dd>
|
|
3410
|
-
</dl>
|
|
3411
|
-
|
|
3412
|
-
<dl>
|
|
3413
|
-
<dd>
|
|
3414
|
-
|
|
3415
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3416
|
-
|
|
3417
|
-
</dd>
|
|
3418
|
-
</dl>
|
|
3419
|
-
</dd>
|
|
3420
|
-
</dl>
|
|
3421
|
-
|
|
3422
|
-
</dd>
|
|
3423
|
-
</dl>
|
|
3424
|
-
</details>
|
|
3425
|
-
|
|
3426
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">createChat</a>({ ...params }) -> AirweaveSDK.Chat</code></summary>
|
|
3427
|
-
<dl>
|
|
3428
|
-
<dd>
|
|
3429
|
-
|
|
3430
|
-
#### 📝 Description
|
|
3431
|
-
|
|
3432
|
-
<dl>
|
|
3433
|
-
<dd>
|
|
3434
|
-
|
|
3435
|
-
<dl>
|
|
3436
|
-
<dd>
|
|
3437
|
-
|
|
3438
|
-
Create a new chat.
|
|
3439
|
-
|
|
3440
|
-
## Args:
|
|
3441
|
-
|
|
3442
|
-
db: The database session.
|
|
3443
|
-
chat_in: The chat creation data.
|
|
3444
|
-
user: The current user.
|
|
3445
|
-
|
|
3446
|
-
## Returns:
|
|
3447
|
-
|
|
3448
|
-
schemas.Chat: The created chat.
|
|
3449
|
-
|
|
3450
|
-
</dd>
|
|
3451
|
-
</dl>
|
|
3452
|
-
</dd>
|
|
3453
|
-
</dl>
|
|
3454
|
-
|
|
3455
|
-
#### 🔌 Usage
|
|
3456
|
-
|
|
3457
|
-
<dl>
|
|
3458
|
-
<dd>
|
|
3459
|
-
|
|
3460
|
-
<dl>
|
|
3461
|
-
<dd>
|
|
3462
|
-
|
|
3463
|
-
```typescript
|
|
3464
|
-
await client.chat.createChat({
|
|
3465
|
-
name: "name",
|
|
3466
|
-
syncId: "sync_id",
|
|
3467
|
-
});
|
|
3468
|
-
```
|
|
3469
|
-
|
|
3470
|
-
</dd>
|
|
3471
|
-
</dl>
|
|
3472
|
-
</dd>
|
|
3473
|
-
</dl>
|
|
3474
|
-
|
|
3475
|
-
#### ⚙️ Parameters
|
|
3476
|
-
|
|
3477
|
-
<dl>
|
|
3478
|
-
<dd>
|
|
3479
|
-
|
|
3480
|
-
<dl>
|
|
3481
|
-
<dd>
|
|
3482
|
-
|
|
3483
|
-
**request:** `AirweaveSDK.ChatCreate`
|
|
3484
|
-
|
|
3485
|
-
</dd>
|
|
3486
|
-
</dl>
|
|
3487
|
-
|
|
3488
|
-
<dl>
|
|
3489
|
-
<dd>
|
|
3490
|
-
|
|
3491
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3492
|
-
|
|
3493
|
-
</dd>
|
|
3494
|
-
</dl>
|
|
3495
|
-
</dd>
|
|
3496
|
-
</dl>
|
|
3497
|
-
|
|
3498
|
-
</dd>
|
|
3499
|
-
</dl>
|
|
3500
|
-
</details>
|
|
3501
|
-
|
|
3502
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">getChat</a>(chatId) -> AirweaveSDK.Chat</code></summary>
|
|
3503
|
-
<dl>
|
|
3504
|
-
<dd>
|
|
3505
|
-
|
|
3506
|
-
#### 📝 Description
|
|
3507
|
-
|
|
3508
|
-
<dl>
|
|
3509
|
-
<dd>
|
|
3510
|
-
|
|
3511
|
-
<dl>
|
|
3512
|
-
<dd>
|
|
3513
|
-
|
|
3514
|
-
Get a specific chat by ID.
|
|
3515
|
-
|
|
3516
|
-
## Args:
|
|
3517
|
-
|
|
3518
|
-
db: The database session.
|
|
3519
|
-
chat_id: The ID of the chat to get.
|
|
3520
|
-
user: The current user.
|
|
3521
|
-
|
|
3522
|
-
## Returns:
|
|
3523
|
-
|
|
3524
|
-
schemas.Chat: The chat.
|
|
3525
|
-
|
|
3526
|
-
</dd>
|
|
3527
|
-
</dl>
|
|
3528
|
-
</dd>
|
|
3529
|
-
</dl>
|
|
3530
|
-
|
|
3531
|
-
#### 🔌 Usage
|
|
3532
|
-
|
|
3533
|
-
<dl>
|
|
3534
|
-
<dd>
|
|
3535
|
-
|
|
3536
|
-
<dl>
|
|
3537
|
-
<dd>
|
|
3538
|
-
|
|
3539
|
-
```typescript
|
|
3540
|
-
await client.chat.getChat("chat_id");
|
|
3541
|
-
```
|
|
3542
|
-
|
|
3543
|
-
</dd>
|
|
3544
|
-
</dl>
|
|
3545
|
-
</dd>
|
|
3546
|
-
</dl>
|
|
3547
|
-
|
|
3548
|
-
#### ⚙️ Parameters
|
|
3549
|
-
|
|
3550
|
-
<dl>
|
|
3551
|
-
<dd>
|
|
3552
|
-
|
|
3553
|
-
<dl>
|
|
3554
|
-
<dd>
|
|
3555
|
-
|
|
3556
|
-
**chatId:** `string`
|
|
3557
|
-
|
|
3558
|
-
</dd>
|
|
3559
|
-
</dl>
|
|
3560
|
-
|
|
3561
|
-
<dl>
|
|
3562
|
-
<dd>
|
|
3563
|
-
|
|
3564
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3565
|
-
|
|
3566
|
-
</dd>
|
|
3567
|
-
</dl>
|
|
3568
|
-
</dd>
|
|
3569
|
-
</dl>
|
|
3570
|
-
|
|
3571
|
-
</dd>
|
|
3572
|
-
</dl>
|
|
3573
|
-
</details>
|
|
3574
|
-
|
|
3575
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">updateChat</a>(chatId, { ...params }) -> AirweaveSDK.Chat</code></summary>
|
|
3576
|
-
<dl>
|
|
3577
|
-
<dd>
|
|
3578
|
-
|
|
3579
|
-
#### 📝 Description
|
|
3580
|
-
|
|
3581
|
-
<dl>
|
|
3582
|
-
<dd>
|
|
3583
|
-
|
|
3584
|
-
<dl>
|
|
3585
|
-
<dd>
|
|
3586
|
-
|
|
3587
|
-
Update a chat.
|
|
3588
|
-
|
|
3589
|
-
## Args:
|
|
3590
|
-
|
|
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.
|
|
3595
|
-
|
|
3596
|
-
## Returns:
|
|
3597
|
-
|
|
3598
|
-
schemas.Chat: The updated chat.
|
|
3599
|
-
|
|
3600
|
-
</dd>
|
|
3601
|
-
</dl>
|
|
3602
|
-
</dd>
|
|
3603
|
-
</dl>
|
|
3604
|
-
|
|
3605
|
-
#### 🔌 Usage
|
|
3606
|
-
|
|
3607
|
-
<dl>
|
|
3608
|
-
<dd>
|
|
3609
|
-
|
|
3610
|
-
<dl>
|
|
3611
|
-
<dd>
|
|
3612
|
-
|
|
3613
|
-
```typescript
|
|
3614
|
-
await client.chat.updateChat("chat_id");
|
|
3615
|
-
```
|
|
3616
|
-
|
|
3617
|
-
</dd>
|
|
3618
|
-
</dl>
|
|
3619
|
-
</dd>
|
|
3620
|
-
</dl>
|
|
3621
|
-
|
|
3622
|
-
#### ⚙️ Parameters
|
|
3623
|
-
|
|
3624
|
-
<dl>
|
|
3625
|
-
<dd>
|
|
3626
|
-
|
|
3627
|
-
<dl>
|
|
3628
|
-
<dd>
|
|
3629
|
-
|
|
3630
|
-
**chatId:** `string`
|
|
3631
|
-
|
|
3632
|
-
</dd>
|
|
3633
|
-
</dl>
|
|
3634
|
-
|
|
3635
|
-
<dl>
|
|
3636
|
-
<dd>
|
|
3637
|
-
|
|
3638
|
-
**request:** `AirweaveSDK.ChatUpdate`
|
|
3639
|
-
|
|
3640
|
-
</dd>
|
|
3641
|
-
</dl>
|
|
3642
|
-
|
|
3643
|
-
<dl>
|
|
3644
|
-
<dd>
|
|
3645
|
-
|
|
3646
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3647
|
-
|
|
3648
|
-
</dd>
|
|
3649
|
-
</dl>
|
|
3650
|
-
</dd>
|
|
3651
|
-
</dl>
|
|
3652
|
-
|
|
3653
|
-
</dd>
|
|
3654
|
-
</dl>
|
|
3655
|
-
</details>
|
|
3656
|
-
|
|
3657
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">deleteChat</a>(chatId) -> void</code></summary>
|
|
3658
|
-
<dl>
|
|
3659
|
-
<dd>
|
|
3660
|
-
|
|
3661
|
-
#### 📝 Description
|
|
3662
|
-
|
|
3663
|
-
<dl>
|
|
3664
|
-
<dd>
|
|
3665
|
-
|
|
3666
|
-
<dl>
|
|
3667
|
-
<dd>
|
|
3668
|
-
|
|
3669
|
-
Archive a chat.
|
|
3670
|
-
|
|
3671
|
-
## Args:
|
|
3672
|
-
|
|
3673
|
-
db: The database session.
|
|
3674
|
-
chat_id: The ID of the chat to archive.
|
|
3675
|
-
user: The current user.
|
|
3676
|
-
|
|
3677
|
-
</dd>
|
|
3678
|
-
</dl>
|
|
3679
|
-
</dd>
|
|
3680
|
-
</dl>
|
|
3681
|
-
|
|
3682
|
-
#### 🔌 Usage
|
|
3683
|
-
|
|
3684
|
-
<dl>
|
|
3685
|
-
<dd>
|
|
3686
|
-
|
|
3687
|
-
<dl>
|
|
3688
|
-
<dd>
|
|
3689
|
-
|
|
3690
|
-
```typescript
|
|
3691
|
-
await client.chat.deleteChat("chat_id");
|
|
3692
|
-
```
|
|
3693
|
-
|
|
3694
|
-
</dd>
|
|
3695
|
-
</dl>
|
|
3696
|
-
</dd>
|
|
3697
|
-
</dl>
|
|
3698
|
-
|
|
3699
|
-
#### ⚙️ Parameters
|
|
3700
|
-
|
|
3701
|
-
<dl>
|
|
3702
|
-
<dd>
|
|
3703
|
-
|
|
3704
|
-
<dl>
|
|
3705
|
-
<dd>
|
|
3706
|
-
|
|
3707
|
-
**chatId:** `string`
|
|
3708
|
-
|
|
3709
|
-
</dd>
|
|
3710
|
-
</dl>
|
|
3711
|
-
|
|
3712
|
-
<dl>
|
|
3713
|
-
<dd>
|
|
3714
|
-
|
|
3715
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3716
|
-
|
|
3717
|
-
</dd>
|
|
3718
|
-
</dl>
|
|
3719
|
-
</dd>
|
|
3720
|
-
</dl>
|
|
3721
|
-
|
|
3722
|
-
</dd>
|
|
3723
|
-
</dl>
|
|
3724
|
-
</details>
|
|
3725
|
-
|
|
3726
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">sendMessage</a>(chatId, { ...params }) -> AirweaveSDK.ChatMessage</code></summary>
|
|
3727
|
-
<dl>
|
|
3728
|
-
<dd>
|
|
3729
|
-
|
|
3730
|
-
#### 📝 Description
|
|
3731
|
-
|
|
3732
|
-
<dl>
|
|
3733
|
-
<dd>
|
|
3734
|
-
|
|
3735
|
-
<dl>
|
|
3736
|
-
<dd>
|
|
3737
|
-
|
|
3738
|
-
Send a message to a chat.
|
|
3739
|
-
|
|
3740
|
-
## Args:
|
|
3741
|
-
|
|
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.
|
|
3746
|
-
|
|
3747
|
-
## Returns:
|
|
3748
|
-
|
|
3749
|
-
schemas.ChatMessage: The sent message.
|
|
3750
|
-
|
|
3751
|
-
</dd>
|
|
3752
|
-
</dl>
|
|
3753
|
-
</dd>
|
|
3754
|
-
</dl>
|
|
3755
|
-
|
|
3756
|
-
#### 🔌 Usage
|
|
3757
|
-
|
|
3758
|
-
<dl>
|
|
3759
|
-
<dd>
|
|
3760
|
-
|
|
3761
|
-
<dl>
|
|
3762
|
-
<dd>
|
|
3763
|
-
|
|
3764
|
-
```typescript
|
|
3765
|
-
await client.chat.sendMessage("chat_id", {
|
|
3766
|
-
content: "content",
|
|
3767
|
-
});
|
|
3768
|
-
```
|
|
3769
|
-
|
|
3770
|
-
</dd>
|
|
3771
|
-
</dl>
|
|
3772
|
-
</dd>
|
|
3773
|
-
</dl>
|
|
3774
|
-
|
|
3775
|
-
#### ⚙️ Parameters
|
|
3776
|
-
|
|
3777
|
-
<dl>
|
|
3778
|
-
<dd>
|
|
3779
|
-
|
|
3780
|
-
<dl>
|
|
3781
|
-
<dd>
|
|
3782
|
-
|
|
3783
|
-
**chatId:** `string`
|
|
3784
|
-
|
|
3785
|
-
</dd>
|
|
3786
|
-
</dl>
|
|
3787
|
-
|
|
3788
|
-
<dl>
|
|
3789
|
-
<dd>
|
|
3790
|
-
|
|
3791
|
-
**request:** `AirweaveSDK.ChatMessageCreate`
|
|
3792
|
-
|
|
3793
|
-
</dd>
|
|
3794
|
-
</dl>
|
|
3795
|
-
|
|
3796
|
-
<dl>
|
|
3797
|
-
<dd>
|
|
3798
|
-
|
|
3799
|
-
**requestOptions:** `Chat.RequestOptions`
|
|
3800
|
-
|
|
3801
|
-
</dd>
|
|
3802
|
-
</dl>
|
|
3803
|
-
</dd>
|
|
3804
|
-
</dl>
|
|
3805
|
-
|
|
3806
|
-
</dd>
|
|
3807
|
-
</dl>
|
|
3808
|
-
</details>
|
|
3809
|
-
|
|
3810
|
-
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">streamChatResponse</a>(chatId) -> void</code></summary>
|
|
3811
|
-
<dl>
|
|
3812
|
-
<dd>
|
|
3813
|
-
|
|
3814
|
-
#### 📝 Description
|
|
3815
|
-
|
|
3816
|
-
<dl>
|
|
3817
|
-
<dd>
|
|
3818
|
-
|
|
3819
|
-
<dl>
|
|
3820
|
-
<dd>
|
|
3821
|
-
|
|
3822
|
-
Stream an AI response for a chat message.
|
|
3823
|
-
|
|
3824
|
-
## Args:
|
|
3825
|
-
|
|
3826
|
-
db: The database session.
|
|
3827
|
-
chat_id: The ID of the chat to stream the response for.
|
|
3828
|
-
user: The current user.
|
|
278
|
+
<dl>
|
|
279
|
+
<dd>
|
|
3829
280
|
|
|
3830
|
-
|
|
281
|
+
<dl>
|
|
282
|
+
<dd>
|
|
3831
283
|
|
|
3832
|
-
|
|
284
|
+
Get a specific collection by its readable ID.
|
|
3833
285
|
|
|
3834
286
|
</dd>
|
|
3835
287
|
</dl>
|
|
@@ -3845,7 +297,7 @@ Stream an AI response for a chat message.
|
|
|
3845
297
|
<dd>
|
|
3846
298
|
|
|
3847
299
|
```typescript
|
|
3848
|
-
await client.
|
|
300
|
+
await client.collections.getCollection("readable_id");
|
|
3849
301
|
```
|
|
3850
302
|
|
|
3851
303
|
</dd>
|
|
@@ -3861,7 +313,7 @@ await client.chat.streamChatResponse("chat_id");
|
|
|
3861
313
|
<dl>
|
|
3862
314
|
<dd>
|
|
3863
315
|
|
|
3864
|
-
**
|
|
316
|
+
**readableId:** `string`
|
|
3865
317
|
|
|
3866
318
|
</dd>
|
|
3867
319
|
</dl>
|
|
@@ -3869,7 +321,7 @@ await client.chat.streamChatResponse("chat_id");
|
|
|
3869
321
|
<dl>
|
|
3870
322
|
<dd>
|
|
3871
323
|
|
|
3872
|
-
**requestOptions:** `
|
|
324
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
3873
325
|
|
|
3874
326
|
</dd>
|
|
3875
327
|
</dl>
|
|
@@ -3880,9 +332,7 @@ await client.chat.streamChatResponse("chat_id");
|
|
|
3880
332
|
</dl>
|
|
3881
333
|
</details>
|
|
3882
334
|
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
335
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">deleteCollection</a>(readableId, { ...params }) -> AirweaveSDK.Collection</code></summary>
|
|
3886
336
|
<dl>
|
|
3887
337
|
<dd>
|
|
3888
338
|
|
|
@@ -3894,7 +344,16 @@ await client.chat.streamChatResponse("chat_id");
|
|
|
3894
344
|
<dl>
|
|
3895
345
|
<dd>
|
|
3896
346
|
|
|
3897
|
-
|
|
347
|
+
Delete a collection by its readable ID.
|
|
348
|
+
|
|
349
|
+
Args:
|
|
350
|
+
readable_id: The readable ID of the collection to delete
|
|
351
|
+
delete_data: Whether to delete the data in destinations
|
|
352
|
+
db: The database session
|
|
353
|
+
current_user: The current user
|
|
354
|
+
|
|
355
|
+
Returns:
|
|
356
|
+
The deleted collection
|
|
3898
357
|
|
|
3899
358
|
</dd>
|
|
3900
359
|
</dl>
|
|
@@ -3910,7 +369,7 @@ Get the DAG definition for a sync.
|
|
|
3910
369
|
<dd>
|
|
3911
370
|
|
|
3912
371
|
```typescript
|
|
3913
|
-
await client.
|
|
372
|
+
await client.collections.deleteCollection("readable_id");
|
|
3914
373
|
```
|
|
3915
374
|
|
|
3916
375
|
</dd>
|
|
@@ -3926,7 +385,15 @@ await client.dag.getSyncDag("sync_id");
|
|
|
3926
385
|
<dl>
|
|
3927
386
|
<dd>
|
|
3928
387
|
|
|
3929
|
-
**
|
|
388
|
+
**readableId:** `string`
|
|
389
|
+
|
|
390
|
+
</dd>
|
|
391
|
+
</dl>
|
|
392
|
+
|
|
393
|
+
<dl>
|
|
394
|
+
<dd>
|
|
395
|
+
|
|
396
|
+
**request:** `AirweaveSDK.DeleteCollectionCollectionsReadableIdDeleteRequest`
|
|
3930
397
|
|
|
3931
398
|
</dd>
|
|
3932
399
|
</dl>
|
|
@@ -3934,7 +401,7 @@ await client.dag.getSyncDag("sync_id");
|
|
|
3934
401
|
<dl>
|
|
3935
402
|
<dd>
|
|
3936
403
|
|
|
3937
|
-
**requestOptions:** `
|
|
404
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
3938
405
|
|
|
3939
406
|
</dd>
|
|
3940
407
|
</dl>
|
|
@@ -3945,7 +412,7 @@ await client.dag.getSyncDag("sync_id");
|
|
|
3945
412
|
</dl>
|
|
3946
413
|
</details>
|
|
3947
414
|
|
|
3948
|
-
<details><summary><code>client.
|
|
415
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">refreshAllSourceConnections</a>(readableId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
|
|
3949
416
|
<dl>
|
|
3950
417
|
<dd>
|
|
3951
418
|
|
|
@@ -3957,7 +424,16 @@ await client.dag.getSyncDag("sync_id");
|
|
|
3957
424
|
<dl>
|
|
3958
425
|
<dd>
|
|
3959
426
|
|
|
3960
|
-
|
|
427
|
+
Start sync jobs for all source connections in the collection.
|
|
428
|
+
|
|
429
|
+
Args:
|
|
430
|
+
readable_id: The readable ID of the collection
|
|
431
|
+
db: The database session
|
|
432
|
+
current_user: The current user
|
|
433
|
+
background_tasks: Background tasks for async operations
|
|
434
|
+
|
|
435
|
+
Returns:
|
|
436
|
+
A list of created sync jobs
|
|
3961
437
|
|
|
3962
438
|
</dd>
|
|
3963
439
|
</dl>
|
|
@@ -3973,22 +449,7 @@ Create a new DAG definition for a sync.
|
|
|
3973
449
|
<dd>
|
|
3974
450
|
|
|
3975
451
|
```typescript
|
|
3976
|
-
await client.
|
|
3977
|
-
name: "name",
|
|
3978
|
-
syncDagCreateSyncId: "sync_id",
|
|
3979
|
-
nodes: [
|
|
3980
|
-
{
|
|
3981
|
-
type: "source",
|
|
3982
|
-
name: "name",
|
|
3983
|
-
},
|
|
3984
|
-
],
|
|
3985
|
-
edges: [
|
|
3986
|
-
{
|
|
3987
|
-
fromNodeId: "from_node_id",
|
|
3988
|
-
toNodeId: "to_node_id",
|
|
3989
|
-
},
|
|
3990
|
-
],
|
|
3991
|
-
});
|
|
452
|
+
await client.collections.refreshAllSourceConnections("readable_id");
|
|
3992
453
|
```
|
|
3993
454
|
|
|
3994
455
|
</dd>
|
|
@@ -4004,15 +465,7 @@ await client.dag.createSyncDag("sync_id", {
|
|
|
4004
465
|
<dl>
|
|
4005
466
|
<dd>
|
|
4006
467
|
|
|
4007
|
-
**
|
|
4008
|
-
|
|
4009
|
-
</dd>
|
|
4010
|
-
</dl>
|
|
4011
|
-
|
|
4012
|
-
<dl>
|
|
4013
|
-
<dd>
|
|
4014
|
-
|
|
4015
|
-
**request:** `AirweaveSDK.SyncDagCreate`
|
|
468
|
+
**readableId:** `string`
|
|
4016
469
|
|
|
4017
470
|
</dd>
|
|
4018
471
|
</dl>
|
|
@@ -4020,7 +473,7 @@ await client.dag.createSyncDag("sync_id", {
|
|
|
4020
473
|
<dl>
|
|
4021
474
|
<dd>
|
|
4022
475
|
|
|
4023
|
-
**requestOptions:** `
|
|
476
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
4024
477
|
|
|
4025
478
|
</dd>
|
|
4026
479
|
</dl>
|
|
@@ -4031,7 +484,9 @@ await client.dag.createSyncDag("sync_id", {
|
|
|
4031
484
|
</dl>
|
|
4032
485
|
</details>
|
|
4033
486
|
|
|
4034
|
-
|
|
487
|
+
## Connections
|
|
488
|
+
|
|
489
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
4035
490
|
<dl>
|
|
4036
491
|
<dd>
|
|
4037
492
|
|
|
@@ -4043,7 +498,17 @@ await client.dag.createSyncDag("sync_id", {
|
|
|
4043
498
|
<dl>
|
|
4044
499
|
<dd>
|
|
4045
500
|
|
|
4046
|
-
|
|
501
|
+
Get a specific connection.
|
|
502
|
+
|
|
503
|
+
## Args:
|
|
504
|
+
|
|
505
|
+
connection_id: The ID of the connection to get.
|
|
506
|
+
db: The database session.
|
|
507
|
+
user: The current user.
|
|
508
|
+
|
|
509
|
+
## Returns:
|
|
510
|
+
|
|
511
|
+
schemas.Connection: The connection.
|
|
4047
512
|
|
|
4048
513
|
</dd>
|
|
4049
514
|
</dl>
|
|
@@ -4059,10 +524,7 @@ Update a DAG definition for a sync.
|
|
|
4059
524
|
<dd>
|
|
4060
525
|
|
|
4061
526
|
```typescript
|
|
4062
|
-
await client.
|
|
4063
|
-
name: "name",
|
|
4064
|
-
syncDagUpdateSyncId: "sync_id",
|
|
4065
|
-
});
|
|
527
|
+
await client.connections.getConnection("connection_id");
|
|
4066
528
|
```
|
|
4067
529
|
|
|
4068
530
|
</dd>
|
|
@@ -4078,15 +540,7 @@ await client.dag.updateSyncDag("sync_id", {
|
|
|
4078
540
|
<dl>
|
|
4079
541
|
<dd>
|
|
4080
542
|
|
|
4081
|
-
**
|
|
4082
|
-
|
|
4083
|
-
</dd>
|
|
4084
|
-
</dl>
|
|
4085
|
-
|
|
4086
|
-
<dl>
|
|
4087
|
-
<dd>
|
|
4088
|
-
|
|
4089
|
-
**request:** `AirweaveSDK.SyncDagUpdate`
|
|
543
|
+
**connectionId:** `string`
|
|
4090
544
|
|
|
4091
545
|
</dd>
|
|
4092
546
|
</dl>
|
|
@@ -4094,7 +548,7 @@ await client.dag.updateSyncDag("sync_id", {
|
|
|
4094
548
|
<dl>
|
|
4095
549
|
<dd>
|
|
4096
550
|
|
|
4097
|
-
**requestOptions:** `
|
|
551
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
4098
552
|
|
|
4099
553
|
</dd>
|
|
4100
554
|
</dl>
|
|
@@ -4105,7 +559,7 @@ await client.dag.updateSyncDag("sync_id", {
|
|
|
4105
559
|
</dl>
|
|
4106
560
|
</details>
|
|
4107
561
|
|
|
4108
|
-
<details><summary><code>client.
|
|
562
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
|
|
4109
563
|
<dl>
|
|
4110
564
|
<dd>
|
|
4111
565
|
|
|
@@ -4117,7 +571,16 @@ await client.dag.updateSyncDag("sync_id", {
|
|
|
4117
571
|
<dl>
|
|
4118
572
|
<dd>
|
|
4119
573
|
|
|
4120
|
-
|
|
574
|
+
Get all active connections for the current user across all integration types.
|
|
575
|
+
|
|
576
|
+
## Args:
|
|
577
|
+
|
|
578
|
+
db: The database session.
|
|
579
|
+
user: The current user.
|
|
580
|
+
|
|
581
|
+
## Returns:
|
|
582
|
+
|
|
583
|
+
list[schemas.Connection]: The list of connections.
|
|
4121
584
|
|
|
4122
585
|
</dd>
|
|
4123
586
|
</dl>
|
|
@@ -4133,9 +596,7 @@ Initialize a new DAG with source, entities, and destination.
|
|
|
4133
596
|
<dd>
|
|
4134
597
|
|
|
4135
598
|
```typescript
|
|
4136
|
-
await client.
|
|
4137
|
-
syncId: "sync_id",
|
|
4138
|
-
});
|
|
599
|
+
await client.connections.listAllConnectedIntegrations();
|
|
4139
600
|
```
|
|
4140
601
|
|
|
4141
602
|
</dd>
|
|
@@ -4151,15 +612,7 @@ await client.dag.initializeDag({
|
|
|
4151
612
|
<dl>
|
|
4152
613
|
<dd>
|
|
4153
614
|
|
|
4154
|
-
**
|
|
4155
|
-
|
|
4156
|
-
</dd>
|
|
4157
|
-
</dl>
|
|
4158
|
-
|
|
4159
|
-
<dl>
|
|
4160
|
-
<dd>
|
|
4161
|
-
|
|
4162
|
-
**requestOptions:** `Dag.RequestOptions`
|
|
615
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
4163
616
|
|
|
4164
617
|
</dd>
|
|
4165
618
|
</dl>
|
|
@@ -4170,9 +623,9 @@ await client.dag.initializeDag({
|
|
|
4170
623
|
</dl>
|
|
4171
624
|
</details>
|
|
4172
625
|
|
|
4173
|
-
##
|
|
626
|
+
## SourceConnections
|
|
4174
627
|
|
|
4175
|
-
<details><summary><code>client.
|
|
628
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listSourceConnections</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
|
|
4176
629
|
<dl>
|
|
4177
630
|
<dd>
|
|
4178
631
|
|
|
@@ -4184,7 +637,17 @@ await client.dag.initializeDag({
|
|
|
4184
637
|
<dl>
|
|
4185
638
|
<dd>
|
|
4186
639
|
|
|
4187
|
-
List all
|
|
640
|
+
List all source connections for the current user.
|
|
641
|
+
|
|
642
|
+
Args:
|
|
643
|
+
db: The database session
|
|
644
|
+
collection: The collection to filter by
|
|
645
|
+
skip: The number of connections to skip
|
|
646
|
+
limit: The number of connections to return
|
|
647
|
+
user: The current user
|
|
648
|
+
|
|
649
|
+
Returns:
|
|
650
|
+
A list of source connection list items with essential information
|
|
4188
651
|
|
|
4189
652
|
</dd>
|
|
4190
653
|
</dl>
|
|
@@ -4200,7 +663,7 @@ List all entity definitions for the current user's organization.
|
|
|
4200
663
|
<dd>
|
|
4201
664
|
|
|
4202
665
|
```typescript
|
|
4203
|
-
await client.
|
|
666
|
+
await client.sourceConnections.listSourceConnections();
|
|
4204
667
|
```
|
|
4205
668
|
|
|
4206
669
|
</dd>
|
|
@@ -4216,7 +679,15 @@ await client.entities.listEntityDefinitions();
|
|
|
4216
679
|
<dl>
|
|
4217
680
|
<dd>
|
|
4218
681
|
|
|
4219
|
-
**
|
|
682
|
+
**request:** `AirweaveSDK.ListSourceConnectionsSourceConnectionsGetRequest`
|
|
683
|
+
|
|
684
|
+
</dd>
|
|
685
|
+
</dl>
|
|
686
|
+
|
|
687
|
+
<dl>
|
|
688
|
+
<dd>
|
|
689
|
+
|
|
690
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4220
691
|
|
|
4221
692
|
</dd>
|
|
4222
693
|
</dl>
|
|
@@ -4227,7 +698,7 @@ await client.entities.listEntityDefinitions();
|
|
|
4227
698
|
</dl>
|
|
4228
699
|
</details>
|
|
4229
700
|
|
|
4230
|
-
<details><summary><code>client.
|
|
701
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">createSourceConnection</a>({ ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
4231
702
|
<dl>
|
|
4232
703
|
<dd>
|
|
4233
704
|
|
|
@@ -4239,7 +710,24 @@ await client.entities.listEntityDefinitions();
|
|
|
4239
710
|
<dl>
|
|
4240
711
|
<dd>
|
|
4241
712
|
|
|
4242
|
-
Create a new
|
|
713
|
+
Create a new source connection.
|
|
714
|
+
|
|
715
|
+
This endpoint creates:
|
|
716
|
+
|
|
717
|
+
1. An integration credential with the provided auth fields
|
|
718
|
+
2. A collection if not provided
|
|
719
|
+
3. The source connection
|
|
720
|
+
4. A sync configuration and DAG
|
|
721
|
+
5. A sync job if immediate execution is requested
|
|
722
|
+
|
|
723
|
+
Args:
|
|
724
|
+
db: The database session
|
|
725
|
+
source_connection_in: The source connection to create
|
|
726
|
+
user: The current user
|
|
727
|
+
background_tasks: Background tasks for async operations
|
|
728
|
+
|
|
729
|
+
Returns:
|
|
730
|
+
The created source connection
|
|
4243
731
|
|
|
4244
732
|
</dd>
|
|
4245
733
|
</dl>
|
|
@@ -4255,12 +743,9 @@ Create a new entity definition.
|
|
|
4255
743
|
<dd>
|
|
4256
744
|
|
|
4257
745
|
```typescript
|
|
4258
|
-
await client.
|
|
746
|
+
await client.sourceConnections.createSourceConnection({
|
|
4259
747
|
name: "name",
|
|
4260
|
-
|
|
4261
|
-
entitySchema: ["entity_schema"],
|
|
4262
|
-
moduleName: "module_name",
|
|
4263
|
-
className: "class_name",
|
|
748
|
+
shortName: "short_name",
|
|
4264
749
|
});
|
|
4265
750
|
```
|
|
4266
751
|
|
|
@@ -4277,7 +762,7 @@ await client.entities.createEntityDefinition({
|
|
|
4277
762
|
<dl>
|
|
4278
763
|
<dd>
|
|
4279
764
|
|
|
4280
|
-
**request:** `AirweaveSDK.
|
|
765
|
+
**request:** `AirweaveSDK.SourceConnectionCreate`
|
|
4281
766
|
|
|
4282
767
|
</dd>
|
|
4283
768
|
</dl>
|
|
@@ -4285,7 +770,7 @@ await client.entities.createEntityDefinition({
|
|
|
4285
770
|
<dl>
|
|
4286
771
|
<dd>
|
|
4287
772
|
|
|
4288
|
-
**requestOptions:** `
|
|
773
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4289
774
|
|
|
4290
775
|
</dd>
|
|
4291
776
|
</dl>
|
|
@@ -4296,7 +781,7 @@ await client.entities.createEntityDefinition({
|
|
|
4296
781
|
</dl>
|
|
4297
782
|
</details>
|
|
4298
783
|
|
|
4299
|
-
<details><summary><code>client.
|
|
784
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">getSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
4300
785
|
<dl>
|
|
4301
786
|
<dd>
|
|
4302
787
|
|
|
@@ -4308,7 +793,16 @@ await client.entities.createEntityDefinition({
|
|
|
4308
793
|
<dl>
|
|
4309
794
|
<dd>
|
|
4310
795
|
|
|
4311
|
-
|
|
796
|
+
Get a specific source connection by ID.
|
|
797
|
+
|
|
798
|
+
Args:
|
|
799
|
+
db: The database session
|
|
800
|
+
source_connection_id: The ID of the source connection
|
|
801
|
+
show_auth_fields: Whether to show the auth fields, default is False
|
|
802
|
+
user: The current user
|
|
803
|
+
|
|
804
|
+
Returns:
|
|
805
|
+
The source connection
|
|
4312
806
|
|
|
4313
807
|
</dd>
|
|
4314
808
|
</dl>
|
|
@@ -4324,13 +818,7 @@ Update an entity definition.
|
|
|
4324
818
|
<dd>
|
|
4325
819
|
|
|
4326
820
|
```typescript
|
|
4327
|
-
await client.
|
|
4328
|
-
name: "name",
|
|
4329
|
-
type: "file",
|
|
4330
|
-
entitySchema: ["entity_schema"],
|
|
4331
|
-
moduleName: "module_name",
|
|
4332
|
-
className: "class_name",
|
|
4333
|
-
});
|
|
821
|
+
await client.sourceConnections.getSourceConnection("source_connection_id");
|
|
4334
822
|
```
|
|
4335
823
|
|
|
4336
824
|
</dd>
|
|
@@ -4346,7 +834,7 @@ await client.entities.updateEntityDefinition("definition_id", {
|
|
|
4346
834
|
<dl>
|
|
4347
835
|
<dd>
|
|
4348
836
|
|
|
4349
|
-
**
|
|
837
|
+
**sourceConnectionId:** `string`
|
|
4350
838
|
|
|
4351
839
|
</dd>
|
|
4352
840
|
</dl>
|
|
@@ -4354,7 +842,7 @@ await client.entities.updateEntityDefinition("definition_id", {
|
|
|
4354
842
|
<dl>
|
|
4355
843
|
<dd>
|
|
4356
844
|
|
|
4357
|
-
**request:** `AirweaveSDK.
|
|
845
|
+
**request:** `AirweaveSDK.GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest`
|
|
4358
846
|
|
|
4359
847
|
</dd>
|
|
4360
848
|
</dl>
|
|
@@ -4362,7 +850,7 @@ await client.entities.updateEntityDefinition("definition_id", {
|
|
|
4362
850
|
<dl>
|
|
4363
851
|
<dd>
|
|
4364
852
|
|
|
4365
|
-
**requestOptions:** `
|
|
853
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4366
854
|
|
|
4367
855
|
</dd>
|
|
4368
856
|
</dl>
|
|
@@ -4373,7 +861,7 @@ await client.entities.updateEntityDefinition("definition_id", {
|
|
|
4373
861
|
</dl>
|
|
4374
862
|
</details>
|
|
4375
863
|
|
|
4376
|
-
<details><summary><code>client.
|
|
864
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">updateSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
4377
865
|
<dl>
|
|
4378
866
|
<dd>
|
|
4379
867
|
|
|
@@ -4385,7 +873,16 @@ await client.entities.updateEntityDefinition("definition_id", {
|
|
|
4385
873
|
<dl>
|
|
4386
874
|
<dd>
|
|
4387
875
|
|
|
4388
|
-
|
|
876
|
+
Update a source connection.
|
|
877
|
+
|
|
878
|
+
Args:
|
|
879
|
+
db: The database session
|
|
880
|
+
source_connection_id: The ID of the source connection to update
|
|
881
|
+
source_connection_in: The updated source connection data
|
|
882
|
+
user: The current user
|
|
883
|
+
|
|
884
|
+
Returns:
|
|
885
|
+
The updated source connection
|
|
4389
886
|
|
|
4390
887
|
</dd>
|
|
4391
888
|
</dl>
|
|
@@ -4401,7 +898,7 @@ List all entity relations for the current user's organization.
|
|
|
4401
898
|
<dd>
|
|
4402
899
|
|
|
4403
900
|
```typescript
|
|
4404
|
-
await client.
|
|
901
|
+
await client.sourceConnections.updateSourceConnection("source_connection_id");
|
|
4405
902
|
```
|
|
4406
903
|
|
|
4407
904
|
</dd>
|
|
@@ -4417,7 +914,23 @@ await client.entities.listEntityRelations();
|
|
|
4417
914
|
<dl>
|
|
4418
915
|
<dd>
|
|
4419
916
|
|
|
4420
|
-
**
|
|
917
|
+
**sourceConnectionId:** `string`
|
|
918
|
+
|
|
919
|
+
</dd>
|
|
920
|
+
</dl>
|
|
921
|
+
|
|
922
|
+
<dl>
|
|
923
|
+
<dd>
|
|
924
|
+
|
|
925
|
+
**request:** `AirweaveSDK.SourceConnectionUpdate`
|
|
926
|
+
|
|
927
|
+
</dd>
|
|
928
|
+
</dl>
|
|
929
|
+
|
|
930
|
+
<dl>
|
|
931
|
+
<dd>
|
|
932
|
+
|
|
933
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4421
934
|
|
|
4422
935
|
</dd>
|
|
4423
936
|
</dl>
|
|
@@ -4428,7 +941,7 @@ await client.entities.listEntityRelations();
|
|
|
4428
941
|
</dl>
|
|
4429
942
|
</details>
|
|
4430
943
|
|
|
4431
|
-
<details><summary><code>client.
|
|
944
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">deleteSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
4432
945
|
<dl>
|
|
4433
946
|
<dd>
|
|
4434
947
|
|
|
@@ -4440,7 +953,16 @@ await client.entities.listEntityRelations();
|
|
|
4440
953
|
<dl>
|
|
4441
954
|
<dd>
|
|
4442
955
|
|
|
4443
|
-
|
|
956
|
+
Delete a source connection and all related components.
|
|
957
|
+
|
|
958
|
+
Args:
|
|
959
|
+
db: The database session
|
|
960
|
+
source_connection_id: The ID of the source connection to delete
|
|
961
|
+
delete_data: Whether to delete the associated data in destinations
|
|
962
|
+
user: The current user
|
|
963
|
+
|
|
964
|
+
Returns:
|
|
965
|
+
The deleted source connection
|
|
4444
966
|
|
|
4445
967
|
</dd>
|
|
4446
968
|
</dl>
|
|
@@ -4456,11 +978,7 @@ Create a new entity relation.
|
|
|
4456
978
|
<dd>
|
|
4457
979
|
|
|
4458
980
|
```typescript
|
|
4459
|
-
await client.
|
|
4460
|
-
name: "name",
|
|
4461
|
-
fromEntityId: "from_entity_id",
|
|
4462
|
-
toEntityId: "to_entity_id",
|
|
4463
|
-
});
|
|
981
|
+
await client.sourceConnections.deleteSourceConnection("source_connection_id");
|
|
4464
982
|
```
|
|
4465
983
|
|
|
4466
984
|
</dd>
|
|
@@ -4476,7 +994,15 @@ await client.entities.createEntityRelation({
|
|
|
4476
994
|
<dl>
|
|
4477
995
|
<dd>
|
|
4478
996
|
|
|
4479
|
-
**
|
|
997
|
+
**sourceConnectionId:** `string`
|
|
998
|
+
|
|
999
|
+
</dd>
|
|
1000
|
+
</dl>
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
**request:** `AirweaveSDK.DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest`
|
|
4480
1006
|
|
|
4481
1007
|
</dd>
|
|
4482
1008
|
</dl>
|
|
@@ -4484,7 +1010,7 @@ await client.entities.createEntityRelation({
|
|
|
4484
1010
|
<dl>
|
|
4485
1011
|
<dd>
|
|
4486
1012
|
|
|
4487
|
-
**requestOptions:** `
|
|
1013
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4488
1014
|
|
|
4489
1015
|
</dd>
|
|
4490
1016
|
</dl>
|
|
@@ -4495,7 +1021,7 @@ await client.entities.createEntityRelation({
|
|
|
4495
1021
|
</dl>
|
|
4496
1022
|
</details>
|
|
4497
1023
|
|
|
4498
|
-
<details><summary><code>client.
|
|
1024
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">runSourceConnection</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob</code></summary>
|
|
4499
1025
|
<dl>
|
|
4500
1026
|
<dd>
|
|
4501
1027
|
|
|
@@ -4507,7 +1033,16 @@ await client.entities.createEntityRelation({
|
|
|
4507
1033
|
<dl>
|
|
4508
1034
|
<dd>
|
|
4509
1035
|
|
|
4510
|
-
|
|
1036
|
+
Trigger a sync run for a source connection.
|
|
1037
|
+
|
|
1038
|
+
Args:
|
|
1039
|
+
db: The database session
|
|
1040
|
+
source_connection_id: The ID of the source connection to run
|
|
1041
|
+
user: The current user
|
|
1042
|
+
background_tasks: Background tasks for async operations
|
|
1043
|
+
|
|
1044
|
+
Returns:
|
|
1045
|
+
The created sync job
|
|
4511
1046
|
|
|
4512
1047
|
</dd>
|
|
4513
1048
|
</dl>
|
|
@@ -4523,11 +1058,7 @@ Update an entity relation.
|
|
|
4523
1058
|
<dd>
|
|
4524
1059
|
|
|
4525
1060
|
```typescript
|
|
4526
|
-
await client.
|
|
4527
|
-
name: "name",
|
|
4528
|
-
fromEntityId: "from_entity_id",
|
|
4529
|
-
toEntityId: "to_entity_id",
|
|
4530
|
-
});
|
|
1061
|
+
await client.sourceConnections.runSourceConnection("source_connection_id");
|
|
4531
1062
|
```
|
|
4532
1063
|
|
|
4533
1064
|
</dd>
|
|
@@ -4543,15 +1074,7 @@ await client.entities.updateEntityRelation("relation_id", {
|
|
|
4543
1074
|
<dl>
|
|
4544
1075
|
<dd>
|
|
4545
1076
|
|
|
4546
|
-
**
|
|
4547
|
-
|
|
4548
|
-
</dd>
|
|
4549
|
-
</dl>
|
|
4550
|
-
|
|
4551
|
-
<dl>
|
|
4552
|
-
<dd>
|
|
4553
|
-
|
|
4554
|
-
**request:** `AirweaveSDK.EntityRelationUpdate`
|
|
1077
|
+
**sourceConnectionId:** `string`
|
|
4555
1078
|
|
|
4556
1079
|
</dd>
|
|
4557
1080
|
</dl>
|
|
@@ -4559,7 +1082,7 @@ await client.entities.updateEntityRelation("relation_id", {
|
|
|
4559
1082
|
<dl>
|
|
4560
1083
|
<dd>
|
|
4561
1084
|
|
|
4562
|
-
**requestOptions:** `
|
|
1085
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4563
1086
|
|
|
4564
1087
|
</dd>
|
|
4565
1088
|
</dl>
|
|
@@ -4570,7 +1093,7 @@ await client.entities.updateEntityRelation("relation_id", {
|
|
|
4570
1093
|
</dl>
|
|
4571
1094
|
</details>
|
|
4572
1095
|
|
|
4573
|
-
<details><summary><code>client.
|
|
1096
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listSourceConnectionJobs</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
|
|
4574
1097
|
<dl>
|
|
4575
1098
|
<dd>
|
|
4576
1099
|
|
|
@@ -4582,15 +1105,15 @@ await client.entities.updateEntityRelation("relation_id", {
|
|
|
4582
1105
|
<dl>
|
|
4583
1106
|
<dd>
|
|
4584
1107
|
|
|
4585
|
-
|
|
1108
|
+
List all sync jobs for a source connection.
|
|
4586
1109
|
|
|
4587
1110
|
Args:
|
|
4588
|
-
|
|
4589
|
-
|
|
4590
|
-
|
|
1111
|
+
db: The database session
|
|
1112
|
+
source_connection_id: The ID of the source connection
|
|
1113
|
+
user: The current user
|
|
4591
1114
|
|
|
4592
1115
|
Returns:
|
|
4593
|
-
|
|
1116
|
+
A list of sync jobs
|
|
4594
1117
|
|
|
4595
1118
|
</dd>
|
|
4596
1119
|
</dl>
|
|
@@ -4606,7 +1129,7 @@ List of entity definitions matching the provided IDs
|
|
|
4606
1129
|
<dd>
|
|
4607
1130
|
|
|
4608
1131
|
```typescript
|
|
4609
|
-
await client.
|
|
1132
|
+
await client.sourceConnections.listSourceConnectionJobs("source_connection_id");
|
|
4610
1133
|
```
|
|
4611
1134
|
|
|
4612
1135
|
</dd>
|
|
@@ -4622,7 +1145,7 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
|
4622
1145
|
<dl>
|
|
4623
1146
|
<dd>
|
|
4624
1147
|
|
|
4625
|
-
**
|
|
1148
|
+
**sourceConnectionId:** `string`
|
|
4626
1149
|
|
|
4627
1150
|
</dd>
|
|
4628
1151
|
</dl>
|
|
@@ -4630,7 +1153,7 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
|
4630
1153
|
<dl>
|
|
4631
1154
|
<dd>
|
|
4632
1155
|
|
|
4633
|
-
**requestOptions:** `
|
|
1156
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
4634
1157
|
|
|
4635
1158
|
</dd>
|
|
4636
1159
|
</dl>
|
|
@@ -4641,7 +1164,9 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
|
4641
1164
|
</dl>
|
|
4642
1165
|
</details>
|
|
4643
1166
|
|
|
4644
|
-
|
|
1167
|
+
## WhiteLabels
|
|
1168
|
+
|
|
1169
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
4645
1170
|
<dl>
|
|
4646
1171
|
<dd>
|
|
4647
1172
|
|
|
@@ -4653,7 +1178,16 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
|
4653
1178
|
<dl>
|
|
4654
1179
|
<dd>
|
|
4655
1180
|
|
|
4656
|
-
|
|
1181
|
+
List all white labels for the current user's organization.
|
|
1182
|
+
|
|
1183
|
+
## Args:
|
|
1184
|
+
|
|
1185
|
+
db: The database session
|
|
1186
|
+
current_user: The current user
|
|
1187
|
+
|
|
1188
|
+
## Returns:
|
|
1189
|
+
|
|
1190
|
+
list[schemas.WhiteLabel]: A list of white labels
|
|
4657
1191
|
|
|
4658
1192
|
</dd>
|
|
4659
1193
|
</dl>
|
|
@@ -4669,9 +1203,7 @@ Get all entity definitions for a given source.
|
|
|
4669
1203
|
<dd>
|
|
4670
1204
|
|
|
4671
1205
|
```typescript
|
|
4672
|
-
await client.
|
|
4673
|
-
sourceShortName: "source_short_name",
|
|
4674
|
-
});
|
|
1206
|
+
await client.whiteLabels.listWhiteLabels();
|
|
4675
1207
|
```
|
|
4676
1208
|
|
|
4677
1209
|
</dd>
|
|
@@ -4687,15 +1219,7 @@ await client.entities.getEntityDefinitionsBySourceShortName({
|
|
|
4687
1219
|
<dl>
|
|
4688
1220
|
<dd>
|
|
4689
1221
|
|
|
4690
|
-
**
|
|
4691
|
-
|
|
4692
|
-
</dd>
|
|
4693
|
-
</dl>
|
|
4694
|
-
|
|
4695
|
-
<dl>
|
|
4696
|
-
<dd>
|
|
4697
|
-
|
|
4698
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
1222
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
4699
1223
|
|
|
4700
1224
|
</dd>
|
|
4701
1225
|
</dl>
|
|
@@ -4706,9 +1230,7 @@ await client.entities.getEntityDefinitionsBySourceShortName({
|
|
|
4706
1230
|
</dl>
|
|
4707
1231
|
</details>
|
|
4708
1232
|
|
|
4709
|
-
|
|
4710
|
-
|
|
4711
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>() -> AirweaveSDK.Transformer[]</code></summary>
|
|
1233
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
4712
1234
|
<dl>
|
|
4713
1235
|
<dd>
|
|
4714
1236
|
|
|
@@ -4720,7 +1242,17 @@ await client.entities.getEntityDefinitionsBySourceShortName({
|
|
|
4720
1242
|
<dl>
|
|
4721
1243
|
<dd>
|
|
4722
1244
|
|
|
4723
|
-
|
|
1245
|
+
Create new white label integration.
|
|
1246
|
+
|
|
1247
|
+
## Args:
|
|
1248
|
+
|
|
1249
|
+
db: The database session
|
|
1250
|
+
current_user: The current user
|
|
1251
|
+
white_label_in: The white label to create
|
|
1252
|
+
|
|
1253
|
+
## Returns:
|
|
1254
|
+
|
|
1255
|
+
white_label (schemas.WhiteLabel): The created white label
|
|
4724
1256
|
|
|
4725
1257
|
</dd>
|
|
4726
1258
|
</dl>
|
|
@@ -4736,7 +1268,13 @@ List all transformers for the current user's organization.
|
|
|
4736
1268
|
<dd>
|
|
4737
1269
|
|
|
4738
1270
|
```typescript
|
|
4739
|
-
await client.
|
|
1271
|
+
await client.whiteLabels.createWhiteLabel({
|
|
1272
|
+
name: "name",
|
|
1273
|
+
sourceShortName: "source_short_name",
|
|
1274
|
+
redirectUrl: "redirect_url",
|
|
1275
|
+
clientId: "client_id",
|
|
1276
|
+
clientSecret: "client_secret",
|
|
1277
|
+
});
|
|
4740
1278
|
```
|
|
4741
1279
|
|
|
4742
1280
|
</dd>
|
|
@@ -4752,7 +1290,15 @@ await client.transformers.listTransformers();
|
|
|
4752
1290
|
<dl>
|
|
4753
1291
|
<dd>
|
|
4754
1292
|
|
|
4755
|
-
**
|
|
1293
|
+
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
1294
|
+
|
|
1295
|
+
</dd>
|
|
1296
|
+
</dl>
|
|
1297
|
+
|
|
1298
|
+
<dl>
|
|
1299
|
+
<dd>
|
|
1300
|
+
|
|
1301
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
4756
1302
|
|
|
4757
1303
|
</dd>
|
|
4758
1304
|
</dl>
|
|
@@ -4763,7 +1309,7 @@ await client.transformers.listTransformers();
|
|
|
4763
1309
|
</dl>
|
|
4764
1310
|
</details>
|
|
4765
1311
|
|
|
4766
|
-
<details><summary><code>client.
|
|
1312
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
4767
1313
|
<dl>
|
|
4768
1314
|
<dd>
|
|
4769
1315
|
|
|
@@ -4775,7 +1321,17 @@ await client.transformers.listTransformers();
|
|
|
4775
1321
|
<dl>
|
|
4776
1322
|
<dd>
|
|
4777
1323
|
|
|
4778
|
-
|
|
1324
|
+
Get a specific white label integration.
|
|
1325
|
+
|
|
1326
|
+
## Args:
|
|
1327
|
+
|
|
1328
|
+
db: The database session
|
|
1329
|
+
white_label_id: The ID of the white label to get
|
|
1330
|
+
current_user: The current user
|
|
1331
|
+
|
|
1332
|
+
## Returns:
|
|
1333
|
+
|
|
1334
|
+
white_label (schemas.WhiteLabel): The white label
|
|
4779
1335
|
|
|
4780
1336
|
</dd>
|
|
4781
1337
|
</dl>
|
|
@@ -4791,13 +1347,7 @@ Create a new transformer.
|
|
|
4791
1347
|
<dd>
|
|
4792
1348
|
|
|
4793
1349
|
```typescript
|
|
4794
|
-
await client.
|
|
4795
|
-
name: "name",
|
|
4796
|
-
methodName: "method_name",
|
|
4797
|
-
moduleName: "module_name",
|
|
4798
|
-
inputEntityDefinitionIds: ["input_entity_definition_ids"],
|
|
4799
|
-
outputEntityDefinitionIds: ["output_entity_definition_ids"],
|
|
4800
|
-
});
|
|
1350
|
+
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
4801
1351
|
```
|
|
4802
1352
|
|
|
4803
1353
|
</dd>
|
|
@@ -4813,7 +1363,7 @@ await client.transformers.createTransformer({
|
|
|
4813
1363
|
<dl>
|
|
4814
1364
|
<dd>
|
|
4815
1365
|
|
|
4816
|
-
**
|
|
1366
|
+
**whiteLabelId:** `string`
|
|
4817
1367
|
|
|
4818
1368
|
</dd>
|
|
4819
1369
|
</dl>
|
|
@@ -4821,7 +1371,7 @@ await client.transformers.createTransformer({
|
|
|
4821
1371
|
<dl>
|
|
4822
1372
|
<dd>
|
|
4823
1373
|
|
|
4824
|
-
**requestOptions:** `
|
|
1374
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
4825
1375
|
|
|
4826
1376
|
</dd>
|
|
4827
1377
|
</dl>
|
|
@@ -4832,7 +1382,7 @@ await client.transformers.createTransformer({
|
|
|
4832
1382
|
</dl>
|
|
4833
1383
|
</details>
|
|
4834
1384
|
|
|
4835
|
-
<details><summary><code>client.
|
|
1385
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
4836
1386
|
<dl>
|
|
4837
1387
|
<dd>
|
|
4838
1388
|
|
|
@@ -4844,7 +1394,18 @@ await client.transformers.createTransformer({
|
|
|
4844
1394
|
<dl>
|
|
4845
1395
|
<dd>
|
|
4846
1396
|
|
|
4847
|
-
Update a
|
|
1397
|
+
Update a white label integration.
|
|
1398
|
+
|
|
1399
|
+
## Args:
|
|
1400
|
+
|
|
1401
|
+
db: The database session
|
|
1402
|
+
current_user: The current user
|
|
1403
|
+
white_label_id: The ID of the white label to update
|
|
1404
|
+
white_label_in: The white label to update
|
|
1405
|
+
|
|
1406
|
+
## Returns:
|
|
1407
|
+
|
|
1408
|
+
white_label (schemas.WhiteLabel): The updated white label
|
|
4848
1409
|
|
|
4849
1410
|
</dd>
|
|
4850
1411
|
</dl>
|
|
@@ -4860,13 +1421,7 @@ Update a transformer.
|
|
|
4860
1421
|
<dd>
|
|
4861
1422
|
|
|
4862
1423
|
```typescript
|
|
4863
|
-
await client.
|
|
4864
|
-
name: "name",
|
|
4865
|
-
methodName: "method_name",
|
|
4866
|
-
moduleName: "module_name",
|
|
4867
|
-
inputEntityDefinitionIds: ["input_entity_definition_ids"],
|
|
4868
|
-
outputEntityDefinitionIds: ["output_entity_definition_ids"],
|
|
4869
|
-
});
|
|
1424
|
+
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
4870
1425
|
```
|
|
4871
1426
|
|
|
4872
1427
|
</dd>
|
|
@@ -4882,7 +1437,7 @@ await client.transformers.updateTransformer("transformer_id", {
|
|
|
4882
1437
|
<dl>
|
|
4883
1438
|
<dd>
|
|
4884
1439
|
|
|
4885
|
-
**
|
|
1440
|
+
**whiteLabelId:** `string`
|
|
4886
1441
|
|
|
4887
1442
|
</dd>
|
|
4888
1443
|
</dl>
|
|
@@ -4890,7 +1445,7 @@ await client.transformers.updateTransformer("transformer_id", {
|
|
|
4890
1445
|
<dl>
|
|
4891
1446
|
<dd>
|
|
4892
1447
|
|
|
4893
|
-
**request:** `AirweaveSDK.
|
|
1448
|
+
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
4894
1449
|
|
|
4895
1450
|
</dd>
|
|
4896
1451
|
</dl>
|
|
@@ -4898,7 +1453,7 @@ await client.transformers.updateTransformer("transformer_id", {
|
|
|
4898
1453
|
<dl>
|
|
4899
1454
|
<dd>
|
|
4900
1455
|
|
|
4901
|
-
**requestOptions:** `
|
|
1456
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
4902
1457
|
|
|
4903
1458
|
</dd>
|
|
4904
1459
|
</dl>
|
|
@@ -4909,9 +1464,7 @@ await client.transformers.updateTransformer("transformer_id", {
|
|
|
4909
1464
|
</dl>
|
|
4910
1465
|
</details>
|
|
4911
1466
|
|
|
4912
|
-
|
|
4913
|
-
|
|
4914
|
-
<details><summary><code>client.cursorDevelopment.<a href="/src/api/resources/cursorDevelopment/client/Client.ts">checkConnectionStatus</a>(shortName) -> AirweaveSDK.Connection[]</code></summary>
|
|
1467
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
4915
1468
|
<dl>
|
|
4916
1469
|
<dd>
|
|
4917
1470
|
|
|
@@ -4923,17 +1476,17 @@ await client.transformers.updateTransformer("transformer_id", {
|
|
|
4923
1476
|
<dl>
|
|
4924
1477
|
<dd>
|
|
4925
1478
|
|
|
4926
|
-
|
|
1479
|
+
Delete a white label integration.
|
|
4927
1480
|
|
|
4928
1481
|
## Args:
|
|
4929
1482
|
|
|
4930
1483
|
db: The database session
|
|
4931
|
-
|
|
4932
|
-
|
|
1484
|
+
current_user: The current user
|
|
1485
|
+
white_label_id: The ID of the white label to delete
|
|
4933
1486
|
|
|
4934
1487
|
## Returns:
|
|
4935
1488
|
|
|
4936
|
-
|
|
1489
|
+
white_label (schemas.WhiteLabel): The deleted white label
|
|
4937
1490
|
|
|
4938
1491
|
</dd>
|
|
4939
1492
|
</dl>
|
|
@@ -4949,7 +1502,7 @@ Check if a source connection exists for the given short_name.
|
|
|
4949
1502
|
<dd>
|
|
4950
1503
|
|
|
4951
1504
|
```typescript
|
|
4952
|
-
await client.
|
|
1505
|
+
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
4953
1506
|
```
|
|
4954
1507
|
|
|
4955
1508
|
</dd>
|
|
@@ -4965,7 +1518,7 @@ await client.cursorDevelopment.checkConnectionStatus("short_name");
|
|
|
4965
1518
|
<dl>
|
|
4966
1519
|
<dd>
|
|
4967
1520
|
|
|
4968
|
-
**
|
|
1521
|
+
**whiteLabelId:** `string`
|
|
4969
1522
|
|
|
4970
1523
|
</dd>
|
|
4971
1524
|
</dl>
|
|
@@ -4973,7 +1526,7 @@ await client.cursorDevelopment.checkConnectionStatus("short_name");
|
|
|
4973
1526
|
<dl>
|
|
4974
1527
|
<dd>
|
|
4975
1528
|
|
|
4976
|
-
**requestOptions:** `
|
|
1529
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
4977
1530
|
|
|
4978
1531
|
</dd>
|
|
4979
1532
|
</dl>
|
|
@@ -4984,7 +1537,7 @@ await client.cursorDevelopment.checkConnectionStatus("short_name");
|
|
|
4984
1537
|
</dl>
|
|
4985
1538
|
</details>
|
|
4986
1539
|
|
|
4987
|
-
<details><summary><code>client.
|
|
1540
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
4988
1541
|
<dl>
|
|
4989
1542
|
<dd>
|
|
4990
1543
|
|
|
@@ -4996,22 +1549,17 @@ await client.cursorDevelopment.checkConnectionStatus("short_name");
|
|
|
4996
1549
|
<dl>
|
|
4997
1550
|
<dd>
|
|
4998
1551
|
|
|
4999
|
-
|
|
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.
|
|
1552
|
+
List all syncs for a specific white label.
|
|
5004
1553
|
|
|
5005
1554
|
## Args:
|
|
5006
1555
|
|
|
1556
|
+
white_label_id: The ID of the white label to list syncs for
|
|
5007
1557
|
db: The database session
|
|
5008
|
-
|
|
5009
|
-
background_tasks: The background tasks
|
|
5010
|
-
user: The admin user
|
|
1558
|
+
current_user: The current user
|
|
5011
1559
|
|
|
5012
1560
|
## Returns:
|
|
5013
1561
|
|
|
5014
|
-
schemas.
|
|
1562
|
+
list[schemas.Sync]: A list of syncs
|
|
5015
1563
|
|
|
5016
1564
|
</dd>
|
|
5017
1565
|
</dl>
|
|
@@ -5027,7 +1575,7 @@ runs a sync on it.
|
|
|
5027
1575
|
<dd>
|
|
5028
1576
|
|
|
5029
1577
|
```typescript
|
|
5030
|
-
await client.
|
|
1578
|
+
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
5031
1579
|
```
|
|
5032
1580
|
|
|
5033
1581
|
</dd>
|
|
@@ -5043,7 +1591,7 @@ await client.cursorDevelopment.testSync("short_name");
|
|
|
5043
1591
|
<dl>
|
|
5044
1592
|
<dd>
|
|
5045
1593
|
|
|
5046
|
-
**
|
|
1594
|
+
**whiteLabelId:** `string`
|
|
5047
1595
|
|
|
5048
1596
|
</dd>
|
|
5049
1597
|
</dl>
|
|
@@ -5051,7 +1599,7 @@ await client.cursorDevelopment.testSync("short_name");
|
|
|
5051
1599
|
<dl>
|
|
5052
1600
|
<dd>
|
|
5053
1601
|
|
|
5054
|
-
**requestOptions:** `
|
|
1602
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
5055
1603
|
|
|
5056
1604
|
</dd>
|
|
5057
1605
|
</dl>
|