@airweave/sdk 0.1.28 → 0.1.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +8 -22
- package/Client.js +13 -38
- package/README.md +9 -11
- package/api/index.d.ts +1 -1
- package/api/index.js +1 -1
- package/api/resources/collections/client/Client.d.ts +112 -0
- package/api/resources/{dag → collections}/client/Client.js +152 -69
- package/api/resources/collections/client/requests/CollectionCreate.d.ts +15 -0
- package/{dist/api/resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts → api/resources/collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.d.ts} +1 -1
- package/{dist/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts → api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.d.ts} +1 -1
- package/api/resources/collections/client/requests/index.d.ts +3 -0
- package/api/resources/connections/client/Client.d.ts +3 -250
- package/api/resources/connections/client/Client.js +7 -792
- package/api/resources/connections/client/index.d.ts +1 -1
- package/api/resources/connections/client/index.js +0 -15
- package/api/resources/index.d.ts +4 -14
- package/api/resources/index.js +5 -15
- package/api/resources/sourceConnections/client/Client.d.ts +191 -0
- package/{dist/api/resources/entities → api/resources/sourceConnections}/client/Client.js +179 -178
- package/api/resources/sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.d.ts +10 -0
- package/api/resources/sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts +10 -0
- package/api/resources/{sync/client/requests/ListSyncsSyncGetRequest.d.ts → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.d.ts} +5 -2
- package/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +17 -0
- package/api/resources/sourceConnections/client/requests/index.d.ts +4 -0
- package/api/resources/sources/client/Client.d.ts +4 -2
- package/api/resources/sources/client/Client.js +11 -6
- package/api/resources/whiteLabels/client/Client.d.ts +3 -47
- package/api/resources/whiteLabels/client/Client.js +20 -170
- package/api/types/ApiKey.d.ts +3 -3
- package/api/types/ApiKeyCreate.d.ts +1 -0
- package/api/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +1 -9
- package/api/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +7 -0
- package/api/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +8 -0
- package/{dist/api/resources/connections/client/requests → api/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +2 -7
- package/api/types/Collection.d.ts +19 -0
- package/api/types/CollectionStatus.d.ts +13 -0
- package/api/types/CollectionStatus.js +12 -0
- package/api/types/CollectionUpdate.d.ts +10 -0
- package/api/types/ConfigValues.d.ts +9 -0
- package/api/types/{DestinationWithConfigFields.d.ts → DestinationWithAuthenticationFields.d.ts} +2 -2
- package/{dist/api/types/EmbeddingModelWithConfigFields.d.ts → api/types/EmbeddingModelWithAuthenticationFields.d.ts} +2 -2
- package/api/types/EntityCount.d.ts +9 -0
- package/api/{resources/entities/client/requests → types}/EntityDefinitionCreate.d.ts +2 -9
- package/api/{resources/entities/client/requests → types}/EntityDefinitionUpdate.d.ts +2 -9
- package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationCreate.d.ts +1 -6
- package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationUpdate.d.ts +1 -6
- package/api/types/Organization.d.ts +13 -0
- package/api/types/ResponseType.d.ts +11 -0
- package/api/types/ResponseType.js +10 -0
- package/api/types/SearchResponse.d.ts +13 -0
- package/api/types/SearchStatus.d.ts +12 -0
- package/api/types/SearchStatus.js +11 -0
- package/api/types/SourceConnection.d.ts +31 -0
- package/api/types/SourceConnectionAuthFields.d.ts +5 -0
- package/api/types/SourceConnectionCreate.d.ts +21 -0
- package/api/types/SourceConnectionJob.d.ts +30 -0
- package/api/types/SourceConnectionListItem.d.ts +21 -0
- package/api/types/SourceConnectionStatus.d.ts +12 -0
- package/api/types/SourceConnectionStatus.js +11 -0
- package/api/types/{SourceWithConfigFields.d.ts → SourceWithAuthenticationFields.d.ts} +2 -2
- package/{dist/api/resources/sync/client/requests → api/types}/SyncCreate.d.ts +2 -7
- package/api/types/SyncDagCreate.d.ts +14 -0
- package/api/{resources/dag/client/requests → types}/SyncDagUpdate.d.ts +3 -7
- package/api/types/SyncJob.d.ts +6 -4
- package/api/{resources/sync/client/requests → types}/SyncUpdate.d.ts +2 -3
- package/{dist/api/resources/transformers/client/requests → api/types}/TransformerCreate.d.ts +1 -8
- package/api/{resources/transformers/client/requests → types}/TransformerUpdate.d.ts +1 -8
- package/api/types/User.d.ts +1 -1
- package/api/types/UserCreate.d.ts +11 -0
- package/api/types/index.d.ts +35 -4
- package/api/types/index.js +35 -4
- package/core/auth/BasicAuth.d.ts +8 -0
- package/core/auth/BasicAuth.js +26 -0
- package/core/auth/BearerToken.d.ts +5 -0
- package/core/auth/BearerToken.js +15 -0
- package/core/auth/index.d.ts +2 -0
- package/core/auth/index.js +7 -0
- package/core/index.d.ts +1 -0
- package/core/index.js +1 -0
- package/dist/Client.d.ts +8 -22
- package/dist/Client.js +13 -38
- package/dist/api/index.d.ts +1 -1
- package/dist/api/index.js +1 -1
- package/dist/api/resources/collections/client/Client.d.ts +112 -0
- package/dist/api/resources/{dag → collections}/client/Client.js +152 -69
- package/dist/api/resources/collections/client/requests/CollectionCreate.d.ts +15 -0
- package/{api/resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts → dist/api/resources/collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.d.ts} +1 -1
- package/{api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts → dist/api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.d.ts} +1 -1
- package/dist/api/resources/collections/client/requests/index.d.ts +3 -0
- package/dist/api/resources/connections/client/Client.d.ts +3 -250
- package/dist/api/resources/connections/client/Client.js +7 -792
- package/dist/api/resources/connections/client/index.d.ts +1 -1
- package/dist/api/resources/connections/client/index.js +0 -15
- package/dist/api/resources/index.d.ts +4 -14
- package/dist/api/resources/index.js +5 -15
- package/dist/api/resources/sourceConnections/client/Client.d.ts +191 -0
- package/{api/resources/entities → dist/api/resources/sourceConnections}/client/Client.js +179 -178
- package/dist/api/resources/sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.d.ts +10 -0
- package/dist/api/resources/sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts +10 -0
- package/dist/api/resources/{sync/client/requests/ListSyncsSyncGetRequest.d.ts → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.d.ts} +5 -2
- package/dist/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +17 -0
- package/dist/api/resources/sourceConnections/client/requests/index.d.ts +4 -0
- package/dist/api/resources/sources/client/Client.d.ts +4 -2
- package/dist/api/resources/sources/client/Client.js +11 -6
- package/dist/api/resources/whiteLabels/client/Client.d.ts +3 -47
- package/dist/api/resources/whiteLabels/client/Client.js +20 -170
- package/dist/api/types/ApiKey.d.ts +3 -3
- package/dist/api/types/ApiKeyCreate.d.ts +1 -0
- package/dist/api/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +1 -9
- package/dist/api/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +7 -0
- package/dist/api/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +8 -0
- package/{api/resources/connections/client/requests → dist/api/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +2 -7
- package/dist/api/types/Collection.d.ts +19 -0
- package/dist/api/types/CollectionStatus.d.ts +13 -0
- package/dist/api/types/CollectionStatus.js +12 -0
- package/dist/api/types/CollectionUpdate.d.ts +10 -0
- package/dist/api/types/CollectionUpdate.js +5 -0
- package/dist/api/types/ConfigValues.d.ts +9 -0
- package/dist/api/types/ConfigValues.js +5 -0
- package/dist/api/types/{DestinationWithConfigFields.d.ts → DestinationWithAuthenticationFields.d.ts} +2 -2
- package/dist/api/types/DestinationWithAuthenticationFields.js +5 -0
- package/{api/types/EmbeddingModelWithConfigFields.d.ts → dist/api/types/EmbeddingModelWithAuthenticationFields.d.ts} +2 -2
- package/dist/api/types/EmbeddingModelWithAuthenticationFields.js +5 -0
- package/dist/api/types/EntityCount.d.ts +9 -0
- package/dist/api/types/EntityCount.js +5 -0
- package/dist/api/{resources/entities/client/requests → types}/EntityDefinitionCreate.d.ts +2 -9
- package/dist/api/types/EntityDefinitionCreate.js +5 -0
- package/dist/api/types/EntityDefinitionCreateEntitySchema.js +5 -0
- package/dist/api/{resources/entities/client/requests → types}/EntityDefinitionUpdate.d.ts +2 -9
- package/dist/api/types/EntityDefinitionUpdate.js +5 -0
- package/dist/api/types/EntityDefinitionUpdateEntitySchema.js +5 -0
- package/{api/resources/entities/client/requests → dist/api/types}/EntityRelationCreate.d.ts +1 -6
- package/dist/api/types/EntityRelationCreate.js +5 -0
- package/{api/resources/entities/client/requests → dist/api/types}/EntityRelationUpdate.d.ts +1 -6
- package/dist/api/types/EntityRelationUpdate.js +5 -0
- package/dist/api/types/Organization.d.ts +13 -0
- package/dist/api/types/Organization.js +5 -0
- package/dist/api/types/ResponseType.d.ts +11 -0
- package/dist/api/types/ResponseType.js +10 -0
- package/dist/api/types/SearchResponse.d.ts +13 -0
- package/dist/api/types/SearchResponse.js +5 -0
- package/dist/api/types/SearchStatus.d.ts +12 -0
- package/dist/api/types/SearchStatus.js +11 -0
- package/dist/api/types/SourceConnection.d.ts +31 -0
- package/dist/api/types/SourceConnection.js +5 -0
- package/dist/api/types/SourceConnectionAuthFields.d.ts +5 -0
- package/dist/api/types/SourceConnectionAuthFields.js +5 -0
- package/dist/api/types/SourceConnectionCreate.d.ts +21 -0
- package/dist/api/types/SourceConnectionCreate.js +5 -0
- package/dist/api/types/SourceConnectionJob.d.ts +30 -0
- package/dist/api/types/SourceConnectionJob.js +5 -0
- package/dist/api/types/SourceConnectionListItem.d.ts +21 -0
- package/dist/api/types/SourceConnectionListItem.js +5 -0
- package/dist/api/types/SourceConnectionStatus.d.ts +12 -0
- package/dist/api/types/SourceConnectionStatus.js +11 -0
- package/dist/api/types/{SourceWithConfigFields.d.ts → SourceWithAuthenticationFields.d.ts} +2 -2
- package/dist/api/types/SourceWithAuthenticationFields.js +5 -0
- package/{api/resources/sync/client/requests → dist/api/types}/SyncCreate.d.ts +2 -7
- package/dist/api/types/SyncCreate.js +5 -0
- package/dist/api/types/SyncDagCreate.d.ts +14 -0
- package/dist/api/types/SyncDagCreate.js +5 -0
- package/dist/api/{resources/dag/client/requests → types}/SyncDagUpdate.d.ts +3 -7
- package/dist/api/types/SyncDagUpdate.js +5 -0
- package/dist/api/types/SyncJob.d.ts +6 -4
- package/dist/api/{resources/sync/client/requests → types}/SyncUpdate.d.ts +2 -3
- package/dist/api/types/SyncUpdate.js +5 -0
- package/{api/resources/transformers/client/requests → dist/api/types}/TransformerCreate.d.ts +1 -8
- package/dist/api/types/TransformerCreate.js +5 -0
- package/dist/api/{resources/transformers/client/requests → types}/TransformerUpdate.d.ts +1 -8
- package/dist/api/types/TransformerUpdate.js +5 -0
- package/dist/api/types/User.d.ts +1 -1
- package/dist/api/types/UserCreate.d.ts +11 -0
- package/dist/api/types/UserCreate.js +5 -0
- package/dist/api/types/index.d.ts +35 -4
- package/dist/api/types/index.js +35 -4
- package/dist/core/auth/BasicAuth.d.ts +8 -0
- package/dist/core/auth/BasicAuth.js +26 -0
- package/dist/core/auth/BearerToken.d.ts +5 -0
- package/dist/core/auth/BearerToken.js +15 -0
- package/dist/core/auth/index.d.ts +2 -0
- package/dist/core/auth/index.js +7 -0
- package/dist/core/index.d.ts +1 -0
- package/dist/core/index.js +1 -0
- package/dist/serialization/index.d.ts +1 -1
- package/dist/serialization/index.js +1 -1
- package/dist/serialization/resources/collections/client/index.d.ts +3 -0
- package/dist/serialization/resources/{transformers → collections}/client/index.js +3 -2
- package/{serialization/resources/sync/client/listAllJobs.d.ts → dist/serialization/resources/collections/client/listCollections.d.ts} +3 -3
- package/{serialization/resources/connections/client/listConnectedIntegrations.js → dist/serialization/resources/collections/client/listCollections.js} +2 -2
- package/dist/serialization/resources/{destinations/client/listDestinations.d.ts → collections/client/refreshAllSourceConnections.d.ts} +3 -3
- package/dist/serialization/resources/{connections/client/getOauth2WhiteLabelAuthUrl.js → collections/client/refreshAllSourceConnections.js} +2 -1
- package/dist/serialization/resources/collections/client/requests/CollectionCreate.d.ts +13 -0
- package/dist/serialization/resources/collections/client/requests/CollectionCreate.js +44 -0
- package/dist/serialization/resources/collections/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/collections/client/requests/index.js +5 -0
- package/dist/serialization/resources/connections/client/index.d.ts +0 -6
- package/dist/serialization/resources/connections/client/index.js +1 -10
- package/dist/serialization/resources/index.d.ts +4 -13
- package/dist/serialization/resources/index.js +5 -14
- package/dist/serialization/resources/sourceConnections/client/index.d.ts +3 -0
- package/{serialization/resources/transformers → dist/serialization/resources/sourceConnections}/client/index.js +3 -2
- package/dist/serialization/resources/{entities/client/getEntityDefinitionsBySourceShortName.d.ts → sourceConnections/client/listSourceConnectionJobs.d.ts} +3 -3
- package/dist/serialization/resources/{connections/client/getConnectionCredentials.js → sourceConnections/client/listSourceConnectionJobs.js} +2 -1
- package/dist/serialization/resources/sourceConnections/client/listSourceConnections.d.ts +11 -0
- package/dist/serialization/resources/sourceConnections/client/listSourceConnections.js +42 -0
- package/dist/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +18 -0
- package/dist/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.js +49 -0
- package/dist/serialization/resources/sourceConnections/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/sourceConnections/client/requests/index.js +5 -0
- package/dist/serialization/resources/whiteLabels/client/index.d.ts +0 -2
- package/dist/serialization/resources/whiteLabels/client/index.js +1 -3
- package/dist/serialization/types/ApiKey.d.ts +2 -2
- package/dist/serialization/types/ApiKey.js +2 -2
- package/dist/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +13 -0
- package/dist/serialization/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +2 -2
- package/dist/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/dist/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +44 -0
- package/dist/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +14 -0
- package/dist/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js +45 -0
- package/dist/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +15 -0
- package/{serialization/resources/connections/client/requests → dist/serialization/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +3 -1
- package/dist/serialization/types/{ApiKeyWithPlainKey.d.ts → Collection.d.ts} +7 -7
- package/dist/serialization/types/{ApiKeyWithPlainKey.js → Collection.js} +7 -7
- package/dist/serialization/types/CollectionStatus.d.ts +10 -0
- package/dist/serialization/types/CollectionStatus.js +41 -0
- package/dist/serialization/types/CollectionUpdate.d.ts +12 -0
- package/dist/serialization/types/CollectionUpdate.js +43 -0
- package/dist/serialization/types/ConfigValues.d.ts +10 -0
- package/dist/serialization/types/ConfigValues.js +41 -0
- package/{serialization/types/DestinationWithConfigFields.d.ts → dist/serialization/types/DestinationWithAuthenticationFields.d.ts} +3 -3
- package/dist/serialization/types/{DestinationWithConfigFields.js → DestinationWithAuthenticationFields.js} +3 -3
- package/{serialization/types/EmbeddingModelWithConfigFields.d.ts → dist/serialization/types/EmbeddingModelWithAuthenticationFields.d.ts} +3 -3
- package/dist/serialization/types/{EmbeddingModelWithConfigFields.js → EmbeddingModelWithAuthenticationFields.js} +3 -3
- package/dist/serialization/types/EntityCount.d.ts +12 -0
- package/dist/serialization/{resources/connections/client/sendOauth2WhiteLabelCode.js → types/EntityCount.js} +5 -3
- package/{serialization/resources/entities/client/requests → dist/serialization/types}/EntityDefinitionCreate.d.ts +6 -6
- package/dist/serialization/{resources/entities/client/requests → types}/EntityDefinitionCreate.js +3 -3
- package/dist/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +3 -3
- package/dist/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +1 -1
- package/dist/serialization/{resources/entities/client/requests → types}/EntityDefinitionUpdate.d.ts +6 -6
- package/dist/serialization/{resources/entities/client/requests → types}/EntityDefinitionUpdate.js +3 -3
- package/{serialization/resources/entities → dist/serialization}/types/EntityDefinitionUpdateEntitySchema.d.ts +3 -3
- package/dist/serialization/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.js +1 -1
- package/dist/serialization/types/EntityRelationCreate.d.ts +15 -0
- package/{serialization/resources/entities/client/requests → dist/serialization/types}/EntityRelationCreate.js +1 -1
- package/dist/serialization/types/EntityRelationUpdate.d.ts +15 -0
- package/dist/serialization/{resources/entities/client/requests → types}/EntityRelationUpdate.js +1 -1
- package/dist/serialization/types/Organization.d.ts +16 -0
- package/dist/serialization/types/Organization.js +47 -0
- package/dist/serialization/types/ResponseType.d.ts +10 -0
- package/dist/serialization/{resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.js → types/ResponseType.js} +3 -3
- package/dist/serialization/types/SearchResponse.d.ts +17 -0
- package/dist/serialization/types/SearchResponse.js +48 -0
- package/dist/serialization/types/SearchStatus.d.ts +10 -0
- package/dist/serialization/types/SearchStatus.js +41 -0
- package/dist/serialization/types/SourceConnection.d.ts +36 -0
- package/dist/serialization/types/SourceConnection.js +67 -0
- package/dist/serialization/types/SourceConnectionAuthFields.d.ts +11 -0
- package/dist/serialization/types/SourceConnectionAuthFields.js +42 -0
- package/dist/serialization/types/SourceConnectionCreate.d.ts +20 -0
- package/dist/serialization/types/SourceConnectionCreate.js +51 -0
- package/dist/serialization/types/SourceConnectionJob.d.ts +30 -0
- package/dist/serialization/types/SourceConnectionJob.js +61 -0
- package/dist/serialization/types/SourceConnectionListItem.d.ts +21 -0
- package/dist/serialization/types/SourceConnectionListItem.js +52 -0
- package/dist/serialization/types/SourceConnectionStatus.d.ts +10 -0
- package/dist/serialization/types/SourceConnectionStatus.js +41 -0
- package/{serialization/types/SourceWithConfigFields.d.ts → dist/serialization/types/SourceWithAuthenticationFields.d.ts} +3 -3
- package/dist/serialization/types/{SourceWithConfigFields.js → SourceWithAuthenticationFields.js} +3 -3
- package/dist/serialization/{resources/sync/client/requests → types}/SyncCreate.d.ts +5 -5
- package/dist/serialization/{resources/sync/client/requests → types}/SyncCreate.js +2 -2
- package/dist/serialization/types/SyncDagCreate.d.ts +18 -0
- package/{serialization/resources/dag/client/requests → dist/serialization/types}/SyncDagCreate.js +4 -4
- package/dist/serialization/types/SyncDagUpdate.d.ts +18 -0
- package/{serialization/resources/dag/client/requests → dist/serialization/types}/SyncDagUpdate.js +4 -4
- package/dist/serialization/types/SyncJob.d.ts +6 -4
- package/dist/serialization/types/SyncJob.js +6 -4
- package/dist/serialization/{resources/sync/client/requests → types}/SyncUpdate.d.ts +5 -5
- package/dist/serialization/{resources/sync/client/requests → types}/SyncUpdate.js +2 -2
- package/dist/serialization/{resources/transformers/client/requests → types}/TransformerCreate.d.ts +4 -4
- package/{serialization/resources/transformers/client/requests → dist/serialization/types}/TransformerCreate.js +1 -1
- package/dist/serialization/{resources/transformers/client/requests → types}/TransformerUpdate.d.ts +4 -4
- package/{serialization/resources/transformers/client/requests → dist/serialization/types}/TransformerUpdate.js +1 -1
- package/dist/serialization/types/User.d.ts +1 -1
- package/dist/serialization/types/User.js +1 -1
- package/dist/serialization/types/UserCreate.d.ts +14 -0
- package/dist/serialization/types/UserCreate.js +45 -0
- package/dist/serialization/types/index.d.ts +35 -4
- package/dist/serialization/types/index.js +35 -4
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +3 -2
- package/reference.md +268 -2521
- package/serialization/index.d.ts +1 -1
- package/serialization/index.js +1 -1
- package/serialization/resources/collections/client/index.d.ts +3 -0
- package/serialization/resources/{sync → collections}/client/index.js +3 -3
- package/{dist/serialization/resources/sync/client/listAllJobs.d.ts → serialization/resources/collections/client/listCollections.d.ts} +3 -3
- package/{dist/serialization/resources/connections/client/listConnectedIntegrations.js → serialization/resources/collections/client/listCollections.js} +2 -2
- package/{dist/serialization/resources/embeddingModels/client/readEmbeddingModels.d.ts → serialization/resources/collections/client/refreshAllSourceConnections.d.ts} +3 -3
- package/serialization/resources/collections/client/refreshAllSourceConnections.js +42 -0
- package/serialization/resources/collections/client/requests/CollectionCreate.d.ts +13 -0
- package/serialization/resources/collections/client/requests/CollectionCreate.js +44 -0
- package/serialization/resources/collections/client/requests/index.d.ts +1 -0
- package/serialization/resources/collections/client/requests/index.js +5 -0
- package/serialization/resources/connections/client/index.d.ts +0 -6
- package/serialization/resources/connections/client/index.js +1 -10
- package/serialization/resources/index.d.ts +4 -13
- package/serialization/resources/index.js +5 -14
- package/serialization/resources/sourceConnections/client/index.d.ts +3 -0
- package/{dist/serialization/resources/sync → serialization/resources/sourceConnections}/client/index.js +3 -3
- package/{dist/serialization/resources/connections/client/listConnectedIntegrations.d.ts → serialization/resources/sourceConnections/client/listSourceConnectionJobs.d.ts} +3 -3
- package/serialization/resources/sourceConnections/client/listSourceConnectionJobs.js +42 -0
- package/serialization/resources/sourceConnections/client/listSourceConnections.d.ts +11 -0
- package/serialization/resources/sourceConnections/client/listSourceConnections.js +42 -0
- package/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +18 -0
- package/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.js +49 -0
- package/serialization/resources/sourceConnections/client/requests/index.d.ts +1 -0
- package/serialization/resources/sourceConnections/client/requests/index.js +5 -0
- package/serialization/resources/whiteLabels/client/index.d.ts +0 -2
- package/serialization/resources/whiteLabels/client/index.js +1 -3
- package/serialization/types/ApiKey.d.ts +2 -2
- package/serialization/types/ApiKey.js +2 -2
- package/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +13 -0
- package/serialization/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +2 -2
- package/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.d.ts +13 -0
- package/serialization/types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js +44 -0
- package/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +14 -0
- package/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js +45 -0
- package/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +15 -0
- package/{dist/serialization/resources/connections/client/requests → serialization/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +3 -1
- package/serialization/types/{ApiKeyWithPlainKey.d.ts → Collection.d.ts} +7 -7
- package/serialization/types/{ApiKeyWithPlainKey.js → Collection.js} +7 -7
- package/serialization/types/CollectionStatus.d.ts +10 -0
- package/serialization/types/CollectionStatus.js +41 -0
- package/serialization/types/CollectionUpdate.d.ts +12 -0
- package/serialization/types/CollectionUpdate.js +43 -0
- package/serialization/types/ConfigValues.d.ts +10 -0
- package/serialization/types/ConfigValues.js +41 -0
- package/{dist/serialization/types/DestinationWithConfigFields.d.ts → serialization/types/DestinationWithAuthenticationFields.d.ts} +3 -3
- package/serialization/types/{DestinationWithConfigFields.js → DestinationWithAuthenticationFields.js} +3 -3
- package/{dist/serialization/types/EmbeddingModelWithConfigFields.d.ts → serialization/types/EmbeddingModelWithAuthenticationFields.d.ts} +3 -3
- package/serialization/types/{EmbeddingModelWithConfigFields.js → EmbeddingModelWithAuthenticationFields.js} +3 -3
- package/serialization/types/EntityCount.d.ts +12 -0
- package/serialization/types/EntityCount.js +43 -0
- package/{dist/serialization/resources/entities/client/requests → serialization/types}/EntityDefinitionCreate.d.ts +6 -6
- package/serialization/{resources/entities/client/requests → types}/EntityDefinitionCreate.js +3 -3
- package/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +3 -3
- package/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +1 -1
- package/serialization/{resources/entities/client/requests → types}/EntityDefinitionUpdate.d.ts +6 -6
- package/serialization/{resources/entities/client/requests → types}/EntityDefinitionUpdate.js +3 -3
- package/{dist/serialization/resources/entities → serialization}/types/EntityDefinitionUpdateEntitySchema.d.ts +3 -3
- package/serialization/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.js +1 -1
- package/serialization/types/EntityRelationCreate.d.ts +15 -0
- package/{dist/serialization/resources/entities/client/requests → serialization/types}/EntityRelationCreate.js +1 -1
- package/serialization/types/EntityRelationUpdate.d.ts +15 -0
- package/serialization/{resources/entities/client/requests → types}/EntityRelationUpdate.js +1 -1
- package/serialization/types/Organization.d.ts +16 -0
- package/serialization/types/Organization.js +47 -0
- package/serialization/types/ResponseType.d.ts +10 -0
- package/{dist/serialization/resources/connections/client/getOauth2AuthUrl.js → serialization/types/ResponseType.js} +3 -3
- package/serialization/types/SearchResponse.d.ts +17 -0
- package/serialization/types/SearchResponse.js +48 -0
- package/serialization/types/SearchStatus.d.ts +10 -0
- package/serialization/types/SearchStatus.js +41 -0
- package/serialization/types/SourceConnection.d.ts +36 -0
- package/serialization/types/SourceConnection.js +67 -0
- package/serialization/types/SourceConnectionAuthFields.d.ts +11 -0
- package/serialization/types/SourceConnectionAuthFields.js +42 -0
- package/serialization/types/SourceConnectionCreate.d.ts +20 -0
- package/serialization/types/SourceConnectionCreate.js +51 -0
- package/serialization/types/SourceConnectionJob.d.ts +30 -0
- package/serialization/types/SourceConnectionJob.js +61 -0
- package/serialization/types/SourceConnectionListItem.d.ts +21 -0
- package/serialization/types/SourceConnectionListItem.js +52 -0
- package/serialization/types/SourceConnectionStatus.d.ts +10 -0
- package/serialization/types/SourceConnectionStatus.js +41 -0
- package/{dist/serialization/types/SourceWithConfigFields.d.ts → serialization/types/SourceWithAuthenticationFields.d.ts} +3 -3
- package/serialization/types/{SourceWithConfigFields.js → SourceWithAuthenticationFields.js} +3 -3
- package/serialization/{resources/sync/client/requests → types}/SyncCreate.d.ts +5 -5
- package/serialization/{resources/sync/client/requests → types}/SyncCreate.js +2 -2
- package/serialization/types/SyncDagCreate.d.ts +18 -0
- package/{dist/serialization/resources/dag/client/requests → serialization/types}/SyncDagCreate.js +4 -4
- package/serialization/types/SyncDagUpdate.d.ts +18 -0
- package/{dist/serialization/resources/dag/client/requests → serialization/types}/SyncDagUpdate.js +4 -4
- package/serialization/types/SyncJob.d.ts +6 -4
- package/serialization/types/SyncJob.js +6 -4
- package/serialization/{resources/sync/client/requests → types}/SyncUpdate.d.ts +5 -5
- package/serialization/{resources/sync/client/requests → types}/SyncUpdate.js +2 -2
- package/serialization/{resources/transformers/client/requests → types}/TransformerCreate.d.ts +4 -4
- package/{dist/serialization/resources/transformers/client/requests → serialization/types}/TransformerCreate.js +1 -1
- package/serialization/{resources/transformers/client/requests → types}/TransformerUpdate.d.ts +4 -4
- package/{dist/serialization/resources/transformers/client/requests → serialization/types}/TransformerUpdate.js +1 -1
- package/serialization/types/User.d.ts +1 -1
- package/serialization/types/User.js +1 -1
- package/serialization/types/UserCreate.d.ts +14 -0
- package/serialization/types/UserCreate.js +45 -0
- package/serialization/types/index.d.ts +35 -4
- package/serialization/types/index.js +35 -4
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.d.ts +0 -12
- package/api/resources/connections/client/requests/index.d.ts +0 -3
- package/api/resources/dag/client/Client.d.ts +0 -95
- package/api/resources/dag/client/requests/InitializeDagDagInitGetRequest.d.ts +0 -12
- package/api/resources/dag/client/requests/SyncDagCreate.d.ts +0 -26
- package/api/resources/dag/client/requests/index.d.ts +0 -3
- package/api/resources/destinations/client/Client.d.ts +0 -71
- package/api/resources/destinations/client/Client.js +0 -211
- package/api/resources/destinations/client/index.d.ts +0 -1
- package/api/resources/embeddingModels/client/Client.d.ts +0 -71
- package/api/resources/embeddingModels/client/Client.js +0 -211
- package/api/resources/embeddingModels/client/index.d.ts +0 -1
- package/api/resources/entities/client/Client.d.ts +0 -155
- package/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -12
- package/api/resources/entities/client/requests/index.d.ts +0 -5
- package/api/resources/entities/client/requests/index.js +0 -2
- package/api/resources/entities/index.d.ts +0 -2
- package/api/resources/entities/index.js +0 -18
- package/api/resources/entities/types/index.d.ts +0 -2
- package/api/resources/entities/types/index.js +0 -18
- package/api/resources/sync/client/Client.d.ts +0 -275
- package/api/resources/sync/client/Client.js +0 -916
- package/api/resources/sync/client/requests/index.d.ts +0 -5
- package/api/resources/sync/client/requests/index.js +0 -2
- package/api/resources/sync/index.d.ts +0 -2
- package/api/resources/sync/index.js +0 -18
- package/api/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -5
- package/api/resources/sync/types/index.d.ts +0 -1
- package/api/resources/sync/types/index.js +0 -17
- package/api/resources/transformers/client/Client.d.ts +0 -77
- package/api/resources/transformers/client/Client.js +0 -272
- package/api/resources/transformers/client/requests/index.d.ts +0 -2
- package/api/resources/transformers/client/requests/index.js +0 -2
- package/api/resources/users/client/Client.d.ts +0 -48
- package/api/resources/users/client/Client.js +0 -135
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/index.js +0 -2
- package/api/types/ApiKeyWithPlainKey.d.ts +0 -18
- package/dist/api/resources/connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.d.ts +0 -12
- package/dist/api/resources/connections/client/requests/index.d.ts +0 -3
- package/dist/api/resources/connections/client/requests/index.js +0 -2
- package/dist/api/resources/dag/client/Client.d.ts +0 -95
- package/dist/api/resources/dag/client/index.d.ts +0 -1
- package/dist/api/resources/dag/client/index.js +0 -17
- package/dist/api/resources/dag/client/requests/InitializeDagDagInitGetRequest.d.ts +0 -12
- package/dist/api/resources/dag/client/requests/SyncDagCreate.d.ts +0 -26
- package/dist/api/resources/dag/client/requests/index.d.ts +0 -3
- package/dist/api/resources/dag/client/requests/index.js +0 -2
- package/dist/api/resources/destinations/client/Client.d.ts +0 -71
- package/dist/api/resources/destinations/client/Client.js +0 -211
- package/dist/api/resources/destinations/client/index.d.ts +0 -1
- package/dist/api/resources/destinations/client/index.js +0 -2
- package/dist/api/resources/embeddingModels/client/Client.d.ts +0 -71
- package/dist/api/resources/embeddingModels/client/Client.js +0 -211
- package/dist/api/resources/embeddingModels/client/index.d.ts +0 -1
- package/dist/api/resources/embeddingModels/client/index.js +0 -2
- package/dist/api/resources/entities/client/Client.d.ts +0 -155
- package/dist/api/resources/entities/client/index.d.ts +0 -1
- package/dist/api/resources/entities/client/index.js +0 -17
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -12
- package/dist/api/resources/entities/client/requests/index.d.ts +0 -5
- package/dist/api/resources/entities/client/requests/index.js +0 -2
- package/dist/api/resources/entities/index.d.ts +0 -2
- package/dist/api/resources/entities/index.js +0 -18
- package/dist/api/resources/entities/types/index.d.ts +0 -2
- package/dist/api/resources/entities/types/index.js +0 -18
- package/dist/api/resources/sync/client/Client.d.ts +0 -275
- package/dist/api/resources/sync/client/Client.js +0 -916
- package/dist/api/resources/sync/client/index.d.ts +0 -1
- package/dist/api/resources/sync/client/index.js +0 -17
- package/dist/api/resources/sync/client/requests/index.d.ts +0 -5
- package/dist/api/resources/sync/client/requests/index.js +0 -2
- package/dist/api/resources/sync/index.d.ts +0 -2
- package/dist/api/resources/sync/index.js +0 -18
- package/dist/api/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -5
- package/dist/api/resources/sync/types/index.d.ts +0 -1
- package/dist/api/resources/sync/types/index.js +0 -17
- package/dist/api/resources/transformers/client/Client.d.ts +0 -77
- package/dist/api/resources/transformers/client/Client.js +0 -272
- package/dist/api/resources/transformers/client/index.d.ts +0 -1
- package/dist/api/resources/transformers/client/index.js +0 -17
- package/dist/api/resources/transformers/client/requests/index.d.ts +0 -2
- package/dist/api/resources/transformers/client/requests/index.js +0 -2
- package/dist/api/resources/transformers/index.d.ts +0 -1
- package/dist/api/resources/transformers/index.js +0 -17
- package/dist/api/resources/users/client/Client.d.ts +0 -48
- package/dist/api/resources/users/client/Client.js +0 -135
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/index.js +0 -2
- package/dist/api/resources/users/index.d.ts +0 -1
- package/dist/api/resources/users/index.js +0 -17
- package/dist/api/types/ApiKeyWithPlainKey.d.ts +0 -18
- package/dist/serialization/resources/connections/client/getConnectionCredentials.d.ts +0 -9
- package/dist/serialization/resources/connections/client/getOauth2AuthUrl.d.ts +0 -9
- package/dist/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.d.ts +0 -9
- package/dist/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -13
- package/dist/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -13
- package/dist/serialization/resources/connections/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/connections/client/requests/index.js +0 -7
- package/dist/serialization/resources/connections/client/sendOauth2WhiteLabelCode.d.ts +0 -9
- package/dist/serialization/resources/dag/client/index.d.ts +0 -1
- package/dist/serialization/resources/dag/client/index.js +0 -17
- package/dist/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +0 -18
- package/dist/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
- package/dist/serialization/resources/dag/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/dag/client/requests/index.js +0 -7
- package/dist/serialization/resources/dag/index.d.ts +0 -1
- package/dist/serialization/resources/dag/index.js +0 -17
- package/dist/serialization/resources/destinations/client/index.d.ts +0 -1
- package/dist/serialization/resources/destinations/client/index.js +0 -37
- package/dist/serialization/resources/destinations/client/listDestinations.js +0 -42
- package/dist/serialization/resources/destinations/index.d.ts +0 -1
- package/dist/serialization/resources/destinations/index.js +0 -17
- package/dist/serialization/resources/embeddingModels/client/index.d.ts +0 -1
- package/dist/serialization/resources/embeddingModels/client/index.js +0 -37
- package/dist/serialization/resources/embeddingModels/client/readEmbeddingModels.js +0 -42
- package/dist/serialization/resources/embeddingModels/index.d.ts +0 -1
- package/dist/serialization/resources/embeddingModels/index.js +0 -17
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
- package/dist/serialization/resources/entities/client/index.d.ts +0 -5
- package/dist/serialization/resources/entities/client/index.js +0 -44
- package/dist/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
- package/dist/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
- package/dist/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
- package/dist/serialization/resources/entities/client/listEntityRelations.js +0 -42
- package/dist/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -15
- package/dist/serialization/resources/entities/client/requests/EntityRelationUpdate.d.ts +0 -15
- package/dist/serialization/resources/entities/client/requests/index.d.ts +0 -4
- package/dist/serialization/resources/entities/client/requests/index.js +0 -11
- package/dist/serialization/resources/entities/index.d.ts +0 -2
- package/dist/serialization/resources/entities/index.js +0 -18
- package/dist/serialization/resources/entities/types/index.d.ts +0 -2
- package/dist/serialization/resources/entities/types/index.js +0 -18
- package/dist/serialization/resources/sync/client/index.d.ts +0 -3
- package/dist/serialization/resources/sync/client/listAllJobs.js +0 -42
- package/dist/serialization/resources/sync/client/listSyncJobs.d.ts +0 -11
- package/dist/serialization/resources/sync/client/listSyncJobs.js +0 -42
- package/dist/serialization/resources/sync/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/sync/client/requests/index.js +0 -7
- package/dist/serialization/resources/sync/index.d.ts +0 -2
- package/dist/serialization/resources/sync/index.js +0 -18
- package/dist/serialization/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -12
- package/dist/serialization/resources/sync/types/ListSyncsSyncGetResponse.js +0 -46
- package/dist/serialization/resources/sync/types/index.d.ts +0 -1
- package/dist/serialization/resources/sync/types/index.js +0 -17
- package/dist/serialization/resources/transformers/client/index.d.ts +0 -2
- package/dist/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
- package/dist/serialization/resources/transformers/client/listTransformers.js +0 -42
- package/dist/serialization/resources/transformers/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/transformers/client/requests/index.js +0 -7
- package/dist/serialization/resources/transformers/index.d.ts +0 -1
- package/dist/serialization/resources/transformers/index.js +0 -17
- package/dist/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.d.ts +0 -9
- package/dist/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.d.ts +0 -9
- package/dist/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.js +0 -41
- package/serialization/resources/connections/client/getConnectionCredentials.d.ts +0 -9
- package/serialization/resources/connections/client/getConnectionCredentials.js +0 -41
- package/serialization/resources/connections/client/getOauth2AuthUrl.d.ts +0 -9
- package/serialization/resources/connections/client/getOauth2AuthUrl.js +0 -41
- package/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.d.ts +0 -9
- package/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.js +0 -41
- package/serialization/resources/connections/client/listConnectedIntegrations.d.ts +0 -11
- package/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -13
- package/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -13
- package/serialization/resources/connections/client/requests/index.d.ts +0 -2
- package/serialization/resources/connections/client/requests/index.js +0 -7
- package/serialization/resources/connections/client/sendOauth2WhiteLabelCode.d.ts +0 -9
- package/serialization/resources/connections/client/sendOauth2WhiteLabelCode.js +0 -41
- package/serialization/resources/dag/client/index.d.ts +0 -1
- package/serialization/resources/dag/client/index.js +0 -17
- package/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +0 -18
- package/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
- package/serialization/resources/dag/client/requests/index.d.ts +0 -2
- package/serialization/resources/dag/client/requests/index.js +0 -7
- package/serialization/resources/dag/index.d.ts +0 -1
- package/serialization/resources/dag/index.js +0 -17
- package/serialization/resources/destinations/client/index.d.ts +0 -1
- package/serialization/resources/destinations/client/index.js +0 -37
- package/serialization/resources/destinations/client/listDestinations.d.ts +0 -11
- package/serialization/resources/destinations/client/listDestinations.js +0 -42
- package/serialization/resources/destinations/index.d.ts +0 -1
- package/serialization/resources/destinations/index.js +0 -17
- package/serialization/resources/embeddingModels/client/index.d.ts +0 -1
- package/serialization/resources/embeddingModels/client/index.js +0 -37
- package/serialization/resources/embeddingModels/client/readEmbeddingModels.d.ts +0 -11
- package/serialization/resources/embeddingModels/client/readEmbeddingModels.js +0 -42
- package/serialization/resources/embeddingModels/index.d.ts +0 -1
- package/serialization/resources/embeddingModels/index.js +0 -17
- package/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
- package/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +0 -11
- package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
- package/serialization/resources/entities/client/index.d.ts +0 -5
- package/serialization/resources/entities/client/index.js +0 -44
- package/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
- package/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
- package/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
- package/serialization/resources/entities/client/listEntityRelations.js +0 -42
- package/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -15
- package/serialization/resources/entities/client/requests/EntityRelationUpdate.d.ts +0 -15
- package/serialization/resources/entities/client/requests/index.d.ts +0 -4
- package/serialization/resources/entities/client/requests/index.js +0 -11
- package/serialization/resources/entities/index.d.ts +0 -2
- package/serialization/resources/entities/index.js +0 -18
- package/serialization/resources/entities/types/index.d.ts +0 -2
- package/serialization/resources/entities/types/index.js +0 -18
- package/serialization/resources/sync/client/index.d.ts +0 -3
- package/serialization/resources/sync/client/listAllJobs.js +0 -42
- package/serialization/resources/sync/client/listSyncJobs.d.ts +0 -11
- package/serialization/resources/sync/client/listSyncJobs.js +0 -42
- package/serialization/resources/sync/client/requests/index.d.ts +0 -2
- package/serialization/resources/sync/client/requests/index.js +0 -7
- package/serialization/resources/sync/index.d.ts +0 -2
- package/serialization/resources/sync/index.js +0 -18
- package/serialization/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -12
- package/serialization/resources/sync/types/ListSyncsSyncGetResponse.js +0 -46
- package/serialization/resources/sync/types/index.d.ts +0 -1
- package/serialization/resources/sync/types/index.js +0 -17
- package/serialization/resources/transformers/client/index.d.ts +0 -2
- package/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
- package/serialization/resources/transformers/client/listTransformers.js +0 -42
- package/serialization/resources/transformers/client/requests/index.d.ts +0 -2
- package/serialization/resources/transformers/client/requests/index.js +0 -7
- package/serialization/resources/transformers/index.d.ts +0 -1
- package/serialization/resources/transformers/index.js +0 -17
- package/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.d.ts +0 -9
- package/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.js +0 -41
- package/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.d.ts +0 -9
- package/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.js +0 -41
- /package/api/resources/{dag → collections}/client/index.d.ts +0 -0
- /package/api/resources/{dag → collections}/client/index.js +0 -0
- /package/api/resources/{connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js → collections/client/requests/CollectionCreate.js} +0 -0
- /package/api/resources/{connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js → collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.js} +0 -0
- /package/api/resources/{connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.js → collections/client/requests/ListCollectionsCollectionsGetRequest.js} +0 -0
- /package/api/resources/{connections → collections}/client/requests/index.js +0 -0
- /package/api/resources/{dag → collections}/index.d.ts +0 -0
- /package/api/resources/{dag → collections}/index.js +0 -0
- /package/api/resources/{entities → sourceConnections}/client/index.d.ts +0 -0
- /package/api/resources/{entities → sourceConnections}/client/index.js +0 -0
- /package/api/resources/{dag/client/requests/InitializeDagDagInitGetRequest.js → sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.js} +0 -0
- /package/api/resources/{dag/client/requests/SyncDagCreate.js → sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
- /package/api/resources/{dag/client/requests/SyncDagUpdate.js → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.js} +0 -0
- /package/api/resources/{entities/client/requests/EntityDefinitionCreate.js → sourceConnections/client/requests/SourceConnectionUpdate.js} +0 -0
- /package/api/resources/{dag → sourceConnections}/client/requests/index.js +0 -0
- /package/api/resources/{destinations → sourceConnections}/index.d.ts +0 -0
- /package/api/resources/{destinations → sourceConnections}/index.js +0 -0
- /package/{dist/api/resources/connections/client/requests → api/types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +0 -0
- /package/api/{resources/entities/client/requests/EntityDefinitionUpdate.js → types/BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js} +0 -0
- /package/api/{resources/entities/client/requests/EntityRelationCreate.js → types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js} +0 -0
- /package/{dist/api/resources/connections/client/requests → api/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +0 -0
- /package/api/{resources/entities/client/requests/EntityRelationUpdate.js → types/Collection.js} +0 -0
- /package/api/{resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → types/CollectionUpdate.js} +0 -0
- /package/api/{resources/entities/types/EntityDefinitionCreateEntitySchema.js → types/ConfigValues.js} +0 -0
- /package/api/{resources/entities/types/EntityDefinitionUpdateEntitySchema.js → types/DestinationWithAuthenticationFields.js} +0 -0
- /package/api/{resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.js → types/EmbeddingModelWithAuthenticationFields.js} +0 -0
- /package/api/{resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js → types/EntityCount.js} +0 -0
- /package/{dist/api/resources/entities/client/requests → api/types}/EntityDefinitionCreate.js +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/{dist/api/resources/entities → api}/types/EntityDefinitionCreateEntitySchema.js +0 -0
- /package/{dist/api/resources/entities/client/requests → api/types}/EntityDefinitionUpdate.js +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.d.ts +0 -0
- /package/{dist/api/resources/entities → api}/types/EntityDefinitionUpdateEntitySchema.js +0 -0
- /package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationCreate.js +0 -0
- /package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationUpdate.js +0 -0
- /package/api/{resources/sync/client/requests/ListSyncsSyncGetRequest.js → types/Organization.js} +0 -0
- /package/api/{resources/sync/client/requests/SyncCreate.js → types/SearchResponse.js} +0 -0
- /package/api/{resources/sync/client/requests/SyncUpdate.js → types/SourceConnection.js} +0 -0
- /package/api/{resources/sync/types/ListSyncsSyncGetResponse.js → types/SourceConnectionAuthFields.js} +0 -0
- /package/api/{resources/transformers/client/requests/TransformerCreate.js → types/SourceConnectionCreate.js} +0 -0
- /package/api/{resources/transformers/client/requests/TransformerUpdate.js → types/SourceConnectionJob.js} +0 -0
- /package/api/types/{ApiKeyWithPlainKey.js → SourceConnectionListItem.js} +0 -0
- /package/api/types/{DestinationWithConfigFields.js → SourceWithAuthenticationFields.js} +0 -0
- /package/{dist/api/resources/sync/client/requests → api/types}/SyncCreate.js +0 -0
- /package/{dist/api/resources/dag/client/requests → api/types}/SyncDagCreate.js +0 -0
- /package/{dist/api/resources/dag/client/requests → api/types}/SyncDagUpdate.js +0 -0
- /package/{dist/api/resources/sync/client/requests → api/types}/SyncUpdate.js +0 -0
- /package/{dist/api/resources/transformers/client/requests → api/types}/TransformerCreate.js +0 -0
- /package/{dist/api/resources/transformers/client/requests → api/types}/TransformerUpdate.js +0 -0
- /package/api/types/{EmbeddingModelWithConfigFields.js → UserCreate.js} +0 -0
- /package/{api/resources/sync → dist/api/resources/collections}/client/index.d.ts +0 -0
- /package/{api/resources/sync → dist/api/resources/collections}/client/index.js +0 -0
- /package/{api/types/SourceWithConfigFields.js → dist/api/resources/collections/client/requests/CollectionCreate.js} +0 -0
- /package/dist/api/resources/{connections/client/requests/GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest.js → collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.js} +0 -0
- /package/dist/api/resources/{dag/client/requests/InitializeDagDagInitGetRequest.js → collections/client/requests/ListCollectionsCollectionsGetRequest.js} +0 -0
- /package/{api/resources/destinations/client → dist/api/resources/collections/client/requests}/index.js +0 -0
- /package/{api/resources/embeddingModels → dist/api/resources/collections}/index.d.ts +0 -0
- /package/{api/resources/embeddingModels → dist/api/resources/collections}/index.js +0 -0
- /package/{api/resources/transformers → dist/api/resources/sourceConnections}/client/index.d.ts +0 -0
- /package/{api/resources/transformers → dist/api/resources/sourceConnections}/client/index.js +0 -0
- /package/dist/api/resources/{entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.js} +0 -0
- /package/dist/api/resources/{sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.js → sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
- /package/dist/api/resources/{sync/client/requests/ListAllJobsSyncJobsGetRequest.js → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.js} +0 -0
- /package/dist/api/resources/{sync/client/requests/ListSyncsSyncGetRequest.js → sourceConnections/client/requests/SourceConnectionUpdate.js} +0 -0
- /package/{api/resources/embeddingModels/client → dist/api/resources/sourceConnections/client/requests}/index.js +0 -0
- /package/{api/resources/transformers → dist/api/resources/sourceConnections}/index.d.ts +0 -0
- /package/{api/resources/transformers → dist/api/resources/sourceConnections}/index.js +0 -0
- /package/dist/api/{resources/sync/types/ListSyncsSyncGetResponse.js → types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js} +0 -0
- /package/dist/api/types/{ApiKeyWithPlainKey.js → BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js} +0 -0
- /package/dist/api/types/{DestinationWithConfigFields.js → BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js} +0 -0
- /package/dist/api/types/{EmbeddingModelWithConfigFields.js → BodySendOauth2CodeConnectionsOauth2SourceCodePost.js} +0 -0
- /package/dist/api/types/{SourceWithConfigFields.js → Collection.js} +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.d.ts +0 -0
- /package/{api/resources/users → dist/serialization/resources/collections}/index.d.ts +0 -0
- /package/{api/resources/users → dist/serialization/resources/collections}/index.js +0 -0
- /package/dist/{api/resources/dag → serialization/resources/sourceConnections}/index.d.ts +0 -0
- /package/dist/{api/resources/dag → serialization/resources/sourceConnections}/index.js +0 -0
- /package/{dist/api/resources/destinations → serialization/resources/collections}/index.d.ts +0 -0
- /package/{dist/api/resources/destinations → serialization/resources/collections}/index.js +0 -0
- /package/{dist/api/resources/embeddingModels → serialization/resources/sourceConnections}/index.d.ts +0 -0
- /package/{dist/api/resources/embeddingModels → serialization/resources/sourceConnections}/index.js +0 -0
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Sources
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithAuthenticationFields</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,15 +14,17 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
Get
|
|
17
|
+
Get source by id.
|
|
18
18
|
|
|
19
19
|
## Args:
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
db (AsyncSession): The database session.
|
|
22
|
+
short_name (str): The short name of the source.
|
|
23
|
+
user (schemas.User): The current user.
|
|
22
24
|
|
|
23
25
|
## Returns:
|
|
24
26
|
|
|
25
|
-
schemas.
|
|
27
|
+
schemas.Source: The source object.
|
|
26
28
|
|
|
27
29
|
</dd>
|
|
28
30
|
</dl>
|
|
@@ -38,7 +40,7 @@ Get current user.
|
|
|
38
40
|
<dd>
|
|
39
41
|
|
|
40
42
|
```typescript
|
|
41
|
-
await client.
|
|
43
|
+
await client.sources.readSource("short_name");
|
|
42
44
|
```
|
|
43
45
|
|
|
44
46
|
</dd>
|
|
@@ -54,7 +56,15 @@ await client.users.readUser();
|
|
|
54
56
|
<dl>
|
|
55
57
|
<dd>
|
|
56
58
|
|
|
57
|
-
**
|
|
59
|
+
**shortName:** `string`
|
|
60
|
+
|
|
61
|
+
</dd>
|
|
62
|
+
</dl>
|
|
63
|
+
|
|
64
|
+
<dl>
|
|
65
|
+
<dd>
|
|
66
|
+
|
|
67
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
58
68
|
|
|
59
69
|
</dd>
|
|
60
70
|
</dl>
|
|
@@ -65,9 +75,7 @@ await client.users.readUser();
|
|
|
65
75
|
</dl>
|
|
66
76
|
</details>
|
|
67
77
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithConfigFields</code></summary>
|
|
78
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
|
|
71
79
|
<dl>
|
|
72
80
|
<dd>
|
|
73
81
|
|
|
@@ -79,17 +87,16 @@ await client.users.readUser();
|
|
|
79
87
|
<dl>
|
|
80
88
|
<dd>
|
|
81
89
|
|
|
82
|
-
Get
|
|
90
|
+
Get all sources for the current user.
|
|
83
91
|
|
|
84
92
|
## Args:
|
|
85
93
|
|
|
86
|
-
db
|
|
87
|
-
|
|
88
|
-
user (schemas.User): The current user.
|
|
94
|
+
db: The database session
|
|
95
|
+
user: The current user
|
|
89
96
|
|
|
90
97
|
## Returns:
|
|
91
98
|
|
|
92
|
-
schemas.Source: The
|
|
99
|
+
list[schemas.Source]: The list of sources.
|
|
93
100
|
|
|
94
101
|
</dd>
|
|
95
102
|
</dl>
|
|
@@ -105,7 +112,7 @@ Get source by id.
|
|
|
105
112
|
<dd>
|
|
106
113
|
|
|
107
114
|
```typescript
|
|
108
|
-
await client.sources.
|
|
115
|
+
await client.sources.readSources();
|
|
109
116
|
```
|
|
110
117
|
|
|
111
118
|
</dd>
|
|
@@ -121,14 +128,6 @@ await client.sources.readSource("short_name");
|
|
|
121
128
|
<dl>
|
|
122
129
|
<dd>
|
|
123
130
|
|
|
124
|
-
**shortName:** `string`
|
|
125
|
-
|
|
126
|
-
</dd>
|
|
127
|
-
</dl>
|
|
128
|
-
|
|
129
|
-
<dl>
|
|
130
|
-
<dd>
|
|
131
|
-
|
|
132
131
|
**requestOptions:** `Sources.RequestOptions`
|
|
133
132
|
|
|
134
133
|
</dd>
|
|
@@ -140,7 +139,9 @@ await client.sources.readSource("short_name");
|
|
|
140
139
|
</dl>
|
|
141
140
|
</details>
|
|
142
141
|
|
|
143
|
-
|
|
142
|
+
## Collections
|
|
143
|
+
|
|
144
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">listCollections</a>({ ...params }) -> AirweaveSDK.Collection[]</code></summary>
|
|
144
145
|
<dl>
|
|
145
146
|
<dd>
|
|
146
147
|
|
|
@@ -152,16 +153,7 @@ await client.sources.readSource("short_name");
|
|
|
152
153
|
<dl>
|
|
153
154
|
<dd>
|
|
154
155
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
## Args:
|
|
158
|
-
|
|
159
|
-
db: The database session
|
|
160
|
-
user: The current user
|
|
161
|
-
|
|
162
|
-
## Returns:
|
|
163
|
-
|
|
164
|
-
list[schemas.Source]: The list of sources.
|
|
156
|
+
List all collections for the current user's organization.
|
|
165
157
|
|
|
166
158
|
</dd>
|
|
167
159
|
</dl>
|
|
@@ -177,7 +169,7 @@ Get all sources for the current user.
|
|
|
177
169
|
<dd>
|
|
178
170
|
|
|
179
171
|
```typescript
|
|
180
|
-
await client.
|
|
172
|
+
await client.collections.listCollections();
|
|
181
173
|
```
|
|
182
174
|
|
|
183
175
|
</dd>
|
|
@@ -193,7 +185,15 @@ await client.sources.readSources();
|
|
|
193
185
|
<dl>
|
|
194
186
|
<dd>
|
|
195
187
|
|
|
196
|
-
**
|
|
188
|
+
**request:** `AirweaveSDK.ListCollectionsCollectionsGetRequest`
|
|
189
|
+
|
|
190
|
+
</dd>
|
|
191
|
+
</dl>
|
|
192
|
+
|
|
193
|
+
<dl>
|
|
194
|
+
<dd>
|
|
195
|
+
|
|
196
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
197
197
|
|
|
198
198
|
</dd>
|
|
199
199
|
</dl>
|
|
@@ -204,9 +204,7 @@ await client.sources.readSources();
|
|
|
204
204
|
</dl>
|
|
205
205
|
</details>
|
|
206
206
|
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>() -> AirweaveSDK.Destination[]</code></summary>
|
|
207
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">createCollection</a>({ ...params }) -> AirweaveSDK.Collection</code></summary>
|
|
210
208
|
<dl>
|
|
211
209
|
<dd>
|
|
212
210
|
|
|
@@ -218,16 +216,7 @@ await client.sources.readSources();
|
|
|
218
216
|
<dl>
|
|
219
217
|
<dd>
|
|
220
218
|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
## Args:
|
|
224
|
-
|
|
225
|
-
db: The database session
|
|
226
|
-
user: The current user
|
|
227
|
-
|
|
228
|
-
## Returns:
|
|
229
|
-
|
|
230
|
-
List[schemas.Destination]: A list of destinations
|
|
219
|
+
Create a new collection.
|
|
231
220
|
|
|
232
221
|
</dd>
|
|
233
222
|
</dl>
|
|
@@ -243,7 +232,9 @@ Get all available destinations.
|
|
|
243
232
|
<dd>
|
|
244
233
|
|
|
245
234
|
```typescript
|
|
246
|
-
await client.
|
|
235
|
+
await client.collections.createCollection({
|
|
236
|
+
name: "name",
|
|
237
|
+
});
|
|
247
238
|
```
|
|
248
239
|
|
|
249
240
|
</dd>
|
|
@@ -259,7 +250,15 @@ await client.destinations.listDestinations();
|
|
|
259
250
|
<dl>
|
|
260
251
|
<dd>
|
|
261
252
|
|
|
262
|
-
**
|
|
253
|
+
**request:** `AirweaveSDK.CollectionCreate`
|
|
254
|
+
|
|
255
|
+
</dd>
|
|
256
|
+
</dl>
|
|
257
|
+
|
|
258
|
+
<dl>
|
|
259
|
+
<dd>
|
|
260
|
+
|
|
261
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
263
262
|
|
|
264
263
|
</dd>
|
|
265
264
|
</dl>
|
|
@@ -270,7 +269,7 @@ await client.destinations.listDestinations();
|
|
|
270
269
|
</dl>
|
|
271
270
|
</details>
|
|
272
271
|
|
|
273
|
-
<details><summary><code>client.
|
|
272
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">getCollection</a>(readableId) -> AirweaveSDK.Collection</code></summary>
|
|
274
273
|
<dl>
|
|
275
274
|
<dd>
|
|
276
275
|
|
|
@@ -282,17 +281,7 @@ await client.destinations.listDestinations();
|
|
|
282
281
|
<dl>
|
|
283
282
|
<dd>
|
|
284
283
|
|
|
285
|
-
Get
|
|
286
|
-
|
|
287
|
-
## Args:
|
|
288
|
-
|
|
289
|
-
db: The database session
|
|
290
|
-
short_name: The short name of the destination
|
|
291
|
-
user: The current user
|
|
292
|
-
|
|
293
|
-
## Returns:
|
|
294
|
-
|
|
295
|
-
destination (schemas.Destination): The destination
|
|
284
|
+
Get a specific collection by its readable ID.
|
|
296
285
|
|
|
297
286
|
</dd>
|
|
298
287
|
</dl>
|
|
@@ -308,7 +297,7 @@ Get destination by short name.
|
|
|
308
297
|
<dd>
|
|
309
298
|
|
|
310
299
|
```typescript
|
|
311
|
-
await client.
|
|
300
|
+
await client.collections.getCollection("readable_id");
|
|
312
301
|
```
|
|
313
302
|
|
|
314
303
|
</dd>
|
|
@@ -324,7 +313,7 @@ await client.destinations.readDestination("short_name");
|
|
|
324
313
|
<dl>
|
|
325
314
|
<dd>
|
|
326
315
|
|
|
327
|
-
**
|
|
316
|
+
**readableId:** `string`
|
|
328
317
|
|
|
329
318
|
</dd>
|
|
330
319
|
</dl>
|
|
@@ -332,7 +321,7 @@ await client.destinations.readDestination("short_name");
|
|
|
332
321
|
<dl>
|
|
333
322
|
<dd>
|
|
334
323
|
|
|
335
|
-
**requestOptions:** `
|
|
324
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
336
325
|
|
|
337
326
|
</dd>
|
|
338
327
|
</dl>
|
|
@@ -343,9 +332,7 @@ await client.destinations.readDestination("short_name");
|
|
|
343
332
|
</dl>
|
|
344
333
|
</details>
|
|
345
334
|
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
|
|
335
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">deleteCollection</a>(readableId, { ...params }) -> AirweaveSDK.Collection</code></summary>
|
|
349
336
|
<dl>
|
|
350
337
|
<dd>
|
|
351
338
|
|
|
@@ -357,17 +344,16 @@ await client.destinations.readDestination("short_name");
|
|
|
357
344
|
<dl>
|
|
358
345
|
<dd>
|
|
359
346
|
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
## Args:
|
|
363
|
-
|
|
364
|
-
db (AsyncSession): The database session.
|
|
365
|
-
short_name (str): The short name of the embedding model.
|
|
366
|
-
user (schemas.User): The current user.
|
|
347
|
+
Delete a collection by its readable ID.
|
|
367
348
|
|
|
368
|
-
|
|
349
|
+
Args:
|
|
350
|
+
readable_id: The readable ID of the collection to delete
|
|
351
|
+
delete_data: Whether to delete the data in destinations
|
|
352
|
+
db: The database session
|
|
353
|
+
current_user: The current user
|
|
369
354
|
|
|
370
|
-
|
|
355
|
+
Returns:
|
|
356
|
+
The deleted collection
|
|
371
357
|
|
|
372
358
|
</dd>
|
|
373
359
|
</dl>
|
|
@@ -383,7 +369,7 @@ Get embedding model by id.
|
|
|
383
369
|
<dd>
|
|
384
370
|
|
|
385
371
|
```typescript
|
|
386
|
-
await client.
|
|
372
|
+
await client.collections.deleteCollection("readable_id");
|
|
387
373
|
```
|
|
388
374
|
|
|
389
375
|
</dd>
|
|
@@ -399,7 +385,7 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
399
385
|
<dl>
|
|
400
386
|
<dd>
|
|
401
387
|
|
|
402
|
-
**
|
|
388
|
+
**readableId:** `string`
|
|
403
389
|
|
|
404
390
|
</dd>
|
|
405
391
|
</dl>
|
|
@@ -407,7 +393,15 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
407
393
|
<dl>
|
|
408
394
|
<dd>
|
|
409
395
|
|
|
410
|
-
**
|
|
396
|
+
**request:** `AirweaveSDK.DeleteCollectionCollectionsReadableIdDeleteRequest`
|
|
397
|
+
|
|
398
|
+
</dd>
|
|
399
|
+
</dl>
|
|
400
|
+
|
|
401
|
+
<dl>
|
|
402
|
+
<dd>
|
|
403
|
+
|
|
404
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
411
405
|
|
|
412
406
|
</dd>
|
|
413
407
|
</dl>
|
|
@@ -418,7 +412,7 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
418
412
|
</dl>
|
|
419
413
|
</details>
|
|
420
414
|
|
|
421
|
-
<details><summary><code>client.
|
|
415
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">refreshAllSourceConnections</a>(readableId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
|
|
422
416
|
<dl>
|
|
423
417
|
<dd>
|
|
424
418
|
|
|
@@ -430,16 +424,16 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
430
424
|
<dl>
|
|
431
425
|
<dd>
|
|
432
426
|
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
## Args:
|
|
436
|
-
|
|
437
|
-
db (AsyncSession): The database session.
|
|
438
|
-
user (schemas.User): The current user.
|
|
427
|
+
Start sync jobs for all source connections in the collection.
|
|
439
428
|
|
|
440
|
-
|
|
429
|
+
Args:
|
|
430
|
+
readable_id: The readable ID of the collection
|
|
431
|
+
db: The database session
|
|
432
|
+
current_user: The current user
|
|
433
|
+
background_tasks: Background tasks for async operations
|
|
441
434
|
|
|
442
|
-
|
|
435
|
+
Returns:
|
|
436
|
+
A list of created sync jobs
|
|
443
437
|
|
|
444
438
|
</dd>
|
|
445
439
|
</dl>
|
|
@@ -455,7 +449,7 @@ Get all embedding models.
|
|
|
455
449
|
<dd>
|
|
456
450
|
|
|
457
451
|
```typescript
|
|
458
|
-
await client.
|
|
452
|
+
await client.collections.refreshAllSourceConnections("readable_id");
|
|
459
453
|
```
|
|
460
454
|
|
|
461
455
|
</dd>
|
|
@@ -471,7 +465,15 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
471
465
|
<dl>
|
|
472
466
|
<dd>
|
|
473
467
|
|
|
474
|
-
**
|
|
468
|
+
**readableId:** `string`
|
|
469
|
+
|
|
470
|
+
</dd>
|
|
471
|
+
</dl>
|
|
472
|
+
|
|
473
|
+
<dl>
|
|
474
|
+
<dd>
|
|
475
|
+
|
|
476
|
+
**requestOptions:** `Collections.RequestOptions`
|
|
475
477
|
|
|
476
478
|
</dd>
|
|
477
479
|
</dl>
|
|
@@ -621,7 +623,9 @@ await client.connections.listAllConnectedIntegrations();
|
|
|
621
623
|
</dl>
|
|
622
624
|
</details>
|
|
623
625
|
|
|
624
|
-
|
|
626
|
+
## SourceConnections
|
|
627
|
+
|
|
628
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listSourceConnections</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
|
|
625
629
|
<dl>
|
|
626
630
|
<dd>
|
|
627
631
|
|
|
@@ -633,17 +637,17 @@ await client.connections.listAllConnectedIntegrations();
|
|
|
633
637
|
<dl>
|
|
634
638
|
<dd>
|
|
635
639
|
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
## Args:
|
|
639
|
-
|
|
640
|
-
integration_type (IntegrationType): The type of integration to get connections for.
|
|
641
|
-
db (AsyncSession): The database session.
|
|
642
|
-
user (schemas.User): The current user.
|
|
640
|
+
List all source connections for the current user.
|
|
643
641
|
|
|
644
|
-
|
|
642
|
+
Args:
|
|
643
|
+
db: The database session
|
|
644
|
+
collection: The collection to filter by
|
|
645
|
+
skip: The number of connections to skip
|
|
646
|
+
limit: The number of connections to return
|
|
647
|
+
user: The current user
|
|
645
648
|
|
|
646
|
-
|
|
649
|
+
Returns:
|
|
650
|
+
A list of source connection list items with essential information
|
|
647
651
|
|
|
648
652
|
</dd>
|
|
649
653
|
</dl>
|
|
@@ -659,7 +663,7 @@ Get all integrations of specified type connected to the current user.
|
|
|
659
663
|
<dd>
|
|
660
664
|
|
|
661
665
|
```typescript
|
|
662
|
-
await client.
|
|
666
|
+
await client.sourceConnections.listSourceConnections();
|
|
663
667
|
```
|
|
664
668
|
|
|
665
669
|
</dd>
|
|
@@ -675,7 +679,7 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
675
679
|
<dl>
|
|
676
680
|
<dd>
|
|
677
681
|
|
|
678
|
-
**
|
|
682
|
+
**request:** `AirweaveSDK.ListSourceConnectionsSourceConnectionsGetRequest`
|
|
679
683
|
|
|
680
684
|
</dd>
|
|
681
685
|
</dl>
|
|
@@ -683,7 +687,7 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
683
687
|
<dl>
|
|
684
688
|
<dd>
|
|
685
689
|
|
|
686
|
-
**requestOptions:** `
|
|
690
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
687
691
|
|
|
688
692
|
</dd>
|
|
689
693
|
</dl>
|
|
@@ -694,7 +698,7 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
694
698
|
</dl>
|
|
695
699
|
</details>
|
|
696
700
|
|
|
697
|
-
<details><summary><code>client.
|
|
701
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">createSourceConnection</a>({ ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
698
702
|
<dl>
|
|
699
703
|
<dd>
|
|
700
704
|
|
|
@@ -706,29 +710,24 @@ await client.connections.listConnectedIntegrations("source");
|
|
|
706
710
|
<dl>
|
|
707
711
|
<dd>
|
|
708
712
|
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
Expects a POST body with:
|
|
712
|
-
|
|
713
|
-
```json
|
|
714
|
-
{
|
|
715
|
-
"name": "required connection name",
|
|
716
|
-
... other config fields specific to the integration type ...
|
|
717
|
-
}
|
|
718
|
-
```
|
|
713
|
+
Create a new source connection.
|
|
719
714
|
|
|
720
|
-
|
|
715
|
+
This endpoint creates:
|
|
721
716
|
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
user: The current user.
|
|
717
|
+
1. An integration credential with the provided auth fields
|
|
718
|
+
2. A collection if not provided
|
|
719
|
+
3. The source connection
|
|
720
|
+
4. A sync configuration and DAG
|
|
721
|
+
5. A sync job if immediate execution is requested
|
|
728
722
|
|
|
729
|
-
|
|
723
|
+
Args:
|
|
724
|
+
db: The database session
|
|
725
|
+
source_connection_in: The source connection to create
|
|
726
|
+
user: The current user
|
|
727
|
+
background_tasks: Background tasks for async operations
|
|
730
728
|
|
|
731
|
-
|
|
729
|
+
Returns:
|
|
730
|
+
The created source connection
|
|
732
731
|
|
|
733
732
|
</dd>
|
|
734
733
|
</dl>
|
|
@@ -744,10 +743,9 @@ Expects a POST body with:
|
|
|
744
743
|
<dd>
|
|
745
744
|
|
|
746
745
|
```typescript
|
|
747
|
-
await client.
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
},
|
|
746
|
+
await client.sourceConnections.createSourceConnection({
|
|
747
|
+
name: "name",
|
|
748
|
+
shortName: "short_name",
|
|
751
749
|
});
|
|
752
750
|
```
|
|
753
751
|
|
|
@@ -764,23 +762,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
764
762
|
<dl>
|
|
765
763
|
<dd>
|
|
766
764
|
|
|
767
|
-
**
|
|
768
|
-
|
|
769
|
-
</dd>
|
|
770
|
-
</dl>
|
|
771
|
-
|
|
772
|
-
<dl>
|
|
773
|
-
<dd>
|
|
774
|
-
|
|
775
|
-
**shortName:** `string`
|
|
776
|
-
|
|
777
|
-
</dd>
|
|
778
|
-
</dl>
|
|
779
|
-
|
|
780
|
-
<dl>
|
|
781
|
-
<dd>
|
|
782
|
-
|
|
783
|
-
**request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
|
|
765
|
+
**request:** `AirweaveSDK.SourceConnectionCreate`
|
|
784
766
|
|
|
785
767
|
</dd>
|
|
786
768
|
</dl>
|
|
@@ -788,7 +770,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
788
770
|
<dl>
|
|
789
771
|
<dd>
|
|
790
772
|
|
|
791
|
-
**requestOptions:** `
|
|
773
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
792
774
|
|
|
793
775
|
</dd>
|
|
794
776
|
</dl>
|
|
@@ -799,7 +781,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
799
781
|
</dl>
|
|
800
782
|
</details>
|
|
801
783
|
|
|
802
|
-
<details><summary><code>client.
|
|
784
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">getSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
803
785
|
<dl>
|
|
804
786
|
<dd>
|
|
805
787
|
|
|
@@ -811,17 +793,16 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
811
793
|
<dl>
|
|
812
794
|
<dd>
|
|
813
795
|
|
|
814
|
-
Get
|
|
815
|
-
|
|
816
|
-
## Args:
|
|
817
|
-
|
|
818
|
-
connection_id (UUID): The ID of the connection to get credentials for
|
|
819
|
-
db (AsyncSession): The database session
|
|
820
|
-
user (schemas.User): The current user
|
|
796
|
+
Get a specific source connection by ID.
|
|
821
797
|
|
|
822
|
-
|
|
798
|
+
Args:
|
|
799
|
+
db: The database session
|
|
800
|
+
source_connection_id: The ID of the source connection
|
|
801
|
+
show_auth_fields: Whether to show the auth fields, default is False
|
|
802
|
+
user: The current user
|
|
823
803
|
|
|
824
|
-
|
|
804
|
+
Returns:
|
|
805
|
+
The source connection
|
|
825
806
|
|
|
826
807
|
</dd>
|
|
827
808
|
</dl>
|
|
@@ -837,7 +818,7 @@ Get the credentials for a connection.
|
|
|
837
818
|
<dd>
|
|
838
819
|
|
|
839
820
|
```typescript
|
|
840
|
-
await client.
|
|
821
|
+
await client.sourceConnections.getSourceConnection("source_connection_id");
|
|
841
822
|
```
|
|
842
823
|
|
|
843
824
|
</dd>
|
|
@@ -853,7 +834,7 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
853
834
|
<dl>
|
|
854
835
|
<dd>
|
|
855
836
|
|
|
856
|
-
**
|
|
837
|
+
**sourceConnectionId:** `string`
|
|
857
838
|
|
|
858
839
|
</dd>
|
|
859
840
|
</dl>
|
|
@@ -861,7 +842,15 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
861
842
|
<dl>
|
|
862
843
|
<dd>
|
|
863
844
|
|
|
864
|
-
**
|
|
845
|
+
**request:** `AirweaveSDK.GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest`
|
|
846
|
+
|
|
847
|
+
</dd>
|
|
848
|
+
</dl>
|
|
849
|
+
|
|
850
|
+
<dl>
|
|
851
|
+
<dd>
|
|
852
|
+
|
|
853
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
865
854
|
|
|
866
855
|
</dd>
|
|
867
856
|
</dl>
|
|
@@ -872,7 +861,7 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
872
861
|
</dl>
|
|
873
862
|
</details>
|
|
874
863
|
|
|
875
|
-
<details><summary><code>client.
|
|
864
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">updateSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
876
865
|
<dl>
|
|
877
866
|
<dd>
|
|
878
867
|
|
|
@@ -884,19 +873,16 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
884
873
|
<dl>
|
|
885
874
|
<dd>
|
|
886
875
|
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
Deletes the connection and integration credential.
|
|
890
|
-
|
|
891
|
-
## Args:
|
|
892
|
-
|
|
893
|
-
db (AsyncSession): The database session
|
|
894
|
-
connection_id (UUID): The ID of the connection to delete
|
|
895
|
-
user (schemas.User): The current user
|
|
876
|
+
Update a source connection.
|
|
896
877
|
|
|
897
|
-
|
|
878
|
+
Args:
|
|
879
|
+
db: The database session
|
|
880
|
+
source_connection_id: The ID of the source connection to update
|
|
881
|
+
source_connection_in: The updated source connection data
|
|
882
|
+
user: The current user
|
|
898
883
|
|
|
899
|
-
|
|
884
|
+
Returns:
|
|
885
|
+
The updated source connection
|
|
900
886
|
|
|
901
887
|
</dd>
|
|
902
888
|
</dl>
|
|
@@ -912,7 +898,7 @@ Deletes the connection and integration credential.
|
|
|
912
898
|
<dd>
|
|
913
899
|
|
|
914
900
|
```typescript
|
|
915
|
-
await client.
|
|
901
|
+
await client.sourceConnections.updateSourceConnection("source_connection_id");
|
|
916
902
|
```
|
|
917
903
|
|
|
918
904
|
</dd>
|
|
@@ -928,7 +914,7 @@ await client.connections.deleteConnection("connection_id");
|
|
|
928
914
|
<dl>
|
|
929
915
|
<dd>
|
|
930
916
|
|
|
931
|
-
**
|
|
917
|
+
**sourceConnectionId:** `string`
|
|
932
918
|
|
|
933
919
|
</dd>
|
|
934
920
|
</dl>
|
|
@@ -936,7 +922,15 @@ await client.connections.deleteConnection("connection_id");
|
|
|
936
922
|
<dl>
|
|
937
923
|
<dd>
|
|
938
924
|
|
|
939
|
-
**
|
|
925
|
+
**request:** `AirweaveSDK.SourceConnectionUpdate`
|
|
926
|
+
|
|
927
|
+
</dd>
|
|
928
|
+
</dl>
|
|
929
|
+
|
|
930
|
+
<dl>
|
|
931
|
+
<dd>
|
|
932
|
+
|
|
933
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
940
934
|
|
|
941
935
|
</dd>
|
|
942
936
|
</dl>
|
|
@@ -947,7 +941,7 @@ await client.connections.deleteConnection("connection_id");
|
|
|
947
941
|
</dl>
|
|
948
942
|
</details>
|
|
949
943
|
|
|
950
|
-
<details><summary><code>client.
|
|
944
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">deleteSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
951
945
|
<dl>
|
|
952
946
|
<dd>
|
|
953
947
|
|
|
@@ -959,17 +953,16 @@ await client.connections.deleteConnection("connection_id");
|
|
|
959
953
|
<dl>
|
|
960
954
|
<dd>
|
|
961
955
|
|
|
962
|
-
|
|
956
|
+
Delete a source connection and all related components.
|
|
963
957
|
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
## Returns:
|
|
958
|
+
Args:
|
|
959
|
+
db: The database session
|
|
960
|
+
source_connection_id: The ID of the source connection to delete
|
|
961
|
+
delete_data: Whether to delete the associated data in destinations
|
|
962
|
+
user: The current user
|
|
971
963
|
|
|
972
|
-
|
|
964
|
+
Returns:
|
|
965
|
+
The deleted source connection
|
|
973
966
|
|
|
974
967
|
</dd>
|
|
975
968
|
</dl>
|
|
@@ -985,7 +978,7 @@ Disconnect from a source connection.
|
|
|
985
978
|
<dd>
|
|
986
979
|
|
|
987
980
|
```typescript
|
|
988
|
-
await client.
|
|
981
|
+
await client.sourceConnections.deleteSourceConnection("source_connection_id");
|
|
989
982
|
```
|
|
990
983
|
|
|
991
984
|
</dd>
|
|
@@ -1001,7 +994,7 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1001
994
|
<dl>
|
|
1002
995
|
<dd>
|
|
1003
996
|
|
|
1004
|
-
**
|
|
997
|
+
**sourceConnectionId:** `string`
|
|
1005
998
|
|
|
1006
999
|
</dd>
|
|
1007
1000
|
</dl>
|
|
@@ -1009,7 +1002,15 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1009
1002
|
<dl>
|
|
1010
1003
|
<dd>
|
|
1011
1004
|
|
|
1012
|
-
**
|
|
1005
|
+
**request:** `AirweaveSDK.DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest`
|
|
1006
|
+
|
|
1007
|
+
</dd>
|
|
1008
|
+
</dl>
|
|
1009
|
+
|
|
1010
|
+
<dl>
|
|
1011
|
+
<dd>
|
|
1012
|
+
|
|
1013
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
1013
1014
|
|
|
1014
1015
|
</dd>
|
|
1015
1016
|
</dl>
|
|
@@ -1020,7 +1021,7 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1020
1021
|
</dl>
|
|
1021
1022
|
</details>
|
|
1022
1023
|
|
|
1023
|
-
<details><summary><code>client.
|
|
1024
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">runSourceConnection</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob</code></summary>
|
|
1024
1025
|
<dl>
|
|
1025
1026
|
<dd>
|
|
1026
1027
|
|
|
@@ -1032,17 +1033,16 @@ await client.connections.disconnectSourceConnection("connection_id");
|
|
|
1032
1033
|
<dl>
|
|
1033
1034
|
<dd>
|
|
1034
1035
|
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
## Args:
|
|
1038
|
-
|
|
1039
|
-
db (AsyncSession): The database session
|
|
1040
|
-
connection_id (UUID): The ID of the connection to disconnect
|
|
1041
|
-
user (schemas.User): The current user
|
|
1036
|
+
Trigger a sync run for a source connection.
|
|
1042
1037
|
|
|
1043
|
-
|
|
1038
|
+
Args:
|
|
1039
|
+
db: The database session
|
|
1040
|
+
source_connection_id: The ID of the source connection to run
|
|
1041
|
+
user: The current user
|
|
1042
|
+
background_tasks: Background tasks for async operations
|
|
1044
1043
|
|
|
1045
|
-
|
|
1044
|
+
Returns:
|
|
1045
|
+
The created sync job
|
|
1046
1046
|
|
|
1047
1047
|
</dd>
|
|
1048
1048
|
</dl>
|
|
@@ -1058,7 +1058,7 @@ Disconnect from a destination connection.
|
|
|
1058
1058
|
<dd>
|
|
1059
1059
|
|
|
1060
1060
|
```typescript
|
|
1061
|
-
await client.
|
|
1061
|
+
await client.sourceConnections.runSourceConnection("source_connection_id");
|
|
1062
1062
|
```
|
|
1063
1063
|
|
|
1064
1064
|
</dd>
|
|
@@ -1074,7 +1074,7 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1074
1074
|
<dl>
|
|
1075
1075
|
<dd>
|
|
1076
1076
|
|
|
1077
|
-
**
|
|
1077
|
+
**sourceConnectionId:** `string`
|
|
1078
1078
|
|
|
1079
1079
|
</dd>
|
|
1080
1080
|
</dl>
|
|
@@ -1082,7 +1082,7 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1082
1082
|
<dl>
|
|
1083
1083
|
<dd>
|
|
1084
1084
|
|
|
1085
|
-
**requestOptions:** `
|
|
1085
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
1086
1086
|
|
|
1087
1087
|
</dd>
|
|
1088
1088
|
</dl>
|
|
@@ -1093,7 +1093,7 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1093
1093
|
</dl>
|
|
1094
1094
|
</details>
|
|
1095
1095
|
|
|
1096
|
-
<details><summary><code>client.
|
|
1096
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listSourceConnectionJobs</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
|
|
1097
1097
|
<dl>
|
|
1098
1098
|
<dd>
|
|
1099
1099
|
|
|
@@ -1105,13 +1105,15 @@ await client.connections.disconnectDestinationConnection("connection_id");
|
|
|
1105
1105
|
<dl>
|
|
1106
1106
|
<dd>
|
|
1107
1107
|
|
|
1108
|
-
|
|
1108
|
+
List all sync jobs for a source connection.
|
|
1109
1109
|
|
|
1110
|
-
|
|
1110
|
+
Args:
|
|
1111
|
+
db: The database session
|
|
1112
|
+
source_connection_id: The ID of the source connection
|
|
1113
|
+
user: The current user
|
|
1111
1114
|
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
user: The current user
|
|
1115
|
+
Returns:
|
|
1116
|
+
A list of sync jobs
|
|
1115
1117
|
|
|
1116
1118
|
</dd>
|
|
1117
1119
|
</dl>
|
|
@@ -1127,9 +1129,7 @@ Get the OAuth2 authorization URL for a source.
|
|
|
1127
1129
|
<dd>
|
|
1128
1130
|
|
|
1129
1131
|
```typescript
|
|
1130
|
-
await client.
|
|
1131
|
-
shortName: "short_name",
|
|
1132
|
-
});
|
|
1132
|
+
await client.sourceConnections.listSourceConnectionJobs("source_connection_id");
|
|
1133
1133
|
```
|
|
1134
1134
|
|
|
1135
1135
|
</dd>
|
|
@@ -1145,7 +1145,7 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1145
1145
|
<dl>
|
|
1146
1146
|
<dd>
|
|
1147
1147
|
|
|
1148
|
-
**
|
|
1148
|
+
**sourceConnectionId:** `string`
|
|
1149
1149
|
|
|
1150
1150
|
</dd>
|
|
1151
1151
|
</dl>
|
|
@@ -1153,7 +1153,7 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1153
1153
|
<dl>
|
|
1154
1154
|
<dd>
|
|
1155
1155
|
|
|
1156
|
-
**requestOptions:** `
|
|
1156
|
+
**requestOptions:** `SourceConnections.RequestOptions`
|
|
1157
1157
|
|
|
1158
1158
|
</dd>
|
|
1159
1159
|
</dl>
|
|
@@ -1164,7 +1164,9 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1164
1164
|
</dl>
|
|
1165
1165
|
</details>
|
|
1166
1166
|
|
|
1167
|
-
|
|
1167
|
+
## WhiteLabels
|
|
1168
|
+
|
|
1169
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
1168
1170
|
<dl>
|
|
1169
1171
|
<dd>
|
|
1170
1172
|
|
|
@@ -1176,24 +1178,16 @@ await client.connections.getOauth2AuthUrl({
|
|
|
1176
1178
|
<dl>
|
|
1177
1179
|
<dd>
|
|
1178
1180
|
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
This will:
|
|
1182
|
-
|
|
1183
|
-
1. Get the OAuth2 settings for the source
|
|
1184
|
-
2. Exchange the authorization code for a token
|
|
1185
|
-
3. Create an integration credential with the token
|
|
1181
|
+
List all white labels for the current user's organization.
|
|
1186
1182
|
|
|
1187
1183
|
## Args:
|
|
1188
1184
|
|
|
1189
1185
|
db: The database session
|
|
1190
|
-
|
|
1191
|
-
code: The authorization code
|
|
1192
|
-
user: The current user
|
|
1186
|
+
current_user: The current user
|
|
1193
1187
|
|
|
1194
1188
|
## Returns:
|
|
1195
1189
|
|
|
1196
|
-
|
|
1190
|
+
list[schemas.WhiteLabel]: A list of white labels
|
|
1197
1191
|
|
|
1198
1192
|
</dd>
|
|
1199
1193
|
</dl>
|
|
@@ -1209,10 +1203,7 @@ This will:
|
|
|
1209
1203
|
<dd>
|
|
1210
1204
|
|
|
1211
1205
|
```typescript
|
|
1212
|
-
await client.
|
|
1213
|
-
shortName: "short_name",
|
|
1214
|
-
code: "code",
|
|
1215
|
-
});
|
|
1206
|
+
await client.whiteLabels.listWhiteLabels();
|
|
1216
1207
|
```
|
|
1217
1208
|
|
|
1218
1209
|
</dd>
|
|
@@ -1228,15 +1219,7 @@ await client.connections.sendOauth2Code({
|
|
|
1228
1219
|
<dl>
|
|
1229
1220
|
<dd>
|
|
1230
1221
|
|
|
1231
|
-
**
|
|
1232
|
-
|
|
1233
|
-
</dd>
|
|
1234
|
-
</dl>
|
|
1235
|
-
|
|
1236
|
-
<dl>
|
|
1237
|
-
<dd>
|
|
1238
|
-
|
|
1239
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1222
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1240
1223
|
|
|
1241
1224
|
</dd>
|
|
1242
1225
|
</dl>
|
|
@@ -1247,7 +1230,7 @@ await client.connections.sendOauth2Code({
|
|
|
1247
1230
|
</dl>
|
|
1248
1231
|
</details>
|
|
1249
1232
|
|
|
1250
|
-
<details><summary><code>client.
|
|
1233
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1251
1234
|
<dl>
|
|
1252
1235
|
<dd>
|
|
1253
1236
|
|
|
@@ -1259,19 +1242,17 @@ await client.connections.sendOauth2Code({
|
|
|
1259
1242
|
<dl>
|
|
1260
1243
|
<dd>
|
|
1261
1244
|
|
|
1262
|
-
|
|
1245
|
+
Create new white label integration.
|
|
1263
1246
|
|
|
1264
1247
|
## Args:
|
|
1265
1248
|
|
|
1266
1249
|
db: The database session
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
user: The current user
|
|
1270
|
-
background_tasks: The background tasks
|
|
1250
|
+
current_user: The current user
|
|
1251
|
+
white_label_in: The white label to create
|
|
1271
1252
|
|
|
1272
1253
|
## Returns:
|
|
1273
1254
|
|
|
1274
|
-
|
|
1255
|
+
white_label (schemas.WhiteLabel): The created white label
|
|
1275
1256
|
|
|
1276
1257
|
</dd>
|
|
1277
1258
|
</dl>
|
|
@@ -1287,7 +1268,13 @@ Exchange the OAuth2 authorization code for a white label integration.
|
|
|
1287
1268
|
<dd>
|
|
1288
1269
|
|
|
1289
1270
|
```typescript
|
|
1290
|
-
await client.
|
|
1271
|
+
await client.whiteLabels.createWhiteLabel({
|
|
1272
|
+
name: "name",
|
|
1273
|
+
sourceShortName: "source_short_name",
|
|
1274
|
+
redirectUrl: "redirect_url",
|
|
1275
|
+
clientId: "client_id",
|
|
1276
|
+
clientSecret: "client_secret",
|
|
1277
|
+
});
|
|
1291
1278
|
```
|
|
1292
1279
|
|
|
1293
1280
|
</dd>
|
|
@@ -1303,7 +1290,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1303
1290
|
<dl>
|
|
1304
1291
|
<dd>
|
|
1305
1292
|
|
|
1306
|
-
**
|
|
1293
|
+
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
1307
1294
|
|
|
1308
1295
|
</dd>
|
|
1309
1296
|
</dl>
|
|
@@ -1311,15 +1298,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1311
1298
|
<dl>
|
|
1312
1299
|
<dd>
|
|
1313
1300
|
|
|
1314
|
-
**
|
|
1315
|
-
|
|
1316
|
-
</dd>
|
|
1317
|
-
</dl>
|
|
1318
|
-
|
|
1319
|
-
<dl>
|
|
1320
|
-
<dd>
|
|
1321
|
-
|
|
1322
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1301
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1323
1302
|
|
|
1324
1303
|
</dd>
|
|
1325
1304
|
</dl>
|
|
@@ -1330,7 +1309,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1330
1309
|
</dl>
|
|
1331
1310
|
</details>
|
|
1332
1311
|
|
|
1333
|
-
<details><summary><code>client.
|
|
1312
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1334
1313
|
<dl>
|
|
1335
1314
|
<dd>
|
|
1336
1315
|
|
|
@@ -1342,17 +1321,17 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
|
1342
1321
|
<dl>
|
|
1343
1322
|
<dd>
|
|
1344
1323
|
|
|
1345
|
-
Get
|
|
1324
|
+
Get a specific white label integration.
|
|
1346
1325
|
|
|
1347
1326
|
## Args:
|
|
1348
1327
|
|
|
1349
1328
|
db: The database session
|
|
1350
|
-
white_label_id: The ID of the white label
|
|
1351
|
-
|
|
1329
|
+
white_label_id: The ID of the white label to get
|
|
1330
|
+
current_user: The current user
|
|
1352
1331
|
|
|
1353
1332
|
## Returns:
|
|
1354
1333
|
|
|
1355
|
-
|
|
1334
|
+
white_label (schemas.WhiteLabel): The white label
|
|
1356
1335
|
|
|
1357
1336
|
</dd>
|
|
1358
1337
|
</dl>
|
|
@@ -1368,7 +1347,7 @@ Get the OAuth2 authorization URL for a white label integration.
|
|
|
1368
1347
|
<dd>
|
|
1369
1348
|
|
|
1370
1349
|
```typescript
|
|
1371
|
-
await client.
|
|
1350
|
+
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
1372
1351
|
```
|
|
1373
1352
|
|
|
1374
1353
|
</dd>
|
|
@@ -1392,162 +1371,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
|
1392
1371
|
<dl>
|
|
1393
1372
|
<dd>
|
|
1394
1373
|
|
|
1395
|
-
**requestOptions:** `
|
|
1396
|
-
|
|
1397
|
-
</dd>
|
|
1398
|
-
</dl>
|
|
1399
|
-
</dd>
|
|
1400
|
-
</dl>
|
|
1401
|
-
|
|
1402
|
-
</dd>
|
|
1403
|
-
</dl>
|
|
1404
|
-
</details>
|
|
1405
|
-
|
|
1406
|
-
## Sync
|
|
1407
|
-
|
|
1408
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1409
|
-
<dl>
|
|
1410
|
-
<dd>
|
|
1411
|
-
|
|
1412
|
-
#### 📝 Description
|
|
1413
|
-
|
|
1414
|
-
<dl>
|
|
1415
|
-
<dd>
|
|
1416
|
-
|
|
1417
|
-
<dl>
|
|
1418
|
-
<dd>
|
|
1419
|
-
|
|
1420
|
-
List all syncs for the current user.
|
|
1421
|
-
|
|
1422
|
-
## Args:
|
|
1423
|
-
|
|
1424
|
-
db: The database session
|
|
1425
|
-
skip: The number of syncs to skip
|
|
1426
|
-
limit: The number of syncs to return
|
|
1427
|
-
with_source_connection: Whether to include the source connection in the response
|
|
1428
|
-
user: The current user
|
|
1429
|
-
|
|
1430
|
-
## Returns:
|
|
1431
|
-
|
|
1432
|
-
list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
|
|
1433
|
-
|
|
1434
|
-
</dd>
|
|
1435
|
-
</dl>
|
|
1436
|
-
</dd>
|
|
1437
|
-
</dl>
|
|
1438
|
-
|
|
1439
|
-
#### 🔌 Usage
|
|
1440
|
-
|
|
1441
|
-
<dl>
|
|
1442
|
-
<dd>
|
|
1443
|
-
|
|
1444
|
-
<dl>
|
|
1445
|
-
<dd>
|
|
1446
|
-
|
|
1447
|
-
```typescript
|
|
1448
|
-
await client.sync.listSyncs();
|
|
1449
|
-
```
|
|
1450
|
-
|
|
1451
|
-
</dd>
|
|
1452
|
-
</dl>
|
|
1453
|
-
</dd>
|
|
1454
|
-
</dl>
|
|
1455
|
-
|
|
1456
|
-
#### ⚙️ Parameters
|
|
1457
|
-
|
|
1458
|
-
<dl>
|
|
1459
|
-
<dd>
|
|
1460
|
-
|
|
1461
|
-
<dl>
|
|
1462
|
-
<dd>
|
|
1463
|
-
|
|
1464
|
-
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1465
|
-
|
|
1466
|
-
</dd>
|
|
1467
|
-
</dl>
|
|
1468
|
-
|
|
1469
|
-
<dl>
|
|
1470
|
-
<dd>
|
|
1471
|
-
|
|
1472
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1473
|
-
|
|
1474
|
-
</dd>
|
|
1475
|
-
</dl>
|
|
1476
|
-
</dd>
|
|
1477
|
-
</dl>
|
|
1478
|
-
|
|
1479
|
-
</dd>
|
|
1480
|
-
</dl>
|
|
1481
|
-
</details>
|
|
1482
|
-
|
|
1483
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">createSync</a>({ ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1484
|
-
<dl>
|
|
1485
|
-
<dd>
|
|
1486
|
-
|
|
1487
|
-
#### 📝 Description
|
|
1488
|
-
|
|
1489
|
-
<dl>
|
|
1490
|
-
<dd>
|
|
1491
|
-
|
|
1492
|
-
<dl>
|
|
1493
|
-
<dd>
|
|
1494
|
-
|
|
1495
|
-
Create a new sync configuration.
|
|
1496
|
-
|
|
1497
|
-
## Args:
|
|
1498
|
-
|
|
1499
|
-
db: The database session
|
|
1500
|
-
sync_in: The sync to create
|
|
1501
|
-
user: The current user
|
|
1502
|
-
background_tasks: The background tasks
|
|
1503
|
-
|
|
1504
|
-
## Returns:
|
|
1505
|
-
|
|
1506
|
-
sync (schemas.Sync): The created sync
|
|
1507
|
-
|
|
1508
|
-
</dd>
|
|
1509
|
-
</dl>
|
|
1510
|
-
</dd>
|
|
1511
|
-
</dl>
|
|
1512
|
-
|
|
1513
|
-
#### 🔌 Usage
|
|
1514
|
-
|
|
1515
|
-
<dl>
|
|
1516
|
-
<dd>
|
|
1517
|
-
|
|
1518
|
-
<dl>
|
|
1519
|
-
<dd>
|
|
1520
|
-
|
|
1521
|
-
```typescript
|
|
1522
|
-
await client.sync.createSync({
|
|
1523
|
-
name: "name",
|
|
1524
|
-
sourceConnectionId: "source_connection_id",
|
|
1525
|
-
destinationConnectionIds: ["destination_connection_ids"],
|
|
1526
|
-
});
|
|
1527
|
-
```
|
|
1528
|
-
|
|
1529
|
-
</dd>
|
|
1530
|
-
</dl>
|
|
1531
|
-
</dd>
|
|
1532
|
-
</dl>
|
|
1533
|
-
|
|
1534
|
-
#### ⚙️ Parameters
|
|
1535
|
-
|
|
1536
|
-
<dl>
|
|
1537
|
-
<dd>
|
|
1538
|
-
|
|
1539
|
-
<dl>
|
|
1540
|
-
<dd>
|
|
1541
|
-
|
|
1542
|
-
**request:** `AirweaveSDK.SyncCreate`
|
|
1543
|
-
|
|
1544
|
-
</dd>
|
|
1545
|
-
</dl>
|
|
1546
|
-
|
|
1547
|
-
<dl>
|
|
1548
|
-
<dd>
|
|
1549
|
-
|
|
1550
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1374
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1551
1375
|
|
|
1552
1376
|
</dd>
|
|
1553
1377
|
</dl>
|
|
@@ -1558,7 +1382,7 @@ await client.sync.createSync({
|
|
|
1558
1382
|
</dl>
|
|
1559
1383
|
</details>
|
|
1560
1384
|
|
|
1561
|
-
<details><summary><code>client.
|
|
1385
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1562
1386
|
<dl>
|
|
1563
1387
|
<dd>
|
|
1564
1388
|
|
|
@@ -1570,18 +1394,18 @@ await client.sync.createSync({
|
|
|
1570
1394
|
<dl>
|
|
1571
1395
|
<dd>
|
|
1572
1396
|
|
|
1573
|
-
|
|
1397
|
+
Update a white label integration.
|
|
1574
1398
|
|
|
1575
1399
|
## Args:
|
|
1576
1400
|
|
|
1577
1401
|
db: The database session
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1402
|
+
current_user: The current user
|
|
1403
|
+
white_label_id: The ID of the white label to update
|
|
1404
|
+
white_label_in: The white label to update
|
|
1581
1405
|
|
|
1582
1406
|
## Returns:
|
|
1583
1407
|
|
|
1584
|
-
|
|
1408
|
+
white_label (schemas.WhiteLabel): The updated white label
|
|
1585
1409
|
|
|
1586
1410
|
</dd>
|
|
1587
1411
|
</dl>
|
|
@@ -1597,7 +1421,7 @@ List all sync jobs across all syncs.
|
|
|
1597
1421
|
<dd>
|
|
1598
1422
|
|
|
1599
1423
|
```typescript
|
|
1600
|
-
await client.
|
|
1424
|
+
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
1601
1425
|
```
|
|
1602
1426
|
|
|
1603
1427
|
</dd>
|
|
@@ -1613,80 +1437,15 @@ await client.sync.listAllJobs();
|
|
|
1613
1437
|
<dl>
|
|
1614
1438
|
<dd>
|
|
1615
1439
|
|
|
1616
|
-
**
|
|
1617
|
-
|
|
1618
|
-
</dd>
|
|
1619
|
-
</dl>
|
|
1620
|
-
|
|
1621
|
-
<dl>
|
|
1622
|
-
<dd>
|
|
1623
|
-
|
|
1624
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1625
|
-
|
|
1626
|
-
</dd>
|
|
1627
|
-
</dl>
|
|
1628
|
-
</dd>
|
|
1629
|
-
</dl>
|
|
1630
|
-
|
|
1631
|
-
</dd>
|
|
1632
|
-
</dl>
|
|
1633
|
-
</details>
|
|
1634
|
-
|
|
1635
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
|
|
1636
|
-
<dl>
|
|
1637
|
-
<dd>
|
|
1638
|
-
|
|
1639
|
-
#### 📝 Description
|
|
1640
|
-
|
|
1641
|
-
<dl>
|
|
1642
|
-
<dd>
|
|
1643
|
-
|
|
1644
|
-
<dl>
|
|
1645
|
-
<dd>
|
|
1646
|
-
|
|
1647
|
-
Get a specific sync by ID.
|
|
1648
|
-
|
|
1649
|
-
## Args:
|
|
1650
|
-
|
|
1651
|
-
db: The database session
|
|
1652
|
-
sync_id: The ID of the sync to get
|
|
1653
|
-
user: The current user
|
|
1654
|
-
|
|
1655
|
-
## Returns:
|
|
1656
|
-
|
|
1657
|
-
sync (schemas.Sync): The sync
|
|
1658
|
-
|
|
1659
|
-
</dd>
|
|
1660
|
-
</dl>
|
|
1661
|
-
</dd>
|
|
1662
|
-
</dl>
|
|
1663
|
-
|
|
1664
|
-
#### 🔌 Usage
|
|
1665
|
-
|
|
1666
|
-
<dl>
|
|
1667
|
-
<dd>
|
|
1668
|
-
|
|
1669
|
-
<dl>
|
|
1670
|
-
<dd>
|
|
1671
|
-
|
|
1672
|
-
```typescript
|
|
1673
|
-
await client.sync.getSync("sync_id");
|
|
1674
|
-
```
|
|
1440
|
+
**whiteLabelId:** `string`
|
|
1675
1441
|
|
|
1676
1442
|
</dd>
|
|
1677
1443
|
</dl>
|
|
1678
|
-
</dd>
|
|
1679
|
-
</dl>
|
|
1680
|
-
|
|
1681
|
-
#### ⚙️ Parameters
|
|
1682
|
-
|
|
1683
|
-
<dl>
|
|
1684
|
-
<dd>
|
|
1685
1444
|
|
|
1686
1445
|
<dl>
|
|
1687
1446
|
<dd>
|
|
1688
1447
|
|
|
1689
|
-
**
|
|
1448
|
+
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
1690
1449
|
|
|
1691
1450
|
</dd>
|
|
1692
1451
|
</dl>
|
|
@@ -1694,7 +1453,7 @@ await client.sync.getSync("sync_id");
|
|
|
1694
1453
|
<dl>
|
|
1695
1454
|
<dd>
|
|
1696
1455
|
|
|
1697
|
-
**requestOptions:** `
|
|
1456
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1698
1457
|
|
|
1699
1458
|
</dd>
|
|
1700
1459
|
</dl>
|
|
@@ -1705,7 +1464,7 @@ await client.sync.getSync("sync_id");
|
|
|
1705
1464
|
</dl>
|
|
1706
1465
|
</details>
|
|
1707
1466
|
|
|
1708
|
-
<details><summary><code>client.
|
|
1467
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
1709
1468
|
<dl>
|
|
1710
1469
|
<dd>
|
|
1711
1470
|
|
|
@@ -1717,18 +1476,17 @@ await client.sync.getSync("sync_id");
|
|
|
1717
1476
|
<dl>
|
|
1718
1477
|
<dd>
|
|
1719
1478
|
|
|
1720
|
-
Delete a
|
|
1479
|
+
Delete a white label integration.
|
|
1721
1480
|
|
|
1722
1481
|
## Args:
|
|
1723
1482
|
|
|
1724
1483
|
db: The database session
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
user: The current user
|
|
1484
|
+
current_user: The current user
|
|
1485
|
+
white_label_id: The ID of the white label to delete
|
|
1728
1486
|
|
|
1729
1487
|
## Returns:
|
|
1730
1488
|
|
|
1731
|
-
|
|
1489
|
+
white_label (schemas.WhiteLabel): The deleted white label
|
|
1732
1490
|
|
|
1733
1491
|
</dd>
|
|
1734
1492
|
</dl>
|
|
@@ -1744,7 +1502,7 @@ Delete a sync configuration and optionally its associated data.
|
|
|
1744
1502
|
<dd>
|
|
1745
1503
|
|
|
1746
1504
|
```typescript
|
|
1747
|
-
await client.
|
|
1505
|
+
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
1748
1506
|
```
|
|
1749
1507
|
|
|
1750
1508
|
</dd>
|
|
@@ -1760,15 +1518,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1760
1518
|
<dl>
|
|
1761
1519
|
<dd>
|
|
1762
1520
|
|
|
1763
|
-
**
|
|
1764
|
-
|
|
1765
|
-
</dd>
|
|
1766
|
-
</dl>
|
|
1767
|
-
|
|
1768
|
-
<dl>
|
|
1769
|
-
<dd>
|
|
1770
|
-
|
|
1771
|
-
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
1521
|
+
**whiteLabelId:** `string`
|
|
1772
1522
|
|
|
1773
1523
|
</dd>
|
|
1774
1524
|
</dl>
|
|
@@ -1776,7 +1526,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1776
1526
|
<dl>
|
|
1777
1527
|
<dd>
|
|
1778
1528
|
|
|
1779
|
-
**requestOptions:** `
|
|
1529
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
1780
1530
|
|
|
1781
1531
|
</dd>
|
|
1782
1532
|
</dl>
|
|
@@ -1787,7 +1537,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1787
1537
|
</dl>
|
|
1788
1538
|
</details>
|
|
1789
1539
|
|
|
1790
|
-
<details><summary><code>client.
|
|
1540
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
1791
1541
|
<dl>
|
|
1792
1542
|
<dd>
|
|
1793
1543
|
|
|
@@ -1799,18 +1549,17 @@ await client.sync.deleteSync("sync_id");
|
|
|
1799
1549
|
<dl>
|
|
1800
1550
|
<dd>
|
|
1801
1551
|
|
|
1802
|
-
|
|
1552
|
+
List all syncs for a specific white label.
|
|
1803
1553
|
|
|
1804
1554
|
## Args:
|
|
1805
1555
|
|
|
1556
|
+
white_label_id: The ID of the white label to list syncs for
|
|
1806
1557
|
db: The database session
|
|
1807
|
-
|
|
1808
|
-
sync_update: The sync update data
|
|
1809
|
-
user: The current user
|
|
1558
|
+
current_user: The current user
|
|
1810
1559
|
|
|
1811
1560
|
## Returns:
|
|
1812
1561
|
|
|
1813
|
-
|
|
1562
|
+
list[schemas.Sync]: A list of syncs
|
|
1814
1563
|
|
|
1815
1564
|
</dd>
|
|
1816
1565
|
</dl>
|
|
@@ -1826,7 +1575,7 @@ Update a sync configuration.
|
|
|
1826
1575
|
<dd>
|
|
1827
1576
|
|
|
1828
1577
|
```typescript
|
|
1829
|
-
await client.
|
|
1578
|
+
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
1830
1579
|
```
|
|
1831
1580
|
|
|
1832
1581
|
</dd>
|
|
@@ -1842,15 +1591,7 @@ await client.sync.updateSync("sync_id");
|
|
|
1842
1591
|
<dl>
|
|
1843
1592
|
<dd>
|
|
1844
1593
|
|
|
1845
|
-
**
|
|
1846
|
-
|
|
1847
|
-
</dd>
|
|
1848
|
-
</dl>
|
|
1849
|
-
|
|
1850
|
-
<dl>
|
|
1851
|
-
<dd>
|
|
1852
|
-
|
|
1853
|
-
**request:** `AirweaveSDK.SyncUpdate`
|
|
1594
|
+
**whiteLabelId:** `string`
|
|
1854
1595
|
|
|
1855
1596
|
</dd>
|
|
1856
1597
|
</dl>
|
|
@@ -1858,2001 +1599,7 @@ await client.sync.updateSync("sync_id");
|
|
|
1858
1599
|
<dl>
|
|
1859
1600
|
<dd>
|
|
1860
1601
|
|
|
1861
|
-
**requestOptions:** `
|
|
1862
|
-
|
|
1863
|
-
</dd>
|
|
1864
|
-
</dl>
|
|
1865
|
-
</dd>
|
|
1866
|
-
</dl>
|
|
1867
|
-
|
|
1868
|
-
</dd>
|
|
1869
|
-
</dl>
|
|
1870
|
-
</details>
|
|
1871
|
-
|
|
1872
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">runSync</a>(syncId) -> AirweaveSDK.SyncJob</code></summary>
|
|
1873
|
-
<dl>
|
|
1874
|
-
<dd>
|
|
1875
|
-
|
|
1876
|
-
#### 📝 Description
|
|
1877
|
-
|
|
1878
|
-
<dl>
|
|
1879
|
-
<dd>
|
|
1880
|
-
|
|
1881
|
-
<dl>
|
|
1882
|
-
<dd>
|
|
1883
|
-
|
|
1884
|
-
Trigger a sync run.
|
|
1885
|
-
|
|
1886
|
-
## Args:
|
|
1887
|
-
|
|
1888
|
-
db: The database session
|
|
1889
|
-
sync_id: The ID of the sync to run
|
|
1890
|
-
user: The current user
|
|
1891
|
-
background_tasks: The background tasks
|
|
1892
|
-
|
|
1893
|
-
## Returns:
|
|
1894
|
-
|
|
1895
|
-
sync_job (schemas.SyncJob): The sync job
|
|
1896
|
-
|
|
1897
|
-
</dd>
|
|
1898
|
-
</dl>
|
|
1899
|
-
</dd>
|
|
1900
|
-
</dl>
|
|
1901
|
-
|
|
1902
|
-
#### 🔌 Usage
|
|
1903
|
-
|
|
1904
|
-
<dl>
|
|
1905
|
-
<dd>
|
|
1906
|
-
|
|
1907
|
-
<dl>
|
|
1908
|
-
<dd>
|
|
1909
|
-
|
|
1910
|
-
```typescript
|
|
1911
|
-
await client.sync.runSync("sync_id");
|
|
1912
|
-
```
|
|
1913
|
-
|
|
1914
|
-
</dd>
|
|
1915
|
-
</dl>
|
|
1916
|
-
</dd>
|
|
1917
|
-
</dl>
|
|
1918
|
-
|
|
1919
|
-
#### ⚙️ Parameters
|
|
1920
|
-
|
|
1921
|
-
<dl>
|
|
1922
|
-
<dd>
|
|
1923
|
-
|
|
1924
|
-
<dl>
|
|
1925
|
-
<dd>
|
|
1926
|
-
|
|
1927
|
-
**syncId:** `string`
|
|
1928
|
-
|
|
1929
|
-
</dd>
|
|
1930
|
-
</dl>
|
|
1931
|
-
|
|
1932
|
-
<dl>
|
|
1933
|
-
<dd>
|
|
1934
|
-
|
|
1935
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1936
|
-
|
|
1937
|
-
</dd>
|
|
1938
|
-
</dl>
|
|
1939
|
-
</dd>
|
|
1940
|
-
</dl>
|
|
1941
|
-
|
|
1942
|
-
</dd>
|
|
1943
|
-
</dl>
|
|
1944
|
-
</details>
|
|
1945
|
-
|
|
1946
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncJobs</a>(syncId) -> AirweaveSDK.SyncJob[]</code></summary>
|
|
1947
|
-
<dl>
|
|
1948
|
-
<dd>
|
|
1949
|
-
|
|
1950
|
-
#### 📝 Description
|
|
1951
|
-
|
|
1952
|
-
<dl>
|
|
1953
|
-
<dd>
|
|
1954
|
-
|
|
1955
|
-
<dl>
|
|
1956
|
-
<dd>
|
|
1957
|
-
|
|
1958
|
-
List all jobs for a specific sync.
|
|
1959
|
-
|
|
1960
|
-
## Args:
|
|
1961
|
-
|
|
1962
|
-
db: The database session
|
|
1963
|
-
sync_id: The ID of the sync to list jobs for
|
|
1964
|
-
user: The current user
|
|
1965
|
-
|
|
1966
|
-
## Returns:
|
|
1967
|
-
|
|
1968
|
-
list[schemas.SyncJob]: A list of sync jobs
|
|
1969
|
-
|
|
1970
|
-
</dd>
|
|
1971
|
-
</dl>
|
|
1972
|
-
</dd>
|
|
1973
|
-
</dl>
|
|
1974
|
-
|
|
1975
|
-
#### 🔌 Usage
|
|
1976
|
-
|
|
1977
|
-
<dl>
|
|
1978
|
-
<dd>
|
|
1979
|
-
|
|
1980
|
-
<dl>
|
|
1981
|
-
<dd>
|
|
1982
|
-
|
|
1983
|
-
```typescript
|
|
1984
|
-
await client.sync.listSyncJobs("sync_id");
|
|
1985
|
-
```
|
|
1986
|
-
|
|
1987
|
-
</dd>
|
|
1988
|
-
</dl>
|
|
1989
|
-
</dd>
|
|
1990
|
-
</dl>
|
|
1991
|
-
|
|
1992
|
-
#### ⚙️ Parameters
|
|
1993
|
-
|
|
1994
|
-
<dl>
|
|
1995
|
-
<dd>
|
|
1996
|
-
|
|
1997
|
-
<dl>
|
|
1998
|
-
<dd>
|
|
1999
|
-
|
|
2000
|
-
**syncId:** `string`
|
|
2001
|
-
|
|
2002
|
-
</dd>
|
|
2003
|
-
</dl>
|
|
2004
|
-
|
|
2005
|
-
<dl>
|
|
2006
|
-
<dd>
|
|
2007
|
-
|
|
2008
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2009
|
-
|
|
2010
|
-
</dd>
|
|
2011
|
-
</dl>
|
|
2012
|
-
</dd>
|
|
2013
|
-
</dl>
|
|
2014
|
-
|
|
2015
|
-
</dd>
|
|
2016
|
-
</dl>
|
|
2017
|
-
</details>
|
|
2018
|
-
|
|
2019
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncJob</a>(syncId, jobId) -> AirweaveSDK.SyncJob</code></summary>
|
|
2020
|
-
<dl>
|
|
2021
|
-
<dd>
|
|
2022
|
-
|
|
2023
|
-
#### 📝 Description
|
|
2024
|
-
|
|
2025
|
-
<dl>
|
|
2026
|
-
<dd>
|
|
2027
|
-
|
|
2028
|
-
<dl>
|
|
2029
|
-
<dd>
|
|
2030
|
-
|
|
2031
|
-
Get details of a specific sync job.
|
|
2032
|
-
|
|
2033
|
-
## Args:
|
|
2034
|
-
|
|
2035
|
-
db: The database session
|
|
2036
|
-
sync_id: The ID of the sync to list jobs for
|
|
2037
|
-
job_id: The ID of the job to get
|
|
2038
|
-
user: The current user
|
|
2039
|
-
|
|
2040
|
-
## Returns:
|
|
2041
|
-
|
|
2042
|
-
sync_job (schemas.SyncJob): The sync job
|
|
2043
|
-
|
|
2044
|
-
</dd>
|
|
2045
|
-
</dl>
|
|
2046
|
-
</dd>
|
|
2047
|
-
</dl>
|
|
2048
|
-
|
|
2049
|
-
#### 🔌 Usage
|
|
2050
|
-
|
|
2051
|
-
<dl>
|
|
2052
|
-
<dd>
|
|
2053
|
-
|
|
2054
|
-
<dl>
|
|
2055
|
-
<dd>
|
|
2056
|
-
|
|
2057
|
-
```typescript
|
|
2058
|
-
await client.sync.getSyncJob("sync_id", "job_id");
|
|
2059
|
-
```
|
|
2060
|
-
|
|
2061
|
-
</dd>
|
|
2062
|
-
</dl>
|
|
2063
|
-
</dd>
|
|
2064
|
-
</dl>
|
|
2065
|
-
|
|
2066
|
-
#### ⚙️ Parameters
|
|
2067
|
-
|
|
2068
|
-
<dl>
|
|
2069
|
-
<dd>
|
|
2070
|
-
|
|
2071
|
-
<dl>
|
|
2072
|
-
<dd>
|
|
2073
|
-
|
|
2074
|
-
**syncId:** `string`
|
|
2075
|
-
|
|
2076
|
-
</dd>
|
|
2077
|
-
</dl>
|
|
2078
|
-
|
|
2079
|
-
<dl>
|
|
2080
|
-
<dd>
|
|
2081
|
-
|
|
2082
|
-
**jobId:** `string`
|
|
2083
|
-
|
|
2084
|
-
</dd>
|
|
2085
|
-
</dl>
|
|
2086
|
-
|
|
2087
|
-
<dl>
|
|
2088
|
-
<dd>
|
|
2089
|
-
|
|
2090
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2091
|
-
|
|
2092
|
-
</dd>
|
|
2093
|
-
</dl>
|
|
2094
|
-
</dd>
|
|
2095
|
-
</dl>
|
|
2096
|
-
|
|
2097
|
-
</dd>
|
|
2098
|
-
</dl>
|
|
2099
|
-
</details>
|
|
2100
|
-
|
|
2101
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">subscribeSyncJob</a>(jobId) -> unknown</code></summary>
|
|
2102
|
-
<dl>
|
|
2103
|
-
<dd>
|
|
2104
|
-
|
|
2105
|
-
#### 📝 Description
|
|
2106
|
-
|
|
2107
|
-
<dl>
|
|
2108
|
-
<dd>
|
|
2109
|
-
|
|
2110
|
-
<dl>
|
|
2111
|
-
<dd>
|
|
2112
|
-
|
|
2113
|
-
Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
2114
|
-
|
|
2115
|
-
## Args:
|
|
2116
|
-
|
|
2117
|
-
job_id: The ID of the job to subscribe to
|
|
2118
|
-
user: The current user
|
|
2119
|
-
|
|
2120
|
-
## Returns:
|
|
2121
|
-
|
|
2122
|
-
StreamingResponse: The streaming response
|
|
2123
|
-
|
|
2124
|
-
</dd>
|
|
2125
|
-
</dl>
|
|
2126
|
-
</dd>
|
|
2127
|
-
</dl>
|
|
2128
|
-
|
|
2129
|
-
#### 🔌 Usage
|
|
2130
|
-
|
|
2131
|
-
<dl>
|
|
2132
|
-
<dd>
|
|
2133
|
-
|
|
2134
|
-
<dl>
|
|
2135
|
-
<dd>
|
|
2136
|
-
|
|
2137
|
-
```typescript
|
|
2138
|
-
await client.sync.subscribeSyncJob("job_id");
|
|
2139
|
-
```
|
|
2140
|
-
|
|
2141
|
-
</dd>
|
|
2142
|
-
</dl>
|
|
2143
|
-
</dd>
|
|
2144
|
-
</dl>
|
|
2145
|
-
|
|
2146
|
-
#### ⚙️ Parameters
|
|
2147
|
-
|
|
2148
|
-
<dl>
|
|
2149
|
-
<dd>
|
|
2150
|
-
|
|
2151
|
-
<dl>
|
|
2152
|
-
<dd>
|
|
2153
|
-
|
|
2154
|
-
**jobId:** `string`
|
|
2155
|
-
|
|
2156
|
-
</dd>
|
|
2157
|
-
</dl>
|
|
2158
|
-
|
|
2159
|
-
<dl>
|
|
2160
|
-
<dd>
|
|
2161
|
-
|
|
2162
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2163
|
-
|
|
2164
|
-
</dd>
|
|
2165
|
-
</dl>
|
|
2166
|
-
</dd>
|
|
2167
|
-
</dl>
|
|
2168
|
-
|
|
2169
|
-
</dd>
|
|
2170
|
-
</dl>
|
|
2171
|
-
</details>
|
|
2172
|
-
|
|
2173
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
2174
|
-
<dl>
|
|
2175
|
-
<dd>
|
|
2176
|
-
|
|
2177
|
-
#### 📝 Description
|
|
2178
|
-
|
|
2179
|
-
<dl>
|
|
2180
|
-
<dd>
|
|
2181
|
-
|
|
2182
|
-
<dl>
|
|
2183
|
-
<dd>
|
|
2184
|
-
|
|
2185
|
-
Get the DAG for a specific sync.
|
|
2186
|
-
|
|
2187
|
-
</dd>
|
|
2188
|
-
</dl>
|
|
2189
|
-
</dd>
|
|
2190
|
-
</dl>
|
|
2191
|
-
|
|
2192
|
-
#### 🔌 Usage
|
|
2193
|
-
|
|
2194
|
-
<dl>
|
|
2195
|
-
<dd>
|
|
2196
|
-
|
|
2197
|
-
<dl>
|
|
2198
|
-
<dd>
|
|
2199
|
-
|
|
2200
|
-
```typescript
|
|
2201
|
-
await client.sync.getSyncDag("sync_id");
|
|
2202
|
-
```
|
|
2203
|
-
|
|
2204
|
-
</dd>
|
|
2205
|
-
</dl>
|
|
2206
|
-
</dd>
|
|
2207
|
-
</dl>
|
|
2208
|
-
|
|
2209
|
-
#### ⚙️ Parameters
|
|
2210
|
-
|
|
2211
|
-
<dl>
|
|
2212
|
-
<dd>
|
|
2213
|
-
|
|
2214
|
-
<dl>
|
|
2215
|
-
<dd>
|
|
2216
|
-
|
|
2217
|
-
**syncId:** `string`
|
|
2218
|
-
|
|
2219
|
-
</dd>
|
|
2220
|
-
</dl>
|
|
2221
|
-
|
|
2222
|
-
<dl>
|
|
2223
|
-
<dd>
|
|
2224
|
-
|
|
2225
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
2226
|
-
|
|
2227
|
-
</dd>
|
|
2228
|
-
</dl>
|
|
2229
|
-
</dd>
|
|
2230
|
-
</dl>
|
|
2231
|
-
|
|
2232
|
-
</dd>
|
|
2233
|
-
</dl>
|
|
2234
|
-
</details>
|
|
2235
|
-
|
|
2236
|
-
## WhiteLabels
|
|
2237
|
-
|
|
2238
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
2239
|
-
<dl>
|
|
2240
|
-
<dd>
|
|
2241
|
-
|
|
2242
|
-
#### 📝 Description
|
|
2243
|
-
|
|
2244
|
-
<dl>
|
|
2245
|
-
<dd>
|
|
2246
|
-
|
|
2247
|
-
<dl>
|
|
2248
|
-
<dd>
|
|
2249
|
-
|
|
2250
|
-
List all white labels for the current user's organization.
|
|
2251
|
-
|
|
2252
|
-
## Args:
|
|
2253
|
-
|
|
2254
|
-
db: The database session
|
|
2255
|
-
current_user: The current user
|
|
2256
|
-
|
|
2257
|
-
## Returns:
|
|
2258
|
-
|
|
2259
|
-
list[schemas.WhiteLabel]: A list of white labels
|
|
2260
|
-
|
|
2261
|
-
</dd>
|
|
2262
|
-
</dl>
|
|
2263
|
-
</dd>
|
|
2264
|
-
</dl>
|
|
2265
|
-
|
|
2266
|
-
#### 🔌 Usage
|
|
2267
|
-
|
|
2268
|
-
<dl>
|
|
2269
|
-
<dd>
|
|
2270
|
-
|
|
2271
|
-
<dl>
|
|
2272
|
-
<dd>
|
|
2273
|
-
|
|
2274
|
-
```typescript
|
|
2275
|
-
await client.whiteLabels.listWhiteLabels();
|
|
2276
|
-
```
|
|
2277
|
-
|
|
2278
|
-
</dd>
|
|
2279
|
-
</dl>
|
|
2280
|
-
</dd>
|
|
2281
|
-
</dl>
|
|
2282
|
-
|
|
2283
|
-
#### ⚙️ Parameters
|
|
2284
|
-
|
|
2285
|
-
<dl>
|
|
2286
|
-
<dd>
|
|
2287
|
-
|
|
2288
|
-
<dl>
|
|
2289
|
-
<dd>
|
|
2290
|
-
|
|
2291
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2292
|
-
|
|
2293
|
-
</dd>
|
|
2294
|
-
</dl>
|
|
2295
|
-
</dd>
|
|
2296
|
-
</dl>
|
|
2297
|
-
|
|
2298
|
-
</dd>
|
|
2299
|
-
</dl>
|
|
2300
|
-
</details>
|
|
2301
|
-
|
|
2302
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2303
|
-
<dl>
|
|
2304
|
-
<dd>
|
|
2305
|
-
|
|
2306
|
-
#### 📝 Description
|
|
2307
|
-
|
|
2308
|
-
<dl>
|
|
2309
|
-
<dd>
|
|
2310
|
-
|
|
2311
|
-
<dl>
|
|
2312
|
-
<dd>
|
|
2313
|
-
|
|
2314
|
-
Create new white label integration.
|
|
2315
|
-
|
|
2316
|
-
## Args:
|
|
2317
|
-
|
|
2318
|
-
db: The database session
|
|
2319
|
-
current_user: The current user
|
|
2320
|
-
white_label_in: The white label to create
|
|
2321
|
-
|
|
2322
|
-
## Returns:
|
|
2323
|
-
|
|
2324
|
-
white_label (schemas.WhiteLabel): The created white label
|
|
2325
|
-
|
|
2326
|
-
</dd>
|
|
2327
|
-
</dl>
|
|
2328
|
-
</dd>
|
|
2329
|
-
</dl>
|
|
2330
|
-
|
|
2331
|
-
#### 🔌 Usage
|
|
2332
|
-
|
|
2333
|
-
<dl>
|
|
2334
|
-
<dd>
|
|
2335
|
-
|
|
2336
|
-
<dl>
|
|
2337
|
-
<dd>
|
|
2338
|
-
|
|
2339
|
-
```typescript
|
|
2340
|
-
await client.whiteLabels.createWhiteLabel({
|
|
2341
|
-
name: "name",
|
|
2342
|
-
sourceShortName: "source_short_name",
|
|
2343
|
-
redirectUrl: "redirect_url",
|
|
2344
|
-
clientId: "client_id",
|
|
2345
|
-
clientSecret: "client_secret",
|
|
2346
|
-
});
|
|
2347
|
-
```
|
|
2348
|
-
|
|
2349
|
-
</dd>
|
|
2350
|
-
</dl>
|
|
2351
|
-
</dd>
|
|
2352
|
-
</dl>
|
|
2353
|
-
|
|
2354
|
-
#### ⚙️ Parameters
|
|
2355
|
-
|
|
2356
|
-
<dl>
|
|
2357
|
-
<dd>
|
|
2358
|
-
|
|
2359
|
-
<dl>
|
|
2360
|
-
<dd>
|
|
2361
|
-
|
|
2362
|
-
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
2363
|
-
|
|
2364
|
-
</dd>
|
|
2365
|
-
</dl>
|
|
2366
|
-
|
|
2367
|
-
<dl>
|
|
2368
|
-
<dd>
|
|
2369
|
-
|
|
2370
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2371
|
-
|
|
2372
|
-
</dd>
|
|
2373
|
-
</dl>
|
|
2374
|
-
</dd>
|
|
2375
|
-
</dl>
|
|
2376
|
-
|
|
2377
|
-
</dd>
|
|
2378
|
-
</dl>
|
|
2379
|
-
</details>
|
|
2380
|
-
|
|
2381
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2382
|
-
<dl>
|
|
2383
|
-
<dd>
|
|
2384
|
-
|
|
2385
|
-
#### 📝 Description
|
|
2386
|
-
|
|
2387
|
-
<dl>
|
|
2388
|
-
<dd>
|
|
2389
|
-
|
|
2390
|
-
<dl>
|
|
2391
|
-
<dd>
|
|
2392
|
-
|
|
2393
|
-
Get a specific white label integration.
|
|
2394
|
-
|
|
2395
|
-
## Args:
|
|
2396
|
-
|
|
2397
|
-
db: The database session
|
|
2398
|
-
white_label_id: The ID of the white label to get
|
|
2399
|
-
current_user: The current user
|
|
2400
|
-
|
|
2401
|
-
## Returns:
|
|
2402
|
-
|
|
2403
|
-
white_label (schemas.WhiteLabel): The white label
|
|
2404
|
-
|
|
2405
|
-
</dd>
|
|
2406
|
-
</dl>
|
|
2407
|
-
</dd>
|
|
2408
|
-
</dl>
|
|
2409
|
-
|
|
2410
|
-
#### 🔌 Usage
|
|
2411
|
-
|
|
2412
|
-
<dl>
|
|
2413
|
-
<dd>
|
|
2414
|
-
|
|
2415
|
-
<dl>
|
|
2416
|
-
<dd>
|
|
2417
|
-
|
|
2418
|
-
```typescript
|
|
2419
|
-
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
2420
|
-
```
|
|
2421
|
-
|
|
2422
|
-
</dd>
|
|
2423
|
-
</dl>
|
|
2424
|
-
</dd>
|
|
2425
|
-
</dl>
|
|
2426
|
-
|
|
2427
|
-
#### ⚙️ Parameters
|
|
2428
|
-
|
|
2429
|
-
<dl>
|
|
2430
|
-
<dd>
|
|
2431
|
-
|
|
2432
|
-
<dl>
|
|
2433
|
-
<dd>
|
|
2434
|
-
|
|
2435
|
-
**whiteLabelId:** `string`
|
|
2436
|
-
|
|
2437
|
-
</dd>
|
|
2438
|
-
</dl>
|
|
2439
|
-
|
|
2440
|
-
<dl>
|
|
2441
|
-
<dd>
|
|
2442
|
-
|
|
2443
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2444
|
-
|
|
2445
|
-
</dd>
|
|
2446
|
-
</dl>
|
|
2447
|
-
</dd>
|
|
2448
|
-
</dl>
|
|
2449
|
-
|
|
2450
|
-
</dd>
|
|
2451
|
-
</dl>
|
|
2452
|
-
</details>
|
|
2453
|
-
|
|
2454
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2455
|
-
<dl>
|
|
2456
|
-
<dd>
|
|
2457
|
-
|
|
2458
|
-
#### 📝 Description
|
|
2459
|
-
|
|
2460
|
-
<dl>
|
|
2461
|
-
<dd>
|
|
2462
|
-
|
|
2463
|
-
<dl>
|
|
2464
|
-
<dd>
|
|
2465
|
-
|
|
2466
|
-
Update a white label integration.
|
|
2467
|
-
|
|
2468
|
-
## Args:
|
|
2469
|
-
|
|
2470
|
-
db: The database session
|
|
2471
|
-
current_user: The current user
|
|
2472
|
-
white_label_id: The ID of the white label to update
|
|
2473
|
-
white_label_in: The white label to update
|
|
2474
|
-
|
|
2475
|
-
## Returns:
|
|
2476
|
-
|
|
2477
|
-
white_label (schemas.WhiteLabel): The updated white label
|
|
2478
|
-
|
|
2479
|
-
</dd>
|
|
2480
|
-
</dl>
|
|
2481
|
-
</dd>
|
|
2482
|
-
</dl>
|
|
2483
|
-
|
|
2484
|
-
#### 🔌 Usage
|
|
2485
|
-
|
|
2486
|
-
<dl>
|
|
2487
|
-
<dd>
|
|
2488
|
-
|
|
2489
|
-
<dl>
|
|
2490
|
-
<dd>
|
|
2491
|
-
|
|
2492
|
-
```typescript
|
|
2493
|
-
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
2494
|
-
```
|
|
2495
|
-
|
|
2496
|
-
</dd>
|
|
2497
|
-
</dl>
|
|
2498
|
-
</dd>
|
|
2499
|
-
</dl>
|
|
2500
|
-
|
|
2501
|
-
#### ⚙️ Parameters
|
|
2502
|
-
|
|
2503
|
-
<dl>
|
|
2504
|
-
<dd>
|
|
2505
|
-
|
|
2506
|
-
<dl>
|
|
2507
|
-
<dd>
|
|
2508
|
-
|
|
2509
|
-
**whiteLabelId:** `string`
|
|
2510
|
-
|
|
2511
|
-
</dd>
|
|
2512
|
-
</dl>
|
|
2513
|
-
|
|
2514
|
-
<dl>
|
|
2515
|
-
<dd>
|
|
2516
|
-
|
|
2517
|
-
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
2518
|
-
|
|
2519
|
-
</dd>
|
|
2520
|
-
</dl>
|
|
2521
|
-
|
|
2522
|
-
<dl>
|
|
2523
|
-
<dd>
|
|
2524
|
-
|
|
2525
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2526
|
-
|
|
2527
|
-
</dd>
|
|
2528
|
-
</dl>
|
|
2529
|
-
</dd>
|
|
2530
|
-
</dl>
|
|
2531
|
-
|
|
2532
|
-
</dd>
|
|
2533
|
-
</dl>
|
|
2534
|
-
</details>
|
|
2535
|
-
|
|
2536
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2537
|
-
<dl>
|
|
2538
|
-
<dd>
|
|
2539
|
-
|
|
2540
|
-
#### 📝 Description
|
|
2541
|
-
|
|
2542
|
-
<dl>
|
|
2543
|
-
<dd>
|
|
2544
|
-
|
|
2545
|
-
<dl>
|
|
2546
|
-
<dd>
|
|
2547
|
-
|
|
2548
|
-
Delete a white label integration.
|
|
2549
|
-
|
|
2550
|
-
## Args:
|
|
2551
|
-
|
|
2552
|
-
db: The database session
|
|
2553
|
-
current_user: The current user
|
|
2554
|
-
white_label_id: The ID of the white label to delete
|
|
2555
|
-
|
|
2556
|
-
## Returns:
|
|
2557
|
-
|
|
2558
|
-
white_label (schemas.WhiteLabel): The deleted white label
|
|
2559
|
-
|
|
2560
|
-
</dd>
|
|
2561
|
-
</dl>
|
|
2562
|
-
</dd>
|
|
2563
|
-
</dl>
|
|
2564
|
-
|
|
2565
|
-
#### 🔌 Usage
|
|
2566
|
-
|
|
2567
|
-
<dl>
|
|
2568
|
-
<dd>
|
|
2569
|
-
|
|
2570
|
-
<dl>
|
|
2571
|
-
<dd>
|
|
2572
|
-
|
|
2573
|
-
```typescript
|
|
2574
|
-
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
2575
|
-
```
|
|
2576
|
-
|
|
2577
|
-
</dd>
|
|
2578
|
-
</dl>
|
|
2579
|
-
</dd>
|
|
2580
|
-
</dl>
|
|
2581
|
-
|
|
2582
|
-
#### ⚙️ Parameters
|
|
2583
|
-
|
|
2584
|
-
<dl>
|
|
2585
|
-
<dd>
|
|
2586
|
-
|
|
2587
|
-
<dl>
|
|
2588
|
-
<dd>
|
|
2589
|
-
|
|
2590
|
-
**whiteLabelId:** `string`
|
|
2591
|
-
|
|
2592
|
-
</dd>
|
|
2593
|
-
</dl>
|
|
2594
|
-
|
|
2595
|
-
<dl>
|
|
2596
|
-
<dd>
|
|
2597
|
-
|
|
2598
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2599
|
-
|
|
2600
|
-
</dd>
|
|
2601
|
-
</dl>
|
|
2602
|
-
</dd>
|
|
2603
|
-
</dl>
|
|
2604
|
-
|
|
2605
|
-
</dd>
|
|
2606
|
-
</dl>
|
|
2607
|
-
</details>
|
|
2608
|
-
|
|
2609
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
2610
|
-
<dl>
|
|
2611
|
-
<dd>
|
|
2612
|
-
|
|
2613
|
-
#### 📝 Description
|
|
2614
|
-
|
|
2615
|
-
<dl>
|
|
2616
|
-
<dd>
|
|
2617
|
-
|
|
2618
|
-
<dl>
|
|
2619
|
-
<dd>
|
|
2620
|
-
|
|
2621
|
-
Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
2622
|
-
|
|
2623
|
-
## Args:
|
|
2624
|
-
|
|
2625
|
-
db: The database session
|
|
2626
|
-
white_label_id: The ID of the white label to get the auth URL for
|
|
2627
|
-
user: The current user
|
|
2628
|
-
|
|
2629
|
-
## Returns:
|
|
2630
|
-
|
|
2631
|
-
str: The OAuth2 authorization URL
|
|
2632
|
-
|
|
2633
|
-
</dd>
|
|
2634
|
-
</dl>
|
|
2635
|
-
</dd>
|
|
2636
|
-
</dl>
|
|
2637
|
-
|
|
2638
|
-
#### 🔌 Usage
|
|
2639
|
-
|
|
2640
|
-
<dl>
|
|
2641
|
-
<dd>
|
|
2642
|
-
|
|
2643
|
-
<dl>
|
|
2644
|
-
<dd>
|
|
2645
|
-
|
|
2646
|
-
```typescript
|
|
2647
|
-
await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
2648
|
-
```
|
|
2649
|
-
|
|
2650
|
-
</dd>
|
|
2651
|
-
</dl>
|
|
2652
|
-
</dd>
|
|
2653
|
-
</dl>
|
|
2654
|
-
|
|
2655
|
-
#### ⚙️ Parameters
|
|
2656
|
-
|
|
2657
|
-
<dl>
|
|
2658
|
-
<dd>
|
|
2659
|
-
|
|
2660
|
-
<dl>
|
|
2661
|
-
<dd>
|
|
2662
|
-
|
|
2663
|
-
**whiteLabelId:** `string`
|
|
2664
|
-
|
|
2665
|
-
</dd>
|
|
2666
|
-
</dl>
|
|
2667
|
-
|
|
2668
|
-
<dl>
|
|
2669
|
-
<dd>
|
|
2670
|
-
|
|
2671
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2672
|
-
|
|
2673
|
-
</dd>
|
|
2674
|
-
</dl>
|
|
2675
|
-
</dd>
|
|
2676
|
-
</dl>
|
|
2677
|
-
|
|
2678
|
-
</dd>
|
|
2679
|
-
</dl>
|
|
2680
|
-
</details>
|
|
2681
|
-
|
|
2682
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
2683
|
-
<dl>
|
|
2684
|
-
<dd>
|
|
2685
|
-
|
|
2686
|
-
#### 📝 Description
|
|
2687
|
-
|
|
2688
|
-
<dl>
|
|
2689
|
-
<dd>
|
|
2690
|
-
|
|
2691
|
-
<dl>
|
|
2692
|
-
<dd>
|
|
2693
|
-
|
|
2694
|
-
Exchange OAuth2 code for tokens and create connection.
|
|
2695
|
-
|
|
2696
|
-
## Args:
|
|
2697
|
-
|
|
2698
|
-
white_label_id: The ID of the white label to exchange the code for
|
|
2699
|
-
code: The OAuth2 code
|
|
2700
|
-
db: The database session
|
|
2701
|
-
user: The current user
|
|
2702
|
-
|
|
2703
|
-
## Returns:
|
|
2704
|
-
|
|
2705
|
-
connection (schemas.Connection): The created connection
|
|
2706
|
-
|
|
2707
|
-
</dd>
|
|
2708
|
-
</dl>
|
|
2709
|
-
</dd>
|
|
2710
|
-
</dl>
|
|
2711
|
-
|
|
2712
|
-
#### 🔌 Usage
|
|
2713
|
-
|
|
2714
|
-
<dl>
|
|
2715
|
-
<dd>
|
|
2716
|
-
|
|
2717
|
-
<dl>
|
|
2718
|
-
<dd>
|
|
2719
|
-
|
|
2720
|
-
```typescript
|
|
2721
|
-
await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string");
|
|
2722
|
-
```
|
|
2723
|
-
|
|
2724
|
-
</dd>
|
|
2725
|
-
</dl>
|
|
2726
|
-
</dd>
|
|
2727
|
-
</dl>
|
|
2728
|
-
|
|
2729
|
-
#### ⚙️ Parameters
|
|
2730
|
-
|
|
2731
|
-
<dl>
|
|
2732
|
-
<dd>
|
|
2733
|
-
|
|
2734
|
-
<dl>
|
|
2735
|
-
<dd>
|
|
2736
|
-
|
|
2737
|
-
**whiteLabelId:** `string`
|
|
2738
|
-
|
|
2739
|
-
</dd>
|
|
2740
|
-
</dl>
|
|
2741
|
-
|
|
2742
|
-
<dl>
|
|
2743
|
-
<dd>
|
|
2744
|
-
|
|
2745
|
-
**request:** `string`
|
|
2746
|
-
|
|
2747
|
-
</dd>
|
|
2748
|
-
</dl>
|
|
2749
|
-
|
|
2750
|
-
<dl>
|
|
2751
|
-
<dd>
|
|
2752
|
-
|
|
2753
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2754
|
-
|
|
2755
|
-
</dd>
|
|
2756
|
-
</dl>
|
|
2757
|
-
</dd>
|
|
2758
|
-
</dl>
|
|
2759
|
-
|
|
2760
|
-
</dd>
|
|
2761
|
-
</dl>
|
|
2762
|
-
</details>
|
|
2763
|
-
|
|
2764
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
2765
|
-
<dl>
|
|
2766
|
-
<dd>
|
|
2767
|
-
|
|
2768
|
-
#### 📝 Description
|
|
2769
|
-
|
|
2770
|
-
<dl>
|
|
2771
|
-
<dd>
|
|
2772
|
-
|
|
2773
|
-
<dl>
|
|
2774
|
-
<dd>
|
|
2775
|
-
|
|
2776
|
-
List all syncs for a specific white label.
|
|
2777
|
-
|
|
2778
|
-
## Args:
|
|
2779
|
-
|
|
2780
|
-
white_label_id: The ID of the white label to list syncs for
|
|
2781
|
-
db: The database session
|
|
2782
|
-
current_user: The current user
|
|
2783
|
-
|
|
2784
|
-
## Returns:
|
|
2785
|
-
|
|
2786
|
-
list[schemas.Sync]: A list of syncs
|
|
2787
|
-
|
|
2788
|
-
</dd>
|
|
2789
|
-
</dl>
|
|
2790
|
-
</dd>
|
|
2791
|
-
</dl>
|
|
2792
|
-
|
|
2793
|
-
#### 🔌 Usage
|
|
2794
|
-
|
|
2795
|
-
<dl>
|
|
2796
|
-
<dd>
|
|
2797
|
-
|
|
2798
|
-
<dl>
|
|
2799
|
-
<dd>
|
|
2800
|
-
|
|
2801
|
-
```typescript
|
|
2802
|
-
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
2803
|
-
```
|
|
2804
|
-
|
|
2805
|
-
</dd>
|
|
2806
|
-
</dl>
|
|
2807
|
-
</dd>
|
|
2808
|
-
</dl>
|
|
2809
|
-
|
|
2810
|
-
#### ⚙️ Parameters
|
|
2811
|
-
|
|
2812
|
-
<dl>
|
|
2813
|
-
<dd>
|
|
2814
|
-
|
|
2815
|
-
<dl>
|
|
2816
|
-
<dd>
|
|
2817
|
-
|
|
2818
|
-
**whiteLabelId:** `string`
|
|
2819
|
-
|
|
2820
|
-
</dd>
|
|
2821
|
-
</dl>
|
|
2822
|
-
|
|
2823
|
-
<dl>
|
|
2824
|
-
<dd>
|
|
2825
|
-
|
|
2826
|
-
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2827
|
-
|
|
2828
|
-
</dd>
|
|
2829
|
-
</dl>
|
|
2830
|
-
</dd>
|
|
2831
|
-
</dl>
|
|
2832
|
-
|
|
2833
|
-
</dd>
|
|
2834
|
-
</dl>
|
|
2835
|
-
</details>
|
|
2836
|
-
|
|
2837
|
-
## Dag
|
|
2838
|
-
|
|
2839
|
-
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
|
|
2840
|
-
<dl>
|
|
2841
|
-
<dd>
|
|
2842
|
-
|
|
2843
|
-
#### 📝 Description
|
|
2844
|
-
|
|
2845
|
-
<dl>
|
|
2846
|
-
<dd>
|
|
2847
|
-
|
|
2848
|
-
<dl>
|
|
2849
|
-
<dd>
|
|
2850
|
-
|
|
2851
|
-
Get the DAG definition for a sync.
|
|
2852
|
-
|
|
2853
|
-
</dd>
|
|
2854
|
-
</dl>
|
|
2855
|
-
</dd>
|
|
2856
|
-
</dl>
|
|
2857
|
-
|
|
2858
|
-
#### 🔌 Usage
|
|
2859
|
-
|
|
2860
|
-
<dl>
|
|
2861
|
-
<dd>
|
|
2862
|
-
|
|
2863
|
-
<dl>
|
|
2864
|
-
<dd>
|
|
2865
|
-
|
|
2866
|
-
```typescript
|
|
2867
|
-
await client.dag.getSyncDag("sync_id");
|
|
2868
|
-
```
|
|
2869
|
-
|
|
2870
|
-
</dd>
|
|
2871
|
-
</dl>
|
|
2872
|
-
</dd>
|
|
2873
|
-
</dl>
|
|
2874
|
-
|
|
2875
|
-
#### ⚙️ Parameters
|
|
2876
|
-
|
|
2877
|
-
<dl>
|
|
2878
|
-
<dd>
|
|
2879
|
-
|
|
2880
|
-
<dl>
|
|
2881
|
-
<dd>
|
|
2882
|
-
|
|
2883
|
-
**syncId:** `string`
|
|
2884
|
-
|
|
2885
|
-
</dd>
|
|
2886
|
-
</dl>
|
|
2887
|
-
|
|
2888
|
-
<dl>
|
|
2889
|
-
<dd>
|
|
2890
|
-
|
|
2891
|
-
**requestOptions:** `Dag.RequestOptions`
|
|
2892
|
-
|
|
2893
|
-
</dd>
|
|
2894
|
-
</dl>
|
|
2895
|
-
</dd>
|
|
2896
|
-
</dl>
|
|
2897
|
-
|
|
2898
|
-
</dd>
|
|
2899
|
-
</dl>
|
|
2900
|
-
</details>
|
|
2901
|
-
|
|
2902
|
-
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">createSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
|
|
2903
|
-
<dl>
|
|
2904
|
-
<dd>
|
|
2905
|
-
|
|
2906
|
-
#### 📝 Description
|
|
2907
|
-
|
|
2908
|
-
<dl>
|
|
2909
|
-
<dd>
|
|
2910
|
-
|
|
2911
|
-
<dl>
|
|
2912
|
-
<dd>
|
|
2913
|
-
|
|
2914
|
-
Create a new DAG definition for a sync.
|
|
2915
|
-
|
|
2916
|
-
</dd>
|
|
2917
|
-
</dl>
|
|
2918
|
-
</dd>
|
|
2919
|
-
</dl>
|
|
2920
|
-
|
|
2921
|
-
#### 🔌 Usage
|
|
2922
|
-
|
|
2923
|
-
<dl>
|
|
2924
|
-
<dd>
|
|
2925
|
-
|
|
2926
|
-
<dl>
|
|
2927
|
-
<dd>
|
|
2928
|
-
|
|
2929
|
-
```typescript
|
|
2930
|
-
await client.dag.createSyncDag("sync_id", {
|
|
2931
|
-
name: "name",
|
|
2932
|
-
syncDagCreateSyncId: "sync_id",
|
|
2933
|
-
nodes: [
|
|
2934
|
-
{
|
|
2935
|
-
type: "source",
|
|
2936
|
-
name: "name",
|
|
2937
|
-
},
|
|
2938
|
-
],
|
|
2939
|
-
edges: [
|
|
2940
|
-
{
|
|
2941
|
-
fromNodeId: "from_node_id",
|
|
2942
|
-
toNodeId: "to_node_id",
|
|
2943
|
-
},
|
|
2944
|
-
],
|
|
2945
|
-
});
|
|
2946
|
-
```
|
|
2947
|
-
|
|
2948
|
-
</dd>
|
|
2949
|
-
</dl>
|
|
2950
|
-
</dd>
|
|
2951
|
-
</dl>
|
|
2952
|
-
|
|
2953
|
-
#### ⚙️ Parameters
|
|
2954
|
-
|
|
2955
|
-
<dl>
|
|
2956
|
-
<dd>
|
|
2957
|
-
|
|
2958
|
-
<dl>
|
|
2959
|
-
<dd>
|
|
2960
|
-
|
|
2961
|
-
**syncId:** `string`
|
|
2962
|
-
|
|
2963
|
-
</dd>
|
|
2964
|
-
</dl>
|
|
2965
|
-
|
|
2966
|
-
<dl>
|
|
2967
|
-
<dd>
|
|
2968
|
-
|
|
2969
|
-
**request:** `AirweaveSDK.SyncDagCreate`
|
|
2970
|
-
|
|
2971
|
-
</dd>
|
|
2972
|
-
</dl>
|
|
2973
|
-
|
|
2974
|
-
<dl>
|
|
2975
|
-
<dd>
|
|
2976
|
-
|
|
2977
|
-
**requestOptions:** `Dag.RequestOptions`
|
|
2978
|
-
|
|
2979
|
-
</dd>
|
|
2980
|
-
</dl>
|
|
2981
|
-
</dd>
|
|
2982
|
-
</dl>
|
|
2983
|
-
|
|
2984
|
-
</dd>
|
|
2985
|
-
</dl>
|
|
2986
|
-
</details>
|
|
2987
|
-
|
|
2988
|
-
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">updateSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
|
|
2989
|
-
<dl>
|
|
2990
|
-
<dd>
|
|
2991
|
-
|
|
2992
|
-
#### 📝 Description
|
|
2993
|
-
|
|
2994
|
-
<dl>
|
|
2995
|
-
<dd>
|
|
2996
|
-
|
|
2997
|
-
<dl>
|
|
2998
|
-
<dd>
|
|
2999
|
-
|
|
3000
|
-
Update a DAG definition for a sync.
|
|
3001
|
-
|
|
3002
|
-
</dd>
|
|
3003
|
-
</dl>
|
|
3004
|
-
</dd>
|
|
3005
|
-
</dl>
|
|
3006
|
-
|
|
3007
|
-
#### 🔌 Usage
|
|
3008
|
-
|
|
3009
|
-
<dl>
|
|
3010
|
-
<dd>
|
|
3011
|
-
|
|
3012
|
-
<dl>
|
|
3013
|
-
<dd>
|
|
3014
|
-
|
|
3015
|
-
```typescript
|
|
3016
|
-
await client.dag.updateSyncDag("sync_id", {
|
|
3017
|
-
name: "name",
|
|
3018
|
-
syncDagUpdateSyncId: "sync_id",
|
|
3019
|
-
});
|
|
3020
|
-
```
|
|
3021
|
-
|
|
3022
|
-
</dd>
|
|
3023
|
-
</dl>
|
|
3024
|
-
</dd>
|
|
3025
|
-
</dl>
|
|
3026
|
-
|
|
3027
|
-
#### ⚙️ Parameters
|
|
3028
|
-
|
|
3029
|
-
<dl>
|
|
3030
|
-
<dd>
|
|
3031
|
-
|
|
3032
|
-
<dl>
|
|
3033
|
-
<dd>
|
|
3034
|
-
|
|
3035
|
-
**syncId:** `string`
|
|
3036
|
-
|
|
3037
|
-
</dd>
|
|
3038
|
-
</dl>
|
|
3039
|
-
|
|
3040
|
-
<dl>
|
|
3041
|
-
<dd>
|
|
3042
|
-
|
|
3043
|
-
**request:** `AirweaveSDK.SyncDagUpdate`
|
|
3044
|
-
|
|
3045
|
-
</dd>
|
|
3046
|
-
</dl>
|
|
3047
|
-
|
|
3048
|
-
<dl>
|
|
3049
|
-
<dd>
|
|
3050
|
-
|
|
3051
|
-
**requestOptions:** `Dag.RequestOptions`
|
|
3052
|
-
|
|
3053
|
-
</dd>
|
|
3054
|
-
</dl>
|
|
3055
|
-
</dd>
|
|
3056
|
-
</dl>
|
|
3057
|
-
|
|
3058
|
-
</dd>
|
|
3059
|
-
</dl>
|
|
3060
|
-
</details>
|
|
3061
|
-
|
|
3062
|
-
<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">initializeDag</a>({ ...params }) -> AirweaveSDK.SyncDag</code></summary>
|
|
3063
|
-
<dl>
|
|
3064
|
-
<dd>
|
|
3065
|
-
|
|
3066
|
-
#### 📝 Description
|
|
3067
|
-
|
|
3068
|
-
<dl>
|
|
3069
|
-
<dd>
|
|
3070
|
-
|
|
3071
|
-
<dl>
|
|
3072
|
-
<dd>
|
|
3073
|
-
|
|
3074
|
-
Initialize a new DAG with source, entities, and destination.
|
|
3075
|
-
|
|
3076
|
-
</dd>
|
|
3077
|
-
</dl>
|
|
3078
|
-
</dd>
|
|
3079
|
-
</dl>
|
|
3080
|
-
|
|
3081
|
-
#### 🔌 Usage
|
|
3082
|
-
|
|
3083
|
-
<dl>
|
|
3084
|
-
<dd>
|
|
3085
|
-
|
|
3086
|
-
<dl>
|
|
3087
|
-
<dd>
|
|
3088
|
-
|
|
3089
|
-
```typescript
|
|
3090
|
-
await client.dag.initializeDag({
|
|
3091
|
-
syncId: "sync_id",
|
|
3092
|
-
});
|
|
3093
|
-
```
|
|
3094
|
-
|
|
3095
|
-
</dd>
|
|
3096
|
-
</dl>
|
|
3097
|
-
</dd>
|
|
3098
|
-
</dl>
|
|
3099
|
-
|
|
3100
|
-
#### ⚙️ Parameters
|
|
3101
|
-
|
|
3102
|
-
<dl>
|
|
3103
|
-
<dd>
|
|
3104
|
-
|
|
3105
|
-
<dl>
|
|
3106
|
-
<dd>
|
|
3107
|
-
|
|
3108
|
-
**request:** `AirweaveSDK.InitializeDagDagInitGetRequest`
|
|
3109
|
-
|
|
3110
|
-
</dd>
|
|
3111
|
-
</dl>
|
|
3112
|
-
|
|
3113
|
-
<dl>
|
|
3114
|
-
<dd>
|
|
3115
|
-
|
|
3116
|
-
**requestOptions:** `Dag.RequestOptions`
|
|
3117
|
-
|
|
3118
|
-
</dd>
|
|
3119
|
-
</dl>
|
|
3120
|
-
</dd>
|
|
3121
|
-
</dl>
|
|
3122
|
-
|
|
3123
|
-
</dd>
|
|
3124
|
-
</dl>
|
|
3125
|
-
</details>
|
|
3126
|
-
|
|
3127
|
-
## Entities
|
|
3128
|
-
|
|
3129
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityDefinitions</a>() -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3130
|
-
<dl>
|
|
3131
|
-
<dd>
|
|
3132
|
-
|
|
3133
|
-
#### 📝 Description
|
|
3134
|
-
|
|
3135
|
-
<dl>
|
|
3136
|
-
<dd>
|
|
3137
|
-
|
|
3138
|
-
<dl>
|
|
3139
|
-
<dd>
|
|
3140
|
-
|
|
3141
|
-
List all entity definitions for the current user's organization.
|
|
3142
|
-
|
|
3143
|
-
</dd>
|
|
3144
|
-
</dl>
|
|
3145
|
-
</dd>
|
|
3146
|
-
</dl>
|
|
3147
|
-
|
|
3148
|
-
#### 🔌 Usage
|
|
3149
|
-
|
|
3150
|
-
<dl>
|
|
3151
|
-
<dd>
|
|
3152
|
-
|
|
3153
|
-
<dl>
|
|
3154
|
-
<dd>
|
|
3155
|
-
|
|
3156
|
-
```typescript
|
|
3157
|
-
await client.entities.listEntityDefinitions();
|
|
3158
|
-
```
|
|
3159
|
-
|
|
3160
|
-
</dd>
|
|
3161
|
-
</dl>
|
|
3162
|
-
</dd>
|
|
3163
|
-
</dl>
|
|
3164
|
-
|
|
3165
|
-
#### ⚙️ Parameters
|
|
3166
|
-
|
|
3167
|
-
<dl>
|
|
3168
|
-
<dd>
|
|
3169
|
-
|
|
3170
|
-
<dl>
|
|
3171
|
-
<dd>
|
|
3172
|
-
|
|
3173
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3174
|
-
|
|
3175
|
-
</dd>
|
|
3176
|
-
</dl>
|
|
3177
|
-
</dd>
|
|
3178
|
-
</dl>
|
|
3179
|
-
|
|
3180
|
-
</dd>
|
|
3181
|
-
</dl>
|
|
3182
|
-
</details>
|
|
3183
|
-
|
|
3184
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityDefinition</a>({ ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
|
|
3185
|
-
<dl>
|
|
3186
|
-
<dd>
|
|
3187
|
-
|
|
3188
|
-
#### 📝 Description
|
|
3189
|
-
|
|
3190
|
-
<dl>
|
|
3191
|
-
<dd>
|
|
3192
|
-
|
|
3193
|
-
<dl>
|
|
3194
|
-
<dd>
|
|
3195
|
-
|
|
3196
|
-
Create a new entity definition.
|
|
3197
|
-
|
|
3198
|
-
</dd>
|
|
3199
|
-
</dl>
|
|
3200
|
-
</dd>
|
|
3201
|
-
</dl>
|
|
3202
|
-
|
|
3203
|
-
#### 🔌 Usage
|
|
3204
|
-
|
|
3205
|
-
<dl>
|
|
3206
|
-
<dd>
|
|
3207
|
-
|
|
3208
|
-
<dl>
|
|
3209
|
-
<dd>
|
|
3210
|
-
|
|
3211
|
-
```typescript
|
|
3212
|
-
await client.entities.createEntityDefinition({
|
|
3213
|
-
name: "name",
|
|
3214
|
-
type: "file",
|
|
3215
|
-
entitySchema: ["entity_schema"],
|
|
3216
|
-
moduleName: "module_name",
|
|
3217
|
-
className: "class_name",
|
|
3218
|
-
});
|
|
3219
|
-
```
|
|
3220
|
-
|
|
3221
|
-
</dd>
|
|
3222
|
-
</dl>
|
|
3223
|
-
</dd>
|
|
3224
|
-
</dl>
|
|
3225
|
-
|
|
3226
|
-
#### ⚙️ Parameters
|
|
3227
|
-
|
|
3228
|
-
<dl>
|
|
3229
|
-
<dd>
|
|
3230
|
-
|
|
3231
|
-
<dl>
|
|
3232
|
-
<dd>
|
|
3233
|
-
|
|
3234
|
-
**request:** `AirweaveSDK.EntityDefinitionCreate`
|
|
3235
|
-
|
|
3236
|
-
</dd>
|
|
3237
|
-
</dl>
|
|
3238
|
-
|
|
3239
|
-
<dl>
|
|
3240
|
-
<dd>
|
|
3241
|
-
|
|
3242
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3243
|
-
|
|
3244
|
-
</dd>
|
|
3245
|
-
</dl>
|
|
3246
|
-
</dd>
|
|
3247
|
-
</dl>
|
|
3248
|
-
|
|
3249
|
-
</dd>
|
|
3250
|
-
</dl>
|
|
3251
|
-
</details>
|
|
3252
|
-
|
|
3253
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntityDefinition</a>(definitionId, { ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
|
|
3254
|
-
<dl>
|
|
3255
|
-
<dd>
|
|
3256
|
-
|
|
3257
|
-
#### 📝 Description
|
|
3258
|
-
|
|
3259
|
-
<dl>
|
|
3260
|
-
<dd>
|
|
3261
|
-
|
|
3262
|
-
<dl>
|
|
3263
|
-
<dd>
|
|
3264
|
-
|
|
3265
|
-
Update an entity definition.
|
|
3266
|
-
|
|
3267
|
-
</dd>
|
|
3268
|
-
</dl>
|
|
3269
|
-
</dd>
|
|
3270
|
-
</dl>
|
|
3271
|
-
|
|
3272
|
-
#### 🔌 Usage
|
|
3273
|
-
|
|
3274
|
-
<dl>
|
|
3275
|
-
<dd>
|
|
3276
|
-
|
|
3277
|
-
<dl>
|
|
3278
|
-
<dd>
|
|
3279
|
-
|
|
3280
|
-
```typescript
|
|
3281
|
-
await client.entities.updateEntityDefinition("definition_id", {
|
|
3282
|
-
name: "name",
|
|
3283
|
-
type: "file",
|
|
3284
|
-
entitySchema: ["entity_schema"],
|
|
3285
|
-
moduleName: "module_name",
|
|
3286
|
-
className: "class_name",
|
|
3287
|
-
});
|
|
3288
|
-
```
|
|
3289
|
-
|
|
3290
|
-
</dd>
|
|
3291
|
-
</dl>
|
|
3292
|
-
</dd>
|
|
3293
|
-
</dl>
|
|
3294
|
-
|
|
3295
|
-
#### ⚙️ Parameters
|
|
3296
|
-
|
|
3297
|
-
<dl>
|
|
3298
|
-
<dd>
|
|
3299
|
-
|
|
3300
|
-
<dl>
|
|
3301
|
-
<dd>
|
|
3302
|
-
|
|
3303
|
-
**definitionId:** `string`
|
|
3304
|
-
|
|
3305
|
-
</dd>
|
|
3306
|
-
</dl>
|
|
3307
|
-
|
|
3308
|
-
<dl>
|
|
3309
|
-
<dd>
|
|
3310
|
-
|
|
3311
|
-
**request:** `AirweaveSDK.EntityDefinitionUpdate`
|
|
3312
|
-
|
|
3313
|
-
</dd>
|
|
3314
|
-
</dl>
|
|
3315
|
-
|
|
3316
|
-
<dl>
|
|
3317
|
-
<dd>
|
|
3318
|
-
|
|
3319
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3320
|
-
|
|
3321
|
-
</dd>
|
|
3322
|
-
</dl>
|
|
3323
|
-
</dd>
|
|
3324
|
-
</dl>
|
|
3325
|
-
|
|
3326
|
-
</dd>
|
|
3327
|
-
</dl>
|
|
3328
|
-
</details>
|
|
3329
|
-
|
|
3330
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityRelations</a>() -> AirweaveSDK.EntityRelation[]</code></summary>
|
|
3331
|
-
<dl>
|
|
3332
|
-
<dd>
|
|
3333
|
-
|
|
3334
|
-
#### 📝 Description
|
|
3335
|
-
|
|
3336
|
-
<dl>
|
|
3337
|
-
<dd>
|
|
3338
|
-
|
|
3339
|
-
<dl>
|
|
3340
|
-
<dd>
|
|
3341
|
-
|
|
3342
|
-
List all entity relations for the current user's organization.
|
|
3343
|
-
|
|
3344
|
-
</dd>
|
|
3345
|
-
</dl>
|
|
3346
|
-
</dd>
|
|
3347
|
-
</dl>
|
|
3348
|
-
|
|
3349
|
-
#### 🔌 Usage
|
|
3350
|
-
|
|
3351
|
-
<dl>
|
|
3352
|
-
<dd>
|
|
3353
|
-
|
|
3354
|
-
<dl>
|
|
3355
|
-
<dd>
|
|
3356
|
-
|
|
3357
|
-
```typescript
|
|
3358
|
-
await client.entities.listEntityRelations();
|
|
3359
|
-
```
|
|
3360
|
-
|
|
3361
|
-
</dd>
|
|
3362
|
-
</dl>
|
|
3363
|
-
</dd>
|
|
3364
|
-
</dl>
|
|
3365
|
-
|
|
3366
|
-
#### ⚙️ Parameters
|
|
3367
|
-
|
|
3368
|
-
<dl>
|
|
3369
|
-
<dd>
|
|
3370
|
-
|
|
3371
|
-
<dl>
|
|
3372
|
-
<dd>
|
|
3373
|
-
|
|
3374
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3375
|
-
|
|
3376
|
-
</dd>
|
|
3377
|
-
</dl>
|
|
3378
|
-
</dd>
|
|
3379
|
-
</dl>
|
|
3380
|
-
|
|
3381
|
-
</dd>
|
|
3382
|
-
</dl>
|
|
3383
|
-
</details>
|
|
3384
|
-
|
|
3385
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityRelation</a>({ ...params }) -> AirweaveSDK.EntityRelation</code></summary>
|
|
3386
|
-
<dl>
|
|
3387
|
-
<dd>
|
|
3388
|
-
|
|
3389
|
-
#### 📝 Description
|
|
3390
|
-
|
|
3391
|
-
<dl>
|
|
3392
|
-
<dd>
|
|
3393
|
-
|
|
3394
|
-
<dl>
|
|
3395
|
-
<dd>
|
|
3396
|
-
|
|
3397
|
-
Create a new entity relation.
|
|
3398
|
-
|
|
3399
|
-
</dd>
|
|
3400
|
-
</dl>
|
|
3401
|
-
</dd>
|
|
3402
|
-
</dl>
|
|
3403
|
-
|
|
3404
|
-
#### 🔌 Usage
|
|
3405
|
-
|
|
3406
|
-
<dl>
|
|
3407
|
-
<dd>
|
|
3408
|
-
|
|
3409
|
-
<dl>
|
|
3410
|
-
<dd>
|
|
3411
|
-
|
|
3412
|
-
```typescript
|
|
3413
|
-
await client.entities.createEntityRelation({
|
|
3414
|
-
name: "name",
|
|
3415
|
-
fromEntityId: "from_entity_id",
|
|
3416
|
-
toEntityId: "to_entity_id",
|
|
3417
|
-
});
|
|
3418
|
-
```
|
|
3419
|
-
|
|
3420
|
-
</dd>
|
|
3421
|
-
</dl>
|
|
3422
|
-
</dd>
|
|
3423
|
-
</dl>
|
|
3424
|
-
|
|
3425
|
-
#### ⚙️ Parameters
|
|
3426
|
-
|
|
3427
|
-
<dl>
|
|
3428
|
-
<dd>
|
|
3429
|
-
|
|
3430
|
-
<dl>
|
|
3431
|
-
<dd>
|
|
3432
|
-
|
|
3433
|
-
**request:** `AirweaveSDK.EntityRelationCreate`
|
|
3434
|
-
|
|
3435
|
-
</dd>
|
|
3436
|
-
</dl>
|
|
3437
|
-
|
|
3438
|
-
<dl>
|
|
3439
|
-
<dd>
|
|
3440
|
-
|
|
3441
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3442
|
-
|
|
3443
|
-
</dd>
|
|
3444
|
-
</dl>
|
|
3445
|
-
</dd>
|
|
3446
|
-
</dl>
|
|
3447
|
-
|
|
3448
|
-
</dd>
|
|
3449
|
-
</dl>
|
|
3450
|
-
</details>
|
|
3451
|
-
|
|
3452
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntityRelation</a>(relationId, { ...params }) -> AirweaveSDK.EntityRelation</code></summary>
|
|
3453
|
-
<dl>
|
|
3454
|
-
<dd>
|
|
3455
|
-
|
|
3456
|
-
#### 📝 Description
|
|
3457
|
-
|
|
3458
|
-
<dl>
|
|
3459
|
-
<dd>
|
|
3460
|
-
|
|
3461
|
-
<dl>
|
|
3462
|
-
<dd>
|
|
3463
|
-
|
|
3464
|
-
Update an entity relation.
|
|
3465
|
-
|
|
3466
|
-
</dd>
|
|
3467
|
-
</dl>
|
|
3468
|
-
</dd>
|
|
3469
|
-
</dl>
|
|
3470
|
-
|
|
3471
|
-
#### 🔌 Usage
|
|
3472
|
-
|
|
3473
|
-
<dl>
|
|
3474
|
-
<dd>
|
|
3475
|
-
|
|
3476
|
-
<dl>
|
|
3477
|
-
<dd>
|
|
3478
|
-
|
|
3479
|
-
```typescript
|
|
3480
|
-
await client.entities.updateEntityRelation("relation_id", {
|
|
3481
|
-
name: "name",
|
|
3482
|
-
fromEntityId: "from_entity_id",
|
|
3483
|
-
toEntityId: "to_entity_id",
|
|
3484
|
-
});
|
|
3485
|
-
```
|
|
3486
|
-
|
|
3487
|
-
</dd>
|
|
3488
|
-
</dl>
|
|
3489
|
-
</dd>
|
|
3490
|
-
</dl>
|
|
3491
|
-
|
|
3492
|
-
#### ⚙️ Parameters
|
|
3493
|
-
|
|
3494
|
-
<dl>
|
|
3495
|
-
<dd>
|
|
3496
|
-
|
|
3497
|
-
<dl>
|
|
3498
|
-
<dd>
|
|
3499
|
-
|
|
3500
|
-
**relationId:** `string`
|
|
3501
|
-
|
|
3502
|
-
</dd>
|
|
3503
|
-
</dl>
|
|
3504
|
-
|
|
3505
|
-
<dl>
|
|
3506
|
-
<dd>
|
|
3507
|
-
|
|
3508
|
-
**request:** `AirweaveSDK.EntityRelationUpdate`
|
|
3509
|
-
|
|
3510
|
-
</dd>
|
|
3511
|
-
</dl>
|
|
3512
|
-
|
|
3513
|
-
<dl>
|
|
3514
|
-
<dd>
|
|
3515
|
-
|
|
3516
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3517
|
-
|
|
3518
|
-
</dd>
|
|
3519
|
-
</dl>
|
|
3520
|
-
</dd>
|
|
3521
|
-
</dl>
|
|
3522
|
-
|
|
3523
|
-
</dd>
|
|
3524
|
-
</dl>
|
|
3525
|
-
</details>
|
|
3526
|
-
|
|
3527
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsByIds</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3528
|
-
<dl>
|
|
3529
|
-
<dd>
|
|
3530
|
-
|
|
3531
|
-
#### 📝 Description
|
|
3532
|
-
|
|
3533
|
-
<dl>
|
|
3534
|
-
<dd>
|
|
3535
|
-
|
|
3536
|
-
<dl>
|
|
3537
|
-
<dd>
|
|
3538
|
-
|
|
3539
|
-
Get multiple entity definitions by their IDs.
|
|
3540
|
-
|
|
3541
|
-
Args:
|
|
3542
|
-
ids: List of entity definition IDs to fetch
|
|
3543
|
-
db: Database session
|
|
3544
|
-
current_user: Current authenticated user
|
|
3545
|
-
|
|
3546
|
-
Returns:
|
|
3547
|
-
List of entity definitions matching the provided IDs
|
|
3548
|
-
|
|
3549
|
-
</dd>
|
|
3550
|
-
</dl>
|
|
3551
|
-
</dd>
|
|
3552
|
-
</dl>
|
|
3553
|
-
|
|
3554
|
-
#### 🔌 Usage
|
|
3555
|
-
|
|
3556
|
-
<dl>
|
|
3557
|
-
<dd>
|
|
3558
|
-
|
|
3559
|
-
<dl>
|
|
3560
|
-
<dd>
|
|
3561
|
-
|
|
3562
|
-
```typescript
|
|
3563
|
-
await client.entities.getEntityDefinitionsByIds(["string"]);
|
|
3564
|
-
```
|
|
3565
|
-
|
|
3566
|
-
</dd>
|
|
3567
|
-
</dl>
|
|
3568
|
-
</dd>
|
|
3569
|
-
</dl>
|
|
3570
|
-
|
|
3571
|
-
#### ⚙️ Parameters
|
|
3572
|
-
|
|
3573
|
-
<dl>
|
|
3574
|
-
<dd>
|
|
3575
|
-
|
|
3576
|
-
<dl>
|
|
3577
|
-
<dd>
|
|
3578
|
-
|
|
3579
|
-
**request:** `string[]`
|
|
3580
|
-
|
|
3581
|
-
</dd>
|
|
3582
|
-
</dl>
|
|
3583
|
-
|
|
3584
|
-
<dl>
|
|
3585
|
-
<dd>
|
|
3586
|
-
|
|
3587
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3588
|
-
|
|
3589
|
-
</dd>
|
|
3590
|
-
</dl>
|
|
3591
|
-
</dd>
|
|
3592
|
-
</dl>
|
|
3593
|
-
|
|
3594
|
-
</dd>
|
|
3595
|
-
</dl>
|
|
3596
|
-
</details>
|
|
3597
|
-
|
|
3598
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsBySourceShortName</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3599
|
-
<dl>
|
|
3600
|
-
<dd>
|
|
3601
|
-
|
|
3602
|
-
#### 📝 Description
|
|
3603
|
-
|
|
3604
|
-
<dl>
|
|
3605
|
-
<dd>
|
|
3606
|
-
|
|
3607
|
-
<dl>
|
|
3608
|
-
<dd>
|
|
3609
|
-
|
|
3610
|
-
Get all entity definitions for a given source.
|
|
3611
|
-
|
|
3612
|
-
</dd>
|
|
3613
|
-
</dl>
|
|
3614
|
-
</dd>
|
|
3615
|
-
</dl>
|
|
3616
|
-
|
|
3617
|
-
#### 🔌 Usage
|
|
3618
|
-
|
|
3619
|
-
<dl>
|
|
3620
|
-
<dd>
|
|
3621
|
-
|
|
3622
|
-
<dl>
|
|
3623
|
-
<dd>
|
|
3624
|
-
|
|
3625
|
-
```typescript
|
|
3626
|
-
await client.entities.getEntityDefinitionsBySourceShortName({
|
|
3627
|
-
sourceShortName: "source_short_name",
|
|
3628
|
-
});
|
|
3629
|
-
```
|
|
3630
|
-
|
|
3631
|
-
</dd>
|
|
3632
|
-
</dl>
|
|
3633
|
-
</dd>
|
|
3634
|
-
</dl>
|
|
3635
|
-
|
|
3636
|
-
#### ⚙️ Parameters
|
|
3637
|
-
|
|
3638
|
-
<dl>
|
|
3639
|
-
<dd>
|
|
3640
|
-
|
|
3641
|
-
<dl>
|
|
3642
|
-
<dd>
|
|
3643
|
-
|
|
3644
|
-
**request:** `AirweaveSDK.GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest`
|
|
3645
|
-
|
|
3646
|
-
</dd>
|
|
3647
|
-
</dl>
|
|
3648
|
-
|
|
3649
|
-
<dl>
|
|
3650
|
-
<dd>
|
|
3651
|
-
|
|
3652
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3653
|
-
|
|
3654
|
-
</dd>
|
|
3655
|
-
</dl>
|
|
3656
|
-
</dd>
|
|
3657
|
-
</dl>
|
|
3658
|
-
|
|
3659
|
-
</dd>
|
|
3660
|
-
</dl>
|
|
3661
|
-
</details>
|
|
3662
|
-
|
|
3663
|
-
## Transformers
|
|
3664
|
-
|
|
3665
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>() -> AirweaveSDK.Transformer[]</code></summary>
|
|
3666
|
-
<dl>
|
|
3667
|
-
<dd>
|
|
3668
|
-
|
|
3669
|
-
#### 📝 Description
|
|
3670
|
-
|
|
3671
|
-
<dl>
|
|
3672
|
-
<dd>
|
|
3673
|
-
|
|
3674
|
-
<dl>
|
|
3675
|
-
<dd>
|
|
3676
|
-
|
|
3677
|
-
List all transformers for the current user's organization.
|
|
3678
|
-
|
|
3679
|
-
</dd>
|
|
3680
|
-
</dl>
|
|
3681
|
-
</dd>
|
|
3682
|
-
</dl>
|
|
3683
|
-
|
|
3684
|
-
#### 🔌 Usage
|
|
3685
|
-
|
|
3686
|
-
<dl>
|
|
3687
|
-
<dd>
|
|
3688
|
-
|
|
3689
|
-
<dl>
|
|
3690
|
-
<dd>
|
|
3691
|
-
|
|
3692
|
-
```typescript
|
|
3693
|
-
await client.transformers.listTransformers();
|
|
3694
|
-
```
|
|
3695
|
-
|
|
3696
|
-
</dd>
|
|
3697
|
-
</dl>
|
|
3698
|
-
</dd>
|
|
3699
|
-
</dl>
|
|
3700
|
-
|
|
3701
|
-
#### ⚙️ Parameters
|
|
3702
|
-
|
|
3703
|
-
<dl>
|
|
3704
|
-
<dd>
|
|
3705
|
-
|
|
3706
|
-
<dl>
|
|
3707
|
-
<dd>
|
|
3708
|
-
|
|
3709
|
-
**requestOptions:** `Transformers.RequestOptions`
|
|
3710
|
-
|
|
3711
|
-
</dd>
|
|
3712
|
-
</dl>
|
|
3713
|
-
</dd>
|
|
3714
|
-
</dl>
|
|
3715
|
-
|
|
3716
|
-
</dd>
|
|
3717
|
-
</dl>
|
|
3718
|
-
</details>
|
|
3719
|
-
|
|
3720
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">createTransformer</a>({ ...params }) -> AirweaveSDK.Transformer</code></summary>
|
|
3721
|
-
<dl>
|
|
3722
|
-
<dd>
|
|
3723
|
-
|
|
3724
|
-
#### 📝 Description
|
|
3725
|
-
|
|
3726
|
-
<dl>
|
|
3727
|
-
<dd>
|
|
3728
|
-
|
|
3729
|
-
<dl>
|
|
3730
|
-
<dd>
|
|
3731
|
-
|
|
3732
|
-
Create a new transformer.
|
|
3733
|
-
|
|
3734
|
-
</dd>
|
|
3735
|
-
</dl>
|
|
3736
|
-
</dd>
|
|
3737
|
-
</dl>
|
|
3738
|
-
|
|
3739
|
-
#### 🔌 Usage
|
|
3740
|
-
|
|
3741
|
-
<dl>
|
|
3742
|
-
<dd>
|
|
3743
|
-
|
|
3744
|
-
<dl>
|
|
3745
|
-
<dd>
|
|
3746
|
-
|
|
3747
|
-
```typescript
|
|
3748
|
-
await client.transformers.createTransformer({
|
|
3749
|
-
name: "name",
|
|
3750
|
-
methodName: "method_name",
|
|
3751
|
-
moduleName: "module_name",
|
|
3752
|
-
inputEntityDefinitionIds: ["input_entity_definition_ids"],
|
|
3753
|
-
outputEntityDefinitionIds: ["output_entity_definition_ids"],
|
|
3754
|
-
});
|
|
3755
|
-
```
|
|
3756
|
-
|
|
3757
|
-
</dd>
|
|
3758
|
-
</dl>
|
|
3759
|
-
</dd>
|
|
3760
|
-
</dl>
|
|
3761
|
-
|
|
3762
|
-
#### ⚙️ Parameters
|
|
3763
|
-
|
|
3764
|
-
<dl>
|
|
3765
|
-
<dd>
|
|
3766
|
-
|
|
3767
|
-
<dl>
|
|
3768
|
-
<dd>
|
|
3769
|
-
|
|
3770
|
-
**request:** `AirweaveSDK.TransformerCreate`
|
|
3771
|
-
|
|
3772
|
-
</dd>
|
|
3773
|
-
</dl>
|
|
3774
|
-
|
|
3775
|
-
<dl>
|
|
3776
|
-
<dd>
|
|
3777
|
-
|
|
3778
|
-
**requestOptions:** `Transformers.RequestOptions`
|
|
3779
|
-
|
|
3780
|
-
</dd>
|
|
3781
|
-
</dl>
|
|
3782
|
-
</dd>
|
|
3783
|
-
</dl>
|
|
3784
|
-
|
|
3785
|
-
</dd>
|
|
3786
|
-
</dl>
|
|
3787
|
-
</details>
|
|
3788
|
-
|
|
3789
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">updateTransformer</a>(transformerId, { ...params }) -> AirweaveSDK.Transformer</code></summary>
|
|
3790
|
-
<dl>
|
|
3791
|
-
<dd>
|
|
3792
|
-
|
|
3793
|
-
#### 📝 Description
|
|
3794
|
-
|
|
3795
|
-
<dl>
|
|
3796
|
-
<dd>
|
|
3797
|
-
|
|
3798
|
-
<dl>
|
|
3799
|
-
<dd>
|
|
3800
|
-
|
|
3801
|
-
Update a transformer.
|
|
3802
|
-
|
|
3803
|
-
</dd>
|
|
3804
|
-
</dl>
|
|
3805
|
-
</dd>
|
|
3806
|
-
</dl>
|
|
3807
|
-
|
|
3808
|
-
#### 🔌 Usage
|
|
3809
|
-
|
|
3810
|
-
<dl>
|
|
3811
|
-
<dd>
|
|
3812
|
-
|
|
3813
|
-
<dl>
|
|
3814
|
-
<dd>
|
|
3815
|
-
|
|
3816
|
-
```typescript
|
|
3817
|
-
await client.transformers.updateTransformer("transformer_id", {
|
|
3818
|
-
name: "name",
|
|
3819
|
-
methodName: "method_name",
|
|
3820
|
-
moduleName: "module_name",
|
|
3821
|
-
inputEntityDefinitionIds: ["input_entity_definition_ids"],
|
|
3822
|
-
outputEntityDefinitionIds: ["output_entity_definition_ids"],
|
|
3823
|
-
});
|
|
3824
|
-
```
|
|
3825
|
-
|
|
3826
|
-
</dd>
|
|
3827
|
-
</dl>
|
|
3828
|
-
</dd>
|
|
3829
|
-
</dl>
|
|
3830
|
-
|
|
3831
|
-
#### ⚙️ Parameters
|
|
3832
|
-
|
|
3833
|
-
<dl>
|
|
3834
|
-
<dd>
|
|
3835
|
-
|
|
3836
|
-
<dl>
|
|
3837
|
-
<dd>
|
|
3838
|
-
|
|
3839
|
-
**transformerId:** `string`
|
|
3840
|
-
|
|
3841
|
-
</dd>
|
|
3842
|
-
</dl>
|
|
3843
|
-
|
|
3844
|
-
<dl>
|
|
3845
|
-
<dd>
|
|
3846
|
-
|
|
3847
|
-
**request:** `AirweaveSDK.TransformerUpdate`
|
|
3848
|
-
|
|
3849
|
-
</dd>
|
|
3850
|
-
</dl>
|
|
3851
|
-
|
|
3852
|
-
<dl>
|
|
3853
|
-
<dd>
|
|
3854
|
-
|
|
3855
|
-
**requestOptions:** `Transformers.RequestOptions`
|
|
1602
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3856
1603
|
|
|
3857
1604
|
</dd>
|
|
3858
1605
|
</dl>
|