@airweave/sdk 0.2.22 → 0.2.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +15 -0
- package/Client.js +37 -12
- package/README.md +7 -15
- package/api/resources/apiKeys/client/Client.d.ts +78 -5
- package/api/resources/apiKeys/client/Client.js +252 -10
- package/api/{types → resources/apiKeys/client/requests}/ApiKeyCreate.d.ts +2 -1
- package/api/resources/{sync/client/requests/GetSyncSyncSyncIdGetRequest.d.ts → apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts} +3 -3
- package/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +11 -0
- package/api/resources/apiKeys/client/requests/index.d.ts +3 -1
- package/api/resources/chat/client/Client.d.ts +77 -0
- package/api/resources/chat/client/Client.js +227 -0
- package/api/resources/chat/client/index.d.ts +1 -0
- package/api/resources/chat/client/index.js +17 -0
- package/api/{types → resources/chat/client/requests}/ChatCreate.d.ts +5 -1
- package/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +11 -0
- package/api/resources/chat/client/requests/index.d.ts +2 -0
- package/api/resources/chat/index.d.ts +1 -0
- package/api/resources/chat/index.js +17 -0
- package/api/resources/connections/client/Client.d.ts +20 -48
- package/api/resources/connections/client/Client.js +30 -107
- package/api/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +3 -8
- package/api/resources/connections/client/requests/index.d.ts +0 -8
- package/api/resources/dag/client/Client.d.ts +81 -0
- package/api/resources/dag/client/Client.js +276 -0
- package/api/resources/dag/client/index.d.ts +1 -0
- package/api/resources/dag/client/index.js +17 -0
- package/api/resources/dag/client/requests/SyncDagCreate.d.ts +26 -0
- package/{dist/api/types → api/resources/dag/client/requests}/SyncDagUpdate.d.ts +7 -3
- package/api/resources/dag/client/requests/index.d.ts +2 -0
- package/api/resources/dag/index.d.ts +1 -0
- package/api/resources/dag/index.js +17 -0
- package/api/resources/embeddingModels/client/Client.d.ts +4 -10
- package/api/resources/embeddingModels/client/Client.js +7 -21
- package/api/resources/embeddingModels/client/index.d.ts +1 -1
- package/api/resources/embeddingModels/client/index.js +0 -15
- package/api/resources/entities/client/Client.d.ts +119 -0
- package/api/resources/entities/client/Client.js +480 -0
- package/api/resources/entities/client/index.d.ts +1 -0
- package/api/resources/entities/client/index.js +17 -0
- package/api/{types → resources/entities/client/requests}/EntityDefinitionCreate.d.ts +9 -2
- package/{dist/api/types → api/resources/entities/client/requests}/EntityRelationCreate.d.ts +6 -1
- package/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +12 -0
- package/api/resources/entities/client/requests/index.d.ts +3 -0
- package/api/resources/entities/index.d.ts +2 -0
- package/api/resources/entities/index.js +18 -0
- package/api/resources/entities/types/index.d.ts +1 -0
- package/api/resources/entities/types/index.js +17 -0
- package/api/resources/index.d.ts +10 -2
- package/api/resources/index.js +11 -3
- package/api/resources/search/client/Client.d.ts +1 -2
- package/api/resources/search/client/Client.js +5 -7
- package/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +1 -3
- package/api/resources/sources/client/Client.d.ts +4 -10
- package/api/resources/sources/client/Client.js +7 -21
- package/api/resources/sources/client/index.d.ts +1 -1
- package/api/resources/sources/client/index.js +0 -15
- package/api/resources/sync/client/Client.d.ts +19 -59
- package/api/resources/sync/client/Client.js +43 -125
- package/api/resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts +1 -4
- package/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +1 -4
- package/api/resources/sync/client/requests/ListSyncsSyncGetRequest.d.ts +1 -4
- package/api/resources/sync/client/requests/SyncCreate.d.ts +1 -12
- package/api/resources/sync/client/requests/SyncUpdate.d.ts +1 -11
- package/api/resources/sync/client/requests/index.d.ts +0 -5
- package/api/resources/transformers/client/Client.d.ts +58 -0
- package/api/resources/transformers/client/Client.js +199 -0
- package/api/resources/transformers/client/index.d.ts +1 -0
- package/api/resources/transformers/client/index.js +17 -0
- package/{dist/api/types → api/resources/transformers/client/requests}/TransformerCreate.d.ts +8 -1
- package/api/resources/transformers/client/requests/index.d.ts +1 -0
- package/api/resources/transformers/index.d.ts +1 -0
- package/api/resources/transformers/index.js +17 -0
- package/api/resources/users/client/Client.d.ts +48 -0
- package/api/resources/users/client/Client.js +135 -0
- package/api/resources/users/client/index.d.ts +1 -0
- package/api/resources/users/client/index.js +2 -0
- package/api/resources/users/index.d.ts +1 -0
- package/api/resources/users/index.js +17 -0
- package/api/resources/whiteLabels/client/Client.d.ts +15 -40
- package/api/resources/whiteLabels/client/Client.js +28 -96
- package/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts +0 -2
- package/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts +1 -8
- package/api/resources/whiteLabels/client/requests/index.d.ts +0 -6
- package/api/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +2 -0
- package/api/types/{DestinationWithConfigFields.d.ts → DestinationWithAuthenticationFields.d.ts} +2 -2
- package/api/types/{EmbeddingModelWithConfigFields.d.ts → EmbeddingModelWithAuthenticationFields.d.ts} +2 -2
- package/api/types/{SourceWithConfigFields.d.ts → SourceWithAuthenticationFields.d.ts} +2 -2
- package/api/types/index.d.ts +3 -11
- package/api/types/index.js +3 -11
- package/dist/Client.d.ts +15 -0
- package/dist/Client.js +37 -12
- package/dist/api/resources/apiKeys/client/Client.d.ts +78 -5
- package/dist/api/resources/apiKeys/client/Client.js +252 -10
- package/dist/api/{types → resources/apiKeys/client/requests}/ApiKeyCreate.d.ts +2 -1
- package/dist/api/resources/{sync/client/requests/GetSyncSyncSyncIdGetRequest.d.ts → apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts} +3 -3
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +11 -0
- package/dist/api/resources/apiKeys/client/requests/index.d.ts +3 -1
- package/dist/api/resources/chat/client/Client.d.ts +77 -0
- package/dist/api/resources/chat/client/Client.js +227 -0
- package/dist/api/resources/chat/client/index.d.ts +1 -0
- package/dist/api/resources/chat/client/index.js +17 -0
- package/dist/api/{types → resources/chat/client/requests}/ChatCreate.d.ts +5 -1
- package/dist/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +11 -0
- package/dist/api/resources/chat/client/requests/index.d.ts +2 -0
- package/dist/api/resources/chat/client/requests/index.js +2 -0
- package/dist/api/resources/chat/index.d.ts +1 -0
- package/dist/api/resources/chat/index.js +17 -0
- package/dist/api/resources/connections/client/Client.d.ts +20 -48
- package/dist/api/resources/connections/client/Client.js +30 -107
- package/dist/api/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +3 -8
- package/dist/api/resources/connections/client/requests/index.d.ts +0 -8
- package/dist/api/resources/dag/client/Client.d.ts +81 -0
- package/dist/api/resources/dag/client/Client.js +276 -0
- package/dist/api/resources/dag/client/index.d.ts +1 -0
- package/dist/api/resources/dag/client/index.js +17 -0
- package/dist/api/resources/dag/client/requests/SyncDagCreate.d.ts +26 -0
- package/{api/types → dist/api/resources/dag/client/requests}/SyncDagUpdate.d.ts +7 -3
- package/dist/api/resources/dag/client/requests/index.d.ts +2 -0
- package/dist/api/resources/dag/client/requests/index.js +2 -0
- package/dist/api/resources/dag/index.d.ts +1 -0
- package/dist/api/resources/dag/index.js +17 -0
- package/dist/api/resources/embeddingModels/client/Client.d.ts +4 -10
- package/dist/api/resources/embeddingModels/client/Client.js +7 -21
- package/dist/api/resources/embeddingModels/client/index.d.ts +1 -1
- package/dist/api/resources/embeddingModels/client/index.js +0 -15
- package/dist/api/resources/entities/client/Client.d.ts +119 -0
- package/dist/api/resources/entities/client/Client.js +480 -0
- package/dist/api/resources/entities/client/index.d.ts +1 -0
- package/dist/api/resources/entities/client/index.js +17 -0
- package/dist/api/{types → resources/entities/client/requests}/EntityDefinitionCreate.d.ts +9 -2
- package/{api/types → dist/api/resources/entities/client/requests}/EntityRelationCreate.d.ts +6 -1
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +12 -0
- package/dist/api/resources/entities/client/requests/index.d.ts +3 -0
- package/dist/api/resources/entities/client/requests/index.js +2 -0
- package/dist/api/resources/entities/index.d.ts +2 -0
- package/dist/api/resources/entities/index.js +18 -0
- package/dist/api/resources/entities/types/index.d.ts +1 -0
- package/dist/api/resources/entities/types/index.js +17 -0
- package/dist/api/resources/index.d.ts +10 -2
- package/dist/api/resources/index.js +11 -3
- package/dist/api/resources/search/client/Client.d.ts +1 -2
- package/dist/api/resources/search/client/Client.js +5 -7
- package/dist/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +1 -3
- package/dist/api/resources/sources/client/Client.d.ts +4 -10
- package/dist/api/resources/sources/client/Client.js +7 -21
- package/dist/api/resources/sources/client/index.d.ts +1 -1
- package/dist/api/resources/sources/client/index.js +0 -15
- package/dist/api/resources/sync/client/Client.d.ts +19 -59
- package/dist/api/resources/sync/client/Client.js +43 -125
- package/dist/api/resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts +1 -4
- package/dist/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +1 -4
- package/dist/api/resources/sync/client/requests/ListSyncsSyncGetRequest.d.ts +1 -4
- package/dist/api/resources/sync/client/requests/SyncCreate.d.ts +1 -12
- package/dist/api/resources/sync/client/requests/SyncUpdate.d.ts +1 -11
- package/dist/api/resources/sync/client/requests/index.d.ts +0 -5
- package/dist/api/resources/transformers/client/Client.d.ts +58 -0
- package/dist/api/resources/transformers/client/Client.js +199 -0
- package/dist/api/resources/transformers/client/index.d.ts +1 -0
- package/dist/api/resources/transformers/client/index.js +17 -0
- package/{api/types → dist/api/resources/transformers/client/requests}/TransformerCreate.d.ts +8 -1
- package/dist/api/resources/transformers/client/requests/index.d.ts +1 -0
- package/dist/api/resources/transformers/client/requests/index.js +2 -0
- package/dist/api/resources/transformers/index.d.ts +1 -0
- package/dist/api/resources/transformers/index.js +17 -0
- package/dist/api/resources/users/client/Client.d.ts +48 -0
- package/dist/api/resources/users/client/Client.js +135 -0
- package/dist/api/resources/users/client/index.d.ts +1 -0
- package/dist/api/resources/users/client/index.js +2 -0
- package/dist/api/resources/users/index.d.ts +1 -0
- package/dist/api/resources/users/index.js +17 -0
- package/dist/api/resources/whiteLabels/client/Client.d.ts +15 -40
- package/dist/api/resources/whiteLabels/client/Client.js +28 -96
- package/dist/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts +0 -2
- package/dist/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts +1 -8
- package/dist/api/resources/whiteLabels/client/requests/index.d.ts +0 -6
- package/dist/api/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +2 -0
- package/dist/api/types/{DestinationWithConfigFields.d.ts → DestinationWithAuthenticationFields.d.ts} +2 -2
- package/dist/api/types/{EmbeddingModelWithConfigFields.d.ts → EmbeddingModelWithAuthenticationFields.d.ts} +2 -2
- package/dist/api/types/{SourceWithConfigFields.d.ts → SourceWithAuthenticationFields.d.ts} +2 -2
- package/dist/api/types/index.d.ts +3 -11
- package/dist/api/types/index.js +3 -11
- package/dist/serialization/resources/apiKeys/client/index.d.ts +2 -0
- package/dist/serialization/resources/apiKeys/client/index.js +41 -0
- package/dist/serialization/resources/apiKeys/client/readApiKeys.d.ts +11 -0
- package/dist/serialization/resources/apiKeys/client/readApiKeys.js +42 -0
- package/dist/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +12 -0
- package/dist/serialization/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +1 -1
- package/dist/serialization/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/apiKeys/client/requests/index.js +5 -0
- package/dist/serialization/resources/apiKeys/index.d.ts +1 -0
- package/dist/serialization/resources/apiKeys/index.js +17 -0
- package/dist/serialization/resources/chat/client/index.d.ts +2 -0
- package/dist/serialization/resources/chat/client/index.js +41 -0
- package/dist/serialization/resources/chat/client/listChats.d.ts +11 -0
- package/dist/serialization/resources/chat/client/listChats.js +42 -0
- package/{serialization/types → dist/serialization/resources/chat/client/requests}/ChatCreate.d.ts +4 -4
- package/{serialization/types → dist/serialization/resources/chat/client/requests}/ChatCreate.js +1 -1
- package/dist/serialization/resources/chat/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/chat/client/requests/index.js +5 -0
- package/dist/serialization/resources/chat/index.d.ts +1 -0
- package/dist/serialization/resources/chat/index.js +17 -0
- package/dist/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +2 -2
- package/dist/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +1 -1
- package/dist/serialization/resources/dag/client/index.d.ts +1 -0
- package/dist/serialization/resources/dag/client/index.js +17 -0
- package/dist/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +18 -0
- package/{serialization/types → dist/serialization/resources/dag/client/requests}/SyncDagCreate.js +4 -4
- package/dist/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +18 -0
- package/dist/serialization/{types → resources/dag/client/requests}/SyncDagUpdate.js +4 -4
- package/dist/serialization/resources/dag/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/dag/client/requests/index.js +7 -0
- package/dist/serialization/resources/dag/index.d.ts +1 -0
- package/dist/serialization/resources/dag/index.js +17 -0
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +15 -0
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.js +43 -0
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +11 -0
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +42 -0
- package/dist/serialization/resources/entities/client/index.d.ts +5 -0
- package/dist/serialization/resources/entities/client/index.js +44 -0
- package/dist/serialization/resources/entities/client/listEntityDefinitions.d.ts +11 -0
- package/dist/serialization/resources/entities/client/listEntityDefinitions.js +42 -0
- package/dist/serialization/resources/entities/client/listEntityRelations.d.ts +11 -0
- package/dist/serialization/resources/entities/client/listEntityRelations.js +42 -0
- package/dist/serialization/{types → resources/entities/client/requests}/EntityDefinitionCreate.d.ts +6 -6
- package/dist/serialization/{types → resources/entities/client/requests}/EntityDefinitionCreate.js +3 -3
- package/dist/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +15 -0
- package/{serialization/types → dist/serialization/resources/entities/client/requests}/EntityRelationCreate.js +1 -1
- package/dist/serialization/resources/entities/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/entities/client/requests/index.js +7 -0
- package/dist/serialization/resources/entities/index.d.ts +2 -0
- package/dist/serialization/resources/entities/index.js +18 -0
- package/dist/serialization/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.d.ts +3 -3
- package/dist/serialization/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.js +1 -1
- package/dist/serialization/resources/entities/types/index.d.ts +1 -0
- package/dist/serialization/resources/entities/types/index.js +17 -0
- package/dist/serialization/resources/index.d.ts +11 -0
- package/dist/serialization/resources/index.js +12 -1
- package/dist/serialization/resources/sync/client/requests/SyncCreate.d.ts +1 -1
- package/dist/serialization/resources/sync/client/requests/SyncUpdate.d.ts +1 -1
- package/dist/serialization/resources/transformers/client/index.d.ts +2 -0
- package/dist/serialization/resources/transformers/client/index.js +41 -0
- package/dist/serialization/resources/transformers/client/listTransformers.d.ts +11 -0
- package/dist/serialization/resources/transformers/client/listTransformers.js +42 -0
- package/dist/serialization/{types → resources/transformers/client/requests}/TransformerCreate.d.ts +4 -4
- package/dist/serialization/{types → resources/transformers/client/requests}/TransformerCreate.js +1 -1
- package/dist/serialization/resources/transformers/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/transformers/client/requests/index.js +5 -0
- package/dist/serialization/resources/transformers/index.d.ts +1 -0
- package/dist/serialization/resources/transformers/index.js +17 -0
- package/dist/serialization/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts +1 -1
- package/dist/serialization/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts +1 -1
- package/dist/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +2 -0
- package/dist/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +2 -0
- package/dist/serialization/types/{DestinationWithConfigFields.d.ts → DestinationWithAuthenticationFields.d.ts} +3 -3
- package/{serialization/types/DestinationWithConfigFields.js → dist/serialization/types/DestinationWithAuthenticationFields.js} +3 -3
- package/{serialization/types/EmbeddingModelWithConfigFields.d.ts → dist/serialization/types/EmbeddingModelWithAuthenticationFields.d.ts} +3 -3
- package/{serialization/types/EmbeddingModelWithConfigFields.js → dist/serialization/types/EmbeddingModelWithAuthenticationFields.js} +3 -3
- package/dist/serialization/types/{SourceWithConfigFields.d.ts → SourceWithAuthenticationFields.d.ts} +3 -3
- package/dist/serialization/types/{SourceWithConfigFields.js → SourceWithAuthenticationFields.js} +3 -3
- package/dist/serialization/types/index.d.ts +3 -11
- package/dist/serialization/types/index.js +3 -11
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +1530 -612
- package/serialization/resources/apiKeys/client/index.d.ts +2 -0
- package/serialization/resources/apiKeys/client/index.js +41 -0
- package/serialization/resources/apiKeys/client/readApiKeys.d.ts +11 -0
- package/serialization/resources/apiKeys/client/readApiKeys.js +42 -0
- package/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +12 -0
- package/serialization/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +1 -1
- package/serialization/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/serialization/resources/apiKeys/client/requests/index.js +5 -0
- package/serialization/resources/apiKeys/index.d.ts +1 -0
- package/serialization/resources/apiKeys/index.js +17 -0
- package/serialization/resources/chat/client/index.d.ts +2 -0
- package/serialization/resources/chat/client/index.js +41 -0
- package/serialization/resources/chat/client/listChats.d.ts +11 -0
- package/serialization/resources/chat/client/listChats.js +42 -0
- package/{dist/serialization/types → serialization/resources/chat/client/requests}/ChatCreate.d.ts +4 -4
- package/{dist/serialization/types → serialization/resources/chat/client/requests}/ChatCreate.js +1 -1
- package/serialization/resources/chat/client/requests/index.d.ts +1 -0
- package/serialization/resources/chat/client/requests/index.js +5 -0
- package/serialization/resources/chat/index.d.ts +1 -0
- package/serialization/resources/chat/index.js +17 -0
- package/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +2 -2
- package/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +1 -1
- package/serialization/resources/dag/client/index.d.ts +1 -0
- package/serialization/resources/dag/client/index.js +17 -0
- package/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +18 -0
- package/{dist/serialization/types → serialization/resources/dag/client/requests}/SyncDagCreate.js +4 -4
- package/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +18 -0
- package/serialization/{types → resources/dag/client/requests}/SyncDagUpdate.js +4 -4
- package/serialization/resources/dag/client/requests/index.d.ts +2 -0
- package/serialization/resources/dag/client/requests/index.js +7 -0
- package/serialization/resources/dag/index.d.ts +1 -0
- package/serialization/resources/dag/index.js +17 -0
- package/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +15 -0
- package/serialization/resources/entities/client/getEntityDefinitionsByIds.js +43 -0
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +11 -0
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +42 -0
- package/serialization/resources/entities/client/index.d.ts +5 -0
- package/serialization/resources/entities/client/index.js +44 -0
- package/serialization/resources/entities/client/listEntityDefinitions.d.ts +11 -0
- package/serialization/resources/entities/client/listEntityDefinitions.js +42 -0
- package/serialization/resources/entities/client/listEntityRelations.d.ts +11 -0
- package/serialization/resources/entities/client/listEntityRelations.js +42 -0
- package/serialization/{types → resources/entities/client/requests}/EntityDefinitionCreate.d.ts +6 -6
- package/serialization/{types → resources/entities/client/requests}/EntityDefinitionCreate.js +3 -3
- package/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +15 -0
- package/{dist/serialization/types → serialization/resources/entities/client/requests}/EntityRelationCreate.js +1 -1
- package/serialization/resources/entities/client/requests/index.d.ts +2 -0
- package/serialization/resources/entities/client/requests/index.js +7 -0
- package/serialization/resources/entities/index.d.ts +2 -0
- package/serialization/resources/entities/index.js +18 -0
- package/serialization/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.d.ts +3 -3
- package/serialization/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.js +1 -1
- package/serialization/resources/entities/types/index.d.ts +1 -0
- package/serialization/resources/entities/types/index.js +17 -0
- package/serialization/resources/index.d.ts +11 -0
- package/serialization/resources/index.js +12 -1
- package/serialization/resources/sync/client/requests/SyncCreate.d.ts +1 -1
- package/serialization/resources/sync/client/requests/SyncUpdate.d.ts +1 -1
- package/serialization/resources/transformers/client/index.d.ts +2 -0
- package/serialization/resources/transformers/client/index.js +41 -0
- package/serialization/resources/transformers/client/listTransformers.d.ts +11 -0
- package/serialization/resources/transformers/client/listTransformers.js +42 -0
- package/serialization/{types → resources/transformers/client/requests}/TransformerCreate.d.ts +4 -4
- package/serialization/{types → resources/transformers/client/requests}/TransformerCreate.js +1 -1
- package/serialization/resources/transformers/client/requests/index.d.ts +1 -0
- package/serialization/resources/transformers/client/requests/index.js +5 -0
- package/serialization/resources/transformers/index.d.ts +1 -0
- package/serialization/resources/transformers/index.js +17 -0
- package/serialization/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts +1 -1
- package/serialization/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts +1 -1
- package/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +2 -0
- package/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +2 -0
- package/serialization/types/{DestinationWithConfigFields.d.ts → DestinationWithAuthenticationFields.d.ts} +3 -3
- package/{dist/serialization/types/DestinationWithConfigFields.js → serialization/types/DestinationWithAuthenticationFields.js} +3 -3
- package/{dist/serialization/types/EmbeddingModelWithConfigFields.d.ts → serialization/types/EmbeddingModelWithAuthenticationFields.d.ts} +3 -3
- package/{dist/serialization/types/EmbeddingModelWithConfigFields.js → serialization/types/EmbeddingModelWithAuthenticationFields.js} +3 -3
- package/serialization/types/{SourceWithConfigFields.d.ts → SourceWithAuthenticationFields.d.ts} +3 -3
- package/serialization/types/{SourceWithConfigFields.js → SourceWithAuthenticationFields.js} +3 -3
- package/serialization/types/index.d.ts +3 -11
- package/serialization/types/index.js +3 -11
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/DeleteConnectionConnectionsDeleteSourceConnectionIdDeleteRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/DisconnectSourceConnectionConnectionsDisconnectSourceConnectionIdPutRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/GetConnectionConnectionsDetailConnectionIdGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/GetConnectionCredentialsConnectionsCredentialsConnectionIdGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/GetOauth2WhiteLabelAuthUrlConnectionsOauth2WhiteLabelWhiteLabelIdAuthUrlGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/ListAllConnectedIntegrationsConnectionsListGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/ListConnectedIntegrationsConnectionsListIntegrationTypeGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/SendOauth2WhiteLabelCodeConnectionsOauth2WhiteLabelWhiteLabelIdCodePostRequest.d.ts +0 -14
- package/api/resources/embeddingModels/client/requests/ReadEmbeddingModelEmbeddingModelsDetailShortNameGetRequest.d.ts +0 -12
- package/api/resources/embeddingModels/client/requests/ReadEmbeddingModelsEmbeddingModelsListGetRequest.d.ts +0 -12
- package/api/resources/embeddingModels/client/requests/index.d.ts +0 -2
- package/api/resources/sources/client/requests/ReadSourceSourcesDetailShortNameGetRequest.d.ts +0 -12
- package/api/resources/sources/client/requests/ReadSourcesSourcesListGetRequest.d.ts +0 -12
- package/api/resources/sources/client/requests/index.d.ts +0 -2
- package/api/resources/sync/client/requests/GetSyncDagSyncSyncIdDagGetRequest.d.ts +0 -12
- package/api/resources/sync/client/requests/GetSyncJobSyncSyncIdJobJobIdGetRequest.d.ts +0 -12
- package/api/resources/sync/client/requests/GetSyncJobSyncSyncIdJobJobIdGetRequest.js +0 -5
- package/api/resources/sync/client/requests/GetSyncSyncSyncIdGetRequest.js +0 -5
- package/api/resources/sync/client/requests/ListSyncJobsSyncSyncIdJobsGetRequest.d.ts +0 -12
- package/api/resources/sync/client/requests/ListSyncJobsSyncSyncIdJobsGetRequest.js +0 -5
- package/api/resources/sync/client/requests/RunSyncSyncSyncIdRunPostRequest.d.ts +0 -12
- package/api/resources/sync/client/requests/RunSyncSyncSyncIdRunPostRequest.js +0 -5
- package/api/resources/whiteLabels/client/requests/DeleteWhiteLabelWhiteLabelsWhiteLabelIdDeleteRequest.d.ts +0 -12
- package/api/resources/whiteLabels/client/requests/DeleteWhiteLabelWhiteLabelsWhiteLabelIdDeleteRequest.js +0 -5
- package/api/resources/whiteLabels/client/requests/ExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePostRequest.d.ts +0 -14
- package/api/resources/whiteLabels/client/requests/ExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePostRequest.js +0 -5
- package/api/resources/whiteLabels/client/requests/GetWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlGetRequest.d.ts +0 -12
- package/api/resources/whiteLabels/client/requests/GetWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlGetRequest.js +0 -5
- package/api/resources/whiteLabels/client/requests/GetWhiteLabelWhiteLabelsWhiteLabelIdGetRequest.d.ts +0 -12
- package/api/resources/whiteLabels/client/requests/GetWhiteLabelWhiteLabelsWhiteLabelIdGetRequest.js +0 -5
- package/api/resources/whiteLabels/client/requests/ListWhiteLabelSyncsWhiteLabelsWhiteLabelIdSyncsGetRequest.d.ts +0 -12
- package/api/resources/whiteLabels/client/requests/ListWhiteLabelSyncsWhiteLabelsWhiteLabelIdSyncsGetRequest.js +0 -5
- package/api/resources/whiteLabels/client/requests/ListWhiteLabelsWhiteLabelsListGetRequest.d.ts +0 -12
- package/api/resources/whiteLabels/client/requests/ListWhiteLabelsWhiteLabelsListGetRequest.js +0 -5
- package/api/types/DestinationWithConfigFields.js +0 -5
- package/api/types/EmbeddingModelWithConfigFields.js +0 -5
- package/api/types/SourceWithConfigFields.js +0 -5
- package/api/types/SyncDagCreate.d.ts +0 -14
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.d.ts +0 -12
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/DeleteConnectionConnectionsDeleteSourceConnectionIdDeleteRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/DeleteConnectionConnectionsDeleteSourceConnectionIdDeleteRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/DisconnectSourceConnectionConnectionsDisconnectSourceConnectionIdPutRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/DisconnectSourceConnectionConnectionsDisconnectSourceConnectionIdPutRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/GetConnectionConnectionsDetailConnectionIdGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/GetConnectionConnectionsDetailConnectionIdGetRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/GetConnectionCredentialsConnectionsCredentialsConnectionIdGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/GetConnectionCredentialsConnectionsCredentialsConnectionIdGetRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/GetOauth2WhiteLabelAuthUrlConnectionsOauth2WhiteLabelWhiteLabelIdAuthUrlGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/GetOauth2WhiteLabelAuthUrlConnectionsOauth2WhiteLabelWhiteLabelIdAuthUrlGetRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/ListAllConnectedIntegrationsConnectionsListGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/ListAllConnectedIntegrationsConnectionsListGetRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/ListConnectedIntegrationsConnectionsListIntegrationTypeGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/ListConnectedIntegrationsConnectionsListIntegrationTypeGetRequest.js +0 -5
- package/dist/api/resources/connections/client/requests/SendOauth2WhiteLabelCodeConnectionsOauth2WhiteLabelWhiteLabelIdCodePostRequest.d.ts +0 -14
- package/dist/api/resources/connections/client/requests/SendOauth2WhiteLabelCodeConnectionsOauth2WhiteLabelWhiteLabelIdCodePostRequest.js +0 -5
- package/dist/api/resources/embeddingModels/client/requests/ReadEmbeddingModelEmbeddingModelsDetailShortNameGetRequest.d.ts +0 -12
- package/dist/api/resources/embeddingModels/client/requests/ReadEmbeddingModelEmbeddingModelsDetailShortNameGetRequest.js +0 -5
- package/dist/api/resources/embeddingModels/client/requests/ReadEmbeddingModelsEmbeddingModelsListGetRequest.d.ts +0 -12
- package/dist/api/resources/embeddingModels/client/requests/ReadEmbeddingModelsEmbeddingModelsListGetRequest.js +0 -5
- package/dist/api/resources/embeddingModels/client/requests/index.d.ts +0 -2
- package/dist/api/resources/sources/client/requests/ReadSourceSourcesDetailShortNameGetRequest.d.ts +0 -12
- package/dist/api/resources/sources/client/requests/ReadSourceSourcesDetailShortNameGetRequest.js +0 -5
- package/dist/api/resources/sources/client/requests/ReadSourcesSourcesListGetRequest.d.ts +0 -12
- package/dist/api/resources/sources/client/requests/ReadSourcesSourcesListGetRequest.js +0 -5
- package/dist/api/resources/sources/client/requests/index.d.ts +0 -2
- package/dist/api/resources/sync/client/requests/GetSyncDagSyncSyncIdDagGetRequest.d.ts +0 -12
- package/dist/api/resources/sync/client/requests/GetSyncDagSyncSyncIdDagGetRequest.js +0 -5
- package/dist/api/resources/sync/client/requests/GetSyncJobSyncSyncIdJobJobIdGetRequest.d.ts +0 -12
- package/dist/api/resources/sync/client/requests/GetSyncJobSyncSyncIdJobJobIdGetRequest.js +0 -5
- package/dist/api/resources/sync/client/requests/GetSyncSyncSyncIdGetRequest.js +0 -5
- package/dist/api/resources/sync/client/requests/ListSyncJobsSyncSyncIdJobsGetRequest.d.ts +0 -12
- package/dist/api/resources/sync/client/requests/ListSyncJobsSyncSyncIdJobsGetRequest.js +0 -5
- package/dist/api/resources/sync/client/requests/RunSyncSyncSyncIdRunPostRequest.d.ts +0 -12
- package/dist/api/resources/sync/client/requests/RunSyncSyncSyncIdRunPostRequest.js +0 -5
- package/dist/api/resources/whiteLabels/client/requests/DeleteWhiteLabelWhiteLabelsWhiteLabelIdDeleteRequest.d.ts +0 -12
- package/dist/api/resources/whiteLabels/client/requests/DeleteWhiteLabelWhiteLabelsWhiteLabelIdDeleteRequest.js +0 -5
- package/dist/api/resources/whiteLabels/client/requests/ExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePostRequest.d.ts +0 -14
- package/dist/api/resources/whiteLabels/client/requests/ExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePostRequest.js +0 -5
- package/dist/api/resources/whiteLabels/client/requests/GetWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlGetRequest.d.ts +0 -12
- package/dist/api/resources/whiteLabels/client/requests/GetWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlGetRequest.js +0 -5
- package/dist/api/resources/whiteLabels/client/requests/GetWhiteLabelWhiteLabelsWhiteLabelIdGetRequest.d.ts +0 -12
- package/dist/api/resources/whiteLabels/client/requests/GetWhiteLabelWhiteLabelsWhiteLabelIdGetRequest.js +0 -5
- package/dist/api/resources/whiteLabels/client/requests/ListWhiteLabelSyncsWhiteLabelsWhiteLabelIdSyncsGetRequest.d.ts +0 -12
- package/dist/api/resources/whiteLabels/client/requests/ListWhiteLabelSyncsWhiteLabelsWhiteLabelIdSyncsGetRequest.js +0 -5
- package/dist/api/resources/whiteLabels/client/requests/ListWhiteLabelsWhiteLabelsListGetRequest.d.ts +0 -12
- package/dist/api/resources/whiteLabels/client/requests/ListWhiteLabelsWhiteLabelsListGetRequest.js +0 -5
- package/dist/api/types/DestinationWithConfigFields.js +0 -5
- package/dist/api/types/EmbeddingModelWithConfigFields.js +0 -5
- package/dist/api/types/SourceWithConfigFields.js +0 -5
- package/dist/api/types/SyncDagCreate.d.ts +0 -14
- package/dist/serialization/types/ApiKeyCreate.d.ts +0 -12
- package/dist/serialization/types/EntityRelationCreate.d.ts +0 -15
- package/dist/serialization/types/SyncDagCreate.d.ts +0 -18
- package/dist/serialization/types/SyncDagUpdate.d.ts +0 -18
- package/serialization/types/ApiKeyCreate.d.ts +0 -12
- package/serialization/types/EntityRelationCreate.d.ts +0 -15
- package/serialization/types/SyncDagCreate.d.ts +0 -18
- package/serialization/types/SyncDagUpdate.d.ts +0 -18
- /package/api/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +0 -0
- /package/api/resources/apiKeys/client/requests/{ReadApiKeyApiKeysIdGetRequest.js → DeleteApiKeyApiKeysDeleteRequest.js} +0 -0
- /package/api/resources/{connections/client/requests/DeleteConnectionConnectionsDeleteSourceConnectionIdDeleteRequest.js → apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js} +0 -0
- /package/api/{types → resources/chat/client/requests}/ChatCreate.js +0 -0
- /package/api/resources/{connections/client/requests/DisconnectSourceConnectionConnectionsDisconnectSourceConnectionIdPutRequest.js → chat/client/requests/ListChatsChatGetRequest.js} +0 -0
- /package/api/resources/{embeddingModels → chat}/client/requests/index.js +0 -0
- /package/api/{types → resources/dag/client/requests}/SyncDagCreate.js +0 -0
- /package/api/{types → resources/dag/client/requests}/SyncDagUpdate.js +0 -0
- /package/api/resources/{sources → dag}/client/requests/index.js +0 -0
- /package/api/{types → resources/entities/client/requests}/EntityDefinitionCreate.js +0 -0
- /package/api/{types → resources/entities/client/requests}/EntityRelationCreate.js +0 -0
- /package/api/resources/{connections/client/requests/GetConnectionConnectionsDetailConnectionIdGetRequest.js → entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js} +0 -0
- /package/{dist/api/resources/embeddingModels → api/resources/entities}/client/requests/index.js +0 -0
- /package/api/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/api/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.js +0 -0
- /package/api/{types → resources/transformers/client/requests}/TransformerCreate.js +0 -0
- /package/{dist/api/resources/sources → api/resources/transformers}/client/requests/index.js +0 -0
- /package/api/{resources/connections/client/requests/GetConnectionCredentialsConnectionsCredentialsConnectionIdGetRequest.js → types/DestinationWithAuthenticationFields.js} +0 -0
- /package/api/{resources/connections/client/requests/GetOauth2WhiteLabelAuthUrlConnectionsOauth2WhiteLabelWhiteLabelIdAuthUrlGetRequest.js → types/EmbeddingModelWithAuthenticationFields.js} +0 -0
- /package/api/{resources/connections/client/requests/ListAllConnectedIntegrationsConnectionsListGetRequest.js → types/SourceWithAuthenticationFields.js} +0 -0
- /package/dist/api/{types → resources/apiKeys/client/requests}/ApiKeyCreate.js +0 -0
- /package/{api/resources/connections/client/requests/ListConnectedIntegrationsConnectionsListIntegrationTypeGetRequest.js → dist/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js} +0 -0
- /package/{api/resources/connections/client/requests/SendOauth2WhiteLabelCodeConnectionsOauth2WhiteLabelWhiteLabelIdCodePostRequest.js → dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js} +0 -0
- /package/dist/api/{types → resources/chat/client/requests}/ChatCreate.js +0 -0
- /package/{api/resources/embeddingModels/client/requests/ReadEmbeddingModelEmbeddingModelsDetailShortNameGetRequest.js → dist/api/resources/chat/client/requests/ListChatsChatGetRequest.js} +0 -0
- /package/dist/api/{types → resources/dag/client/requests}/SyncDagCreate.js +0 -0
- /package/dist/api/{types → resources/dag/client/requests}/SyncDagUpdate.js +0 -0
- /package/dist/api/{types → resources/entities/client/requests}/EntityDefinitionCreate.js +0 -0
- /package/dist/api/{types → resources/entities/client/requests}/EntityRelationCreate.js +0 -0
- /package/{api/resources/embeddingModels/client/requests/ReadEmbeddingModelsEmbeddingModelsListGetRequest.js → dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js} +0 -0
- /package/dist/api/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/dist/api/{types → resources/entities/types}/EntityDefinitionCreateEntitySchema.js +0 -0
- /package/dist/api/{types → resources/transformers/client/requests}/TransformerCreate.js +0 -0
- /package/{api/resources/sources/client/requests/ReadSourceSourcesDetailShortNameGetRequest.js → dist/api/types/DestinationWithAuthenticationFields.js} +0 -0
- /package/{api/resources/sources/client/requests/ReadSourcesSourcesListGetRequest.js → dist/api/types/EmbeddingModelWithAuthenticationFields.js} +0 -0
- /package/{api/resources/sync/client/requests/GetSyncDagSyncSyncIdDagGetRequest.js → dist/api/types/SourceWithAuthenticationFields.js} +0 -0
package/reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## ApiKeys
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">
|
|
5
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKeys</a>({ ...params }) -> AirweaveSDK.ApiKey[]</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,21 +14,18 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
Retrieve
|
|
17
|
+
Retrieve all API keys for the current user.
|
|
18
18
|
|
|
19
19
|
## Args:
|
|
20
20
|
|
|
21
21
|
db (AsyncSession): The database session.
|
|
22
|
-
|
|
22
|
+
skip (int): Number of records to skip for pagination.
|
|
23
|
+
limit (int): Maximum number of records to return.
|
|
23
24
|
user (schemas.User): The current user.
|
|
24
25
|
|
|
25
26
|
## Returns:
|
|
26
27
|
|
|
27
|
-
schemas.APIKey:
|
|
28
|
-
|
|
29
|
-
## Raises:
|
|
30
|
-
|
|
31
|
-
HTTPException: If the API key is not found.
|
|
28
|
+
List[schemas.APIKey]: A list of API keys.
|
|
32
29
|
|
|
33
30
|
</dd>
|
|
34
31
|
</dl>
|
|
@@ -44,9 +41,7 @@ Retrieve an API key by ID.
|
|
|
44
41
|
<dd>
|
|
45
42
|
|
|
46
43
|
```typescript
|
|
47
|
-
await client.apiKeys.
|
|
48
|
-
creds: "creds",
|
|
49
|
-
});
|
|
44
|
+
await client.apiKeys.readApiKeys();
|
|
50
45
|
```
|
|
51
46
|
|
|
52
47
|
</dd>
|
|
@@ -62,15 +57,7 @@ await client.apiKeys.readApiKey("id", {
|
|
|
62
57
|
<dl>
|
|
63
58
|
<dd>
|
|
64
59
|
|
|
65
|
-
**
|
|
66
|
-
|
|
67
|
-
</dd>
|
|
68
|
-
</dl>
|
|
69
|
-
|
|
70
|
-
<dl>
|
|
71
|
-
<dd>
|
|
72
|
-
|
|
73
|
-
**request:** `AirweaveSDK.ReadApiKeyApiKeysIdGetRequest`
|
|
60
|
+
**request:** `AirweaveSDK.ReadApiKeysApiKeysGetRequest`
|
|
74
61
|
|
|
75
62
|
</dd>
|
|
76
63
|
</dl>
|
|
@@ -89,9 +76,7 @@ await client.apiKeys.readApiKey("id", {
|
|
|
89
76
|
</dl>
|
|
90
77
|
</details>
|
|
91
78
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName, { ...params }) -> AirweaveSDK.SourceWithConfigFields</code></summary>
|
|
79
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">createApiKey</a>({ ...params }) -> AirweaveSDK.ApiKeyWithPlainKey</code></summary>
|
|
95
80
|
<dl>
|
|
96
81
|
<dd>
|
|
97
82
|
|
|
@@ -103,17 +88,20 @@ await client.apiKeys.readApiKey("id", {
|
|
|
103
88
|
<dl>
|
|
104
89
|
<dd>
|
|
105
90
|
|
|
106
|
-
|
|
91
|
+
Create a new API key for the current user.
|
|
92
|
+
|
|
93
|
+
Returns a temporary plain key for the user to store securely.
|
|
94
|
+
This is not stored in the database.
|
|
107
95
|
|
|
108
96
|
## Args:
|
|
109
97
|
|
|
110
98
|
db (AsyncSession): The database session.
|
|
111
|
-
|
|
99
|
+
api_key_in (schemas.APIKeyCreate): The API key creation data.
|
|
112
100
|
user (schemas.User): The current user.
|
|
113
101
|
|
|
114
102
|
## Returns:
|
|
115
103
|
|
|
116
|
-
schemas.
|
|
104
|
+
schemas.APIKeyWithPlainKey: The created API key object, including the key.
|
|
117
105
|
|
|
118
106
|
</dd>
|
|
119
107
|
</dl>
|
|
@@ -129,9 +117,7 @@ Get source by id.
|
|
|
129
117
|
<dd>
|
|
130
118
|
|
|
131
119
|
```typescript
|
|
132
|
-
await client.
|
|
133
|
-
creds: "creds",
|
|
134
|
-
});
|
|
120
|
+
await client.apiKeys.createApiKey();
|
|
135
121
|
```
|
|
136
122
|
|
|
137
123
|
</dd>
|
|
@@ -147,15 +133,7 @@ await client.sources.readSource("short_name", {
|
|
|
147
133
|
<dl>
|
|
148
134
|
<dd>
|
|
149
135
|
|
|
150
|
-
**
|
|
151
|
-
|
|
152
|
-
</dd>
|
|
153
|
-
</dl>
|
|
154
|
-
|
|
155
|
-
<dl>
|
|
156
|
-
<dd>
|
|
157
|
-
|
|
158
|
-
**request:** `AirweaveSDK.ReadSourceSourcesDetailShortNameGetRequest`
|
|
136
|
+
**request:** `AirweaveSDK.ApiKeyCreate`
|
|
159
137
|
|
|
160
138
|
</dd>
|
|
161
139
|
</dl>
|
|
@@ -163,7 +141,7 @@ await client.sources.readSource("short_name", {
|
|
|
163
141
|
<dl>
|
|
164
142
|
<dd>
|
|
165
143
|
|
|
166
|
-
**requestOptions:** `
|
|
144
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
167
145
|
|
|
168
146
|
</dd>
|
|
169
147
|
</dl>
|
|
@@ -174,7 +152,7 @@ await client.sources.readSource("short_name", {
|
|
|
174
152
|
</dl>
|
|
175
153
|
</details>
|
|
176
154
|
|
|
177
|
-
<details><summary><code>client.
|
|
155
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">deleteApiKey</a>({ ...params }) -> AirweaveSDK.ApiKey</code></summary>
|
|
178
156
|
<dl>
|
|
179
157
|
<dd>
|
|
180
158
|
|
|
@@ -186,16 +164,21 @@ await client.sources.readSource("short_name", {
|
|
|
186
164
|
<dl>
|
|
187
165
|
<dd>
|
|
188
166
|
|
|
189
|
-
|
|
167
|
+
Delete an API key.
|
|
190
168
|
|
|
191
169
|
## Args:
|
|
192
170
|
|
|
193
|
-
db: The database session
|
|
194
|
-
|
|
171
|
+
db (AsyncSession): The database session.
|
|
172
|
+
id (UUID): The ID of the API key.
|
|
173
|
+
user (schemas.User): The current user.
|
|
195
174
|
|
|
196
175
|
## Returns:
|
|
197
176
|
|
|
198
|
-
|
|
177
|
+
schemas.APIKey: The revoked API key object.
|
|
178
|
+
|
|
179
|
+
## Raises:
|
|
180
|
+
|
|
181
|
+
HTTPException: If the API key is not found.
|
|
199
182
|
|
|
200
183
|
</dd>
|
|
201
184
|
</dl>
|
|
@@ -211,8 +194,8 @@ Get all sources for the current user.
|
|
|
211
194
|
<dd>
|
|
212
195
|
|
|
213
196
|
```typescript
|
|
214
|
-
await client.
|
|
215
|
-
|
|
197
|
+
await client.apiKeys.deleteApiKey({
|
|
198
|
+
id: "id",
|
|
216
199
|
});
|
|
217
200
|
```
|
|
218
201
|
|
|
@@ -229,7 +212,7 @@ await client.sources.readSources({
|
|
|
229
212
|
<dl>
|
|
230
213
|
<dd>
|
|
231
214
|
|
|
232
|
-
**request:** `AirweaveSDK.
|
|
215
|
+
**request:** `AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest`
|
|
233
216
|
|
|
234
217
|
</dd>
|
|
235
218
|
</dl>
|
|
@@ -237,7 +220,7 @@ await client.sources.readSources({
|
|
|
237
220
|
<dl>
|
|
238
221
|
<dd>
|
|
239
222
|
|
|
240
|
-
**requestOptions:** `
|
|
223
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
241
224
|
|
|
242
225
|
</dd>
|
|
243
226
|
</dl>
|
|
@@ -248,9 +231,7 @@ await client.sources.readSources({
|
|
|
248
231
|
</dl>
|
|
249
232
|
</details>
|
|
250
233
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName, { ...params }) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
|
|
234
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKey</a>(id) -> AirweaveSDK.ApiKey</code></summary>
|
|
254
235
|
<dl>
|
|
255
236
|
<dd>
|
|
256
237
|
|
|
@@ -262,17 +243,21 @@ await client.sources.readSources({
|
|
|
262
243
|
<dl>
|
|
263
244
|
<dd>
|
|
264
245
|
|
|
265
|
-
|
|
246
|
+
Retrieve an API key by ID.
|
|
266
247
|
|
|
267
248
|
## Args:
|
|
268
249
|
|
|
269
250
|
db (AsyncSession): The database session.
|
|
270
|
-
|
|
251
|
+
id (UUID): The ID of the API key.
|
|
271
252
|
user (schemas.User): The current user.
|
|
272
253
|
|
|
273
254
|
## Returns:
|
|
274
255
|
|
|
275
|
-
schemas.
|
|
256
|
+
schemas.APIKey: The API key object.
|
|
257
|
+
|
|
258
|
+
## Raises:
|
|
259
|
+
|
|
260
|
+
HTTPException: If the API key is not found.
|
|
276
261
|
|
|
277
262
|
</dd>
|
|
278
263
|
</dl>
|
|
@@ -288,9 +273,7 @@ Get embedding model by id.
|
|
|
288
273
|
<dd>
|
|
289
274
|
|
|
290
275
|
```typescript
|
|
291
|
-
await client.
|
|
292
|
-
creds: "creds",
|
|
293
|
-
});
|
|
276
|
+
await client.apiKeys.readApiKey("id");
|
|
294
277
|
```
|
|
295
278
|
|
|
296
279
|
</dd>
|
|
@@ -306,15 +289,7 @@ await client.embeddingModels.readEmbeddingModel("short_name", {
|
|
|
306
289
|
<dl>
|
|
307
290
|
<dd>
|
|
308
291
|
|
|
309
|
-
**
|
|
310
|
-
|
|
311
|
-
</dd>
|
|
312
|
-
</dl>
|
|
313
|
-
|
|
314
|
-
<dl>
|
|
315
|
-
<dd>
|
|
316
|
-
|
|
317
|
-
**request:** `AirweaveSDK.ReadEmbeddingModelEmbeddingModelsDetailShortNameGetRequest`
|
|
292
|
+
**id:** `string`
|
|
318
293
|
|
|
319
294
|
</dd>
|
|
320
295
|
</dl>
|
|
@@ -322,7 +297,7 @@ await client.embeddingModels.readEmbeddingModel("short_name", {
|
|
|
322
297
|
<dl>
|
|
323
298
|
<dd>
|
|
324
299
|
|
|
325
|
-
**requestOptions:** `
|
|
300
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
326
301
|
|
|
327
302
|
</dd>
|
|
328
303
|
</dl>
|
|
@@ -333,7 +308,9 @@ await client.embeddingModels.readEmbeddingModel("short_name", {
|
|
|
333
308
|
</dl>
|
|
334
309
|
</details>
|
|
335
310
|
|
|
336
|
-
|
|
311
|
+
## Users
|
|
312
|
+
|
|
313
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">readUser</a>() -> AirweaveSDK.User</code></summary>
|
|
337
314
|
<dl>
|
|
338
315
|
<dd>
|
|
339
316
|
|
|
@@ -345,16 +322,15 @@ await client.embeddingModels.readEmbeddingModel("short_name", {
|
|
|
345
322
|
<dl>
|
|
346
323
|
<dd>
|
|
347
324
|
|
|
348
|
-
Get
|
|
325
|
+
Get current user.
|
|
349
326
|
|
|
350
327
|
## Args:
|
|
351
328
|
|
|
352
|
-
|
|
353
|
-
user (schemas.User): The current user.
|
|
329
|
+
current_user (User): The current user.
|
|
354
330
|
|
|
355
331
|
## Returns:
|
|
356
332
|
|
|
357
|
-
|
|
333
|
+
schemas.User: The user object.
|
|
358
334
|
|
|
359
335
|
</dd>
|
|
360
336
|
</dl>
|
|
@@ -370,9 +346,7 @@ Get all embedding models.
|
|
|
370
346
|
<dd>
|
|
371
347
|
|
|
372
348
|
```typescript
|
|
373
|
-
await client.
|
|
374
|
-
creds: "creds",
|
|
375
|
-
});
|
|
349
|
+
await client.users.readUser();
|
|
376
350
|
```
|
|
377
351
|
|
|
378
352
|
</dd>
|
|
@@ -388,15 +362,7 @@ await client.embeddingModels.readEmbeddingModels({
|
|
|
388
362
|
<dl>
|
|
389
363
|
<dd>
|
|
390
364
|
|
|
391
|
-
**
|
|
392
|
-
|
|
393
|
-
</dd>
|
|
394
|
-
</dl>
|
|
395
|
-
|
|
396
|
-
<dl>
|
|
397
|
-
<dd>
|
|
398
|
-
|
|
399
|
-
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
365
|
+
**requestOptions:** `Users.RequestOptions`
|
|
400
366
|
|
|
401
367
|
</dd>
|
|
402
368
|
</dl>
|
|
@@ -407,9 +373,9 @@ await client.embeddingModels.readEmbeddingModels({
|
|
|
407
373
|
</dl>
|
|
408
374
|
</details>
|
|
409
375
|
|
|
410
|
-
##
|
|
376
|
+
## Sources
|
|
411
377
|
|
|
412
|
-
<details><summary><code>client.
|
|
378
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithAuthenticationFields</code></summary>
|
|
413
379
|
<dl>
|
|
414
380
|
<dd>
|
|
415
381
|
|
|
@@ -421,17 +387,17 @@ await client.embeddingModels.readEmbeddingModels({
|
|
|
421
387
|
<dl>
|
|
422
388
|
<dd>
|
|
423
389
|
|
|
424
|
-
Get
|
|
390
|
+
Get source by id.
|
|
425
391
|
|
|
426
392
|
## Args:
|
|
427
393
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
user: The current user.
|
|
394
|
+
db (AsyncSession): The database session.
|
|
395
|
+
short_name (str): The short name of the source.
|
|
396
|
+
user (schemas.User): The current user.
|
|
431
397
|
|
|
432
398
|
## Returns:
|
|
433
399
|
|
|
434
|
-
schemas.
|
|
400
|
+
schemas.Source: The source object.
|
|
435
401
|
|
|
436
402
|
</dd>
|
|
437
403
|
</dl>
|
|
@@ -447,9 +413,7 @@ Get a specific connection.
|
|
|
447
413
|
<dd>
|
|
448
414
|
|
|
449
415
|
```typescript
|
|
450
|
-
await client.
|
|
451
|
-
creds: "creds",
|
|
452
|
-
});
|
|
416
|
+
await client.sources.readSource("short_name");
|
|
453
417
|
```
|
|
454
418
|
|
|
455
419
|
</dd>
|
|
@@ -465,15 +429,7 @@ await client.connections.getConnection("connection_id", {
|
|
|
465
429
|
<dl>
|
|
466
430
|
<dd>
|
|
467
431
|
|
|
468
|
-
**
|
|
469
|
-
|
|
470
|
-
</dd>
|
|
471
|
-
</dl>
|
|
472
|
-
|
|
473
|
-
<dl>
|
|
474
|
-
<dd>
|
|
475
|
-
|
|
476
|
-
**request:** `AirweaveSDK.GetConnectionConnectionsDetailConnectionIdGetRequest`
|
|
432
|
+
**shortName:** `string`
|
|
477
433
|
|
|
478
434
|
</dd>
|
|
479
435
|
</dl>
|
|
@@ -481,7 +437,7 @@ await client.connections.getConnection("connection_id", {
|
|
|
481
437
|
<dl>
|
|
482
438
|
<dd>
|
|
483
439
|
|
|
484
|
-
**requestOptions:** `
|
|
440
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
485
441
|
|
|
486
442
|
</dd>
|
|
487
443
|
</dl>
|
|
@@ -492,7 +448,7 @@ await client.connections.getConnection("connection_id", {
|
|
|
492
448
|
</dl>
|
|
493
449
|
</details>
|
|
494
450
|
|
|
495
|
-
<details><summary><code>client.
|
|
451
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
|
|
496
452
|
<dl>
|
|
497
453
|
<dd>
|
|
498
454
|
|
|
@@ -504,16 +460,16 @@ await client.connections.getConnection("connection_id", {
|
|
|
504
460
|
<dl>
|
|
505
461
|
<dd>
|
|
506
462
|
|
|
507
|
-
Get all
|
|
463
|
+
Get all sources for the current user.
|
|
508
464
|
|
|
509
465
|
## Args:
|
|
510
466
|
|
|
511
|
-
db: The database session
|
|
512
|
-
user: The current user
|
|
467
|
+
db: The database session
|
|
468
|
+
user: The current user
|
|
513
469
|
|
|
514
470
|
## Returns:
|
|
515
471
|
|
|
516
|
-
list[schemas.
|
|
472
|
+
list[schemas.Source]: The list of sources.
|
|
517
473
|
|
|
518
474
|
</dd>
|
|
519
475
|
</dl>
|
|
@@ -529,9 +485,7 @@ Get all active connections for the current user across all integration types.
|
|
|
529
485
|
<dd>
|
|
530
486
|
|
|
531
487
|
```typescript
|
|
532
|
-
await client.
|
|
533
|
-
creds: "creds",
|
|
534
|
-
});
|
|
488
|
+
await client.sources.readSources();
|
|
535
489
|
```
|
|
536
490
|
|
|
537
491
|
</dd>
|
|
@@ -547,15 +501,7 @@ await client.connections.listAllConnectedIntegrations({
|
|
|
547
501
|
<dl>
|
|
548
502
|
<dd>
|
|
549
503
|
|
|
550
|
-
**
|
|
551
|
-
|
|
552
|
-
</dd>
|
|
553
|
-
</dl>
|
|
554
|
-
|
|
555
|
-
<dl>
|
|
556
|
-
<dd>
|
|
557
|
-
|
|
558
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
504
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
559
505
|
|
|
560
506
|
</dd>
|
|
561
507
|
</dl>
|
|
@@ -566,7 +512,9 @@ await client.connections.listAllConnectedIntegrations({
|
|
|
566
512
|
</dl>
|
|
567
513
|
</details>
|
|
568
514
|
|
|
569
|
-
|
|
515
|
+
## EmbeddingModels
|
|
516
|
+
|
|
517
|
+
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithAuthenticationFields</code></summary>
|
|
570
518
|
<dl>
|
|
571
519
|
<dd>
|
|
572
520
|
|
|
@@ -578,17 +526,17 @@ await client.connections.listAllConnectedIntegrations({
|
|
|
578
526
|
<dl>
|
|
579
527
|
<dd>
|
|
580
528
|
|
|
581
|
-
Get
|
|
529
|
+
Get embedding model by id.
|
|
582
530
|
|
|
583
531
|
## Args:
|
|
584
532
|
|
|
585
|
-
integration_type (IntegrationType): The type of integration to get connections for.
|
|
586
533
|
db (AsyncSession): The database session.
|
|
534
|
+
short_name (str): The short name of the embedding model.
|
|
587
535
|
user (schemas.User): The current user.
|
|
588
536
|
|
|
589
537
|
## Returns:
|
|
590
538
|
|
|
591
|
-
|
|
539
|
+
schemas.EmbeddingModel: The embedding model object.
|
|
592
540
|
|
|
593
541
|
</dd>
|
|
594
542
|
</dl>
|
|
@@ -604,9 +552,7 @@ Get all integrations of specified type connected to the current user.
|
|
|
604
552
|
<dd>
|
|
605
553
|
|
|
606
554
|
```typescript
|
|
607
|
-
await client.
|
|
608
|
-
creds: "creds",
|
|
609
|
-
});
|
|
555
|
+
await client.embeddingModels.readEmbeddingModel("short_name");
|
|
610
556
|
```
|
|
611
557
|
|
|
612
558
|
</dd>
|
|
@@ -622,15 +568,7 @@ await client.connections.listConnectedIntegrations("source", {
|
|
|
622
568
|
<dl>
|
|
623
569
|
<dd>
|
|
624
570
|
|
|
625
|
-
**
|
|
626
|
-
|
|
627
|
-
</dd>
|
|
628
|
-
</dl>
|
|
629
|
-
|
|
630
|
-
<dl>
|
|
631
|
-
<dd>
|
|
632
|
-
|
|
633
|
-
**request:** `AirweaveSDK.ListConnectedIntegrationsConnectionsListIntegrationTypeGetRequest`
|
|
571
|
+
**shortName:** `string`
|
|
634
572
|
|
|
635
573
|
</dd>
|
|
636
574
|
</dl>
|
|
@@ -638,7 +576,7 @@ await client.connections.listConnectedIntegrations("source", {
|
|
|
638
576
|
<dl>
|
|
639
577
|
<dd>
|
|
640
578
|
|
|
641
|
-
**requestOptions:** `
|
|
579
|
+
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
642
580
|
|
|
643
581
|
</dd>
|
|
644
582
|
</dl>
|
|
@@ -649,7 +587,7 @@ await client.connections.listConnectedIntegrations("source", {
|
|
|
649
587
|
</dl>
|
|
650
588
|
</details>
|
|
651
589
|
|
|
652
|
-
<details><summary><code>client.
|
|
590
|
+
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModels</a>() -> AirweaveSDK.EmbeddingModel[]</code></summary>
|
|
653
591
|
<dl>
|
|
654
592
|
<dd>
|
|
655
593
|
|
|
@@ -661,29 +599,16 @@ await client.connections.listConnectedIntegrations("source", {
|
|
|
661
599
|
<dl>
|
|
662
600
|
<dd>
|
|
663
601
|
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
Expects a POST body with:
|
|
667
|
-
|
|
668
|
-
```json
|
|
669
|
-
{
|
|
670
|
-
"name": "required connection name",
|
|
671
|
-
... other config fields specific to the integration type ...
|
|
672
|
-
}
|
|
673
|
-
```
|
|
602
|
+
Get all embedding models.
|
|
674
603
|
|
|
675
604
|
## Args:
|
|
676
605
|
|
|
677
|
-
db: The database session.
|
|
678
|
-
|
|
679
|
-
short_name: The short name of the integration to connect to.
|
|
680
|
-
name: The name of the connection.
|
|
681
|
-
config_fields: The config fields for the integration.
|
|
682
|
-
user: The current user.
|
|
606
|
+
db (AsyncSession): The database session.
|
|
607
|
+
user (schemas.User): The current user.
|
|
683
608
|
|
|
684
609
|
## Returns:
|
|
685
610
|
|
|
686
|
-
schemas.
|
|
611
|
+
list[schemas.EmbeddingModel]: The list of embedding models.
|
|
687
612
|
|
|
688
613
|
</dd>
|
|
689
614
|
</dl>
|
|
@@ -699,15 +624,7 @@ Expects a POST body with:
|
|
|
699
624
|
<dd>
|
|
700
625
|
|
|
701
626
|
```typescript
|
|
702
|
-
await client.
|
|
703
|
-
creds: "creds",
|
|
704
|
-
name: undefined,
|
|
705
|
-
configFields: {
|
|
706
|
-
config_fields: {
|
|
707
|
-
key: "value",
|
|
708
|
-
},
|
|
709
|
-
},
|
|
710
|
-
});
|
|
627
|
+
await client.embeddingModels.readEmbeddingModels();
|
|
711
628
|
```
|
|
712
629
|
|
|
713
630
|
</dd>
|
|
@@ -723,31 +640,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
723
640
|
<dl>
|
|
724
641
|
<dd>
|
|
725
642
|
|
|
726
|
-
**
|
|
727
|
-
|
|
728
|
-
</dd>
|
|
729
|
-
</dl>
|
|
730
|
-
|
|
731
|
-
<dl>
|
|
732
|
-
<dd>
|
|
733
|
-
|
|
734
|
-
**shortName:** `string`
|
|
735
|
-
|
|
736
|
-
</dd>
|
|
737
|
-
</dl>
|
|
738
|
-
|
|
739
|
-
<dl>
|
|
740
|
-
<dd>
|
|
741
|
-
|
|
742
|
-
**request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
|
|
743
|
-
|
|
744
|
-
</dd>
|
|
745
|
-
</dl>
|
|
746
|
-
|
|
747
|
-
<dl>
|
|
748
|
-
<dd>
|
|
749
|
-
|
|
750
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
643
|
+
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
751
644
|
|
|
752
645
|
</dd>
|
|
753
646
|
</dl>
|
|
@@ -758,7 +651,9 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
758
651
|
</dl>
|
|
759
652
|
</details>
|
|
760
653
|
|
|
761
|
-
|
|
654
|
+
## Connections
|
|
655
|
+
|
|
656
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
762
657
|
<dl>
|
|
763
658
|
<dd>
|
|
764
659
|
|
|
@@ -770,17 +665,17 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
770
665
|
<dl>
|
|
771
666
|
<dd>
|
|
772
667
|
|
|
773
|
-
Get
|
|
668
|
+
Get a specific connection.
|
|
774
669
|
|
|
775
670
|
## Args:
|
|
776
671
|
|
|
777
|
-
connection_id
|
|
778
|
-
db
|
|
779
|
-
user
|
|
672
|
+
connection_id: The ID of the connection to get.
|
|
673
|
+
db: The database session.
|
|
674
|
+
user: The current user.
|
|
780
675
|
|
|
781
676
|
## Returns:
|
|
782
677
|
|
|
783
|
-
|
|
678
|
+
schemas.Connection: The connection.
|
|
784
679
|
|
|
785
680
|
</dd>
|
|
786
681
|
</dl>
|
|
@@ -796,9 +691,7 @@ Get the credentials for a connection.
|
|
|
796
691
|
<dd>
|
|
797
692
|
|
|
798
693
|
```typescript
|
|
799
|
-
await client.connections.
|
|
800
|
-
creds: "creds",
|
|
801
|
-
});
|
|
694
|
+
await client.connections.getConnection("connection_id");
|
|
802
695
|
```
|
|
803
696
|
|
|
804
697
|
</dd>
|
|
@@ -822,14 +715,6 @@ await client.connections.getConnectionCredentials("connection_id", {
|
|
|
822
715
|
<dl>
|
|
823
716
|
<dd>
|
|
824
717
|
|
|
825
|
-
**request:** `AirweaveSDK.GetConnectionCredentialsConnectionsCredentialsConnectionIdGetRequest`
|
|
826
|
-
|
|
827
|
-
</dd>
|
|
828
|
-
</dl>
|
|
829
|
-
|
|
830
|
-
<dl>
|
|
831
|
-
<dd>
|
|
832
|
-
|
|
833
718
|
**requestOptions:** `Connections.RequestOptions`
|
|
834
719
|
|
|
835
720
|
</dd>
|
|
@@ -841,7 +726,7 @@ await client.connections.getConnectionCredentials("connection_id", {
|
|
|
841
726
|
</dl>
|
|
842
727
|
</details>
|
|
843
728
|
|
|
844
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
729
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
|
|
845
730
|
<dl>
|
|
846
731
|
<dd>
|
|
847
732
|
|
|
@@ -853,19 +738,16 @@ await client.connections.getConnectionCredentials("connection_id", {
|
|
|
853
738
|
<dl>
|
|
854
739
|
<dd>
|
|
855
740
|
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
Deletes the connection and integration credential.
|
|
741
|
+
Get all active connections for the current user across all integration types.
|
|
859
742
|
|
|
860
743
|
## Args:
|
|
861
744
|
|
|
862
|
-
db
|
|
863
|
-
|
|
864
|
-
user (schemas.User): The current user
|
|
745
|
+
db: The database session.
|
|
746
|
+
user: The current user.
|
|
865
747
|
|
|
866
748
|
## Returns:
|
|
867
749
|
|
|
868
|
-
|
|
750
|
+
list[schemas.Connection]: The list of connections.
|
|
869
751
|
|
|
870
752
|
</dd>
|
|
871
753
|
</dl>
|
|
@@ -881,9 +763,7 @@ Deletes the connection and integration credential.
|
|
|
881
763
|
<dd>
|
|
882
764
|
|
|
883
765
|
```typescript
|
|
884
|
-
await client.connections.
|
|
885
|
-
creds: "creds",
|
|
886
|
-
});
|
|
766
|
+
await client.connections.listAllConnectedIntegrations();
|
|
887
767
|
```
|
|
888
768
|
|
|
889
769
|
</dd>
|
|
@@ -899,22 +779,6 @@ await client.connections.deleteConnection("connection_id", {
|
|
|
899
779
|
<dl>
|
|
900
780
|
<dd>
|
|
901
781
|
|
|
902
|
-
**connectionId:** `string`
|
|
903
|
-
|
|
904
|
-
</dd>
|
|
905
|
-
</dl>
|
|
906
|
-
|
|
907
|
-
<dl>
|
|
908
|
-
<dd>
|
|
909
|
-
|
|
910
|
-
**request:** `AirweaveSDK.DeleteConnectionConnectionsDeleteSourceConnectionIdDeleteRequest`
|
|
911
|
-
|
|
912
|
-
</dd>
|
|
913
|
-
</dl>
|
|
914
|
-
|
|
915
|
-
<dl>
|
|
916
|
-
<dd>
|
|
917
|
-
|
|
918
782
|
**requestOptions:** `Connections.RequestOptions`
|
|
919
783
|
|
|
920
784
|
</dd>
|
|
@@ -926,7 +790,7 @@ await client.connections.deleteConnection("connection_id", {
|
|
|
926
790
|
</dl>
|
|
927
791
|
</details>
|
|
928
792
|
|
|
929
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
793
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listConnectedIntegrations</a>(integrationType) -> AirweaveSDK.Connection[]</code></summary>
|
|
930
794
|
<dl>
|
|
931
795
|
<dd>
|
|
932
796
|
|
|
@@ -938,17 +802,17 @@ await client.connections.deleteConnection("connection_id", {
|
|
|
938
802
|
<dl>
|
|
939
803
|
<dd>
|
|
940
804
|
|
|
941
|
-
|
|
805
|
+
Get all integrations of specified type connected to the current user.
|
|
942
806
|
|
|
943
807
|
## Args:
|
|
944
808
|
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
user (schemas.User): The current user
|
|
809
|
+
integration_type (IntegrationType): The type of integration to get connections for.
|
|
810
|
+
db (AsyncSession): The database session.
|
|
811
|
+
user (schemas.User): The current user.
|
|
948
812
|
|
|
949
813
|
## Returns:
|
|
950
814
|
|
|
951
|
-
|
|
815
|
+
list[schemas.Connection]: The list of connections.
|
|
952
816
|
|
|
953
817
|
</dd>
|
|
954
818
|
</dl>
|
|
@@ -964,9 +828,7 @@ Disconnect from a source connection.
|
|
|
964
828
|
<dd>
|
|
965
829
|
|
|
966
830
|
```typescript
|
|
967
|
-
await client.connections.
|
|
968
|
-
creds: "creds",
|
|
969
|
-
});
|
|
831
|
+
await client.connections.listConnectedIntegrations("source");
|
|
970
832
|
```
|
|
971
833
|
|
|
972
834
|
</dd>
|
|
@@ -982,15 +844,7 @@ await client.connections.disconnectSourceConnection("connection_id", {
|
|
|
982
844
|
<dl>
|
|
983
845
|
<dd>
|
|
984
846
|
|
|
985
|
-
**
|
|
986
|
-
|
|
987
|
-
</dd>
|
|
988
|
-
</dl>
|
|
989
|
-
|
|
990
|
-
<dl>
|
|
991
|
-
<dd>
|
|
992
|
-
|
|
993
|
-
**request:** `AirweaveSDK.DisconnectSourceConnectionConnectionsDisconnectSourceConnectionIdPutRequest`
|
|
847
|
+
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
994
848
|
|
|
995
849
|
</dd>
|
|
996
850
|
</dl>
|
|
@@ -1009,7 +863,7 @@ await client.connections.disconnectSourceConnection("connection_id", {
|
|
|
1009
863
|
</dl>
|
|
1010
864
|
</details>
|
|
1011
865
|
|
|
1012
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
866
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">connectIntegration</a>(integrationType, shortName, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1013
867
|
<dl>
|
|
1014
868
|
<dd>
|
|
1015
869
|
|
|
@@ -1021,19 +875,29 @@ await client.connections.disconnectSourceConnection("connection_id", {
|
|
|
1021
875
|
<dl>
|
|
1022
876
|
<dd>
|
|
1023
877
|
|
|
1024
|
-
|
|
878
|
+
Connect to a source, destination, or embedding model.
|
|
879
|
+
|
|
880
|
+
Expects a POST body with:
|
|
881
|
+
|
|
882
|
+
```json
|
|
883
|
+
{
|
|
884
|
+
"name": "required connection name",
|
|
885
|
+
... other config fields specific to the integration type ...
|
|
886
|
+
}
|
|
887
|
+
```
|
|
1025
888
|
|
|
1026
889
|
## Args:
|
|
1027
890
|
|
|
1028
|
-
db: The database session
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
891
|
+
db: The database session.
|
|
892
|
+
integration_type: The type of integration to connect to.
|
|
893
|
+
short_name: The short name of the integration to connect to.
|
|
894
|
+
name: The name of the connection.
|
|
895
|
+
auth_fields: The config fields for the integration.
|
|
896
|
+
user: The current user.
|
|
1033
897
|
|
|
1034
898
|
## Returns:
|
|
1035
899
|
|
|
1036
|
-
|
|
900
|
+
schemas.Connection: The connection.
|
|
1037
901
|
|
|
1038
902
|
</dd>
|
|
1039
903
|
</dl>
|
|
@@ -1049,9 +913,10 @@ Exchange the OAuth2 authorization code for a white label integration.
|
|
|
1049
913
|
<dd>
|
|
1050
914
|
|
|
1051
915
|
```typescript
|
|
1052
|
-
await client.connections.
|
|
1053
|
-
|
|
1054
|
-
|
|
916
|
+
await client.connections.connectIntegration("source", "short_name", {
|
|
917
|
+
authFields: {
|
|
918
|
+
key: "value",
|
|
919
|
+
},
|
|
1055
920
|
});
|
|
1056
921
|
```
|
|
1057
922
|
|
|
@@ -1068,7 +933,15 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1068
933
|
<dl>
|
|
1069
934
|
<dd>
|
|
1070
935
|
|
|
1071
|
-
**
|
|
936
|
+
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
937
|
+
|
|
938
|
+
</dd>
|
|
939
|
+
</dl>
|
|
940
|
+
|
|
941
|
+
<dl>
|
|
942
|
+
<dd>
|
|
943
|
+
|
|
944
|
+
**shortName:** `string`
|
|
1072
945
|
|
|
1073
946
|
</dd>
|
|
1074
947
|
</dl>
|
|
@@ -1076,7 +949,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1076
949
|
<dl>
|
|
1077
950
|
<dd>
|
|
1078
951
|
|
|
1079
|
-
**request:** `AirweaveSDK.
|
|
952
|
+
**request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
|
|
1080
953
|
|
|
1081
954
|
</dd>
|
|
1082
955
|
</dl>
|
|
@@ -1095,7 +968,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1095
968
|
</dl>
|
|
1096
969
|
</details>
|
|
1097
970
|
|
|
1098
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
971
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnectionCredentials</a>(connectionId) -> Record<string, unknown></code></summary>
|
|
1099
972
|
<dl>
|
|
1100
973
|
<dd>
|
|
1101
974
|
|
|
@@ -1107,17 +980,17 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1107
980
|
<dl>
|
|
1108
981
|
<dd>
|
|
1109
982
|
|
|
1110
|
-
Get the
|
|
983
|
+
Get the credentials for a connection.
|
|
1111
984
|
|
|
1112
985
|
## Args:
|
|
1113
986
|
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
user: The current user
|
|
987
|
+
connection_id (UUID): The ID of the connection to get credentials for
|
|
988
|
+
db (AsyncSession): The database session
|
|
989
|
+
user (schemas.User): The current user
|
|
1117
990
|
|
|
1118
991
|
## Returns:
|
|
1119
992
|
|
|
1120
|
-
|
|
993
|
+
decrypted_credentials (dict): The credentials for the connection
|
|
1121
994
|
|
|
1122
995
|
</dd>
|
|
1123
996
|
</dl>
|
|
@@ -1133,9 +1006,7 @@ Get the OAuth2 authorization URL for a white label integration.
|
|
|
1133
1006
|
<dd>
|
|
1134
1007
|
|
|
1135
1008
|
```typescript
|
|
1136
|
-
await client.connections.
|
|
1137
|
-
creds: "creds",
|
|
1138
|
-
});
|
|
1009
|
+
await client.connections.getConnectionCredentials("connection_id");
|
|
1139
1010
|
```
|
|
1140
1011
|
|
|
1141
1012
|
</dd>
|
|
@@ -1151,15 +1022,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id", {
|
|
|
1151
1022
|
<dl>
|
|
1152
1023
|
<dd>
|
|
1153
1024
|
|
|
1154
|
-
**
|
|
1155
|
-
|
|
1156
|
-
</dd>
|
|
1157
|
-
</dl>
|
|
1158
|
-
|
|
1159
|
-
<dl>
|
|
1160
|
-
<dd>
|
|
1161
|
-
|
|
1162
|
-
**request:** `AirweaveSDK.GetOauth2WhiteLabelAuthUrlConnectionsOauth2WhiteLabelWhiteLabelIdAuthUrlGetRequest`
|
|
1025
|
+
**connectionId:** `string`
|
|
1163
1026
|
|
|
1164
1027
|
</dd>
|
|
1165
1028
|
</dl>
|
|
@@ -1178,9 +1041,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id", {
|
|
|
1178
1041
|
</dl>
|
|
1179
1042
|
</details>
|
|
1180
1043
|
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1044
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">deleteConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1184
1045
|
<dl>
|
|
1185
1046
|
<dd>
|
|
1186
1047
|
|
|
@@ -1192,19 +1053,19 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id", {
|
|
|
1192
1053
|
<dl>
|
|
1193
1054
|
<dd>
|
|
1194
1055
|
|
|
1195
|
-
|
|
1056
|
+
Delete a connection.
|
|
1057
|
+
|
|
1058
|
+
Deletes the connection and integration credential.
|
|
1196
1059
|
|
|
1197
1060
|
## Args:
|
|
1198
1061
|
|
|
1199
|
-
db: The database session
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
with_source_connection: Whether to include the source connection in the response
|
|
1203
|
-
user: The current user
|
|
1062
|
+
db (AsyncSession): The database session
|
|
1063
|
+
connection_id (UUID): The ID of the connection to delete
|
|
1064
|
+
user (schemas.User): The current user
|
|
1204
1065
|
|
|
1205
1066
|
## Returns:
|
|
1206
1067
|
|
|
1207
|
-
|
|
1068
|
+
connection (schemas.Connection): The deleted connection
|
|
1208
1069
|
|
|
1209
1070
|
</dd>
|
|
1210
1071
|
</dl>
|
|
@@ -1220,9 +1081,7 @@ List all syncs for the current user.
|
|
|
1220
1081
|
<dd>
|
|
1221
1082
|
|
|
1222
1083
|
```typescript
|
|
1223
|
-
await client.
|
|
1224
|
-
creds: "creds",
|
|
1225
|
-
});
|
|
1084
|
+
await client.connections.deleteConnection("connection_id");
|
|
1226
1085
|
```
|
|
1227
1086
|
|
|
1228
1087
|
</dd>
|
|
@@ -1238,7 +1097,7 @@ await client.sync.listSyncs({
|
|
|
1238
1097
|
<dl>
|
|
1239
1098
|
<dd>
|
|
1240
1099
|
|
|
1241
|
-
**
|
|
1100
|
+
**connectionId:** `string`
|
|
1242
1101
|
|
|
1243
1102
|
</dd>
|
|
1244
1103
|
</dl>
|
|
@@ -1246,7 +1105,7 @@ await client.sync.listSyncs({
|
|
|
1246
1105
|
<dl>
|
|
1247
1106
|
<dd>
|
|
1248
1107
|
|
|
1249
|
-
**requestOptions:** `
|
|
1108
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1250
1109
|
|
|
1251
1110
|
</dd>
|
|
1252
1111
|
</dl>
|
|
@@ -1257,7 +1116,7 @@ await client.sync.listSyncs({
|
|
|
1257
1116
|
</dl>
|
|
1258
1117
|
</details>
|
|
1259
1118
|
|
|
1260
|
-
<details><summary><code>client.
|
|
1119
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectSourceConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1261
1120
|
<dl>
|
|
1262
1121
|
<dd>
|
|
1263
1122
|
|
|
@@ -1269,18 +1128,17 @@ await client.sync.listSyncs({
|
|
|
1269
1128
|
<dl>
|
|
1270
1129
|
<dd>
|
|
1271
1130
|
|
|
1272
|
-
|
|
1131
|
+
Disconnect from a source connection.
|
|
1273
1132
|
|
|
1274
1133
|
## Args:
|
|
1275
1134
|
|
|
1276
|
-
db: The database session
|
|
1277
|
-
|
|
1278
|
-
user: The current user
|
|
1279
|
-
background_tasks: The background tasks
|
|
1135
|
+
db (AsyncSession): The database session
|
|
1136
|
+
connection_id (UUID): The ID of the connection to disconnect
|
|
1137
|
+
user (schemas.User): The current user
|
|
1280
1138
|
|
|
1281
1139
|
## Returns:
|
|
1282
1140
|
|
|
1283
|
-
|
|
1141
|
+
connection (schemas.Connection): The disconnected connection
|
|
1284
1142
|
|
|
1285
1143
|
</dd>
|
|
1286
1144
|
</dl>
|
|
@@ -1296,21 +1154,7 @@ Create a new sync configuration.
|
|
|
1296
1154
|
<dd>
|
|
1297
1155
|
|
|
1298
1156
|
```typescript
|
|
1299
|
-
await client.
|
|
1300
|
-
creds: "creds",
|
|
1301
|
-
name: "name",
|
|
1302
|
-
sourceConnectionId: "source_connection_id",
|
|
1303
|
-
embeddingModelConnectionId: undefined,
|
|
1304
|
-
destinationConnectionIds: ["destination_connection_ids", "destination_connection_ids"],
|
|
1305
|
-
description: undefined,
|
|
1306
|
-
cronSchedule: undefined,
|
|
1307
|
-
nextScheduledRun: undefined,
|
|
1308
|
-
whiteLabelId: undefined,
|
|
1309
|
-
whiteLabelUserIdentifier: undefined,
|
|
1310
|
-
syncMetadata: undefined,
|
|
1311
|
-
status: undefined,
|
|
1312
|
-
runImmediately: undefined,
|
|
1313
|
-
});
|
|
1157
|
+
await client.connections.disconnectSourceConnection("connection_id");
|
|
1314
1158
|
```
|
|
1315
1159
|
|
|
1316
1160
|
</dd>
|
|
@@ -1326,7 +1170,7 @@ await client.sync.createSync({
|
|
|
1326
1170
|
<dl>
|
|
1327
1171
|
<dd>
|
|
1328
1172
|
|
|
1329
|
-
**
|
|
1173
|
+
**connectionId:** `string`
|
|
1330
1174
|
|
|
1331
1175
|
</dd>
|
|
1332
1176
|
</dl>
|
|
@@ -1334,7 +1178,7 @@ await client.sync.createSync({
|
|
|
1334
1178
|
<dl>
|
|
1335
1179
|
<dd>
|
|
1336
1180
|
|
|
1337
|
-
**requestOptions:** `
|
|
1181
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1338
1182
|
|
|
1339
1183
|
</dd>
|
|
1340
1184
|
</dl>
|
|
@@ -1345,7 +1189,7 @@ await client.sync.createSync({
|
|
|
1345
1189
|
</dl>
|
|
1346
1190
|
</details>
|
|
1347
1191
|
|
|
1348
|
-
<details><summary><code>client.
|
|
1192
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2WhiteLabelCode</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1349
1193
|
<dl>
|
|
1350
1194
|
<dd>
|
|
1351
1195
|
|
|
@@ -1357,19 +1201,19 @@ await client.sync.createSync({
|
|
|
1357
1201
|
<dl>
|
|
1358
1202
|
<dd>
|
|
1359
1203
|
|
|
1360
|
-
|
|
1204
|
+
Exchange the OAuth2 authorization code for a white label integration.
|
|
1361
1205
|
|
|
1362
1206
|
## Args:
|
|
1363
1207
|
|
|
1364
1208
|
db: The database session
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
status: Filter by job status
|
|
1209
|
+
white_label_id: The ID of the white label integration
|
|
1210
|
+
code: The authorization code
|
|
1368
1211
|
user: The current user
|
|
1212
|
+
background_tasks: The background tasks
|
|
1369
1213
|
|
|
1370
1214
|
## Returns:
|
|
1371
1215
|
|
|
1372
|
-
|
|
1216
|
+
connection (schemas.Connection): The created connection
|
|
1373
1217
|
|
|
1374
1218
|
</dd>
|
|
1375
1219
|
</dl>
|
|
@@ -1385,9 +1229,7 @@ List all sync jobs across all syncs.
|
|
|
1385
1229
|
<dd>
|
|
1386
1230
|
|
|
1387
1231
|
```typescript
|
|
1388
|
-
await client.
|
|
1389
|
-
creds: "creds",
|
|
1390
|
-
});
|
|
1232
|
+
await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
1391
1233
|
```
|
|
1392
1234
|
|
|
1393
1235
|
</dd>
|
|
@@ -1403,7 +1245,7 @@ await client.sync.listAllJobs({
|
|
|
1403
1245
|
<dl>
|
|
1404
1246
|
<dd>
|
|
1405
1247
|
|
|
1406
|
-
**
|
|
1248
|
+
**whiteLabelId:** `string`
|
|
1407
1249
|
|
|
1408
1250
|
</dd>
|
|
1409
1251
|
</dl>
|
|
@@ -1411,7 +1253,15 @@ await client.sync.listAllJobs({
|
|
|
1411
1253
|
<dl>
|
|
1412
1254
|
<dd>
|
|
1413
1255
|
|
|
1414
|
-
**
|
|
1256
|
+
**request:** `string`
|
|
1257
|
+
|
|
1258
|
+
</dd>
|
|
1259
|
+
</dl>
|
|
1260
|
+
|
|
1261
|
+
<dl>
|
|
1262
|
+
<dd>
|
|
1263
|
+
|
|
1264
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1415
1265
|
|
|
1416
1266
|
</dd>
|
|
1417
1267
|
</dl>
|
|
@@ -1422,7 +1272,7 @@ await client.sync.listAllJobs({
|
|
|
1422
1272
|
</dl>
|
|
1423
1273
|
</details>
|
|
1424
1274
|
|
|
1425
|
-
<details><summary><code>client.
|
|
1275
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2WhiteLabelAuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
1426
1276
|
<dl>
|
|
1427
1277
|
<dd>
|
|
1428
1278
|
|
|
@@ -1434,17 +1284,17 @@ await client.sync.listAllJobs({
|
|
|
1434
1284
|
<dl>
|
|
1435
1285
|
<dd>
|
|
1436
1286
|
|
|
1437
|
-
Get a
|
|
1287
|
+
Get the OAuth2 authorization URL for a white label integration.
|
|
1438
1288
|
|
|
1439
1289
|
## Args:
|
|
1440
1290
|
|
|
1441
1291
|
db: The database session
|
|
1442
|
-
|
|
1292
|
+
white_label_id: The ID of the white label integration
|
|
1443
1293
|
user: The current user
|
|
1444
1294
|
|
|
1445
1295
|
## Returns:
|
|
1446
1296
|
|
|
1447
|
-
|
|
1297
|
+
str: The OAuth2 authorization URL
|
|
1448
1298
|
|
|
1449
1299
|
</dd>
|
|
1450
1300
|
</dl>
|
|
@@ -1460,9 +1310,7 @@ Get a specific sync by ID.
|
|
|
1460
1310
|
<dd>
|
|
1461
1311
|
|
|
1462
1312
|
```typescript
|
|
1463
|
-
await client.
|
|
1464
|
-
creds: "creds",
|
|
1465
|
-
});
|
|
1313
|
+
await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
1466
1314
|
```
|
|
1467
1315
|
|
|
1468
1316
|
</dd>
|
|
@@ -1478,15 +1326,7 @@ await client.sync.getSync("sync_id", {
|
|
|
1478
1326
|
<dl>
|
|
1479
1327
|
<dd>
|
|
1480
1328
|
|
|
1481
|
-
**
|
|
1482
|
-
|
|
1483
|
-
</dd>
|
|
1484
|
-
</dl>
|
|
1485
|
-
|
|
1486
|
-
<dl>
|
|
1487
|
-
<dd>
|
|
1488
|
-
|
|
1489
|
-
**request:** `AirweaveSDK.GetSyncSyncSyncIdGetRequest`
|
|
1329
|
+
**whiteLabelId:** `string`
|
|
1490
1330
|
|
|
1491
1331
|
</dd>
|
|
1492
1332
|
</dl>
|
|
@@ -1494,7 +1334,7 @@ await client.sync.getSync("sync_id", {
|
|
|
1494
1334
|
<dl>
|
|
1495
1335
|
<dd>
|
|
1496
1336
|
|
|
1497
|
-
**requestOptions:** `
|
|
1337
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1498
1338
|
|
|
1499
1339
|
</dd>
|
|
1500
1340
|
</dl>
|
|
@@ -1505,7 +1345,9 @@ await client.sync.getSync("sync_id", {
|
|
|
1505
1345
|
</dl>
|
|
1506
1346
|
</details>
|
|
1507
1347
|
|
|
1508
|
-
|
|
1348
|
+
## Sync
|
|
1349
|
+
|
|
1350
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1509
1351
|
<dl>
|
|
1510
1352
|
<dd>
|
|
1511
1353
|
|
|
@@ -1517,18 +1359,19 @@ await client.sync.getSync("sync_id", {
|
|
|
1517
1359
|
<dl>
|
|
1518
1360
|
<dd>
|
|
1519
1361
|
|
|
1520
|
-
|
|
1362
|
+
List all syncs for the current user.
|
|
1521
1363
|
|
|
1522
1364
|
## Args:
|
|
1523
1365
|
|
|
1524
1366
|
db: The database session
|
|
1525
|
-
|
|
1526
|
-
|
|
1367
|
+
skip: The number of syncs to skip
|
|
1368
|
+
limit: The number of syncs to return
|
|
1369
|
+
with_source_connection: Whether to include the source connection in the response
|
|
1527
1370
|
user: The current user
|
|
1528
1371
|
|
|
1529
1372
|
## Returns:
|
|
1530
1373
|
|
|
1531
|
-
|
|
1374
|
+
list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
|
|
1532
1375
|
|
|
1533
1376
|
</dd>
|
|
1534
1377
|
</dl>
|
|
@@ -1544,9 +1387,7 @@ Delete a sync configuration and optionally its associated data.
|
|
|
1544
1387
|
<dd>
|
|
1545
1388
|
|
|
1546
1389
|
```typescript
|
|
1547
|
-
await client.sync.
|
|
1548
|
-
creds: "creds",
|
|
1549
|
-
});
|
|
1390
|
+
await client.sync.listSyncs();
|
|
1550
1391
|
```
|
|
1551
1392
|
|
|
1552
1393
|
</dd>
|
|
@@ -1562,15 +1403,7 @@ await client.sync.deleteSync("sync_id", {
|
|
|
1562
1403
|
<dl>
|
|
1563
1404
|
<dd>
|
|
1564
1405
|
|
|
1565
|
-
**
|
|
1566
|
-
|
|
1567
|
-
</dd>
|
|
1568
|
-
</dl>
|
|
1569
|
-
|
|
1570
|
-
<dl>
|
|
1571
|
-
<dd>
|
|
1572
|
-
|
|
1573
|
-
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
1406
|
+
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1574
1407
|
|
|
1575
1408
|
</dd>
|
|
1576
1409
|
</dl>
|
|
@@ -1589,7 +1422,7 @@ await client.sync.deleteSync("sync_id", {
|
|
|
1589
1422
|
</dl>
|
|
1590
1423
|
</details>
|
|
1591
1424
|
|
|
1592
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">
|
|
1425
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">createSync</a>({ ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1593
1426
|
<dl>
|
|
1594
1427
|
<dd>
|
|
1595
1428
|
|
|
@@ -1601,18 +1434,18 @@ await client.sync.deleteSync("sync_id", {
|
|
|
1601
1434
|
<dl>
|
|
1602
1435
|
<dd>
|
|
1603
1436
|
|
|
1604
|
-
|
|
1437
|
+
Create a new sync configuration.
|
|
1605
1438
|
|
|
1606
1439
|
## Args:
|
|
1607
1440
|
|
|
1608
1441
|
db: The database session
|
|
1609
|
-
|
|
1610
|
-
sync_update: The sync update data
|
|
1442
|
+
sync_in: The sync to create
|
|
1611
1443
|
user: The current user
|
|
1444
|
+
background_tasks: The background tasks
|
|
1612
1445
|
|
|
1613
1446
|
## Returns:
|
|
1614
1447
|
|
|
1615
|
-
sync (schemas.Sync): The
|
|
1448
|
+
sync (schemas.Sync): The created sync
|
|
1616
1449
|
|
|
1617
1450
|
</dd>
|
|
1618
1451
|
</dl>
|
|
@@ -1628,15 +1461,10 @@ Update a sync configuration.
|
|
|
1628
1461
|
<dd>
|
|
1629
1462
|
|
|
1630
1463
|
```typescript
|
|
1631
|
-
await client.sync.
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
nextScheduledRun: undefined,
|
|
1636
|
-
whiteLabelId: undefined,
|
|
1637
|
-
whiteLabelUserIdentifier: undefined,
|
|
1638
|
-
syncMetadata: undefined,
|
|
1639
|
-
status: undefined,
|
|
1464
|
+
await client.sync.createSync({
|
|
1465
|
+
name: "name",
|
|
1466
|
+
sourceConnectionId: "source_connection_id",
|
|
1467
|
+
destinationConnectionIds: ["destination_connection_ids"],
|
|
1640
1468
|
});
|
|
1641
1469
|
```
|
|
1642
1470
|
|
|
@@ -1653,15 +1481,7 @@ await client.sync.updateSync("sync_id", {
|
|
|
1653
1481
|
<dl>
|
|
1654
1482
|
<dd>
|
|
1655
1483
|
|
|
1656
|
-
**
|
|
1657
|
-
|
|
1658
|
-
</dd>
|
|
1659
|
-
</dl>
|
|
1660
|
-
|
|
1661
|
-
<dl>
|
|
1662
|
-
<dd>
|
|
1663
|
-
|
|
1664
|
-
**request:** `AirweaveSDK.SyncUpdate`
|
|
1484
|
+
**request:** `AirweaveSDK.SyncCreate`
|
|
1665
1485
|
|
|
1666
1486
|
</dd>
|
|
1667
1487
|
</dl>
|
|
@@ -1680,7 +1500,7 @@ await client.sync.updateSync("sync_id", {
|
|
|
1680
1500
|
</dl>
|
|
1681
1501
|
</details>
|
|
1682
1502
|
|
|
1683
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">
|
|
1503
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listAllJobs</a>({ ...params }) -> AirweaveSDK.SyncJob[]</code></summary>
|
|
1684
1504
|
<dl>
|
|
1685
1505
|
<dd>
|
|
1686
1506
|
|
|
@@ -1692,18 +1512,19 @@ await client.sync.updateSync("sync_id", {
|
|
|
1692
1512
|
<dl>
|
|
1693
1513
|
<dd>
|
|
1694
1514
|
|
|
1695
|
-
|
|
1515
|
+
List all sync jobs across all syncs.
|
|
1696
1516
|
|
|
1697
1517
|
## Args:
|
|
1698
1518
|
|
|
1699
1519
|
db: The database session
|
|
1700
|
-
|
|
1520
|
+
skip: The number of jobs to skip
|
|
1521
|
+
limit: The number of jobs to return
|
|
1522
|
+
status: Filter by job status
|
|
1701
1523
|
user: The current user
|
|
1702
|
-
background_tasks: The background tasks
|
|
1703
1524
|
|
|
1704
1525
|
## Returns:
|
|
1705
1526
|
|
|
1706
|
-
|
|
1527
|
+
list[schemas.SyncJob]: A list of all sync jobs
|
|
1707
1528
|
|
|
1708
1529
|
</dd>
|
|
1709
1530
|
</dl>
|
|
@@ -1719,9 +1540,7 @@ Trigger a sync run.
|
|
|
1719
1540
|
<dd>
|
|
1720
1541
|
|
|
1721
1542
|
```typescript
|
|
1722
|
-
await client.sync.
|
|
1723
|
-
creds: "creds",
|
|
1724
|
-
});
|
|
1543
|
+
await client.sync.listAllJobs();
|
|
1725
1544
|
```
|
|
1726
1545
|
|
|
1727
1546
|
</dd>
|
|
@@ -1737,15 +1556,7 @@ await client.sync.runSync("sync_id", {
|
|
|
1737
1556
|
<dl>
|
|
1738
1557
|
<dd>
|
|
1739
1558
|
|
|
1740
|
-
**
|
|
1741
|
-
|
|
1742
|
-
</dd>
|
|
1743
|
-
</dl>
|
|
1744
|
-
|
|
1745
|
-
<dl>
|
|
1746
|
-
<dd>
|
|
1747
|
-
|
|
1748
|
-
**request:** `AirweaveSDK.RunSyncSyncSyncIdRunPostRequest`
|
|
1559
|
+
**request:** `AirweaveSDK.ListAllJobsSyncJobsGetRequest`
|
|
1749
1560
|
|
|
1750
1561
|
</dd>
|
|
1751
1562
|
</dl>
|
|
@@ -1764,7 +1575,7 @@ await client.sync.runSync("sync_id", {
|
|
|
1764
1575
|
</dl>
|
|
1765
1576
|
</details>
|
|
1766
1577
|
|
|
1767
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">
|
|
1578
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
|
|
1768
1579
|
<dl>
|
|
1769
1580
|
<dd>
|
|
1770
1581
|
|
|
@@ -1776,17 +1587,17 @@ await client.sync.runSync("sync_id", {
|
|
|
1776
1587
|
<dl>
|
|
1777
1588
|
<dd>
|
|
1778
1589
|
|
|
1779
|
-
|
|
1590
|
+
Get a specific sync by ID.
|
|
1780
1591
|
|
|
1781
1592
|
## Args:
|
|
1782
1593
|
|
|
1783
1594
|
db: The database session
|
|
1784
|
-
sync_id: The ID of the sync to
|
|
1595
|
+
sync_id: The ID of the sync to get
|
|
1785
1596
|
user: The current user
|
|
1786
1597
|
|
|
1787
1598
|
## Returns:
|
|
1788
1599
|
|
|
1789
|
-
|
|
1600
|
+
sync (schemas.Sync): The sync
|
|
1790
1601
|
|
|
1791
1602
|
</dd>
|
|
1792
1603
|
</dl>
|
|
@@ -1802,9 +1613,7 @@ List all jobs for a specific sync.
|
|
|
1802
1613
|
<dd>
|
|
1803
1614
|
|
|
1804
1615
|
```typescript
|
|
1805
|
-
await client.sync.
|
|
1806
|
-
creds: "creds",
|
|
1807
|
-
});
|
|
1616
|
+
await client.sync.getSync("sync_id");
|
|
1808
1617
|
```
|
|
1809
1618
|
|
|
1810
1619
|
</dd>
|
|
@@ -1828,14 +1637,6 @@ await client.sync.listSyncJobs("sync_id", {
|
|
|
1828
1637
|
<dl>
|
|
1829
1638
|
<dd>
|
|
1830
1639
|
|
|
1831
|
-
**request:** `AirweaveSDK.ListSyncJobsSyncSyncIdJobsGetRequest`
|
|
1832
|
-
|
|
1833
|
-
</dd>
|
|
1834
|
-
</dl>
|
|
1835
|
-
|
|
1836
|
-
<dl>
|
|
1837
|
-
<dd>
|
|
1838
|
-
|
|
1839
1640
|
**requestOptions:** `Sync.RequestOptions`
|
|
1840
1641
|
|
|
1841
1642
|
</dd>
|
|
@@ -1847,7 +1648,7 @@ await client.sync.listSyncJobs("sync_id", {
|
|
|
1847
1648
|
</dl>
|
|
1848
1649
|
</details>
|
|
1849
1650
|
|
|
1850
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">
|
|
1651
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">deleteSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1851
1652
|
<dl>
|
|
1852
1653
|
<dd>
|
|
1853
1654
|
|
|
@@ -1859,18 +1660,18 @@ await client.sync.listSyncJobs("sync_id", {
|
|
|
1859
1660
|
<dl>
|
|
1860
1661
|
<dd>
|
|
1861
1662
|
|
|
1862
|
-
|
|
1663
|
+
Delete a sync configuration and optionally its associated data.
|
|
1863
1664
|
|
|
1864
1665
|
## Args:
|
|
1865
1666
|
|
|
1866
1667
|
db: The database session
|
|
1867
|
-
sync_id: The ID of the sync to
|
|
1868
|
-
|
|
1668
|
+
sync_id: The ID of the sync to delete
|
|
1669
|
+
delete_data: Whether to delete the data associated with the sync
|
|
1869
1670
|
user: The current user
|
|
1870
1671
|
|
|
1871
1672
|
## Returns:
|
|
1872
1673
|
|
|
1873
|
-
|
|
1674
|
+
sync (schemas.Sync): The deleted sync
|
|
1874
1675
|
|
|
1875
1676
|
</dd>
|
|
1876
1677
|
</dl>
|
|
@@ -1886,9 +1687,7 @@ Get details of a specific sync job.
|
|
|
1886
1687
|
<dd>
|
|
1887
1688
|
|
|
1888
1689
|
```typescript
|
|
1889
|
-
await client.sync.
|
|
1890
|
-
creds: "creds",
|
|
1891
|
-
});
|
|
1690
|
+
await client.sync.deleteSync("sync_id");
|
|
1892
1691
|
```
|
|
1893
1692
|
|
|
1894
1693
|
</dd>
|
|
@@ -1912,15 +1711,7 @@ await client.sync.getSyncJob("sync_id", "job_id", {
|
|
|
1912
1711
|
<dl>
|
|
1913
1712
|
<dd>
|
|
1914
1713
|
|
|
1915
|
-
**
|
|
1916
|
-
|
|
1917
|
-
</dd>
|
|
1918
|
-
</dl>
|
|
1919
|
-
|
|
1920
|
-
<dl>
|
|
1921
|
-
<dd>
|
|
1922
|
-
|
|
1923
|
-
**request:** `AirweaveSDK.GetSyncJobSyncSyncIdJobJobIdGetRequest`
|
|
1714
|
+
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
1924
1715
|
|
|
1925
1716
|
</dd>
|
|
1926
1717
|
</dl>
|
|
@@ -1939,7 +1730,7 @@ await client.sync.getSyncJob("sync_id", "job_id", {
|
|
|
1939
1730
|
</dl>
|
|
1940
1731
|
</details>
|
|
1941
1732
|
|
|
1942
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">
|
|
1733
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">updateSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1943
1734
|
<dl>
|
|
1944
1735
|
<dd>
|
|
1945
1736
|
|
|
@@ -1951,17 +1742,18 @@ await client.sync.getSyncJob("sync_id", "job_id", {
|
|
|
1951
1742
|
<dl>
|
|
1952
1743
|
<dd>
|
|
1953
1744
|
|
|
1954
|
-
|
|
1745
|
+
Update a sync configuration.
|
|
1955
1746
|
|
|
1956
1747
|
## Args:
|
|
1957
1748
|
|
|
1958
|
-
job_id: The ID of the job to subscribe to
|
|
1959
|
-
request: The request object
|
|
1960
1749
|
db: The database session
|
|
1750
|
+
sync_id: The ID of the sync to update
|
|
1751
|
+
sync_update: The sync update data
|
|
1752
|
+
user: The current user
|
|
1961
1753
|
|
|
1962
1754
|
## Returns:
|
|
1963
1755
|
|
|
1964
|
-
|
|
1756
|
+
sync (schemas.Sync): The updated sync
|
|
1965
1757
|
|
|
1966
1758
|
</dd>
|
|
1967
1759
|
</dl>
|
|
@@ -1977,7 +1769,7 @@ Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
|
1977
1769
|
<dd>
|
|
1978
1770
|
|
|
1979
1771
|
```typescript
|
|
1980
|
-
await client.sync.
|
|
1772
|
+
await client.sync.updateSync("sync_id");
|
|
1981
1773
|
```
|
|
1982
1774
|
|
|
1983
1775
|
</dd>
|
|
@@ -1993,7 +1785,15 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
1993
1785
|
<dl>
|
|
1994
1786
|
<dd>
|
|
1995
1787
|
|
|
1996
|
-
**
|
|
1788
|
+
**syncId:** `string`
|
|
1789
|
+
|
|
1790
|
+
</dd>
|
|
1791
|
+
</dl>
|
|
1792
|
+
|
|
1793
|
+
<dl>
|
|
1794
|
+
<dd>
|
|
1795
|
+
|
|
1796
|
+
**request:** `AirweaveSDK.SyncUpdate`
|
|
1997
1797
|
|
|
1998
1798
|
</dd>
|
|
1999
1799
|
</dl>
|
|
@@ -2012,7 +1812,7 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2012
1812
|
</dl>
|
|
2013
1813
|
</details>
|
|
2014
1814
|
|
|
2015
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">
|
|
1815
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">runSync</a>(syncId) -> AirweaveSDK.SyncJob</code></summary>
|
|
2016
1816
|
<dl>
|
|
2017
1817
|
<dd>
|
|
2018
1818
|
|
|
@@ -2024,7 +1824,18 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2024
1824
|
<dl>
|
|
2025
1825
|
<dd>
|
|
2026
1826
|
|
|
2027
|
-
|
|
1827
|
+
Trigger a sync run.
|
|
1828
|
+
|
|
1829
|
+
## Args:
|
|
1830
|
+
|
|
1831
|
+
db: The database session
|
|
1832
|
+
sync_id: The ID of the sync to run
|
|
1833
|
+
user: The current user
|
|
1834
|
+
background_tasks: The background tasks
|
|
1835
|
+
|
|
1836
|
+
## Returns:
|
|
1837
|
+
|
|
1838
|
+
sync_job (schemas.SyncJob): The sync job
|
|
2028
1839
|
|
|
2029
1840
|
</dd>
|
|
2030
1841
|
</dl>
|
|
@@ -2040,9 +1851,7 @@ Get the DAG for a specific sync.
|
|
|
2040
1851
|
<dd>
|
|
2041
1852
|
|
|
2042
1853
|
```typescript
|
|
2043
|
-
await client.sync.
|
|
2044
|
-
creds: "creds",
|
|
2045
|
-
});
|
|
1854
|
+
await client.sync.runSync("sync_id");
|
|
2046
1855
|
```
|
|
2047
1856
|
|
|
2048
1857
|
</dd>
|
|
@@ -2066,14 +1875,6 @@ await client.sync.getSyncDag("sync_id", {
|
|
|
2066
1875
|
<dl>
|
|
2067
1876
|
<dd>
|
|
2068
1877
|
|
|
2069
|
-
**request:** `AirweaveSDK.GetSyncDagSyncSyncIdDagGetRequest`
|
|
2070
|
-
|
|
2071
|
-
</dd>
|
|
2072
|
-
</dl>
|
|
2073
|
-
|
|
2074
|
-
<dl>
|
|
2075
|
-
<dd>
|
|
2076
|
-
|
|
2077
1878
|
**requestOptions:** `Sync.RequestOptions`
|
|
2078
1879
|
|
|
2079
1880
|
</dd>
|
|
@@ -2085,9 +1886,7 @@ await client.sync.getSyncDag("sync_id", {
|
|
|
2085
1886
|
</dl>
|
|
2086
1887
|
</details>
|
|
2087
1888
|
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>({ ...params }) -> Record<string, unknown></code></summary>
|
|
1889
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncJobs</a>(syncId) -> AirweaveSDK.SyncJob[]</code></summary>
|
|
2091
1890
|
<dl>
|
|
2092
1891
|
<dd>
|
|
2093
1892
|
|
|
@@ -2099,19 +1898,17 @@ await client.sync.getSyncDag("sync_id", {
|
|
|
2099
1898
|
<dl>
|
|
2100
1899
|
<dd>
|
|
2101
1900
|
|
|
2102
|
-
|
|
1901
|
+
List all jobs for a specific sync.
|
|
2103
1902
|
|
|
2104
1903
|
## Args:
|
|
2105
1904
|
|
|
2106
1905
|
db: The database session
|
|
2107
|
-
sync_id: The ID of the sync to
|
|
2108
|
-
query: The search query text
|
|
2109
|
-
response_type: Type of response (raw results or AI completion)
|
|
1906
|
+
sync_id: The ID of the sync to list jobs for
|
|
2110
1907
|
user: The current user
|
|
2111
1908
|
|
|
2112
1909
|
## Returns:
|
|
2113
1910
|
|
|
2114
|
-
|
|
1911
|
+
list[schemas.SyncJob]: A list of sync jobs
|
|
2115
1912
|
|
|
2116
1913
|
</dd>
|
|
2117
1914
|
</dl>
|
|
@@ -2127,11 +1924,7 @@ Search for documents within a specific sync.
|
|
|
2127
1924
|
<dd>
|
|
2128
1925
|
|
|
2129
1926
|
```typescript
|
|
2130
|
-
await client.
|
|
2131
|
-
syncId: "sync_id",
|
|
2132
|
-
query: "query",
|
|
2133
|
-
creds: "creds",
|
|
2134
|
-
});
|
|
1927
|
+
await client.sync.listSyncJobs("sync_id");
|
|
2135
1928
|
```
|
|
2136
1929
|
|
|
2137
1930
|
</dd>
|
|
@@ -2147,7 +1940,7 @@ await client.search.search({
|
|
|
2147
1940
|
<dl>
|
|
2148
1941
|
<dd>
|
|
2149
1942
|
|
|
2150
|
-
**
|
|
1943
|
+
**syncId:** `string`
|
|
2151
1944
|
|
|
2152
1945
|
</dd>
|
|
2153
1946
|
</dl>
|
|
@@ -2155,7 +1948,7 @@ await client.search.search({
|
|
|
2155
1948
|
<dl>
|
|
2156
1949
|
<dd>
|
|
2157
1950
|
|
|
2158
|
-
**requestOptions:** `
|
|
1951
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2159
1952
|
|
|
2160
1953
|
</dd>
|
|
2161
1954
|
</dl>
|
|
@@ -2166,9 +1959,7 @@ await client.search.search({
|
|
|
2166
1959
|
</dl>
|
|
2167
1960
|
</details>
|
|
2168
1961
|
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>({ ...params }) -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
1962
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncJob</a>(syncId, jobId) -> AirweaveSDK.SyncJob</code></summary>
|
|
2172
1963
|
<dl>
|
|
2173
1964
|
<dd>
|
|
2174
1965
|
|
|
@@ -2180,16 +1971,18 @@ await client.search.search({
|
|
|
2180
1971
|
<dl>
|
|
2181
1972
|
<dd>
|
|
2182
1973
|
|
|
2183
|
-
|
|
1974
|
+
Get details of a specific sync job.
|
|
2184
1975
|
|
|
2185
1976
|
## Args:
|
|
2186
1977
|
|
|
2187
1978
|
db: The database session
|
|
2188
|
-
|
|
1979
|
+
sync_id: The ID of the sync to list jobs for
|
|
1980
|
+
job_id: The ID of the job to get
|
|
1981
|
+
user: The current user
|
|
2189
1982
|
|
|
2190
1983
|
## Returns:
|
|
2191
1984
|
|
|
2192
|
-
|
|
1985
|
+
sync_job (schemas.SyncJob): The sync job
|
|
2193
1986
|
|
|
2194
1987
|
</dd>
|
|
2195
1988
|
</dl>
|
|
@@ -2205,9 +1998,7 @@ List all white labels for the current user's organization.
|
|
|
2205
1998
|
<dd>
|
|
2206
1999
|
|
|
2207
2000
|
```typescript
|
|
2208
|
-
await client.
|
|
2209
|
-
creds: "creds",
|
|
2210
|
-
});
|
|
2001
|
+
await client.sync.getSyncJob("sync_id", "job_id");
|
|
2211
2002
|
```
|
|
2212
2003
|
|
|
2213
2004
|
</dd>
|
|
@@ -2223,7 +2014,7 @@ await client.whiteLabels.listWhiteLabels({
|
|
|
2223
2014
|
<dl>
|
|
2224
2015
|
<dd>
|
|
2225
2016
|
|
|
2226
|
-
**
|
|
2017
|
+
**syncId:** `string`
|
|
2227
2018
|
|
|
2228
2019
|
</dd>
|
|
2229
2020
|
</dl>
|
|
@@ -2231,7 +2022,15 @@ await client.whiteLabels.listWhiteLabels({
|
|
|
2231
2022
|
<dl>
|
|
2232
2023
|
<dd>
|
|
2233
2024
|
|
|
2234
|
-
**
|
|
2025
|
+
**jobId:** `string`
|
|
2026
|
+
|
|
2027
|
+
</dd>
|
|
2028
|
+
</dl>
|
|
2029
|
+
|
|
2030
|
+
<dl>
|
|
2031
|
+
<dd>
|
|
2032
|
+
|
|
2033
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2235
2034
|
|
|
2236
2035
|
</dd>
|
|
2237
2036
|
</dl>
|
|
@@ -2242,7 +2041,7 @@ await client.whiteLabels.listWhiteLabels({
|
|
|
2242
2041
|
</dl>
|
|
2243
2042
|
</details>
|
|
2244
2043
|
|
|
2245
|
-
<details><summary><code>client.
|
|
2044
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">subscribeSyncJob</a>(jobId) -> unknown</code></summary>
|
|
2246
2045
|
<dl>
|
|
2247
2046
|
<dd>
|
|
2248
2047
|
|
|
@@ -2254,17 +2053,17 @@ await client.whiteLabels.listWhiteLabels({
|
|
|
2254
2053
|
<dl>
|
|
2255
2054
|
<dd>
|
|
2256
2055
|
|
|
2257
|
-
|
|
2056
|
+
Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
2258
2057
|
|
|
2259
2058
|
## Args:
|
|
2260
2059
|
|
|
2060
|
+
job_id: The ID of the job to subscribe to
|
|
2061
|
+
request: The request object
|
|
2261
2062
|
db: The database session
|
|
2262
|
-
current_user: The current user
|
|
2263
|
-
white_label_in: The white label to create
|
|
2264
2063
|
|
|
2265
2064
|
## Returns:
|
|
2266
2065
|
|
|
2267
|
-
|
|
2066
|
+
StreamingResponse: The streaming response
|
|
2268
2067
|
|
|
2269
2068
|
</dd>
|
|
2270
2069
|
</dl>
|
|
@@ -2280,14 +2079,7 @@ Create new white label integration.
|
|
|
2280
2079
|
<dd>
|
|
2281
2080
|
|
|
2282
2081
|
```typescript
|
|
2283
|
-
await client.
|
|
2284
|
-
creds: "creds",
|
|
2285
|
-
name: "name",
|
|
2286
|
-
sourceShortName: "source_short_name",
|
|
2287
|
-
redirectUrl: "redirect_url",
|
|
2288
|
-
clientId: "client_id",
|
|
2289
|
-
clientSecret: "client_secret",
|
|
2290
|
-
});
|
|
2082
|
+
await client.sync.subscribeSyncJob("job_id");
|
|
2291
2083
|
```
|
|
2292
2084
|
|
|
2293
2085
|
</dd>
|
|
@@ -2303,7 +2095,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2303
2095
|
<dl>
|
|
2304
2096
|
<dd>
|
|
2305
2097
|
|
|
2306
|
-
**
|
|
2098
|
+
**jobId:** `string`
|
|
2307
2099
|
|
|
2308
2100
|
</dd>
|
|
2309
2101
|
</dl>
|
|
@@ -2311,7 +2103,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2311
2103
|
<dl>
|
|
2312
2104
|
<dd>
|
|
2313
2105
|
|
|
2314
|
-
**requestOptions:** `
|
|
2106
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2315
2107
|
|
|
2316
2108
|
</dd>
|
|
2317
2109
|
</dl>
|
|
@@ -2322,7 +2114,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2322
2114
|
</dl>
|
|
2323
2115
|
</details>
|
|
2324
2116
|
|
|
2325
|
-
<details><summary><code>client.
|
|
2117
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
2326
2118
|
<dl>
|
|
2327
2119
|
<dd>
|
|
2328
2120
|
|
|
@@ -2334,17 +2126,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2334
2126
|
<dl>
|
|
2335
2127
|
<dd>
|
|
2336
2128
|
|
|
2337
|
-
Get a specific
|
|
2338
|
-
|
|
2339
|
-
## Args:
|
|
2340
|
-
|
|
2341
|
-
db: The database session
|
|
2342
|
-
white_label_id: The ID of the white label to get
|
|
2343
|
-
current_user: The current user
|
|
2344
|
-
|
|
2345
|
-
## Returns:
|
|
2346
|
-
|
|
2347
|
-
white_label (schemas.WhiteLabel): The white label
|
|
2129
|
+
Get the DAG for a specific sync.
|
|
2348
2130
|
|
|
2349
2131
|
</dd>
|
|
2350
2132
|
</dl>
|
|
@@ -2360,9 +2142,7 @@ Get a specific white label integration.
|
|
|
2360
2142
|
<dd>
|
|
2361
2143
|
|
|
2362
2144
|
```typescript
|
|
2363
|
-
await client.
|
|
2364
|
-
creds: "creds",
|
|
2365
|
-
});
|
|
2145
|
+
await client.sync.getSyncDag("sync_id");
|
|
2366
2146
|
```
|
|
2367
2147
|
|
|
2368
2148
|
</dd>
|
|
@@ -2378,15 +2158,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id", {
|
|
|
2378
2158
|
<dl>
|
|
2379
2159
|
<dd>
|
|
2380
2160
|
|
|
2381
|
-
**
|
|
2382
|
-
|
|
2383
|
-
</dd>
|
|
2384
|
-
</dl>
|
|
2385
|
-
|
|
2386
|
-
<dl>
|
|
2387
|
-
<dd>
|
|
2388
|
-
|
|
2389
|
-
**request:** `AirweaveSDK.GetWhiteLabelWhiteLabelsWhiteLabelIdGetRequest`
|
|
2161
|
+
**syncId:** `string`
|
|
2390
2162
|
|
|
2391
2163
|
</dd>
|
|
2392
2164
|
</dl>
|
|
@@ -2394,7 +2166,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id", {
|
|
|
2394
2166
|
<dl>
|
|
2395
2167
|
<dd>
|
|
2396
2168
|
|
|
2397
|
-
**requestOptions:** `
|
|
2169
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2398
2170
|
|
|
2399
2171
|
</dd>
|
|
2400
2172
|
</dl>
|
|
@@ -2405,7 +2177,9 @@ await client.whiteLabels.getWhiteLabel("white_label_id", {
|
|
|
2405
2177
|
</dl>
|
|
2406
2178
|
</details>
|
|
2407
2179
|
|
|
2408
|
-
|
|
2180
|
+
## Search
|
|
2181
|
+
|
|
2182
|
+
<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>({ ...params }) -> Record<string, unknown></code></summary>
|
|
2409
2183
|
<dl>
|
|
2410
2184
|
<dd>
|
|
2411
2185
|
|
|
@@ -2417,18 +2191,19 @@ await client.whiteLabels.getWhiteLabel("white_label_id", {
|
|
|
2417
2191
|
<dl>
|
|
2418
2192
|
<dd>
|
|
2419
2193
|
|
|
2420
|
-
|
|
2194
|
+
Search for documents within a specific sync.
|
|
2421
2195
|
|
|
2422
2196
|
## Args:
|
|
2423
2197
|
|
|
2424
2198
|
db: The database session
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2199
|
+
sync_id: The ID of the sync to search within
|
|
2200
|
+
query: The search query text
|
|
2201
|
+
response_type: Type of response (raw results or AI completion)
|
|
2202
|
+
user: The current user
|
|
2428
2203
|
|
|
2429
2204
|
## Returns:
|
|
2430
2205
|
|
|
2431
|
-
|
|
2206
|
+
dict: A dictionary containing search results or AI completion
|
|
2432
2207
|
|
|
2433
2208
|
</dd>
|
|
2434
2209
|
</dl>
|
|
@@ -2444,12 +2219,9 @@ Update a white label integration.
|
|
|
2444
2219
|
<dd>
|
|
2445
2220
|
|
|
2446
2221
|
```typescript
|
|
2447
|
-
await client.
|
|
2448
|
-
|
|
2449
|
-
|
|
2450
|
-
redirectUrl: undefined,
|
|
2451
|
-
clientId: undefined,
|
|
2452
|
-
clientSecret: undefined,
|
|
2222
|
+
await client.search.search({
|
|
2223
|
+
syncId: "sync_id",
|
|
2224
|
+
query: "query",
|
|
2453
2225
|
});
|
|
2454
2226
|
```
|
|
2455
2227
|
|
|
@@ -2466,15 +2238,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id", {
|
|
|
2466
2238
|
<dl>
|
|
2467
2239
|
<dd>
|
|
2468
2240
|
|
|
2469
|
-
**
|
|
2470
|
-
|
|
2471
|
-
</dd>
|
|
2472
|
-
</dl>
|
|
2473
|
-
|
|
2474
|
-
<dl>
|
|
2475
|
-
<dd>
|
|
2476
|
-
|
|
2477
|
-
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
2241
|
+
**request:** `AirweaveSDK.SearchSearchGetRequest`
|
|
2478
2242
|
|
|
2479
2243
|
</dd>
|
|
2480
2244
|
</dl>
|
|
@@ -2482,7 +2246,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id", {
|
|
|
2482
2246
|
<dl>
|
|
2483
2247
|
<dd>
|
|
2484
2248
|
|
|
2485
|
-
**requestOptions:** `
|
|
2249
|
+
**requestOptions:** `Search.RequestOptions`
|
|
2486
2250
|
|
|
2487
2251
|
</dd>
|
|
2488
2252
|
</dl>
|
|
@@ -2493,7 +2257,9 @@ await client.whiteLabels.updateWhiteLabel("white_label_id", {
|
|
|
2493
2257
|
</dl>
|
|
2494
2258
|
</details>
|
|
2495
2259
|
|
|
2496
|
-
|
|
2260
|
+
## WhiteLabels
|
|
2261
|
+
|
|
2262
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
2497
2263
|
<dl>
|
|
2498
2264
|
<dd>
|
|
2499
2265
|
|
|
@@ -2505,17 +2271,16 @@ await client.whiteLabels.updateWhiteLabel("white_label_id", {
|
|
|
2505
2271
|
<dl>
|
|
2506
2272
|
<dd>
|
|
2507
2273
|
|
|
2508
|
-
|
|
2274
|
+
List all white labels for the current user's organization.
|
|
2509
2275
|
|
|
2510
2276
|
## Args:
|
|
2511
2277
|
|
|
2512
2278
|
db: The database session
|
|
2513
2279
|
current_user: The current user
|
|
2514
|
-
white_label_id: The ID of the white label to delete
|
|
2515
2280
|
|
|
2516
2281
|
## Returns:
|
|
2517
2282
|
|
|
2518
|
-
|
|
2283
|
+
list[schemas.WhiteLabel]: A list of white labels
|
|
2519
2284
|
|
|
2520
2285
|
</dd>
|
|
2521
2286
|
</dl>
|
|
@@ -2531,9 +2296,7 @@ Delete a white label integration.
|
|
|
2531
2296
|
<dd>
|
|
2532
2297
|
|
|
2533
2298
|
```typescript
|
|
2534
|
-
await client.whiteLabels.
|
|
2535
|
-
creds: "creds",
|
|
2536
|
-
});
|
|
2299
|
+
await client.whiteLabels.listWhiteLabels();
|
|
2537
2300
|
```
|
|
2538
2301
|
|
|
2539
2302
|
</dd>
|
|
@@ -2549,22 +2312,6 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id", {
|
|
|
2549
2312
|
<dl>
|
|
2550
2313
|
<dd>
|
|
2551
2314
|
|
|
2552
|
-
**whiteLabelId:** `string`
|
|
2553
|
-
|
|
2554
|
-
</dd>
|
|
2555
|
-
</dl>
|
|
2556
|
-
|
|
2557
|
-
<dl>
|
|
2558
|
-
<dd>
|
|
2559
|
-
|
|
2560
|
-
**request:** `AirweaveSDK.DeleteWhiteLabelWhiteLabelsWhiteLabelIdDeleteRequest`
|
|
2561
|
-
|
|
2562
|
-
</dd>
|
|
2563
|
-
</dl>
|
|
2564
|
-
|
|
2565
|
-
<dl>
|
|
2566
|
-
<dd>
|
|
2567
|
-
|
|
2568
2315
|
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2569
2316
|
|
|
2570
2317
|
</dd>
|
|
@@ -2576,7 +2323,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id", {
|
|
|
2576
2323
|
</dl>
|
|
2577
2324
|
</details>
|
|
2578
2325
|
|
|
2579
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">
|
|
2326
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2580
2327
|
<dl>
|
|
2581
2328
|
<dd>
|
|
2582
2329
|
|
|
@@ -2588,17 +2335,17 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id", {
|
|
|
2588
2335
|
<dl>
|
|
2589
2336
|
<dd>
|
|
2590
2337
|
|
|
2591
|
-
|
|
2338
|
+
Create new white label integration.
|
|
2592
2339
|
|
|
2593
2340
|
## Args:
|
|
2594
2341
|
|
|
2595
2342
|
db: The database session
|
|
2596
|
-
|
|
2597
|
-
|
|
2343
|
+
current_user: The current user
|
|
2344
|
+
white_label_in: The white label to create
|
|
2598
2345
|
|
|
2599
2346
|
## Returns:
|
|
2600
2347
|
|
|
2601
|
-
|
|
2348
|
+
white_label (schemas.WhiteLabel): The created white label
|
|
2602
2349
|
|
|
2603
2350
|
</dd>
|
|
2604
2351
|
</dl>
|
|
@@ -2614,8 +2361,12 @@ Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
|
2614
2361
|
<dd>
|
|
2615
2362
|
|
|
2616
2363
|
```typescript
|
|
2617
|
-
await client.whiteLabels.
|
|
2618
|
-
|
|
2364
|
+
await client.whiteLabels.createWhiteLabel({
|
|
2365
|
+
name: "name",
|
|
2366
|
+
sourceShortName: "source_short_name",
|
|
2367
|
+
redirectUrl: "redirect_url",
|
|
2368
|
+
clientId: "client_id",
|
|
2369
|
+
clientSecret: "client_secret",
|
|
2619
2370
|
});
|
|
2620
2371
|
```
|
|
2621
2372
|
|
|
@@ -2632,15 +2383,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id", {
|
|
|
2632
2383
|
<dl>
|
|
2633
2384
|
<dd>
|
|
2634
2385
|
|
|
2635
|
-
**
|
|
2636
|
-
|
|
2637
|
-
</dd>
|
|
2638
|
-
</dl>
|
|
2639
|
-
|
|
2640
|
-
<dl>
|
|
2641
|
-
<dd>
|
|
2642
|
-
|
|
2643
|
-
**request:** `AirweaveSDK.GetWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlGetRequest`
|
|
2386
|
+
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
2644
2387
|
|
|
2645
2388
|
</dd>
|
|
2646
2389
|
</dl>
|
|
@@ -2659,7 +2402,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id", {
|
|
|
2659
2402
|
</dl>
|
|
2660
2403
|
</details>
|
|
2661
2404
|
|
|
2662
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">
|
|
2405
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2663
2406
|
<dl>
|
|
2664
2407
|
<dd>
|
|
2665
2408
|
|
|
@@ -2671,18 +2414,17 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id", {
|
|
|
2671
2414
|
<dl>
|
|
2672
2415
|
<dd>
|
|
2673
2416
|
|
|
2674
|
-
|
|
2417
|
+
Get a specific white label integration.
|
|
2675
2418
|
|
|
2676
2419
|
## Args:
|
|
2677
2420
|
|
|
2678
|
-
white_label_id: The ID of the white label to exchange the code for
|
|
2679
|
-
code: The OAuth2 code
|
|
2680
2421
|
db: The database session
|
|
2681
|
-
|
|
2422
|
+
white_label_id: The ID of the white label to get
|
|
2423
|
+
current_user: The current user
|
|
2682
2424
|
|
|
2683
2425
|
## Returns:
|
|
2684
2426
|
|
|
2685
|
-
|
|
2427
|
+
white_label (schemas.WhiteLabel): The white label
|
|
2686
2428
|
|
|
2687
2429
|
</dd>
|
|
2688
2430
|
</dl>
|
|
@@ -2698,10 +2440,7 @@ Exchange OAuth2 code for tokens and create connection.
|
|
|
2698
2440
|
<dd>
|
|
2699
2441
|
|
|
2700
2442
|
```typescript
|
|
2701
|
-
await client.whiteLabels.
|
|
2702
|
-
creds: "creds",
|
|
2703
|
-
body: "string",
|
|
2704
|
-
});
|
|
2443
|
+
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
2705
2444
|
```
|
|
2706
2445
|
|
|
2707
2446
|
</dd>
|
|
@@ -2725,14 +2464,6 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
|
2725
2464
|
<dl>
|
|
2726
2465
|
<dd>
|
|
2727
2466
|
|
|
2728
|
-
**request:** `AirweaveSDK.ExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePostRequest`
|
|
2729
|
-
|
|
2730
|
-
</dd>
|
|
2731
|
-
</dl>
|
|
2732
|
-
|
|
2733
|
-
<dl>
|
|
2734
|
-
<dd>
|
|
2735
|
-
|
|
2736
2467
|
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2737
2468
|
|
|
2738
2469
|
</dd>
|
|
@@ -2744,7 +2475,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
|
2744
2475
|
</dl>
|
|
2745
2476
|
</details>
|
|
2746
2477
|
|
|
2747
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">
|
|
2478
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2748
2479
|
<dl>
|
|
2749
2480
|
<dd>
|
|
2750
2481
|
|
|
@@ -2756,17 +2487,18 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
|
2756
2487
|
<dl>
|
|
2757
2488
|
<dd>
|
|
2758
2489
|
|
|
2759
|
-
|
|
2490
|
+
Update a white label integration.
|
|
2760
2491
|
|
|
2761
2492
|
## Args:
|
|
2762
2493
|
|
|
2763
|
-
white_label_id: The ID of the white label to list syncs for
|
|
2764
2494
|
db: The database session
|
|
2765
2495
|
current_user: The current user
|
|
2496
|
+
white_label_id: The ID of the white label to update
|
|
2497
|
+
white_label_in: The white label to update
|
|
2766
2498
|
|
|
2767
2499
|
## Returns:
|
|
2768
2500
|
|
|
2769
|
-
|
|
2501
|
+
white_label (schemas.WhiteLabel): The updated white label
|
|
2770
2502
|
|
|
2771
2503
|
</dd>
|
|
2772
2504
|
</dl>
|
|
@@ -2782,9 +2514,7 @@ List all syncs for a specific white label.
|
|
|
2782
2514
|
<dd>
|
|
2783
2515
|
|
|
2784
2516
|
```typescript
|
|
2785
|
-
await client.whiteLabels.
|
|
2786
|
-
creds: "creds",
|
|
2787
|
-
});
|
|
2517
|
+
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
2788
2518
|
```
|
|
2789
2519
|
|
|
2790
2520
|
</dd>
|
|
@@ -2808,7 +2538,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id", {
|
|
|
2808
2538
|
<dl>
|
|
2809
2539
|
<dd>
|
|
2810
2540
|
|
|
2811
|
-
**request:** `AirweaveSDK.
|
|
2541
|
+
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
2812
2542
|
|
|
2813
2543
|
</dd>
|
|
2814
2544
|
</dl>
|
|
@@ -2826,3 +2556,1191 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id", {
|
|
|
2826
2556
|
</dd>
|
|
2827
2557
|
</dl>
|
|
2828
2558
|
</details>
|
|
2559
|
+
|
|
2560
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2561
|
+
<dl>
|
|
2562
|
+
<dd>
|
|
2563
|
+
|
|
2564
|
+
#### 📝 Description
|
|
2565
|
+
|
|
2566
|
+
<dl>
|
|
2567
|
+
<dd>
|
|
2568
|
+
|
|
2569
|
+
<dl>
|
|
2570
|
+
<dd>
|
|
2571
|
+
|
|
2572
|
+
Delete a white label integration.
|
|
2573
|
+
|
|
2574
|
+
## Args:
|
|
2575
|
+
|
|
2576
|
+
db: The database session
|
|
2577
|
+
current_user: The current user
|
|
2578
|
+
white_label_id: The ID of the white label to delete
|
|
2579
|
+
|
|
2580
|
+
## Returns:
|
|
2581
|
+
|
|
2582
|
+
white_label (schemas.WhiteLabel): The deleted white label
|
|
2583
|
+
|
|
2584
|
+
</dd>
|
|
2585
|
+
</dl>
|
|
2586
|
+
</dd>
|
|
2587
|
+
</dl>
|
|
2588
|
+
|
|
2589
|
+
#### 🔌 Usage
|
|
2590
|
+
|
|
2591
|
+
<dl>
|
|
2592
|
+
<dd>
|
|
2593
|
+
|
|
2594
|
+
<dl>
|
|
2595
|
+
<dd>
|
|
2596
|
+
|
|
2597
|
+
```typescript
|
|
2598
|
+
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
2599
|
+
```
|
|
2600
|
+
|
|
2601
|
+
</dd>
|
|
2602
|
+
</dl>
|
|
2603
|
+
</dd>
|
|
2604
|
+
</dl>
|
|
2605
|
+
|
|
2606
|
+
#### ⚙️ Parameters
|
|
2607
|
+
|
|
2608
|
+
<dl>
|
|
2609
|
+
<dd>
|
|
2610
|
+
|
|
2611
|
+
<dl>
|
|
2612
|
+
<dd>
|
|
2613
|
+
|
|
2614
|
+
**whiteLabelId:** `string`
|
|
2615
|
+
|
|
2616
|
+
</dd>
|
|
2617
|
+
</dl>
|
|
2618
|
+
|
|
2619
|
+
<dl>
|
|
2620
|
+
<dd>
|
|
2621
|
+
|
|
2622
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2623
|
+
|
|
2624
|
+
</dd>
|
|
2625
|
+
</dl>
|
|
2626
|
+
</dd>
|
|
2627
|
+
</dl>
|
|
2628
|
+
|
|
2629
|
+
</dd>
|
|
2630
|
+
</dl>
|
|
2631
|
+
</details>
|
|
2632
|
+
|
|
2633
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
2634
|
+
<dl>
|
|
2635
|
+
<dd>
|
|
2636
|
+
|
|
2637
|
+
#### 📝 Description
|
|
2638
|
+
|
|
2639
|
+
<dl>
|
|
2640
|
+
<dd>
|
|
2641
|
+
|
|
2642
|
+
<dl>
|
|
2643
|
+
<dd>
|
|
2644
|
+
|
|
2645
|
+
Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
2646
|
+
|
|
2647
|
+
## Args:
|
|
2648
|
+
|
|
2649
|
+
db: The database session
|
|
2650
|
+
white_label_id: The ID of the white label to get the auth URL for
|
|
2651
|
+
user: The current user
|
|
2652
|
+
|
|
2653
|
+
## Returns:
|
|
2654
|
+
|
|
2655
|
+
str: The OAuth2 authorization URL
|
|
2656
|
+
|
|
2657
|
+
</dd>
|
|
2658
|
+
</dl>
|
|
2659
|
+
</dd>
|
|
2660
|
+
</dl>
|
|
2661
|
+
|
|
2662
|
+
#### 🔌 Usage
|
|
2663
|
+
|
|
2664
|
+
<dl>
|
|
2665
|
+
<dd>
|
|
2666
|
+
|
|
2667
|
+
<dl>
|
|
2668
|
+
<dd>
|
|
2669
|
+
|
|
2670
|
+
```typescript
|
|
2671
|
+
await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
2672
|
+
```
|
|
2673
|
+
|
|
2674
|
+
</dd>
|
|
2675
|
+
</dl>
|
|
2676
|
+
</dd>
|
|
2677
|
+
</dl>
|
|
2678
|
+
|
|
2679
|
+
#### ⚙️ Parameters
|
|
2680
|
+
|
|
2681
|
+
<dl>
|
|
2682
|
+
<dd>
|
|
2683
|
+
|
|
2684
|
+
<dl>
|
|
2685
|
+
<dd>
|
|
2686
|
+
|
|
2687
|
+
**whiteLabelId:** `string`
|
|
2688
|
+
|
|
2689
|
+
</dd>
|
|
2690
|
+
</dl>
|
|
2691
|
+
|
|
2692
|
+
<dl>
|
|
2693
|
+
<dd>
|
|
2694
|
+
|
|
2695
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2696
|
+
|
|
2697
|
+
</dd>
|
|
2698
|
+
</dl>
|
|
2699
|
+
</dd>
|
|
2700
|
+
</dl>
|
|
2701
|
+
|
|
2702
|
+
</dd>
|
|
2703
|
+
</dl>
|
|
2704
|
+
</details>
|
|
2705
|
+
|
|
2706
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
2707
|
+
<dl>
|
|
2708
|
+
<dd>
|
|
2709
|
+
|
|
2710
|
+
#### 📝 Description
|
|
2711
|
+
|
|
2712
|
+
<dl>
|
|
2713
|
+
<dd>
|
|
2714
|
+
|
|
2715
|
+
<dl>
|
|
2716
|
+
<dd>
|
|
2717
|
+
|
|
2718
|
+
Exchange OAuth2 code for tokens and create connection.
|
|
2719
|
+
|
|
2720
|
+
## Args:
|
|
2721
|
+
|
|
2722
|
+
white_label_id: The ID of the white label to exchange the code for
|
|
2723
|
+
code: The OAuth2 code
|
|
2724
|
+
db: The database session
|
|
2725
|
+
user: The current user
|
|
2726
|
+
|
|
2727
|
+
## Returns:
|
|
2728
|
+
|
|
2729
|
+
connection (schemas.Connection): The created connection
|
|
2730
|
+
|
|
2731
|
+
</dd>
|
|
2732
|
+
</dl>
|
|
2733
|
+
</dd>
|
|
2734
|
+
</dl>
|
|
2735
|
+
|
|
2736
|
+
#### 🔌 Usage
|
|
2737
|
+
|
|
2738
|
+
<dl>
|
|
2739
|
+
<dd>
|
|
2740
|
+
|
|
2741
|
+
<dl>
|
|
2742
|
+
<dd>
|
|
2743
|
+
|
|
2744
|
+
```typescript
|
|
2745
|
+
await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string");
|
|
2746
|
+
```
|
|
2747
|
+
|
|
2748
|
+
</dd>
|
|
2749
|
+
</dl>
|
|
2750
|
+
</dd>
|
|
2751
|
+
</dl>
|
|
2752
|
+
|
|
2753
|
+
#### ⚙️ Parameters
|
|
2754
|
+
|
|
2755
|
+
<dl>
|
|
2756
|
+
<dd>
|
|
2757
|
+
|
|
2758
|
+
<dl>
|
|
2759
|
+
<dd>
|
|
2760
|
+
|
|
2761
|
+
**whiteLabelId:** `string`
|
|
2762
|
+
|
|
2763
|
+
</dd>
|
|
2764
|
+
</dl>
|
|
2765
|
+
|
|
2766
|
+
<dl>
|
|
2767
|
+
<dd>
|
|
2768
|
+
|
|
2769
|
+
**request:** `string`
|
|
2770
|
+
|
|
2771
|
+
</dd>
|
|
2772
|
+
</dl>
|
|
2773
|
+
|
|
2774
|
+
<dl>
|
|
2775
|
+
<dd>
|
|
2776
|
+
|
|
2777
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2778
|
+
|
|
2779
|
+
</dd>
|
|
2780
|
+
</dl>
|
|
2781
|
+
</dd>
|
|
2782
|
+
</dl>
|
|
2783
|
+
|
|
2784
|
+
</dd>
|
|
2785
|
+
</dl>
|
|
2786
|
+
</details>
|
|
2787
|
+
|
|
2788
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
2789
|
+
<dl>
|
|
2790
|
+
<dd>
|
|
2791
|
+
|
|
2792
|
+
#### 📝 Description
|
|
2793
|
+
|
|
2794
|
+
<dl>
|
|
2795
|
+
<dd>
|
|
2796
|
+
|
|
2797
|
+
<dl>
|
|
2798
|
+
<dd>
|
|
2799
|
+
|
|
2800
|
+
List all syncs for a specific white label.
|
|
2801
|
+
|
|
2802
|
+
## Args:
|
|
2803
|
+
|
|
2804
|
+
white_label_id: The ID of the white label to list syncs for
|
|
2805
|
+
db: The database session
|
|
2806
|
+
current_user: The current user
|
|
2807
|
+
|
|
2808
|
+
## Returns:
|
|
2809
|
+
|
|
2810
|
+
list[schemas.Sync]: A list of syncs
|
|
2811
|
+
|
|
2812
|
+
</dd>
|
|
2813
|
+
</dl>
|
|
2814
|
+
</dd>
|
|
2815
|
+
</dl>
|
|
2816
|
+
|
|
2817
|
+
#### 🔌 Usage
|
|
2818
|
+
|
|
2819
|
+
<dl>
|
|
2820
|
+
<dd>
|
|
2821
|
+
|
|
2822
|
+
<dl>
|
|
2823
|
+
<dd>
|
|
2824
|
+
|
|
2825
|
+
```typescript
|
|
2826
|
+
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
2827
|
+
```
|
|
2828
|
+
|
|
2829
|
+
</dd>
|
|
2830
|
+
</dl>
|
|
2831
|
+
</dd>
|
|
2832
|
+
</dl>
|
|
2833
|
+
|
|
2834
|
+
#### ⚙️ Parameters
|
|
2835
|
+
|
|
2836
|
+
<dl>
|
|
2837
|
+
<dd>
|
|
2838
|
+
|
|
2839
|
+
<dl>
|
|
2840
|
+
<dd>
|
|
2841
|
+
|
|
2842
|
+
**whiteLabelId:** `string`
|
|
2843
|
+
|
|
2844
|
+
</dd>
|
|
2845
|
+
</dl>
|
|
2846
|
+
|
|
2847
|
+
<dl>
|
|
2848
|
+
<dd>
|
|
2849
|
+
|
|
2850
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2851
|
+
|
|
2852
|
+
</dd>
|
|
2853
|
+
</dl>
|
|
2854
|
+
</dd>
|
|
2855
|
+
</dl>
|
|
2856
|
+
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
</details>
|
|
2860
|
+
|
|
2861
|
+
## Chat
|
|
2862
|
+
|
|
2863
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">listChats</a>({ ...params }) -> AirweaveSDK.Chat[]</code></summary>
|
|
2864
|
+
<dl>
|
|
2865
|
+
<dd>
|
|
2866
|
+
|
|
2867
|
+
#### 📝 Description
|
|
2868
|
+
|
|
2869
|
+
<dl>
|
|
2870
|
+
<dd>
|
|
2871
|
+
|
|
2872
|
+
<dl>
|
|
2873
|
+
<dd>
|
|
2874
|
+
|
|
2875
|
+
List all chats for the current user.
|
|
2876
|
+
|
|
2877
|
+
## Args:
|
|
2878
|
+
|
|
2879
|
+
db: The database session.
|
|
2880
|
+
skip: The number of chats to skip.
|
|
2881
|
+
limit: The number of chats to return.
|
|
2882
|
+
user: The current user.
|
|
2883
|
+
|
|
2884
|
+
## Returns:
|
|
2885
|
+
|
|
2886
|
+
list[schemas.Chat]: The list of chats.
|
|
2887
|
+
|
|
2888
|
+
</dd>
|
|
2889
|
+
</dl>
|
|
2890
|
+
</dd>
|
|
2891
|
+
</dl>
|
|
2892
|
+
|
|
2893
|
+
#### 🔌 Usage
|
|
2894
|
+
|
|
2895
|
+
<dl>
|
|
2896
|
+
<dd>
|
|
2897
|
+
|
|
2898
|
+
<dl>
|
|
2899
|
+
<dd>
|
|
2900
|
+
|
|
2901
|
+
```typescript
|
|
2902
|
+
await client.chat.listChats();
|
|
2903
|
+
```
|
|
2904
|
+
|
|
2905
|
+
</dd>
|
|
2906
|
+
</dl>
|
|
2907
|
+
</dd>
|
|
2908
|
+
</dl>
|
|
2909
|
+
|
|
2910
|
+
#### ⚙️ Parameters
|
|
2911
|
+
|
|
2912
|
+
<dl>
|
|
2913
|
+
<dd>
|
|
2914
|
+
|
|
2915
|
+
<dl>
|
|
2916
|
+
<dd>
|
|
2917
|
+
|
|
2918
|
+
**request:** `AirweaveSDK.ListChatsChatGetRequest`
|
|
2919
|
+
|
|
2920
|
+
</dd>
|
|
2921
|
+
</dl>
|
|
2922
|
+
|
|
2923
|
+
<dl>
|
|
2924
|
+
<dd>
|
|
2925
|
+
|
|
2926
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
2927
|
+
|
|
2928
|
+
</dd>
|
|
2929
|
+
</dl>
|
|
2930
|
+
</dd>
|
|
2931
|
+
</dl>
|
|
2932
|
+
|
|
2933
|
+
</dd>
|
|
2934
|
+
</dl>
|
|
2935
|
+
</details>
|
|
2936
|
+
|
|
2937
|
+
<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">createChat</a>({ ...params }) -> AirweaveSDK.Chat</code></summary>
|
|
2938
|
+
<dl>
|
|
2939
|
+
<dd>
|
|
2940
|
+
|
|
2941
|
+
#### 📝 Description
|
|
2942
|
+
|
|
2943
|
+
<dl>
|
|
2944
|
+
<dd>
|
|
2945
|
+
|
|
2946
|
+
<dl>
|
|
2947
|
+
<dd>
|
|
2948
|
+
|
|
2949
|
+
Create a new chat.
|
|
2950
|
+
|
|
2951
|
+
## Args:
|
|
2952
|
+
|
|
2953
|
+
db: The database session.
|
|
2954
|
+
chat_in: The chat creation data.
|
|
2955
|
+
user: The current user.
|
|
2956
|
+
|
|
2957
|
+
## Returns:
|
|
2958
|
+
|
|
2959
|
+
schemas.Chat: The created chat.
|
|
2960
|
+
|
|
2961
|
+
</dd>
|
|
2962
|
+
</dl>
|
|
2963
|
+
</dd>
|
|
2964
|
+
</dl>
|
|
2965
|
+
|
|
2966
|
+
#### 🔌 Usage
|
|
2967
|
+
|
|
2968
|
+
<dl>
|
|
2969
|
+
<dd>
|
|
2970
|
+
|
|
2971
|
+
<dl>
|
|
2972
|
+
<dd>
|
|
2973
|
+
|
|
2974
|
+
```typescript
|
|
2975
|
+
await client.chat.createChat({
|
|
2976
|
+
name: "name",
|
|
2977
|
+
syncId: "sync_id",
|
|
2978
|
+
});
|
|
2979
|
+
```
|
|
2980
|
+
|
|
2981
|
+
</dd>
|
|
2982
|
+
</dl>
|
|
2983
|
+
</dd>
|
|
2984
|
+
</dl>
|
|
2985
|
+
|
|
2986
|
+
#### ⚙️ Parameters
|
|
2987
|
+
|
|
2988
|
+
<dl>
|
|
2989
|
+
<dd>
|
|
2990
|
+
|
|
2991
|
+
<dl>
|
|
2992
|
+
<dd>
|
|
2993
|
+
|
|
2994
|
+
**request:** `AirweaveSDK.ChatCreate`
|
|
2995
|
+
|
|
2996
|
+
</dd>
|
|
2997
|
+
</dl>
|
|
2998
|
+
|
|
2999
|
+
<dl>
|
|
3000
|
+
<dd>
|
|
3001
|
+
|
|
3002
|
+
**requestOptions:** `Chat.RequestOptions`
|
|
3003
|
+
|
|
3004
|
+
</dd>
|
|
3005
|
+
</dl>
|
|
3006
|
+
</dd>
|
|
3007
|
+
</dl>
|
|
3008
|
+
|
|
3009
|
+
</dd>
|
|
3010
|
+
</dl>
|
|
3011
|
+
</details>
|
|
3012
|
+
|
|
3013
|
+
## Dag
|
|
3014
|
+
|
|
3015
|
+
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
3016
|
+
<dl>
|
|
3017
|
+
<dd>
|
|
3018
|
+
|
|
3019
|
+
#### 📝 Description
|
|
3020
|
+
|
|
3021
|
+
<dl>
|
|
3022
|
+
<dd>
|
|
3023
|
+
|
|
3024
|
+
<dl>
|
|
3025
|
+
<dd>
|
|
3026
|
+
|
|
3027
|
+
Get the DAG definition for a sync.
|
|
3028
|
+
|
|
3029
|
+
</dd>
|
|
3030
|
+
</dl>
|
|
3031
|
+
</dd>
|
|
3032
|
+
</dl>
|
|
3033
|
+
|
|
3034
|
+
#### 🔌 Usage
|
|
3035
|
+
|
|
3036
|
+
<dl>
|
|
3037
|
+
<dd>
|
|
3038
|
+
|
|
3039
|
+
<dl>
|
|
3040
|
+
<dd>
|
|
3041
|
+
|
|
3042
|
+
```typescript
|
|
3043
|
+
await client.dag.getSyncDag("sync_id");
|
|
3044
|
+
```
|
|
3045
|
+
|
|
3046
|
+
</dd>
|
|
3047
|
+
</dl>
|
|
3048
|
+
</dd>
|
|
3049
|
+
</dl>
|
|
3050
|
+
|
|
3051
|
+
#### ⚙️ Parameters
|
|
3052
|
+
|
|
3053
|
+
<dl>
|
|
3054
|
+
<dd>
|
|
3055
|
+
|
|
3056
|
+
<dl>
|
|
3057
|
+
<dd>
|
|
3058
|
+
|
|
3059
|
+
**syncId:** `string`
|
|
3060
|
+
|
|
3061
|
+
</dd>
|
|
3062
|
+
</dl>
|
|
3063
|
+
|
|
3064
|
+
<dl>
|
|
3065
|
+
<dd>
|
|
3066
|
+
|
|
3067
|
+
**requestOptions:** `Dag.RequestOptions`
|
|
3068
|
+
|
|
3069
|
+
</dd>
|
|
3070
|
+
</dl>
|
|
3071
|
+
</dd>
|
|
3072
|
+
</dl>
|
|
3073
|
+
|
|
3074
|
+
</dd>
|
|
3075
|
+
</dl>
|
|
3076
|
+
</details>
|
|
3077
|
+
|
|
3078
|
+
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">createSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
|
|
3079
|
+
<dl>
|
|
3080
|
+
<dd>
|
|
3081
|
+
|
|
3082
|
+
#### 📝 Description
|
|
3083
|
+
|
|
3084
|
+
<dl>
|
|
3085
|
+
<dd>
|
|
3086
|
+
|
|
3087
|
+
<dl>
|
|
3088
|
+
<dd>
|
|
3089
|
+
|
|
3090
|
+
Create a new DAG definition for a sync.
|
|
3091
|
+
|
|
3092
|
+
</dd>
|
|
3093
|
+
</dl>
|
|
3094
|
+
</dd>
|
|
3095
|
+
</dl>
|
|
3096
|
+
|
|
3097
|
+
#### 🔌 Usage
|
|
3098
|
+
|
|
3099
|
+
<dl>
|
|
3100
|
+
<dd>
|
|
3101
|
+
|
|
3102
|
+
<dl>
|
|
3103
|
+
<dd>
|
|
3104
|
+
|
|
3105
|
+
```typescript
|
|
3106
|
+
await client.dag.createSyncDag("sync_id", {
|
|
3107
|
+
name: "name",
|
|
3108
|
+
syncDagCreateSyncId: "sync_id",
|
|
3109
|
+
nodes: [
|
|
3110
|
+
{
|
|
3111
|
+
type: "source",
|
|
3112
|
+
name: "name",
|
|
3113
|
+
},
|
|
3114
|
+
],
|
|
3115
|
+
edges: [
|
|
3116
|
+
{
|
|
3117
|
+
fromNodeId: "from_node_id",
|
|
3118
|
+
toNodeId: "to_node_id",
|
|
3119
|
+
},
|
|
3120
|
+
],
|
|
3121
|
+
});
|
|
3122
|
+
```
|
|
3123
|
+
|
|
3124
|
+
</dd>
|
|
3125
|
+
</dl>
|
|
3126
|
+
</dd>
|
|
3127
|
+
</dl>
|
|
3128
|
+
|
|
3129
|
+
#### ⚙️ Parameters
|
|
3130
|
+
|
|
3131
|
+
<dl>
|
|
3132
|
+
<dd>
|
|
3133
|
+
|
|
3134
|
+
<dl>
|
|
3135
|
+
<dd>
|
|
3136
|
+
|
|
3137
|
+
**syncId:** `string`
|
|
3138
|
+
|
|
3139
|
+
</dd>
|
|
3140
|
+
</dl>
|
|
3141
|
+
|
|
3142
|
+
<dl>
|
|
3143
|
+
<dd>
|
|
3144
|
+
|
|
3145
|
+
**request:** `AirweaveSDK.SyncDagCreate`
|
|
3146
|
+
|
|
3147
|
+
</dd>
|
|
3148
|
+
</dl>
|
|
3149
|
+
|
|
3150
|
+
<dl>
|
|
3151
|
+
<dd>
|
|
3152
|
+
|
|
3153
|
+
**requestOptions:** `Dag.RequestOptions`
|
|
3154
|
+
|
|
3155
|
+
</dd>
|
|
3156
|
+
</dl>
|
|
3157
|
+
</dd>
|
|
3158
|
+
</dl>
|
|
3159
|
+
|
|
3160
|
+
</dd>
|
|
3161
|
+
</dl>
|
|
3162
|
+
</details>
|
|
3163
|
+
|
|
3164
|
+
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">updateSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
|
|
3165
|
+
<dl>
|
|
3166
|
+
<dd>
|
|
3167
|
+
|
|
3168
|
+
#### 📝 Description
|
|
3169
|
+
|
|
3170
|
+
<dl>
|
|
3171
|
+
<dd>
|
|
3172
|
+
|
|
3173
|
+
<dl>
|
|
3174
|
+
<dd>
|
|
3175
|
+
|
|
3176
|
+
Update a DAG definition for a sync.
|
|
3177
|
+
|
|
3178
|
+
</dd>
|
|
3179
|
+
</dl>
|
|
3180
|
+
</dd>
|
|
3181
|
+
</dl>
|
|
3182
|
+
|
|
3183
|
+
#### 🔌 Usage
|
|
3184
|
+
|
|
3185
|
+
<dl>
|
|
3186
|
+
<dd>
|
|
3187
|
+
|
|
3188
|
+
<dl>
|
|
3189
|
+
<dd>
|
|
3190
|
+
|
|
3191
|
+
```typescript
|
|
3192
|
+
await client.dag.updateSyncDag("sync_id", {
|
|
3193
|
+
name: "name",
|
|
3194
|
+
syncDagUpdateSyncId: "sync_id",
|
|
3195
|
+
});
|
|
3196
|
+
```
|
|
3197
|
+
|
|
3198
|
+
</dd>
|
|
3199
|
+
</dl>
|
|
3200
|
+
</dd>
|
|
3201
|
+
</dl>
|
|
3202
|
+
|
|
3203
|
+
#### ⚙️ Parameters
|
|
3204
|
+
|
|
3205
|
+
<dl>
|
|
3206
|
+
<dd>
|
|
3207
|
+
|
|
3208
|
+
<dl>
|
|
3209
|
+
<dd>
|
|
3210
|
+
|
|
3211
|
+
**syncId:** `string`
|
|
3212
|
+
|
|
3213
|
+
</dd>
|
|
3214
|
+
</dl>
|
|
3215
|
+
|
|
3216
|
+
<dl>
|
|
3217
|
+
<dd>
|
|
3218
|
+
|
|
3219
|
+
**request:** `AirweaveSDK.SyncDagUpdate`
|
|
3220
|
+
|
|
3221
|
+
</dd>
|
|
3222
|
+
</dl>
|
|
3223
|
+
|
|
3224
|
+
<dl>
|
|
3225
|
+
<dd>
|
|
3226
|
+
|
|
3227
|
+
**requestOptions:** `Dag.RequestOptions`
|
|
3228
|
+
|
|
3229
|
+
</dd>
|
|
3230
|
+
</dl>
|
|
3231
|
+
</dd>
|
|
3232
|
+
</dl>
|
|
3233
|
+
|
|
3234
|
+
</dd>
|
|
3235
|
+
</dl>
|
|
3236
|
+
</details>
|
|
3237
|
+
|
|
3238
|
+
## Entities
|
|
3239
|
+
|
|
3240
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityDefinitions</a>() -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3241
|
+
<dl>
|
|
3242
|
+
<dd>
|
|
3243
|
+
|
|
3244
|
+
#### 📝 Description
|
|
3245
|
+
|
|
3246
|
+
<dl>
|
|
3247
|
+
<dd>
|
|
3248
|
+
|
|
3249
|
+
<dl>
|
|
3250
|
+
<dd>
|
|
3251
|
+
|
|
3252
|
+
List all entity definitions for the current user's organization.
|
|
3253
|
+
|
|
3254
|
+
</dd>
|
|
3255
|
+
</dl>
|
|
3256
|
+
</dd>
|
|
3257
|
+
</dl>
|
|
3258
|
+
|
|
3259
|
+
#### 🔌 Usage
|
|
3260
|
+
|
|
3261
|
+
<dl>
|
|
3262
|
+
<dd>
|
|
3263
|
+
|
|
3264
|
+
<dl>
|
|
3265
|
+
<dd>
|
|
3266
|
+
|
|
3267
|
+
```typescript
|
|
3268
|
+
await client.entities.listEntityDefinitions();
|
|
3269
|
+
```
|
|
3270
|
+
|
|
3271
|
+
</dd>
|
|
3272
|
+
</dl>
|
|
3273
|
+
</dd>
|
|
3274
|
+
</dl>
|
|
3275
|
+
|
|
3276
|
+
#### ⚙️ Parameters
|
|
3277
|
+
|
|
3278
|
+
<dl>
|
|
3279
|
+
<dd>
|
|
3280
|
+
|
|
3281
|
+
<dl>
|
|
3282
|
+
<dd>
|
|
3283
|
+
|
|
3284
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
3285
|
+
|
|
3286
|
+
</dd>
|
|
3287
|
+
</dl>
|
|
3288
|
+
</dd>
|
|
3289
|
+
</dl>
|
|
3290
|
+
|
|
3291
|
+
</dd>
|
|
3292
|
+
</dl>
|
|
3293
|
+
</details>
|
|
3294
|
+
|
|
3295
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityDefinition</a>({ ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
|
|
3296
|
+
<dl>
|
|
3297
|
+
<dd>
|
|
3298
|
+
|
|
3299
|
+
#### 📝 Description
|
|
3300
|
+
|
|
3301
|
+
<dl>
|
|
3302
|
+
<dd>
|
|
3303
|
+
|
|
3304
|
+
<dl>
|
|
3305
|
+
<dd>
|
|
3306
|
+
|
|
3307
|
+
Create a new entity definition.
|
|
3308
|
+
|
|
3309
|
+
</dd>
|
|
3310
|
+
</dl>
|
|
3311
|
+
</dd>
|
|
3312
|
+
</dl>
|
|
3313
|
+
|
|
3314
|
+
#### 🔌 Usage
|
|
3315
|
+
|
|
3316
|
+
<dl>
|
|
3317
|
+
<dd>
|
|
3318
|
+
|
|
3319
|
+
<dl>
|
|
3320
|
+
<dd>
|
|
3321
|
+
|
|
3322
|
+
```typescript
|
|
3323
|
+
await client.entities.createEntityDefinition({
|
|
3324
|
+
name: "name",
|
|
3325
|
+
type: "file",
|
|
3326
|
+
entitySchema: ["entity_schema"],
|
|
3327
|
+
moduleName: "module_name",
|
|
3328
|
+
className: "class_name",
|
|
3329
|
+
});
|
|
3330
|
+
```
|
|
3331
|
+
|
|
3332
|
+
</dd>
|
|
3333
|
+
</dl>
|
|
3334
|
+
</dd>
|
|
3335
|
+
</dl>
|
|
3336
|
+
|
|
3337
|
+
#### ⚙️ Parameters
|
|
3338
|
+
|
|
3339
|
+
<dl>
|
|
3340
|
+
<dd>
|
|
3341
|
+
|
|
3342
|
+
<dl>
|
|
3343
|
+
<dd>
|
|
3344
|
+
|
|
3345
|
+
**request:** `AirweaveSDK.EntityDefinitionCreate`
|
|
3346
|
+
|
|
3347
|
+
</dd>
|
|
3348
|
+
</dl>
|
|
3349
|
+
|
|
3350
|
+
<dl>
|
|
3351
|
+
<dd>
|
|
3352
|
+
|
|
3353
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
3354
|
+
|
|
3355
|
+
</dd>
|
|
3356
|
+
</dl>
|
|
3357
|
+
</dd>
|
|
3358
|
+
</dl>
|
|
3359
|
+
|
|
3360
|
+
</dd>
|
|
3361
|
+
</dl>
|
|
3362
|
+
</details>
|
|
3363
|
+
|
|
3364
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityRelations</a>() -> AirweaveSDK.EntityRelation[]</code></summary>
|
|
3365
|
+
<dl>
|
|
3366
|
+
<dd>
|
|
3367
|
+
|
|
3368
|
+
#### 📝 Description
|
|
3369
|
+
|
|
3370
|
+
<dl>
|
|
3371
|
+
<dd>
|
|
3372
|
+
|
|
3373
|
+
<dl>
|
|
3374
|
+
<dd>
|
|
3375
|
+
|
|
3376
|
+
List all entity relations for the current user's organization.
|
|
3377
|
+
|
|
3378
|
+
</dd>
|
|
3379
|
+
</dl>
|
|
3380
|
+
</dd>
|
|
3381
|
+
</dl>
|
|
3382
|
+
|
|
3383
|
+
#### 🔌 Usage
|
|
3384
|
+
|
|
3385
|
+
<dl>
|
|
3386
|
+
<dd>
|
|
3387
|
+
|
|
3388
|
+
<dl>
|
|
3389
|
+
<dd>
|
|
3390
|
+
|
|
3391
|
+
```typescript
|
|
3392
|
+
await client.entities.listEntityRelations();
|
|
3393
|
+
```
|
|
3394
|
+
|
|
3395
|
+
</dd>
|
|
3396
|
+
</dl>
|
|
3397
|
+
</dd>
|
|
3398
|
+
</dl>
|
|
3399
|
+
|
|
3400
|
+
#### ⚙️ Parameters
|
|
3401
|
+
|
|
3402
|
+
<dl>
|
|
3403
|
+
<dd>
|
|
3404
|
+
|
|
3405
|
+
<dl>
|
|
3406
|
+
<dd>
|
|
3407
|
+
|
|
3408
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
3409
|
+
|
|
3410
|
+
</dd>
|
|
3411
|
+
</dl>
|
|
3412
|
+
</dd>
|
|
3413
|
+
</dl>
|
|
3414
|
+
|
|
3415
|
+
</dd>
|
|
3416
|
+
</dl>
|
|
3417
|
+
</details>
|
|
3418
|
+
|
|
3419
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityRelation</a>({ ...params }) -> AirweaveSDK.EntityRelation</code></summary>
|
|
3420
|
+
<dl>
|
|
3421
|
+
<dd>
|
|
3422
|
+
|
|
3423
|
+
#### 📝 Description
|
|
3424
|
+
|
|
3425
|
+
<dl>
|
|
3426
|
+
<dd>
|
|
3427
|
+
|
|
3428
|
+
<dl>
|
|
3429
|
+
<dd>
|
|
3430
|
+
|
|
3431
|
+
Create a new entity relation.
|
|
3432
|
+
|
|
3433
|
+
</dd>
|
|
3434
|
+
</dl>
|
|
3435
|
+
</dd>
|
|
3436
|
+
</dl>
|
|
3437
|
+
|
|
3438
|
+
#### 🔌 Usage
|
|
3439
|
+
|
|
3440
|
+
<dl>
|
|
3441
|
+
<dd>
|
|
3442
|
+
|
|
3443
|
+
<dl>
|
|
3444
|
+
<dd>
|
|
3445
|
+
|
|
3446
|
+
```typescript
|
|
3447
|
+
await client.entities.createEntityRelation({
|
|
3448
|
+
name: "name",
|
|
3449
|
+
fromEntityId: "from_entity_id",
|
|
3450
|
+
toEntityId: "to_entity_id",
|
|
3451
|
+
});
|
|
3452
|
+
```
|
|
3453
|
+
|
|
3454
|
+
</dd>
|
|
3455
|
+
</dl>
|
|
3456
|
+
</dd>
|
|
3457
|
+
</dl>
|
|
3458
|
+
|
|
3459
|
+
#### ⚙️ Parameters
|
|
3460
|
+
|
|
3461
|
+
<dl>
|
|
3462
|
+
<dd>
|
|
3463
|
+
|
|
3464
|
+
<dl>
|
|
3465
|
+
<dd>
|
|
3466
|
+
|
|
3467
|
+
**request:** `AirweaveSDK.EntityRelationCreate`
|
|
3468
|
+
|
|
3469
|
+
</dd>
|
|
3470
|
+
</dl>
|
|
3471
|
+
|
|
3472
|
+
<dl>
|
|
3473
|
+
<dd>
|
|
3474
|
+
|
|
3475
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
3476
|
+
|
|
3477
|
+
</dd>
|
|
3478
|
+
</dl>
|
|
3479
|
+
</dd>
|
|
3480
|
+
</dl>
|
|
3481
|
+
|
|
3482
|
+
</dd>
|
|
3483
|
+
</dl>
|
|
3484
|
+
</details>
|
|
3485
|
+
|
|
3486
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsByIds</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3487
|
+
<dl>
|
|
3488
|
+
<dd>
|
|
3489
|
+
|
|
3490
|
+
#### 📝 Description
|
|
3491
|
+
|
|
3492
|
+
<dl>
|
|
3493
|
+
<dd>
|
|
3494
|
+
|
|
3495
|
+
<dl>
|
|
3496
|
+
<dd>
|
|
3497
|
+
|
|
3498
|
+
Get multiple entity definitions by their IDs.
|
|
3499
|
+
|
|
3500
|
+
Args:
|
|
3501
|
+
ids: List of entity definition IDs to fetch
|
|
3502
|
+
db: Database session
|
|
3503
|
+
current_user: Current authenticated user
|
|
3504
|
+
|
|
3505
|
+
Returns:
|
|
3506
|
+
List of entity definitions matching the provided IDs
|
|
3507
|
+
|
|
3508
|
+
</dd>
|
|
3509
|
+
</dl>
|
|
3510
|
+
</dd>
|
|
3511
|
+
</dl>
|
|
3512
|
+
|
|
3513
|
+
#### 🔌 Usage
|
|
3514
|
+
|
|
3515
|
+
<dl>
|
|
3516
|
+
<dd>
|
|
3517
|
+
|
|
3518
|
+
<dl>
|
|
3519
|
+
<dd>
|
|
3520
|
+
|
|
3521
|
+
```typescript
|
|
3522
|
+
await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
3523
|
+
```
|
|
3524
|
+
|
|
3525
|
+
</dd>
|
|
3526
|
+
</dl>
|
|
3527
|
+
</dd>
|
|
3528
|
+
</dl>
|
|
3529
|
+
|
|
3530
|
+
#### ⚙️ Parameters
|
|
3531
|
+
|
|
3532
|
+
<dl>
|
|
3533
|
+
<dd>
|
|
3534
|
+
|
|
3535
|
+
<dl>
|
|
3536
|
+
<dd>
|
|
3537
|
+
|
|
3538
|
+
**request:** `string[]`
|
|
3539
|
+
|
|
3540
|
+
</dd>
|
|
3541
|
+
</dl>
|
|
3542
|
+
|
|
3543
|
+
<dl>
|
|
3544
|
+
<dd>
|
|
3545
|
+
|
|
3546
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
3547
|
+
|
|
3548
|
+
</dd>
|
|
3549
|
+
</dl>
|
|
3550
|
+
</dd>
|
|
3551
|
+
</dl>
|
|
3552
|
+
|
|
3553
|
+
</dd>
|
|
3554
|
+
</dl>
|
|
3555
|
+
</details>
|
|
3556
|
+
|
|
3557
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsBySourceShortName</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3558
|
+
<dl>
|
|
3559
|
+
<dd>
|
|
3560
|
+
|
|
3561
|
+
#### 📝 Description
|
|
3562
|
+
|
|
3563
|
+
<dl>
|
|
3564
|
+
<dd>
|
|
3565
|
+
|
|
3566
|
+
<dl>
|
|
3567
|
+
<dd>
|
|
3568
|
+
|
|
3569
|
+
Get all entity definitions for a given source.
|
|
3570
|
+
|
|
3571
|
+
</dd>
|
|
3572
|
+
</dl>
|
|
3573
|
+
</dd>
|
|
3574
|
+
</dl>
|
|
3575
|
+
|
|
3576
|
+
#### 🔌 Usage
|
|
3577
|
+
|
|
3578
|
+
<dl>
|
|
3579
|
+
<dd>
|
|
3580
|
+
|
|
3581
|
+
<dl>
|
|
3582
|
+
<dd>
|
|
3583
|
+
|
|
3584
|
+
```typescript
|
|
3585
|
+
await client.entities.getEntityDefinitionsBySourceShortName({
|
|
3586
|
+
sourceShortName: "source_short_name",
|
|
3587
|
+
});
|
|
3588
|
+
```
|
|
3589
|
+
|
|
3590
|
+
</dd>
|
|
3591
|
+
</dl>
|
|
3592
|
+
</dd>
|
|
3593
|
+
</dl>
|
|
3594
|
+
|
|
3595
|
+
#### ⚙️ Parameters
|
|
3596
|
+
|
|
3597
|
+
<dl>
|
|
3598
|
+
<dd>
|
|
3599
|
+
|
|
3600
|
+
<dl>
|
|
3601
|
+
<dd>
|
|
3602
|
+
|
|
3603
|
+
**request:** `AirweaveSDK.GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest`
|
|
3604
|
+
|
|
3605
|
+
</dd>
|
|
3606
|
+
</dl>
|
|
3607
|
+
|
|
3608
|
+
<dl>
|
|
3609
|
+
<dd>
|
|
3610
|
+
|
|
3611
|
+
**requestOptions:** `Entities.RequestOptions`
|
|
3612
|
+
|
|
3613
|
+
</dd>
|
|
3614
|
+
</dl>
|
|
3615
|
+
</dd>
|
|
3616
|
+
</dl>
|
|
3617
|
+
|
|
3618
|
+
</dd>
|
|
3619
|
+
</dl>
|
|
3620
|
+
</details>
|
|
3621
|
+
|
|
3622
|
+
## Transformers
|
|
3623
|
+
|
|
3624
|
+
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>() -> AirweaveSDK.Transformer[]</code></summary>
|
|
3625
|
+
<dl>
|
|
3626
|
+
<dd>
|
|
3627
|
+
|
|
3628
|
+
#### 📝 Description
|
|
3629
|
+
|
|
3630
|
+
<dl>
|
|
3631
|
+
<dd>
|
|
3632
|
+
|
|
3633
|
+
<dl>
|
|
3634
|
+
<dd>
|
|
3635
|
+
|
|
3636
|
+
List all transformers for the current user's organization.
|
|
3637
|
+
|
|
3638
|
+
</dd>
|
|
3639
|
+
</dl>
|
|
3640
|
+
</dd>
|
|
3641
|
+
</dl>
|
|
3642
|
+
|
|
3643
|
+
#### 🔌 Usage
|
|
3644
|
+
|
|
3645
|
+
<dl>
|
|
3646
|
+
<dd>
|
|
3647
|
+
|
|
3648
|
+
<dl>
|
|
3649
|
+
<dd>
|
|
3650
|
+
|
|
3651
|
+
```typescript
|
|
3652
|
+
await client.transformers.listTransformers();
|
|
3653
|
+
```
|
|
3654
|
+
|
|
3655
|
+
</dd>
|
|
3656
|
+
</dl>
|
|
3657
|
+
</dd>
|
|
3658
|
+
</dl>
|
|
3659
|
+
|
|
3660
|
+
#### ⚙️ Parameters
|
|
3661
|
+
|
|
3662
|
+
<dl>
|
|
3663
|
+
<dd>
|
|
3664
|
+
|
|
3665
|
+
<dl>
|
|
3666
|
+
<dd>
|
|
3667
|
+
|
|
3668
|
+
**requestOptions:** `Transformers.RequestOptions`
|
|
3669
|
+
|
|
3670
|
+
</dd>
|
|
3671
|
+
</dl>
|
|
3672
|
+
</dd>
|
|
3673
|
+
</dl>
|
|
3674
|
+
|
|
3675
|
+
</dd>
|
|
3676
|
+
</dl>
|
|
3677
|
+
</details>
|
|
3678
|
+
|
|
3679
|
+
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">createTransformer</a>({ ...params }) -> AirweaveSDK.Transformer</code></summary>
|
|
3680
|
+
<dl>
|
|
3681
|
+
<dd>
|
|
3682
|
+
|
|
3683
|
+
#### 📝 Description
|
|
3684
|
+
|
|
3685
|
+
<dl>
|
|
3686
|
+
<dd>
|
|
3687
|
+
|
|
3688
|
+
<dl>
|
|
3689
|
+
<dd>
|
|
3690
|
+
|
|
3691
|
+
Create a new transformer.
|
|
3692
|
+
|
|
3693
|
+
</dd>
|
|
3694
|
+
</dl>
|
|
3695
|
+
</dd>
|
|
3696
|
+
</dl>
|
|
3697
|
+
|
|
3698
|
+
#### 🔌 Usage
|
|
3699
|
+
|
|
3700
|
+
<dl>
|
|
3701
|
+
<dd>
|
|
3702
|
+
|
|
3703
|
+
<dl>
|
|
3704
|
+
<dd>
|
|
3705
|
+
|
|
3706
|
+
```typescript
|
|
3707
|
+
await client.transformers.createTransformer({
|
|
3708
|
+
name: "name",
|
|
3709
|
+
methodName: "method_name",
|
|
3710
|
+
moduleName: "module_name",
|
|
3711
|
+
inputEntityDefinitionIds: ["input_entity_definition_ids"],
|
|
3712
|
+
outputEntityDefinitionIds: ["output_entity_definition_ids"],
|
|
3713
|
+
});
|
|
3714
|
+
```
|
|
3715
|
+
|
|
3716
|
+
</dd>
|
|
3717
|
+
</dl>
|
|
3718
|
+
</dd>
|
|
3719
|
+
</dl>
|
|
3720
|
+
|
|
3721
|
+
#### ⚙️ Parameters
|
|
3722
|
+
|
|
3723
|
+
<dl>
|
|
3724
|
+
<dd>
|
|
3725
|
+
|
|
3726
|
+
<dl>
|
|
3727
|
+
<dd>
|
|
3728
|
+
|
|
3729
|
+
**request:** `AirweaveSDK.TransformerCreate`
|
|
3730
|
+
|
|
3731
|
+
</dd>
|
|
3732
|
+
</dl>
|
|
3733
|
+
|
|
3734
|
+
<dl>
|
|
3735
|
+
<dd>
|
|
3736
|
+
|
|
3737
|
+
**requestOptions:** `Transformers.RequestOptions`
|
|
3738
|
+
|
|
3739
|
+
</dd>
|
|
3740
|
+
</dl>
|
|
3741
|
+
</dd>
|
|
3742
|
+
</dl>
|
|
3743
|
+
|
|
3744
|
+
</dd>
|
|
3745
|
+
</dl>
|
|
3746
|
+
</details>
|