@airweave/sdk 0.2.18 → 0.2.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +3 -12
- package/Client.js +13 -28
- package/README.md +13 -10
- package/api/resources/apiKeys/client/Client.d.ts +58 -0
- package/{dist/api/resources/destinations → api/resources/apiKeys}/client/Client.js +22 -98
- package/{dist/api/resources/users/client/requests/ReadUserUsersGetRequest.d.ts → api/resources/apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.d.ts} +1 -1
- package/api/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/api/resources/connections/client/Client.d.ts +0 -32
- package/api/resources/connections/client/Client.js +9 -101
- package/api/resources/connections/client/requests/index.d.ts +0 -1
- package/api/resources/embeddingModels/client/Client.js +2 -2
- package/api/resources/index.d.ts +2 -9
- package/api/resources/index.js +3 -10
- package/api/resources/search/client/Client.js +1 -1
- package/api/resources/sources/client/Client.js +2 -2
- package/api/resources/sync/client/Client.d.ts +1 -0
- package/api/resources/sync/client/Client.js +21 -12
- package/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +4 -0
- package/api/resources/whiteLabels/client/Client.js +8 -8
- package/api/types/ApiKey.d.ts +1 -1
- package/api/types/ApiKeyCreate.d.ts +1 -0
- package/api/types/ApiKeyWithPlainKey.d.ts +1 -1
- package/api/{resources/connections/client/requests → types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -9
- package/api/types/EntityCount.d.ts +9 -0
- package/api/types/EntityDefinitionCreate.d.ts +16 -0
- package/api/types/EntityDefinitionUpdate.d.ts +16 -0
- package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationCreate.d.ts +1 -9
- package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationUpdate.d.ts +1 -9
- package/api/types/Organization.d.ts +13 -0
- package/api/types/SyncJob.d.ts +5 -4
- package/api/types/TransformerCreate.d.ts +15 -0
- package/api/types/TransformerUpdate.d.ts +15 -0
- package/{dist/api/resources/users/client/requests → api/types}/UserCreate.d.ts +1 -8
- package/api/types/index.d.ts +12 -0
- package/api/types/index.js +12 -0
- package/dist/Client.d.ts +3 -12
- package/dist/Client.js +13 -28
- package/dist/api/resources/apiKeys/client/Client.d.ts +58 -0
- package/{api/resources/destinations → dist/api/resources/apiKeys}/client/Client.js +22 -98
- package/{api/resources/users/client/requests/ReadUserUsersGetRequest.d.ts → dist/api/resources/apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.d.ts} +1 -1
- package/dist/api/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/dist/api/resources/connections/client/Client.d.ts +0 -32
- package/dist/api/resources/connections/client/Client.js +9 -101
- package/dist/api/resources/connections/client/requests/index.d.ts +0 -1
- package/dist/api/resources/embeddingModels/client/Client.js +2 -2
- package/dist/api/resources/index.d.ts +2 -9
- package/dist/api/resources/index.js +3 -10
- package/dist/api/resources/search/client/Client.js +1 -1
- package/dist/api/resources/sources/client/Client.js +2 -2
- package/dist/api/resources/sync/client/Client.d.ts +1 -0
- package/dist/api/resources/sync/client/Client.js +21 -12
- package/dist/api/resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts +4 -0
- package/dist/api/resources/whiteLabels/client/Client.js +8 -8
- package/dist/api/types/ApiKey.d.ts +1 -1
- package/dist/api/types/ApiKeyCreate.d.ts +1 -0
- package/dist/api/types/ApiKeyWithPlainKey.d.ts +1 -1
- package/dist/api/{resources/connections/client/requests → types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -9
- package/dist/api/types/EntityCount.d.ts +9 -0
- package/dist/api/types/EntityDefinitionCreate.d.ts +16 -0
- package/dist/api/types/EntityDefinitionUpdate.d.ts +16 -0
- package/{api/resources/entities/client/requests → dist/api/types}/EntityRelationCreate.d.ts +1 -9
- package/{api/resources/entities/client/requests → dist/api/types}/EntityRelationUpdate.d.ts +1 -9
- package/dist/api/types/Organization.d.ts +13 -0
- package/dist/api/types/SyncJob.d.ts +5 -4
- package/dist/api/types/TransformerCreate.d.ts +15 -0
- package/dist/api/types/TransformerUpdate.d.ts +15 -0
- package/{api/resources/users/client/requests → dist/api/types}/UserCreate.d.ts +1 -8
- package/dist/api/types/index.d.ts +12 -0
- package/dist/api/types/index.js +12 -0
- package/dist/serialization/resources/connections/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/connections/client/requests/index.js +1 -3
- package/dist/serialization/resources/index.d.ts +0 -8
- package/dist/serialization/resources/index.js +1 -9
- package/dist/serialization/types/ApiKey.d.ts +1 -1
- package/dist/serialization/types/ApiKey.js +1 -1
- package/dist/serialization/types/ApiKeyWithPlainKey.d.ts +1 -1
- package/dist/serialization/types/ApiKeyWithPlainKey.js +1 -1
- package/dist/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +13 -0
- package/dist/serialization/{resources/connections/client/requests → types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +1 -1
- package/dist/serialization/types/EntityCount.d.ts +12 -0
- package/dist/serialization/{resources/transformers/client/listTransformers.js → types/EntityCount.js} +5 -4
- 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/dist/serialization/{resources/entities/types → 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/dist/serialization/{resources/entities/client/requests → 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/SyncJob.d.ts +5 -4
- package/dist/serialization/types/SyncJob.js +5 -4
- package/{serialization/resources/transformers/client/requests → dist/serialization/types}/TransformerCreate.d.ts +4 -4
- package/dist/serialization/{resources/transformers/client/requests → 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/UserCreate.d.ts +14 -0
- package/dist/serialization/{resources/users/client/requests → types}/UserCreate.js +1 -1
- package/dist/serialization/types/index.d.ts +12 -0
- package/dist/serialization/types/index.js +12 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +49 -1147
- package/serialization/resources/connections/client/requests/index.d.ts +0 -1
- package/serialization/resources/connections/client/requests/index.js +1 -3
- package/serialization/resources/index.d.ts +0 -8
- package/serialization/resources/index.js +1 -9
- package/serialization/types/ApiKey.d.ts +1 -1
- package/serialization/types/ApiKey.js +1 -1
- package/serialization/types/ApiKeyWithPlainKey.d.ts +1 -1
- package/serialization/types/ApiKeyWithPlainKey.js +1 -1
- package/serialization/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +13 -0
- package/serialization/{resources/connections/client/requests → types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +1 -1
- package/serialization/types/EntityCount.d.ts +12 -0
- package/serialization/{resources/transformers/client/listTransformers.js → types/EntityCount.js} +5 -4
- 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/serialization/{resources/entities/types → 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/serialization/{resources/entities/client/requests → 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/SyncJob.d.ts +5 -4
- package/serialization/types/SyncJob.js +5 -4
- package/{dist/serialization/resources/transformers/client/requests → serialization/types}/TransformerCreate.d.ts +4 -4
- package/serialization/{resources/transformers/client/requests → 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/UserCreate.d.ts +14 -0
- package/serialization/{resources/users/client/requests → types}/UserCreate.js +1 -1
- package/serialization/types/index.d.ts +12 -0
- package/serialization/types/index.js +12 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/destinations/client/Client.d.ts +0 -77
- package/api/resources/destinations/client/requests/ListDestinationsDestinationsListGetRequest.d.ts +0 -12
- package/api/resources/destinations/client/requests/ReadDestinationDestinationsDetailShortNameGetRequest.d.ts +0 -12
- package/api/resources/destinations/client/requests/index.d.ts +0 -2
- package/api/resources/entities/client/Client.d.ts +0 -175
- package/api/resources/entities/client/Client.js +0 -684
- package/api/resources/entities/client/requests/EntityDefinitionCreate.d.ts +0 -27
- package/api/resources/entities/client/requests/EntityDefinitionUpdate.d.ts +0 -27
- package/api/resources/entities/client/requests/GetEntityDefinitionsByIdsEntitiesDefinitionsByIdsPostRequest.d.ts +0 -14
- package/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -14
- package/api/resources/entities/client/requests/ListEntityDefinitionsEntitiesDefinitionsGetRequest.d.ts +0 -12
- package/api/resources/entities/client/requests/ListEntityRelationsEntitiesRelationsGetRequest.d.ts +0 -12
- package/api/resources/entities/client/requests/index.d.ts +0 -8
- 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/transformers/client/Client.d.ts +0 -86
- package/api/resources/transformers/client/Client.js +0 -304
- package/api/resources/transformers/client/index.d.ts +0 -1
- package/api/resources/transformers/client/index.js +0 -17
- package/api/resources/transformers/client/requests/ListTransformersTransformersGetRequest.d.ts +0 -12
- package/api/resources/transformers/client/requests/ListTransformersTransformersGetRequest.js +0 -5
- package/api/resources/transformers/client/requests/TransformerCreate.d.ts +0 -26
- package/api/resources/transformers/client/requests/TransformerUpdate.d.ts +0 -26
- package/api/resources/transformers/client/requests/index.d.ts +0 -3
- package/api/resources/transformers/client/requests/index.js +0 -2
- package/api/resources/users/client/Client.d.ts +0 -81
- package/api/resources/users/client/Client.js +0 -241
- package/api/resources/users/client/index.d.ts +0 -1
- package/api/resources/users/client/index.js +0 -17
- package/api/resources/users/client/requests/ReadUserUsersGetRequest.js +0 -5
- package/api/resources/users/client/requests/index.d.ts +0 -2
- package/api/resources/users/client/requests/index.js +0 -2
- package/api/resources/users/index.d.ts +0 -1
- package/api/resources/users/index.js +0 -17
- package/dist/api/resources/destinations/client/Client.d.ts +0 -77
- package/dist/api/resources/destinations/client/index.d.ts +0 -1
- package/dist/api/resources/destinations/client/index.js +0 -17
- package/dist/api/resources/destinations/client/requests/ListDestinationsDestinationsListGetRequest.d.ts +0 -12
- package/dist/api/resources/destinations/client/requests/ListDestinationsDestinationsListGetRequest.js +0 -5
- package/dist/api/resources/destinations/client/requests/ReadDestinationDestinationsDetailShortNameGetRequest.d.ts +0 -12
- package/dist/api/resources/destinations/client/requests/ReadDestinationDestinationsDetailShortNameGetRequest.js +0 -5
- package/dist/api/resources/destinations/client/requests/index.d.ts +0 -2
- package/dist/api/resources/destinations/client/requests/index.js +0 -2
- package/dist/api/resources/destinations/index.d.ts +0 -1
- package/dist/api/resources/destinations/index.js +0 -17
- package/dist/api/resources/entities/client/Client.d.ts +0 -175
- package/dist/api/resources/entities/client/Client.js +0 -684
- package/dist/api/resources/entities/client/index.d.ts +0 -1
- package/dist/api/resources/entities/client/index.js +0 -17
- package/dist/api/resources/entities/client/requests/EntityDefinitionCreate.d.ts +0 -27
- package/dist/api/resources/entities/client/requests/EntityDefinitionUpdate.d.ts +0 -27
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsByIdsEntitiesDefinitionsByIdsPostRequest.d.ts +0 -14
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsByIdsEntitiesDefinitionsByIdsPostRequest.js +0 -5
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -14
- package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js +0 -5
- package/dist/api/resources/entities/client/requests/ListEntityDefinitionsEntitiesDefinitionsGetRequest.d.ts +0 -12
- package/dist/api/resources/entities/client/requests/ListEntityDefinitionsEntitiesDefinitionsGetRequest.js +0 -5
- package/dist/api/resources/entities/client/requests/ListEntityRelationsEntitiesRelationsGetRequest.d.ts +0 -12
- package/dist/api/resources/entities/client/requests/ListEntityRelationsEntitiesRelationsGetRequest.js +0 -5
- package/dist/api/resources/entities/client/requests/index.d.ts +0 -8
- 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/transformers/client/Client.d.ts +0 -86
- package/dist/api/resources/transformers/client/Client.js +0 -304
- 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/ListTransformersTransformersGetRequest.d.ts +0 -12
- package/dist/api/resources/transformers/client/requests/ListTransformersTransformersGetRequest.js +0 -5
- package/dist/api/resources/transformers/client/requests/TransformerCreate.d.ts +0 -26
- package/dist/api/resources/transformers/client/requests/TransformerUpdate.d.ts +0 -26
- package/dist/api/resources/transformers/client/requests/index.d.ts +0 -3
- 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 -81
- package/dist/api/resources/users/client/Client.js +0 -241
- package/dist/api/resources/users/client/index.d.ts +0 -1
- package/dist/api/resources/users/client/index.js +0 -17
- package/dist/api/resources/users/client/requests/ReadUserUsersGetRequest.js +0 -5
- package/dist/api/resources/users/client/requests/index.d.ts +0 -2
- package/dist/api/resources/users/client/requests/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/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -13
- package/dist/serialization/resources/destinations/client/index.d.ts +0 -1
- package/dist/serialization/resources/destinations/client/index.js +0 -37
- package/dist/serialization/resources/destinations/client/listDestinations.d.ts +0 -11
- package/dist/serialization/resources/destinations/client/listDestinations.js +0 -42
- package/dist/serialization/resources/destinations/index.d.ts +0 -1
- package/dist/serialization/resources/destinations/index.js +0 -17
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
- package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +0 -11
- package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
- package/dist/serialization/resources/entities/client/index.d.ts +0 -5
- package/dist/serialization/resources/entities/client/index.js +0 -44
- package/dist/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
- package/dist/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
- package/dist/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
- package/dist/serialization/resources/entities/client/listEntityRelations.js +0 -42
- package/dist/serialization/resources/entities/client/requests/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/transformers/client/index.d.ts +0 -2
- package/dist/serialization/resources/transformers/client/index.js +0 -41
- package/dist/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
- package/dist/serialization/resources/transformers/client/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/users/client/index.d.ts +0 -1
- package/dist/serialization/resources/users/client/index.js +0 -17
- package/dist/serialization/resources/users/client/requests/UserCreate.d.ts +0 -14
- package/dist/serialization/resources/users/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/users/client/requests/index.js +0 -5
- package/dist/serialization/resources/users/index.d.ts +0 -1
- package/dist/serialization/resources/users/index.js +0 -17
- package/serialization/resources/connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.d.ts +0 -13
- 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/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/transformers/client/index.d.ts +0 -2
- package/serialization/resources/transformers/client/index.js +0 -41
- package/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
- package/serialization/resources/transformers/client/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/users/client/index.d.ts +0 -1
- package/serialization/resources/users/client/index.js +0 -17
- package/serialization/resources/users/client/requests/UserCreate.d.ts +0 -14
- package/serialization/resources/users/client/requests/index.d.ts +0 -1
- package/serialization/resources/users/client/requests/index.js +0 -5
- package/serialization/resources/users/index.d.ts +0 -1
- package/serialization/resources/users/index.js +0 -17
- /package/api/resources/{destinations → apiKeys}/client/index.d.ts +0 -0
- /package/api/resources/{destinations → apiKeys}/client/index.js +0 -0
- /package/api/resources/{connections/client/requests/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js → apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.js} +0 -0
- /package/api/resources/{destinations → apiKeys}/client/requests/index.js +0 -0
- /package/api/resources/{destinations → apiKeys}/index.d.ts +0 -0
- /package/api/resources/{destinations → apiKeys}/index.js +0 -0
- /package/{dist/api/resources/connections/client/requests → api/types}/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js +0 -0
- /package/api/{resources/destinations/client/requests/ListDestinationsDestinationsListGetRequest.js → types/EntityCount.js} +0 -0
- /package/api/{resources/entities/client/requests → types}/EntityDefinitionCreate.js +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +0 -0
- /package/api/{resources/entities/client/requests → types}/EntityDefinitionUpdate.js +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.d.ts +0 -0
- /package/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.js +0 -0
- /package/api/{resources/entities/client/requests → types}/EntityRelationCreate.js +0 -0
- /package/api/{resources/entities/client/requests → types}/EntityRelationUpdate.js +0 -0
- /package/api/{resources/destinations/client/requests/ReadDestinationDestinationsDetailShortNameGetRequest.js → types/Organization.js} +0 -0
- /package/api/{resources/transformers/client/requests → types}/TransformerCreate.js +0 -0
- /package/api/{resources/transformers/client/requests → types}/TransformerUpdate.js +0 -0
- /package/api/{resources/users/client/requests → types}/UserCreate.js +0 -0
- /package/{api/resources/entities → dist/api/resources/apiKeys}/client/index.d.ts +0 -0
- /package/{api/resources/entities → dist/api/resources/apiKeys}/client/index.js +0 -0
- /package/{api/resources/entities/client/requests/GetEntityDefinitionsByIdsEntitiesDefinitionsByIdsPostRequest.js → dist/api/resources/apiKeys/client/requests/ReadApiKeyApiKeysIdGetRequest.js} +0 -0
- /package/{api/resources/entities → dist/api/resources/apiKeys}/client/requests/index.js +0 -0
- /package/{api/resources/transformers → dist/api/resources/apiKeys}/index.d.ts +0 -0
- /package/{api/resources/transformers → dist/api/resources/apiKeys}/index.js +0 -0
- /package/{api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → dist/api/types/BodySendOauth2CodeConnectionsOauth2SourceCodePost.js} +0 -0
- /package/{api/resources/entities/client/requests/ListEntityDefinitionsEntitiesDefinitionsGetRequest.js → dist/api/types/EntityCount.js} +0 -0
- /package/dist/api/{resources/entities/client/requests → types}/EntityDefinitionCreate.js +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +0 -0
- /package/dist/api/{resources/entities/client/requests → types}/EntityDefinitionUpdate.js +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.d.ts +0 -0
- /package/dist/api/{resources/entities/types → types}/EntityDefinitionUpdateEntitySchema.js +0 -0
- /package/dist/api/{resources/entities/client/requests → types}/EntityRelationCreate.js +0 -0
- /package/dist/api/{resources/entities/client/requests → types}/EntityRelationUpdate.js +0 -0
- /package/{api/resources/entities/client/requests/ListEntityRelationsEntitiesRelationsGetRequest.js → dist/api/types/Organization.js} +0 -0
- /package/dist/api/{resources/transformers/client/requests → types}/TransformerCreate.js +0 -0
- /package/dist/api/{resources/transformers/client/requests → types}/TransformerUpdate.js +0 -0
- /package/dist/api/{resources/users/client/requests → types}/UserCreate.js +0 -0
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## ApiKeys
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKey</a>(id, { ...params }) -> AirweaveSDK.ApiKey</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,15 +14,21 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Retrieve an API key by ID.
|
|
18
18
|
|
|
19
19
|
## Args:
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
db (AsyncSession): The database session.
|
|
22
|
+
id (UUID): The ID of the API key.
|
|
23
|
+
user (schemas.User): The current user.
|
|
22
24
|
|
|
23
25
|
## Returns:
|
|
24
26
|
|
|
25
|
-
schemas.
|
|
27
|
+
schemas.APIKey: The API key object.
|
|
28
|
+
|
|
29
|
+
## Raises:
|
|
30
|
+
|
|
31
|
+
HTTPException: If the API key is not found.
|
|
26
32
|
|
|
27
33
|
</dd>
|
|
28
34
|
</dl>
|
|
@@ -38,7 +44,7 @@ Get current user.
|
|
|
38
44
|
<dd>
|
|
39
45
|
|
|
40
46
|
```typescript
|
|
41
|
-
await client.
|
|
47
|
+
await client.apiKeys.readApiKey("id", {
|
|
42
48
|
creds: "creds",
|
|
43
49
|
});
|
|
44
50
|
```
|
|
@@ -56,88 +62,15 @@ await client.users.readUser({
|
|
|
56
62
|
<dl>
|
|
57
63
|
<dd>
|
|
58
64
|
|
|
59
|
-
**
|
|
60
|
-
|
|
61
|
-
</dd>
|
|
62
|
-
</dl>
|
|
63
|
-
|
|
64
|
-
<dl>
|
|
65
|
-
<dd>
|
|
66
|
-
|
|
67
|
-
**requestOptions:** `Users.RequestOptions`
|
|
68
|
-
|
|
69
|
-
</dd>
|
|
70
|
-
</dl>
|
|
71
|
-
</dd>
|
|
72
|
-
</dl>
|
|
73
|
-
|
|
74
|
-
</dd>
|
|
75
|
-
</dl>
|
|
76
|
-
</details>
|
|
77
|
-
|
|
78
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createOrUpdateUser</a>({ ...params }) -> AirweaveSDK.User</code></summary>
|
|
79
|
-
<dl>
|
|
80
|
-
<dd>
|
|
81
|
-
|
|
82
|
-
#### 📝 Description
|
|
83
|
-
|
|
84
|
-
<dl>
|
|
85
|
-
<dd>
|
|
86
|
-
|
|
87
|
-
<dl>
|
|
88
|
-
<dd>
|
|
89
|
-
|
|
90
|
-
Create new user in database if it does not exist.
|
|
65
|
+
**id:** `string`
|
|
91
66
|
|
|
92
|
-
Can only create user with the same email as the authenticated user.
|
|
93
|
-
|
|
94
|
-
Args:
|
|
95
|
-
user_data (schemas.UserCreate): The user object to be created.
|
|
96
|
-
db (AsyncSession): Database session dependency to handle database operations.
|
|
97
|
-
auth0_user (Auth0User): Authenticated auth0 user.
|
|
98
|
-
|
|
99
|
-
Returns:
|
|
100
|
-
schemas.User: The created user object.
|
|
101
|
-
|
|
102
|
-
Raises:
|
|
103
|
-
HTTPException: If the user is not authorized to create this user.
|
|
104
|
-
|
|
105
|
-
</dd>
|
|
106
|
-
</dl>
|
|
107
|
-
</dd>
|
|
108
|
-
</dl>
|
|
109
|
-
|
|
110
|
-
#### 🔌 Usage
|
|
111
|
-
|
|
112
|
-
<dl>
|
|
113
|
-
<dd>
|
|
114
|
-
|
|
115
|
-
<dl>
|
|
116
|
-
<dd>
|
|
117
|
-
|
|
118
|
-
```typescript
|
|
119
|
-
await client.users.createOrUpdateUser({
|
|
120
|
-
creds: "creds",
|
|
121
|
-
email: "email",
|
|
122
|
-
fullName: undefined,
|
|
123
|
-
organizationId: undefined,
|
|
124
|
-
});
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
</dd>
|
|
128
|
-
</dl>
|
|
129
67
|
</dd>
|
|
130
68
|
</dl>
|
|
131
69
|
|
|
132
|
-
#### ⚙️ Parameters
|
|
133
|
-
|
|
134
|
-
<dl>
|
|
135
|
-
<dd>
|
|
136
|
-
|
|
137
70
|
<dl>
|
|
138
71
|
<dd>
|
|
139
72
|
|
|
140
|
-
**request:** `AirweaveSDK.
|
|
73
|
+
**request:** `AirweaveSDK.ReadApiKeyApiKeysIdGetRequest`
|
|
141
74
|
|
|
142
75
|
</dd>
|
|
143
76
|
</dl>
|
|
@@ -145,7 +78,7 @@ await client.users.createOrUpdateUser({
|
|
|
145
78
|
<dl>
|
|
146
79
|
<dd>
|
|
147
80
|
|
|
148
|
-
**requestOptions:** `
|
|
81
|
+
**requestOptions:** `ApiKeys.RequestOptions`
|
|
149
82
|
|
|
150
83
|
</dd>
|
|
151
84
|
</dl>
|
|
@@ -315,165 +248,6 @@ await client.sources.readSources({
|
|
|
315
248
|
</dl>
|
|
316
249
|
</details>
|
|
317
250
|
|
|
318
|
-
## Destinations
|
|
319
|
-
|
|
320
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>({ ...params }) -> AirweaveSDK.Destination[]</code></summary>
|
|
321
|
-
<dl>
|
|
322
|
-
<dd>
|
|
323
|
-
|
|
324
|
-
#### 📝 Description
|
|
325
|
-
|
|
326
|
-
<dl>
|
|
327
|
-
<dd>
|
|
328
|
-
|
|
329
|
-
<dl>
|
|
330
|
-
<dd>
|
|
331
|
-
|
|
332
|
-
Get all available destinations.
|
|
333
|
-
|
|
334
|
-
## Args:
|
|
335
|
-
|
|
336
|
-
db: The database session
|
|
337
|
-
user: The current user
|
|
338
|
-
|
|
339
|
-
## Returns:
|
|
340
|
-
|
|
341
|
-
List[schemas.Destination]: A list of destinations
|
|
342
|
-
|
|
343
|
-
</dd>
|
|
344
|
-
</dl>
|
|
345
|
-
</dd>
|
|
346
|
-
</dl>
|
|
347
|
-
|
|
348
|
-
#### 🔌 Usage
|
|
349
|
-
|
|
350
|
-
<dl>
|
|
351
|
-
<dd>
|
|
352
|
-
|
|
353
|
-
<dl>
|
|
354
|
-
<dd>
|
|
355
|
-
|
|
356
|
-
```typescript
|
|
357
|
-
await client.destinations.listDestinations({
|
|
358
|
-
creds: "creds",
|
|
359
|
-
});
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
</dd>
|
|
363
|
-
</dl>
|
|
364
|
-
</dd>
|
|
365
|
-
</dl>
|
|
366
|
-
|
|
367
|
-
#### ⚙️ Parameters
|
|
368
|
-
|
|
369
|
-
<dl>
|
|
370
|
-
<dd>
|
|
371
|
-
|
|
372
|
-
<dl>
|
|
373
|
-
<dd>
|
|
374
|
-
|
|
375
|
-
**request:** `AirweaveSDK.ListDestinationsDestinationsListGetRequest`
|
|
376
|
-
|
|
377
|
-
</dd>
|
|
378
|
-
</dl>
|
|
379
|
-
|
|
380
|
-
<dl>
|
|
381
|
-
<dd>
|
|
382
|
-
|
|
383
|
-
**requestOptions:** `Destinations.RequestOptions`
|
|
384
|
-
|
|
385
|
-
</dd>
|
|
386
|
-
</dl>
|
|
387
|
-
</dd>
|
|
388
|
-
</dl>
|
|
389
|
-
|
|
390
|
-
</dd>
|
|
391
|
-
</dl>
|
|
392
|
-
</details>
|
|
393
|
-
|
|
394
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">readDestination</a>(shortName, { ...params }) -> AirweaveSDK.DestinationWithConfigFields</code></summary>
|
|
395
|
-
<dl>
|
|
396
|
-
<dd>
|
|
397
|
-
|
|
398
|
-
#### 📝 Description
|
|
399
|
-
|
|
400
|
-
<dl>
|
|
401
|
-
<dd>
|
|
402
|
-
|
|
403
|
-
<dl>
|
|
404
|
-
<dd>
|
|
405
|
-
|
|
406
|
-
Get destination by short name.
|
|
407
|
-
|
|
408
|
-
## Args:
|
|
409
|
-
|
|
410
|
-
db: The database session
|
|
411
|
-
short_name: The short name of the destination
|
|
412
|
-
user: The current user
|
|
413
|
-
|
|
414
|
-
## Returns:
|
|
415
|
-
|
|
416
|
-
destination (schemas.Destination): The destination
|
|
417
|
-
|
|
418
|
-
</dd>
|
|
419
|
-
</dl>
|
|
420
|
-
</dd>
|
|
421
|
-
</dl>
|
|
422
|
-
|
|
423
|
-
#### 🔌 Usage
|
|
424
|
-
|
|
425
|
-
<dl>
|
|
426
|
-
<dd>
|
|
427
|
-
|
|
428
|
-
<dl>
|
|
429
|
-
<dd>
|
|
430
|
-
|
|
431
|
-
```typescript
|
|
432
|
-
await client.destinations.readDestination("short_name", {
|
|
433
|
-
creds: "creds",
|
|
434
|
-
});
|
|
435
|
-
```
|
|
436
|
-
|
|
437
|
-
</dd>
|
|
438
|
-
</dl>
|
|
439
|
-
</dd>
|
|
440
|
-
</dl>
|
|
441
|
-
|
|
442
|
-
#### ⚙️ Parameters
|
|
443
|
-
|
|
444
|
-
<dl>
|
|
445
|
-
<dd>
|
|
446
|
-
|
|
447
|
-
<dl>
|
|
448
|
-
<dd>
|
|
449
|
-
|
|
450
|
-
**shortName:** `string`
|
|
451
|
-
|
|
452
|
-
</dd>
|
|
453
|
-
</dl>
|
|
454
|
-
|
|
455
|
-
<dl>
|
|
456
|
-
<dd>
|
|
457
|
-
|
|
458
|
-
**request:** `AirweaveSDK.ReadDestinationDestinationsDetailShortNameGetRequest`
|
|
459
|
-
|
|
460
|
-
</dd>
|
|
461
|
-
</dl>
|
|
462
|
-
|
|
463
|
-
<dl>
|
|
464
|
-
<dd>
|
|
465
|
-
|
|
466
|
-
**requestOptions:** `Destinations.RequestOptions`
|
|
467
|
-
|
|
468
|
-
</dd>
|
|
469
|
-
</dl>
|
|
470
|
-
</dd>
|
|
471
|
-
</dl>
|
|
472
|
-
|
|
473
|
-
</dd>
|
|
474
|
-
</dl>
|
|
475
|
-
</details>
|
|
476
|
-
|
|
477
251
|
## EmbeddingModels
|
|
478
252
|
|
|
479
253
|
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName, { ...params }) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
|
|
@@ -1235,7 +1009,7 @@ await client.connections.disconnectSourceConnection("connection_id", {
|
|
|
1235
1009
|
</dl>
|
|
1236
1010
|
</details>
|
|
1237
1011
|
|
|
1238
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
1012
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2WhiteLabelCode</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1239
1013
|
<dl>
|
|
1240
1014
|
<dd>
|
|
1241
1015
|
|
|
@@ -1247,20 +1021,15 @@ await client.connections.disconnectSourceConnection("connection_id", {
|
|
|
1247
1021
|
<dl>
|
|
1248
1022
|
<dd>
|
|
1249
1023
|
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
This will:
|
|
1253
|
-
|
|
1254
|
-
1. Get the OAuth2 settings for the source
|
|
1255
|
-
2. Exchange the authorization code for a token
|
|
1256
|
-
3. Create an integration credential with the token
|
|
1024
|
+
Exchange the OAuth2 authorization code for a white label integration.
|
|
1257
1025
|
|
|
1258
1026
|
## Args:
|
|
1259
1027
|
|
|
1260
1028
|
db: The database session
|
|
1261
|
-
|
|
1029
|
+
white_label_id: The ID of the white label integration
|
|
1262
1030
|
code: The authorization code
|
|
1263
1031
|
user: The current user
|
|
1032
|
+
background_tasks: The background tasks
|
|
1264
1033
|
|
|
1265
1034
|
## Returns:
|
|
1266
1035
|
|
|
@@ -1280,10 +1049,9 @@ This will:
|
|
|
1280
1049
|
<dd>
|
|
1281
1050
|
|
|
1282
1051
|
```typescript
|
|
1283
|
-
await client.connections.
|
|
1052
|
+
await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
1284
1053
|
creds: "creds",
|
|
1285
|
-
|
|
1286
|
-
code: "code",
|
|
1054
|
+
body: "string",
|
|
1287
1055
|
});
|
|
1288
1056
|
```
|
|
1289
1057
|
|
|
@@ -1300,7 +1068,15 @@ await client.connections.sendOauth2Code({
|
|
|
1300
1068
|
<dl>
|
|
1301
1069
|
<dd>
|
|
1302
1070
|
|
|
1303
|
-
**
|
|
1071
|
+
**whiteLabelId:** `string`
|
|
1072
|
+
|
|
1073
|
+
</dd>
|
|
1074
|
+
</dl>
|
|
1075
|
+
|
|
1076
|
+
<dl>
|
|
1077
|
+
<dd>
|
|
1078
|
+
|
|
1079
|
+
**request:** `AirweaveSDK.SendOauth2WhiteLabelCodeConnectionsOauth2WhiteLabelWhiteLabelIdCodePostRequest`
|
|
1304
1080
|
|
|
1305
1081
|
</dd>
|
|
1306
1082
|
</dl>
|
|
@@ -1319,7 +1095,7 @@ await client.connections.sendOauth2Code({
|
|
|
1319
1095
|
</dl>
|
|
1320
1096
|
</details>
|
|
1321
1097
|
|
|
1322
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
1098
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2WhiteLabelAuthUrl</a>(whiteLabelId, { ...params }) -> string</code></summary>
|
|
1323
1099
|
<dl>
|
|
1324
1100
|
<dd>
|
|
1325
1101
|
|
|
@@ -1331,19 +1107,17 @@ await client.connections.sendOauth2Code({
|
|
|
1331
1107
|
<dl>
|
|
1332
1108
|
<dd>
|
|
1333
1109
|
|
|
1334
|
-
|
|
1110
|
+
Get the OAuth2 authorization URL for a white label integration.
|
|
1335
1111
|
|
|
1336
1112
|
## Args:
|
|
1337
1113
|
|
|
1338
1114
|
db: The database session
|
|
1339
1115
|
white_label_id: The ID of the white label integration
|
|
1340
|
-
code: The authorization code
|
|
1341
1116
|
user: The current user
|
|
1342
|
-
background_tasks: The background tasks
|
|
1343
1117
|
|
|
1344
1118
|
## Returns:
|
|
1345
1119
|
|
|
1346
|
-
|
|
1120
|
+
str: The OAuth2 authorization URL
|
|
1347
1121
|
|
|
1348
1122
|
</dd>
|
|
1349
1123
|
</dl>
|
|
@@ -1359,9 +1133,8 @@ Exchange the OAuth2 authorization code for a white label integration.
|
|
|
1359
1133
|
<dd>
|
|
1360
1134
|
|
|
1361
1135
|
```typescript
|
|
1362
|
-
await client.connections.
|
|
1136
|
+
await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id", {
|
|
1363
1137
|
creds: "creds",
|
|
1364
|
-
body: "string",
|
|
1365
1138
|
});
|
|
1366
1139
|
```
|
|
1367
1140
|
|
|
@@ -1386,7 +1159,7 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1386
1159
|
<dl>
|
|
1387
1160
|
<dd>
|
|
1388
1161
|
|
|
1389
|
-
**request:** `AirweaveSDK.
|
|
1162
|
+
**request:** `AirweaveSDK.GetOauth2WhiteLabelAuthUrlConnectionsOauth2WhiteLabelWhiteLabelIdAuthUrlGetRequest`
|
|
1390
1163
|
|
|
1391
1164
|
</dd>
|
|
1392
1165
|
</dl>
|
|
@@ -1405,7 +1178,9 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1405
1178
|
</dl>
|
|
1406
1179
|
</details>
|
|
1407
1180
|
|
|
1408
|
-
|
|
1181
|
+
## Sync
|
|
1182
|
+
|
|
1183
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1409
1184
|
<dl>
|
|
1410
1185
|
<dd>
|
|
1411
1186
|
|
|
@@ -1417,17 +1192,19 @@ await client.connections.sendOauth2WhiteLabelCode("white_label_id", {
|
|
|
1417
1192
|
<dl>
|
|
1418
1193
|
<dd>
|
|
1419
1194
|
|
|
1420
|
-
|
|
1195
|
+
List all syncs for the current user.
|
|
1421
1196
|
|
|
1422
1197
|
## Args:
|
|
1423
1198
|
|
|
1424
1199
|
db: The database session
|
|
1425
|
-
|
|
1200
|
+
skip: The number of syncs to skip
|
|
1201
|
+
limit: The number of syncs to return
|
|
1202
|
+
with_source_connection: Whether to include the source connection in the response
|
|
1426
1203
|
user: The current user
|
|
1427
1204
|
|
|
1428
1205
|
## Returns:
|
|
1429
1206
|
|
|
1430
|
-
|
|
1207
|
+
list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
|
|
1431
1208
|
|
|
1432
1209
|
</dd>
|
|
1433
1210
|
</dl>
|
|
@@ -1443,7 +1220,7 @@ Get the OAuth2 authorization URL for a white label integration.
|
|
|
1443
1220
|
<dd>
|
|
1444
1221
|
|
|
1445
1222
|
```typescript
|
|
1446
|
-
await client.
|
|
1223
|
+
await client.sync.listSyncs({
|
|
1447
1224
|
creds: "creds",
|
|
1448
1225
|
});
|
|
1449
1226
|
```
|
|
@@ -1461,7 +1238,7 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id", {
|
|
|
1461
1238
|
<dl>
|
|
1462
1239
|
<dd>
|
|
1463
1240
|
|
|
1464
|
-
**
|
|
1241
|
+
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1465
1242
|
|
|
1466
1243
|
</dd>
|
|
1467
1244
|
</dl>
|
|
@@ -1469,97 +1246,10 @@ await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id", {
|
|
|
1469
1246
|
<dl>
|
|
1470
1247
|
<dd>
|
|
1471
1248
|
|
|
1472
|
-
**
|
|
1249
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
1473
1250
|
|
|
1474
|
-
</dd>
|
|
1475
|
-
</dl>
|
|
1476
|
-
|
|
1477
|
-
<dl>
|
|
1478
|
-
<dd>
|
|
1479
|
-
|
|
1480
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1481
|
-
|
|
1482
|
-
</dd>
|
|
1483
|
-
</dl>
|
|
1484
|
-
</dd>
|
|
1485
|
-
</dl>
|
|
1486
|
-
|
|
1487
|
-
</dd>
|
|
1488
|
-
</dl>
|
|
1489
|
-
</details>
|
|
1490
|
-
|
|
1491
|
-
## Sync
|
|
1492
|
-
|
|
1493
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1494
|
-
<dl>
|
|
1495
|
-
<dd>
|
|
1496
|
-
|
|
1497
|
-
#### 📝 Description
|
|
1498
|
-
|
|
1499
|
-
<dl>
|
|
1500
|
-
<dd>
|
|
1501
|
-
|
|
1502
|
-
<dl>
|
|
1503
|
-
<dd>
|
|
1504
|
-
|
|
1505
|
-
List all syncs for the current user.
|
|
1506
|
-
|
|
1507
|
-
## Args:
|
|
1508
|
-
|
|
1509
|
-
db: The database session
|
|
1510
|
-
skip: The number of syncs to skip
|
|
1511
|
-
limit: The number of syncs to return
|
|
1512
|
-
with_source_connection: Whether to include the source connection in the response
|
|
1513
|
-
user: The current user
|
|
1514
|
-
|
|
1515
|
-
## Returns:
|
|
1516
|
-
|
|
1517
|
-
list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
|
|
1518
|
-
|
|
1519
|
-
</dd>
|
|
1520
|
-
</dl>
|
|
1521
|
-
</dd>
|
|
1522
|
-
</dl>
|
|
1523
|
-
|
|
1524
|
-
#### 🔌 Usage
|
|
1525
|
-
|
|
1526
|
-
<dl>
|
|
1527
|
-
<dd>
|
|
1528
|
-
|
|
1529
|
-
<dl>
|
|
1530
|
-
<dd>
|
|
1531
|
-
|
|
1532
|
-
```typescript
|
|
1533
|
-
await client.sync.listSyncs({
|
|
1534
|
-
creds: "creds",
|
|
1535
|
-
});
|
|
1536
|
-
```
|
|
1537
|
-
|
|
1538
|
-
</dd>
|
|
1539
|
-
</dl>
|
|
1540
|
-
</dd>
|
|
1541
|
-
</dl>
|
|
1542
|
-
|
|
1543
|
-
#### ⚙️ Parameters
|
|
1544
|
-
|
|
1545
|
-
<dl>
|
|
1546
|
-
<dd>
|
|
1547
|
-
|
|
1548
|
-
<dl>
|
|
1549
|
-
<dd>
|
|
1550
|
-
|
|
1551
|
-
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1552
|
-
|
|
1553
|
-
</dd>
|
|
1554
|
-
</dl>
|
|
1555
|
-
|
|
1556
|
-
<dl>
|
|
1557
|
-
<dd>
|
|
1558
|
-
|
|
1559
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1560
|
-
|
|
1561
|
-
</dd>
|
|
1562
|
-
</dl>
|
|
1251
|
+
</dd>
|
|
1252
|
+
</dl>
|
|
1563
1253
|
</dd>
|
|
1564
1254
|
</dl>
|
|
1565
1255
|
|
|
@@ -1674,6 +1364,7 @@ List all sync jobs across all syncs.
|
|
|
1674
1364
|
db: The database session
|
|
1675
1365
|
skip: The number of jobs to skip
|
|
1676
1366
|
limit: The number of jobs to return
|
|
1367
|
+
status: Filter by job status
|
|
1677
1368
|
user: The current user
|
|
1678
1369
|
|
|
1679
1370
|
## Returns:
|
|
@@ -3135,792 +2826,3 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id", {
|
|
|
3135
2826
|
</dd>
|
|
3136
2827
|
</dl>
|
|
3137
2828
|
</details>
|
|
3138
|
-
|
|
3139
|
-
## Entities
|
|
3140
|
-
|
|
3141
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityDefinitions</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3142
|
-
<dl>
|
|
3143
|
-
<dd>
|
|
3144
|
-
|
|
3145
|
-
#### 📝 Description
|
|
3146
|
-
|
|
3147
|
-
<dl>
|
|
3148
|
-
<dd>
|
|
3149
|
-
|
|
3150
|
-
<dl>
|
|
3151
|
-
<dd>
|
|
3152
|
-
|
|
3153
|
-
List all entity definitions for the current user's organization.
|
|
3154
|
-
|
|
3155
|
-
</dd>
|
|
3156
|
-
</dl>
|
|
3157
|
-
</dd>
|
|
3158
|
-
</dl>
|
|
3159
|
-
|
|
3160
|
-
#### 🔌 Usage
|
|
3161
|
-
|
|
3162
|
-
<dl>
|
|
3163
|
-
<dd>
|
|
3164
|
-
|
|
3165
|
-
<dl>
|
|
3166
|
-
<dd>
|
|
3167
|
-
|
|
3168
|
-
```typescript
|
|
3169
|
-
await client.entities.listEntityDefinitions({
|
|
3170
|
-
creds: "creds",
|
|
3171
|
-
});
|
|
3172
|
-
```
|
|
3173
|
-
|
|
3174
|
-
</dd>
|
|
3175
|
-
</dl>
|
|
3176
|
-
</dd>
|
|
3177
|
-
</dl>
|
|
3178
|
-
|
|
3179
|
-
#### ⚙️ Parameters
|
|
3180
|
-
|
|
3181
|
-
<dl>
|
|
3182
|
-
<dd>
|
|
3183
|
-
|
|
3184
|
-
<dl>
|
|
3185
|
-
<dd>
|
|
3186
|
-
|
|
3187
|
-
**request:** `AirweaveSDK.ListEntityDefinitionsEntitiesDefinitionsGetRequest`
|
|
3188
|
-
|
|
3189
|
-
</dd>
|
|
3190
|
-
</dl>
|
|
3191
|
-
|
|
3192
|
-
<dl>
|
|
3193
|
-
<dd>
|
|
3194
|
-
|
|
3195
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3196
|
-
|
|
3197
|
-
</dd>
|
|
3198
|
-
</dl>
|
|
3199
|
-
</dd>
|
|
3200
|
-
</dl>
|
|
3201
|
-
|
|
3202
|
-
</dd>
|
|
3203
|
-
</dl>
|
|
3204
|
-
</details>
|
|
3205
|
-
|
|
3206
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityDefinition</a>({ ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
|
|
3207
|
-
<dl>
|
|
3208
|
-
<dd>
|
|
3209
|
-
|
|
3210
|
-
#### 📝 Description
|
|
3211
|
-
|
|
3212
|
-
<dl>
|
|
3213
|
-
<dd>
|
|
3214
|
-
|
|
3215
|
-
<dl>
|
|
3216
|
-
<dd>
|
|
3217
|
-
|
|
3218
|
-
Create a new entity definition.
|
|
3219
|
-
|
|
3220
|
-
</dd>
|
|
3221
|
-
</dl>
|
|
3222
|
-
</dd>
|
|
3223
|
-
</dl>
|
|
3224
|
-
|
|
3225
|
-
#### 🔌 Usage
|
|
3226
|
-
|
|
3227
|
-
<dl>
|
|
3228
|
-
<dd>
|
|
3229
|
-
|
|
3230
|
-
<dl>
|
|
3231
|
-
<dd>
|
|
3232
|
-
|
|
3233
|
-
```typescript
|
|
3234
|
-
await client.entities.createEntityDefinition({
|
|
3235
|
-
creds: "creds",
|
|
3236
|
-
name: "name",
|
|
3237
|
-
description: undefined,
|
|
3238
|
-
type: "file",
|
|
3239
|
-
entitySchema: ["entity_schema", "entity_schema"],
|
|
3240
|
-
parentId: undefined,
|
|
3241
|
-
moduleName: "module_name",
|
|
3242
|
-
className: "class_name",
|
|
3243
|
-
});
|
|
3244
|
-
```
|
|
3245
|
-
|
|
3246
|
-
</dd>
|
|
3247
|
-
</dl>
|
|
3248
|
-
</dd>
|
|
3249
|
-
</dl>
|
|
3250
|
-
|
|
3251
|
-
#### ⚙️ Parameters
|
|
3252
|
-
|
|
3253
|
-
<dl>
|
|
3254
|
-
<dd>
|
|
3255
|
-
|
|
3256
|
-
<dl>
|
|
3257
|
-
<dd>
|
|
3258
|
-
|
|
3259
|
-
**request:** `AirweaveSDK.EntityDefinitionCreate`
|
|
3260
|
-
|
|
3261
|
-
</dd>
|
|
3262
|
-
</dl>
|
|
3263
|
-
|
|
3264
|
-
<dl>
|
|
3265
|
-
<dd>
|
|
3266
|
-
|
|
3267
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3268
|
-
|
|
3269
|
-
</dd>
|
|
3270
|
-
</dl>
|
|
3271
|
-
</dd>
|
|
3272
|
-
</dl>
|
|
3273
|
-
|
|
3274
|
-
</dd>
|
|
3275
|
-
</dl>
|
|
3276
|
-
</details>
|
|
3277
|
-
|
|
3278
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntityDefinition</a>(definitionId, { ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
|
|
3279
|
-
<dl>
|
|
3280
|
-
<dd>
|
|
3281
|
-
|
|
3282
|
-
#### 📝 Description
|
|
3283
|
-
|
|
3284
|
-
<dl>
|
|
3285
|
-
<dd>
|
|
3286
|
-
|
|
3287
|
-
<dl>
|
|
3288
|
-
<dd>
|
|
3289
|
-
|
|
3290
|
-
Update an entity definition.
|
|
3291
|
-
|
|
3292
|
-
</dd>
|
|
3293
|
-
</dl>
|
|
3294
|
-
</dd>
|
|
3295
|
-
</dl>
|
|
3296
|
-
|
|
3297
|
-
#### 🔌 Usage
|
|
3298
|
-
|
|
3299
|
-
<dl>
|
|
3300
|
-
<dd>
|
|
3301
|
-
|
|
3302
|
-
<dl>
|
|
3303
|
-
<dd>
|
|
3304
|
-
|
|
3305
|
-
```typescript
|
|
3306
|
-
await client.entities.updateEntityDefinition("definition_id", {
|
|
3307
|
-
creds: "creds",
|
|
3308
|
-
name: "name",
|
|
3309
|
-
description: undefined,
|
|
3310
|
-
type: "file",
|
|
3311
|
-
entitySchema: ["entity_schema", "entity_schema"],
|
|
3312
|
-
parentId: undefined,
|
|
3313
|
-
moduleName: "module_name",
|
|
3314
|
-
className: "class_name",
|
|
3315
|
-
});
|
|
3316
|
-
```
|
|
3317
|
-
|
|
3318
|
-
</dd>
|
|
3319
|
-
</dl>
|
|
3320
|
-
</dd>
|
|
3321
|
-
</dl>
|
|
3322
|
-
|
|
3323
|
-
#### ⚙️ Parameters
|
|
3324
|
-
|
|
3325
|
-
<dl>
|
|
3326
|
-
<dd>
|
|
3327
|
-
|
|
3328
|
-
<dl>
|
|
3329
|
-
<dd>
|
|
3330
|
-
|
|
3331
|
-
**definitionId:** `string`
|
|
3332
|
-
|
|
3333
|
-
</dd>
|
|
3334
|
-
</dl>
|
|
3335
|
-
|
|
3336
|
-
<dl>
|
|
3337
|
-
<dd>
|
|
3338
|
-
|
|
3339
|
-
**request:** `AirweaveSDK.EntityDefinitionUpdate`
|
|
3340
|
-
|
|
3341
|
-
</dd>
|
|
3342
|
-
</dl>
|
|
3343
|
-
|
|
3344
|
-
<dl>
|
|
3345
|
-
<dd>
|
|
3346
|
-
|
|
3347
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3348
|
-
|
|
3349
|
-
</dd>
|
|
3350
|
-
</dl>
|
|
3351
|
-
</dd>
|
|
3352
|
-
</dl>
|
|
3353
|
-
|
|
3354
|
-
</dd>
|
|
3355
|
-
</dl>
|
|
3356
|
-
</details>
|
|
3357
|
-
|
|
3358
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityRelations</a>({ ...params }) -> AirweaveSDK.EntityRelation[]</code></summary>
|
|
3359
|
-
<dl>
|
|
3360
|
-
<dd>
|
|
3361
|
-
|
|
3362
|
-
#### 📝 Description
|
|
3363
|
-
|
|
3364
|
-
<dl>
|
|
3365
|
-
<dd>
|
|
3366
|
-
|
|
3367
|
-
<dl>
|
|
3368
|
-
<dd>
|
|
3369
|
-
|
|
3370
|
-
List all entity relations for the current user's organization.
|
|
3371
|
-
|
|
3372
|
-
</dd>
|
|
3373
|
-
</dl>
|
|
3374
|
-
</dd>
|
|
3375
|
-
</dl>
|
|
3376
|
-
|
|
3377
|
-
#### 🔌 Usage
|
|
3378
|
-
|
|
3379
|
-
<dl>
|
|
3380
|
-
<dd>
|
|
3381
|
-
|
|
3382
|
-
<dl>
|
|
3383
|
-
<dd>
|
|
3384
|
-
|
|
3385
|
-
```typescript
|
|
3386
|
-
await client.entities.listEntityRelations({
|
|
3387
|
-
creds: "creds",
|
|
3388
|
-
});
|
|
3389
|
-
```
|
|
3390
|
-
|
|
3391
|
-
</dd>
|
|
3392
|
-
</dl>
|
|
3393
|
-
</dd>
|
|
3394
|
-
</dl>
|
|
3395
|
-
|
|
3396
|
-
#### ⚙️ Parameters
|
|
3397
|
-
|
|
3398
|
-
<dl>
|
|
3399
|
-
<dd>
|
|
3400
|
-
|
|
3401
|
-
<dl>
|
|
3402
|
-
<dd>
|
|
3403
|
-
|
|
3404
|
-
**request:** `AirweaveSDK.ListEntityRelationsEntitiesRelationsGetRequest`
|
|
3405
|
-
|
|
3406
|
-
</dd>
|
|
3407
|
-
</dl>
|
|
3408
|
-
|
|
3409
|
-
<dl>
|
|
3410
|
-
<dd>
|
|
3411
|
-
|
|
3412
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3413
|
-
|
|
3414
|
-
</dd>
|
|
3415
|
-
</dl>
|
|
3416
|
-
</dd>
|
|
3417
|
-
</dl>
|
|
3418
|
-
|
|
3419
|
-
</dd>
|
|
3420
|
-
</dl>
|
|
3421
|
-
</details>
|
|
3422
|
-
|
|
3423
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityRelation</a>({ ...params }) -> AirweaveSDK.EntityRelation</code></summary>
|
|
3424
|
-
<dl>
|
|
3425
|
-
<dd>
|
|
3426
|
-
|
|
3427
|
-
#### 📝 Description
|
|
3428
|
-
|
|
3429
|
-
<dl>
|
|
3430
|
-
<dd>
|
|
3431
|
-
|
|
3432
|
-
<dl>
|
|
3433
|
-
<dd>
|
|
3434
|
-
|
|
3435
|
-
Create a new entity relation.
|
|
3436
|
-
|
|
3437
|
-
</dd>
|
|
3438
|
-
</dl>
|
|
3439
|
-
</dd>
|
|
3440
|
-
</dl>
|
|
3441
|
-
|
|
3442
|
-
#### 🔌 Usage
|
|
3443
|
-
|
|
3444
|
-
<dl>
|
|
3445
|
-
<dd>
|
|
3446
|
-
|
|
3447
|
-
<dl>
|
|
3448
|
-
<dd>
|
|
3449
|
-
|
|
3450
|
-
```typescript
|
|
3451
|
-
await client.entities.createEntityRelation({
|
|
3452
|
-
creds: "creds",
|
|
3453
|
-
name: "name",
|
|
3454
|
-
description: undefined,
|
|
3455
|
-
fromEntityId: "from_entity_id",
|
|
3456
|
-
toEntityId: "to_entity_id",
|
|
3457
|
-
});
|
|
3458
|
-
```
|
|
3459
|
-
|
|
3460
|
-
</dd>
|
|
3461
|
-
</dl>
|
|
3462
|
-
</dd>
|
|
3463
|
-
</dl>
|
|
3464
|
-
|
|
3465
|
-
#### ⚙️ Parameters
|
|
3466
|
-
|
|
3467
|
-
<dl>
|
|
3468
|
-
<dd>
|
|
3469
|
-
|
|
3470
|
-
<dl>
|
|
3471
|
-
<dd>
|
|
3472
|
-
|
|
3473
|
-
**request:** `AirweaveSDK.EntityRelationCreate`
|
|
3474
|
-
|
|
3475
|
-
</dd>
|
|
3476
|
-
</dl>
|
|
3477
|
-
|
|
3478
|
-
<dl>
|
|
3479
|
-
<dd>
|
|
3480
|
-
|
|
3481
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3482
|
-
|
|
3483
|
-
</dd>
|
|
3484
|
-
</dl>
|
|
3485
|
-
</dd>
|
|
3486
|
-
</dl>
|
|
3487
|
-
|
|
3488
|
-
</dd>
|
|
3489
|
-
</dl>
|
|
3490
|
-
</details>
|
|
3491
|
-
|
|
3492
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntityRelation</a>(relationId, { ...params }) -> AirweaveSDK.EntityRelation</code></summary>
|
|
3493
|
-
<dl>
|
|
3494
|
-
<dd>
|
|
3495
|
-
|
|
3496
|
-
#### 📝 Description
|
|
3497
|
-
|
|
3498
|
-
<dl>
|
|
3499
|
-
<dd>
|
|
3500
|
-
|
|
3501
|
-
<dl>
|
|
3502
|
-
<dd>
|
|
3503
|
-
|
|
3504
|
-
Update an entity relation.
|
|
3505
|
-
|
|
3506
|
-
</dd>
|
|
3507
|
-
</dl>
|
|
3508
|
-
</dd>
|
|
3509
|
-
</dl>
|
|
3510
|
-
|
|
3511
|
-
#### 🔌 Usage
|
|
3512
|
-
|
|
3513
|
-
<dl>
|
|
3514
|
-
<dd>
|
|
3515
|
-
|
|
3516
|
-
<dl>
|
|
3517
|
-
<dd>
|
|
3518
|
-
|
|
3519
|
-
```typescript
|
|
3520
|
-
await client.entities.updateEntityRelation("relation_id", {
|
|
3521
|
-
creds: "creds",
|
|
3522
|
-
name: "name",
|
|
3523
|
-
description: undefined,
|
|
3524
|
-
fromEntityId: "from_entity_id",
|
|
3525
|
-
toEntityId: "to_entity_id",
|
|
3526
|
-
});
|
|
3527
|
-
```
|
|
3528
|
-
|
|
3529
|
-
</dd>
|
|
3530
|
-
</dl>
|
|
3531
|
-
</dd>
|
|
3532
|
-
</dl>
|
|
3533
|
-
|
|
3534
|
-
#### ⚙️ Parameters
|
|
3535
|
-
|
|
3536
|
-
<dl>
|
|
3537
|
-
<dd>
|
|
3538
|
-
|
|
3539
|
-
<dl>
|
|
3540
|
-
<dd>
|
|
3541
|
-
|
|
3542
|
-
**relationId:** `string`
|
|
3543
|
-
|
|
3544
|
-
</dd>
|
|
3545
|
-
</dl>
|
|
3546
|
-
|
|
3547
|
-
<dl>
|
|
3548
|
-
<dd>
|
|
3549
|
-
|
|
3550
|
-
**request:** `AirweaveSDK.EntityRelationUpdate`
|
|
3551
|
-
|
|
3552
|
-
</dd>
|
|
3553
|
-
</dl>
|
|
3554
|
-
|
|
3555
|
-
<dl>
|
|
3556
|
-
<dd>
|
|
3557
|
-
|
|
3558
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3559
|
-
|
|
3560
|
-
</dd>
|
|
3561
|
-
</dl>
|
|
3562
|
-
</dd>
|
|
3563
|
-
</dl>
|
|
3564
|
-
|
|
3565
|
-
</dd>
|
|
3566
|
-
</dl>
|
|
3567
|
-
</details>
|
|
3568
|
-
|
|
3569
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsByIds</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3570
|
-
<dl>
|
|
3571
|
-
<dd>
|
|
3572
|
-
|
|
3573
|
-
#### 📝 Description
|
|
3574
|
-
|
|
3575
|
-
<dl>
|
|
3576
|
-
<dd>
|
|
3577
|
-
|
|
3578
|
-
<dl>
|
|
3579
|
-
<dd>
|
|
3580
|
-
|
|
3581
|
-
Get multiple entity definitions by their IDs.
|
|
3582
|
-
|
|
3583
|
-
Args:
|
|
3584
|
-
ids: List of entity definition IDs to fetch
|
|
3585
|
-
db: Database session
|
|
3586
|
-
current_user: Current authenticated user
|
|
3587
|
-
|
|
3588
|
-
Returns:
|
|
3589
|
-
List of entity definitions matching the provided IDs
|
|
3590
|
-
|
|
3591
|
-
</dd>
|
|
3592
|
-
</dl>
|
|
3593
|
-
</dd>
|
|
3594
|
-
</dl>
|
|
3595
|
-
|
|
3596
|
-
#### 🔌 Usage
|
|
3597
|
-
|
|
3598
|
-
<dl>
|
|
3599
|
-
<dd>
|
|
3600
|
-
|
|
3601
|
-
<dl>
|
|
3602
|
-
<dd>
|
|
3603
|
-
|
|
3604
|
-
```typescript
|
|
3605
|
-
await client.entities.getEntityDefinitionsByIds({
|
|
3606
|
-
creds: "creds",
|
|
3607
|
-
body: ["string", "string"],
|
|
3608
|
-
});
|
|
3609
|
-
```
|
|
3610
|
-
|
|
3611
|
-
</dd>
|
|
3612
|
-
</dl>
|
|
3613
|
-
</dd>
|
|
3614
|
-
</dl>
|
|
3615
|
-
|
|
3616
|
-
#### ⚙️ Parameters
|
|
3617
|
-
|
|
3618
|
-
<dl>
|
|
3619
|
-
<dd>
|
|
3620
|
-
|
|
3621
|
-
<dl>
|
|
3622
|
-
<dd>
|
|
3623
|
-
|
|
3624
|
-
**request:** `AirweaveSDK.GetEntityDefinitionsByIdsEntitiesDefinitionsByIdsPostRequest`
|
|
3625
|
-
|
|
3626
|
-
</dd>
|
|
3627
|
-
</dl>
|
|
3628
|
-
|
|
3629
|
-
<dl>
|
|
3630
|
-
<dd>
|
|
3631
|
-
|
|
3632
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3633
|
-
|
|
3634
|
-
</dd>
|
|
3635
|
-
</dl>
|
|
3636
|
-
</dd>
|
|
3637
|
-
</dl>
|
|
3638
|
-
|
|
3639
|
-
</dd>
|
|
3640
|
-
</dl>
|
|
3641
|
-
</details>
|
|
3642
|
-
|
|
3643
|
-
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsBySourceShortName</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
|
|
3644
|
-
<dl>
|
|
3645
|
-
<dd>
|
|
3646
|
-
|
|
3647
|
-
#### 📝 Description
|
|
3648
|
-
|
|
3649
|
-
<dl>
|
|
3650
|
-
<dd>
|
|
3651
|
-
|
|
3652
|
-
<dl>
|
|
3653
|
-
<dd>
|
|
3654
|
-
|
|
3655
|
-
Get all entity definitions for a given source.
|
|
3656
|
-
|
|
3657
|
-
</dd>
|
|
3658
|
-
</dl>
|
|
3659
|
-
</dd>
|
|
3660
|
-
</dl>
|
|
3661
|
-
|
|
3662
|
-
#### 🔌 Usage
|
|
3663
|
-
|
|
3664
|
-
<dl>
|
|
3665
|
-
<dd>
|
|
3666
|
-
|
|
3667
|
-
<dl>
|
|
3668
|
-
<dd>
|
|
3669
|
-
|
|
3670
|
-
```typescript
|
|
3671
|
-
await client.entities.getEntityDefinitionsBySourceShortName({
|
|
3672
|
-
sourceShortName: "source_short_name",
|
|
3673
|
-
creds: "creds",
|
|
3674
|
-
});
|
|
3675
|
-
```
|
|
3676
|
-
|
|
3677
|
-
</dd>
|
|
3678
|
-
</dl>
|
|
3679
|
-
</dd>
|
|
3680
|
-
</dl>
|
|
3681
|
-
|
|
3682
|
-
#### ⚙️ Parameters
|
|
3683
|
-
|
|
3684
|
-
<dl>
|
|
3685
|
-
<dd>
|
|
3686
|
-
|
|
3687
|
-
<dl>
|
|
3688
|
-
<dd>
|
|
3689
|
-
|
|
3690
|
-
**request:** `AirweaveSDK.GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest`
|
|
3691
|
-
|
|
3692
|
-
</dd>
|
|
3693
|
-
</dl>
|
|
3694
|
-
|
|
3695
|
-
<dl>
|
|
3696
|
-
<dd>
|
|
3697
|
-
|
|
3698
|
-
**requestOptions:** `Entities.RequestOptions`
|
|
3699
|
-
|
|
3700
|
-
</dd>
|
|
3701
|
-
</dl>
|
|
3702
|
-
</dd>
|
|
3703
|
-
</dl>
|
|
3704
|
-
|
|
3705
|
-
</dd>
|
|
3706
|
-
</dl>
|
|
3707
|
-
</details>
|
|
3708
|
-
|
|
3709
|
-
## Transformers
|
|
3710
|
-
|
|
3711
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>({ ...params }) -> AirweaveSDK.Transformer[]</code></summary>
|
|
3712
|
-
<dl>
|
|
3713
|
-
<dd>
|
|
3714
|
-
|
|
3715
|
-
#### 📝 Description
|
|
3716
|
-
|
|
3717
|
-
<dl>
|
|
3718
|
-
<dd>
|
|
3719
|
-
|
|
3720
|
-
<dl>
|
|
3721
|
-
<dd>
|
|
3722
|
-
|
|
3723
|
-
List all transformers for the current user's organization.
|
|
3724
|
-
|
|
3725
|
-
</dd>
|
|
3726
|
-
</dl>
|
|
3727
|
-
</dd>
|
|
3728
|
-
</dl>
|
|
3729
|
-
|
|
3730
|
-
#### 🔌 Usage
|
|
3731
|
-
|
|
3732
|
-
<dl>
|
|
3733
|
-
<dd>
|
|
3734
|
-
|
|
3735
|
-
<dl>
|
|
3736
|
-
<dd>
|
|
3737
|
-
|
|
3738
|
-
```typescript
|
|
3739
|
-
await client.transformers.listTransformers({
|
|
3740
|
-
creds: "creds",
|
|
3741
|
-
});
|
|
3742
|
-
```
|
|
3743
|
-
|
|
3744
|
-
</dd>
|
|
3745
|
-
</dl>
|
|
3746
|
-
</dd>
|
|
3747
|
-
</dl>
|
|
3748
|
-
|
|
3749
|
-
#### ⚙️ Parameters
|
|
3750
|
-
|
|
3751
|
-
<dl>
|
|
3752
|
-
<dd>
|
|
3753
|
-
|
|
3754
|
-
<dl>
|
|
3755
|
-
<dd>
|
|
3756
|
-
|
|
3757
|
-
**request:** `AirweaveSDK.ListTransformersTransformersGetRequest`
|
|
3758
|
-
|
|
3759
|
-
</dd>
|
|
3760
|
-
</dl>
|
|
3761
|
-
|
|
3762
|
-
<dl>
|
|
3763
|
-
<dd>
|
|
3764
|
-
|
|
3765
|
-
**requestOptions:** `Transformers.RequestOptions`
|
|
3766
|
-
|
|
3767
|
-
</dd>
|
|
3768
|
-
</dl>
|
|
3769
|
-
</dd>
|
|
3770
|
-
</dl>
|
|
3771
|
-
|
|
3772
|
-
</dd>
|
|
3773
|
-
</dl>
|
|
3774
|
-
</details>
|
|
3775
|
-
|
|
3776
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">createTransformer</a>({ ...params }) -> AirweaveSDK.Transformer</code></summary>
|
|
3777
|
-
<dl>
|
|
3778
|
-
<dd>
|
|
3779
|
-
|
|
3780
|
-
#### 📝 Description
|
|
3781
|
-
|
|
3782
|
-
<dl>
|
|
3783
|
-
<dd>
|
|
3784
|
-
|
|
3785
|
-
<dl>
|
|
3786
|
-
<dd>
|
|
3787
|
-
|
|
3788
|
-
Create a new transformer.
|
|
3789
|
-
|
|
3790
|
-
</dd>
|
|
3791
|
-
</dl>
|
|
3792
|
-
</dd>
|
|
3793
|
-
</dl>
|
|
3794
|
-
|
|
3795
|
-
#### 🔌 Usage
|
|
3796
|
-
|
|
3797
|
-
<dl>
|
|
3798
|
-
<dd>
|
|
3799
|
-
|
|
3800
|
-
<dl>
|
|
3801
|
-
<dd>
|
|
3802
|
-
|
|
3803
|
-
```typescript
|
|
3804
|
-
await client.transformers.createTransformer({
|
|
3805
|
-
creds: "creds",
|
|
3806
|
-
name: "name",
|
|
3807
|
-
description: undefined,
|
|
3808
|
-
methodName: "method_name",
|
|
3809
|
-
moduleName: "module_name",
|
|
3810
|
-
inputEntityDefinitionIds: ["input_entity_definition_ids", "input_entity_definition_ids"],
|
|
3811
|
-
outputEntityDefinitionIds: ["output_entity_definition_ids", "output_entity_definition_ids"],
|
|
3812
|
-
configSchema: undefined,
|
|
3813
|
-
});
|
|
3814
|
-
```
|
|
3815
|
-
|
|
3816
|
-
</dd>
|
|
3817
|
-
</dl>
|
|
3818
|
-
</dd>
|
|
3819
|
-
</dl>
|
|
3820
|
-
|
|
3821
|
-
#### ⚙️ Parameters
|
|
3822
|
-
|
|
3823
|
-
<dl>
|
|
3824
|
-
<dd>
|
|
3825
|
-
|
|
3826
|
-
<dl>
|
|
3827
|
-
<dd>
|
|
3828
|
-
|
|
3829
|
-
**request:** `AirweaveSDK.TransformerCreate`
|
|
3830
|
-
|
|
3831
|
-
</dd>
|
|
3832
|
-
</dl>
|
|
3833
|
-
|
|
3834
|
-
<dl>
|
|
3835
|
-
<dd>
|
|
3836
|
-
|
|
3837
|
-
**requestOptions:** `Transformers.RequestOptions`
|
|
3838
|
-
|
|
3839
|
-
</dd>
|
|
3840
|
-
</dl>
|
|
3841
|
-
</dd>
|
|
3842
|
-
</dl>
|
|
3843
|
-
|
|
3844
|
-
</dd>
|
|
3845
|
-
</dl>
|
|
3846
|
-
</details>
|
|
3847
|
-
|
|
3848
|
-
<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">updateTransformer</a>(transformerId, { ...params }) -> AirweaveSDK.Transformer</code></summary>
|
|
3849
|
-
<dl>
|
|
3850
|
-
<dd>
|
|
3851
|
-
|
|
3852
|
-
#### 📝 Description
|
|
3853
|
-
|
|
3854
|
-
<dl>
|
|
3855
|
-
<dd>
|
|
3856
|
-
|
|
3857
|
-
<dl>
|
|
3858
|
-
<dd>
|
|
3859
|
-
|
|
3860
|
-
Update a transformer.
|
|
3861
|
-
|
|
3862
|
-
</dd>
|
|
3863
|
-
</dl>
|
|
3864
|
-
</dd>
|
|
3865
|
-
</dl>
|
|
3866
|
-
|
|
3867
|
-
#### 🔌 Usage
|
|
3868
|
-
|
|
3869
|
-
<dl>
|
|
3870
|
-
<dd>
|
|
3871
|
-
|
|
3872
|
-
<dl>
|
|
3873
|
-
<dd>
|
|
3874
|
-
|
|
3875
|
-
```typescript
|
|
3876
|
-
await client.transformers.updateTransformer("transformer_id", {
|
|
3877
|
-
creds: "creds",
|
|
3878
|
-
name: "name",
|
|
3879
|
-
description: undefined,
|
|
3880
|
-
methodName: "method_name",
|
|
3881
|
-
moduleName: "module_name",
|
|
3882
|
-
inputEntityDefinitionIds: ["input_entity_definition_ids", "input_entity_definition_ids"],
|
|
3883
|
-
outputEntityDefinitionIds: ["output_entity_definition_ids", "output_entity_definition_ids"],
|
|
3884
|
-
configSchema: undefined,
|
|
3885
|
-
});
|
|
3886
|
-
```
|
|
3887
|
-
|
|
3888
|
-
</dd>
|
|
3889
|
-
</dl>
|
|
3890
|
-
</dd>
|
|
3891
|
-
</dl>
|
|
3892
|
-
|
|
3893
|
-
#### ⚙️ Parameters
|
|
3894
|
-
|
|
3895
|
-
<dl>
|
|
3896
|
-
<dd>
|
|
3897
|
-
|
|
3898
|
-
<dl>
|
|
3899
|
-
<dd>
|
|
3900
|
-
|
|
3901
|
-
**transformerId:** `string`
|
|
3902
|
-
|
|
3903
|
-
</dd>
|
|
3904
|
-
</dl>
|
|
3905
|
-
|
|
3906
|
-
<dl>
|
|
3907
|
-
<dd>
|
|
3908
|
-
|
|
3909
|
-
**request:** `AirweaveSDK.TransformerUpdate`
|
|
3910
|
-
|
|
3911
|
-
</dd>
|
|
3912
|
-
</dl>
|
|
3913
|
-
|
|
3914
|
-
<dl>
|
|
3915
|
-
<dd>
|
|
3916
|
-
|
|
3917
|
-
**requestOptions:** `Transformers.RequestOptions`
|
|
3918
|
-
|
|
3919
|
-
</dd>
|
|
3920
|
-
</dl>
|
|
3921
|
-
</dd>
|
|
3922
|
-
</dl>
|
|
3923
|
-
|
|
3924
|
-
</dd>
|
|
3925
|
-
</dl>
|
|
3926
|
-
</details>
|