@airweave/sdk 0.2.25 → 0.2.27

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.
Files changed (682) hide show
  1. package/Client.d.ts +8 -28
  2. package/Client.js +13 -48
  3. package/README.md +10 -8
  4. package/api/index.d.ts +1 -1
  5. package/api/index.js +1 -1
  6. package/api/resources/collections/client/Client.d.ts +112 -0
  7. package/api/resources/{entities → collections}/client/Client.js +91 -141
  8. package/api/resources/collections/client/requests/CollectionCreate.d.ts +15 -0
  9. package/api/resources/{sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts → collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.d.ts} +1 -1
  10. package/{dist/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts → api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.d.ts} +1 -1
  11. package/api/resources/collections/client/requests/index.d.ts +3 -0
  12. package/api/resources/connections/client/Client.d.ts +3 -177
  13. package/api/resources/connections/client/Client.js +7 -553
  14. package/api/resources/connections/client/index.d.ts +1 -1
  15. package/api/resources/connections/client/index.js +0 -15
  16. package/api/resources/index.d.ts +4 -19
  17. package/api/resources/index.js +5 -20
  18. package/api/resources/sourceConnections/client/Client.d.ts +191 -0
  19. package/api/resources/{sync → sourceConnections}/client/Client.js +121 -422
  20. package/api/resources/sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.d.ts +10 -0
  21. package/api/resources/sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts +10 -0
  22. package/api/resources/{sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.d.ts} +5 -5
  23. package/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +17 -0
  24. package/api/resources/sourceConnections/client/requests/index.d.ts +4 -0
  25. package/api/resources/sources/client/Client.d.ts +3 -1
  26. package/api/resources/sources/client/Client.js +10 -5
  27. package/api/resources/whiteLabels/client/Client.d.ts +3 -47
  28. package/api/resources/whiteLabels/client/Client.js +18 -168
  29. package/api/types/ApiKey.d.ts +2 -2
  30. package/api/{resources/apiKeys/client/requests → types}/ApiKeyCreate.d.ts +1 -2
  31. package/{dist/api/resources/connections/client/requests → api/types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -8
  32. package/api/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +8 -0
  33. package/{dist/api/resources/chat/client/requests → api/types}/ChatCreate.d.ts +1 -5
  34. package/api/types/Collection.d.ts +19 -0
  35. package/api/types/CollectionStatus.d.ts +13 -0
  36. package/api/types/CollectionStatus.js +12 -0
  37. package/api/types/CollectionUpdate.d.ts +10 -0
  38. package/api/types/ConfigValues.d.ts +9 -0
  39. package/api/{resources/entities/client/requests → types}/EntityDefinitionCreate.d.ts +2 -9
  40. package/api/{resources/entities/client/requests → types}/EntityRelationCreate.d.ts +1 -6
  41. package/api/types/SearchResponse.d.ts +13 -0
  42. package/api/types/SearchStatus.d.ts +12 -0
  43. package/api/types/SearchStatus.js +11 -0
  44. package/api/types/SourceConnection.d.ts +31 -0
  45. package/api/types/SourceConnectionAuthFields.d.ts +5 -0
  46. package/api/types/SourceConnectionCreate.d.ts +21 -0
  47. package/api/types/SourceConnectionJob.d.ts +30 -0
  48. package/api/types/SourceConnectionListItem.d.ts +21 -0
  49. package/api/types/SourceConnectionStatus.d.ts +12 -0
  50. package/api/types/SourceConnectionStatus.js +11 -0
  51. package/api/{resources/sync/client/requests → types}/SyncCreate.d.ts +2 -7
  52. package/api/types/SyncDagCreate.d.ts +14 -0
  53. package/api/{resources/dag/client/requests → types}/SyncDagUpdate.d.ts +3 -7
  54. package/api/types/SyncJob.d.ts +1 -0
  55. package/api/{resources/sync/client/requests → types}/SyncUpdate.d.ts +2 -3
  56. package/api/{resources/transformers/client/requests → types}/TransformerCreate.d.ts +1 -8
  57. package/api/types/index.d.ts +24 -1
  58. package/api/types/index.js +24 -1
  59. package/core/auth/BasicAuth.d.ts +8 -0
  60. package/core/auth/BasicAuth.js +26 -0
  61. package/core/auth/BearerToken.d.ts +5 -0
  62. package/core/auth/BearerToken.js +15 -0
  63. package/core/auth/index.d.ts +2 -0
  64. package/core/auth/index.js +7 -0
  65. package/core/index.d.ts +1 -0
  66. package/core/index.js +1 -0
  67. package/dist/Client.d.ts +8 -28
  68. package/dist/Client.js +13 -48
  69. package/dist/api/index.d.ts +1 -1
  70. package/dist/api/index.js +1 -1
  71. package/dist/api/resources/collections/client/Client.d.ts +112 -0
  72. package/dist/api/resources/{entities → collections}/client/Client.js +91 -141
  73. package/dist/api/resources/collections/client/requests/CollectionCreate.d.ts +15 -0
  74. package/dist/api/resources/{sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.d.ts → collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.d.ts} +1 -1
  75. package/{api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts → dist/api/resources/collections/client/requests/ListCollectionsCollectionsGetRequest.d.ts} +1 -1
  76. package/dist/api/resources/collections/client/requests/index.d.ts +3 -0
  77. package/dist/api/resources/connections/client/Client.d.ts +3 -177
  78. package/dist/api/resources/connections/client/Client.js +7 -553
  79. package/dist/api/resources/connections/client/index.d.ts +1 -1
  80. package/dist/api/resources/connections/client/index.js +0 -15
  81. package/dist/api/resources/index.d.ts +4 -19
  82. package/dist/api/resources/index.js +5 -20
  83. package/dist/api/resources/sourceConnections/client/Client.d.ts +191 -0
  84. package/dist/api/resources/{sync → sourceConnections}/client/Client.js +121 -422
  85. package/dist/api/resources/sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.d.ts +10 -0
  86. package/dist/api/resources/sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts +10 -0
  87. package/dist/api/resources/{sync/client/requests/ListAllJobsSyncJobsGetRequest.d.ts → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.d.ts} +5 -5
  88. package/dist/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +17 -0
  89. package/dist/api/resources/sourceConnections/client/requests/index.d.ts +4 -0
  90. package/dist/api/resources/sources/client/Client.d.ts +3 -1
  91. package/dist/api/resources/sources/client/Client.js +10 -5
  92. package/dist/api/resources/whiteLabels/client/Client.d.ts +3 -47
  93. package/dist/api/resources/whiteLabels/client/Client.js +18 -168
  94. package/dist/api/types/ApiKey.d.ts +2 -2
  95. package/dist/api/{resources/apiKeys/client/requests → types}/ApiKeyCreate.d.ts +1 -2
  96. package/{api/resources/connections/client/requests → dist/api/types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -8
  97. package/dist/api/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +8 -0
  98. package/{api/resources/chat/client/requests → dist/api/types}/ChatCreate.d.ts +1 -5
  99. package/dist/api/types/Collection.d.ts +19 -0
  100. package/dist/api/types/CollectionStatus.d.ts +13 -0
  101. package/dist/api/types/CollectionStatus.js +12 -0
  102. package/dist/api/types/CollectionUpdate.d.ts +10 -0
  103. package/dist/api/types/ConfigValues.d.ts +9 -0
  104. package/dist/api/{resources/entities/client/requests → types}/EntityDefinitionCreate.d.ts +2 -9
  105. package/dist/api/types/EntityDefinitionCreate.js +5 -0
  106. package/dist/api/types/EntityDefinitionCreateEntitySchema.js +5 -0
  107. package/dist/api/{resources/entities/client/requests → types}/EntityRelationCreate.d.ts +1 -6
  108. package/dist/api/types/EntityRelationCreate.js +5 -0
  109. package/dist/api/types/SearchResponse.d.ts +13 -0
  110. package/dist/api/types/SearchResponse.js +5 -0
  111. package/dist/api/types/SearchStatus.d.ts +12 -0
  112. package/dist/api/types/SearchStatus.js +11 -0
  113. package/dist/api/types/SourceConnection.d.ts +31 -0
  114. package/dist/api/types/SourceConnection.js +5 -0
  115. package/dist/api/types/SourceConnectionAuthFields.d.ts +5 -0
  116. package/dist/api/types/SourceConnectionAuthFields.js +5 -0
  117. package/dist/api/types/SourceConnectionCreate.d.ts +21 -0
  118. package/dist/api/types/SourceConnectionCreate.js +5 -0
  119. package/dist/api/types/SourceConnectionJob.d.ts +30 -0
  120. package/dist/api/types/SourceConnectionJob.js +5 -0
  121. package/dist/api/types/SourceConnectionListItem.d.ts +21 -0
  122. package/dist/api/types/SourceConnectionListItem.js +5 -0
  123. package/dist/api/types/SourceConnectionStatus.d.ts +12 -0
  124. package/dist/api/types/SourceConnectionStatus.js +11 -0
  125. package/dist/api/{resources/sync/client/requests → types}/SyncCreate.d.ts +2 -7
  126. package/dist/api/types/SyncCreate.js +5 -0
  127. package/dist/api/types/SyncDagCreate.d.ts +14 -0
  128. package/dist/api/types/SyncDagCreate.js +5 -0
  129. package/dist/api/{resources/dag/client/requests → types}/SyncDagUpdate.d.ts +3 -7
  130. package/dist/api/types/SyncDagUpdate.js +5 -0
  131. package/dist/api/types/SyncJob.d.ts +1 -0
  132. package/dist/api/{resources/sync/client/requests → types}/SyncUpdate.d.ts +2 -3
  133. package/dist/api/types/SyncUpdate.js +5 -0
  134. package/dist/api/{resources/transformers/client/requests → types}/TransformerCreate.d.ts +1 -8
  135. package/dist/api/types/TransformerCreate.js +5 -0
  136. package/dist/api/types/index.d.ts +24 -1
  137. package/dist/api/types/index.js +24 -1
  138. package/dist/core/auth/BasicAuth.d.ts +8 -0
  139. package/dist/core/auth/BasicAuth.js +26 -0
  140. package/dist/core/auth/BearerToken.d.ts +5 -0
  141. package/dist/core/auth/BearerToken.js +15 -0
  142. package/dist/core/auth/index.d.ts +2 -0
  143. package/dist/core/auth/index.js +7 -0
  144. package/dist/core/index.d.ts +1 -0
  145. package/dist/core/index.js +1 -0
  146. package/dist/serialization/index.d.ts +1 -1
  147. package/dist/serialization/index.js +1 -1
  148. package/dist/serialization/resources/collections/client/index.d.ts +3 -0
  149. package/dist/serialization/resources/{sync → collections}/client/index.js +3 -3
  150. package/dist/serialization/resources/{apiKeys/client/readApiKeys.d.ts → collections/client/listCollections.d.ts} +3 -3
  151. package/dist/serialization/resources/{connections/client/listConnectedIntegrations.js → collections/client/listCollections.js} +2 -2
  152. package/dist/serialization/resources/{connections/client/listConnectedIntegrations.d.ts → collections/client/refreshAllSourceConnections.d.ts} +3 -3
  153. package/dist/serialization/resources/{chat/client/listChats.js → collections/client/refreshAllSourceConnections.js} +2 -2
  154. package/dist/serialization/resources/{apiKeys/client/requests/ApiKeyCreate.d.ts → collections/client/requests/CollectionCreate.d.ts} +4 -3
  155. package/dist/serialization/resources/collections/client/requests/CollectionCreate.js +44 -0
  156. package/dist/serialization/resources/collections/client/requests/index.d.ts +1 -0
  157. package/dist/serialization/resources/collections/client/requests/index.js +5 -0
  158. package/dist/serialization/resources/connections/client/index.d.ts +0 -5
  159. package/dist/serialization/resources/connections/client/index.js +1 -9
  160. package/dist/serialization/resources/index.d.ts +4 -17
  161. package/dist/serialization/resources/index.js +5 -18
  162. package/dist/serialization/resources/sourceConnections/client/index.d.ts +3 -0
  163. package/dist/serialization/resources/{apiKeys → sourceConnections}/client/index.js +3 -2
  164. package/dist/serialization/resources/sourceConnections/client/listSourceConnectionJobs.d.ts +11 -0
  165. package/dist/serialization/resources/{connections/client/getOauth2WhiteLabelAuthUrl.js → sourceConnections/client/listSourceConnectionJobs.js} +2 -1
  166. package/dist/serialization/resources/sourceConnections/client/listSourceConnections.d.ts +11 -0
  167. package/dist/serialization/resources/sourceConnections/client/listSourceConnections.js +42 -0
  168. package/dist/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +18 -0
  169. package/dist/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.js +49 -0
  170. package/dist/serialization/resources/sourceConnections/client/requests/index.d.ts +1 -0
  171. package/dist/serialization/resources/sourceConnections/client/requests/index.js +5 -0
  172. package/dist/serialization/resources/whiteLabels/client/index.d.ts +0 -2
  173. package/dist/serialization/resources/whiteLabels/client/index.js +1 -3
  174. package/dist/serialization/types/ApiKey.d.ts +1 -1
  175. package/dist/serialization/types/ApiKey.js +1 -1
  176. package/dist/serialization/types/ApiKeyCreate.d.ts +12 -0
  177. package/{serialization/resources/apiKeys/client/requests → dist/serialization/types}/ApiKeyCreate.js +1 -1
  178. package/dist/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +13 -0
  179. package/dist/serialization/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +1 -1
  180. package/dist/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +14 -0
  181. package/dist/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js +45 -0
  182. package/{serialization/resources/chat/client/requests → dist/serialization/types}/ChatCreate.d.ts +4 -4
  183. package/{serialization/resources/chat/client/requests → dist/serialization/types}/ChatCreate.js +1 -1
  184. package/dist/serialization/types/{ApiKeyWithPlainKey.d.ts → Collection.d.ts} +7 -7
  185. package/{serialization/types/ApiKeyWithPlainKey.js → dist/serialization/types/Collection.js} +7 -7
  186. package/dist/serialization/types/CollectionStatus.d.ts +10 -0
  187. package/dist/serialization/types/CollectionStatus.js +41 -0
  188. package/dist/serialization/types/CollectionUpdate.d.ts +12 -0
  189. package/dist/serialization/types/CollectionUpdate.js +43 -0
  190. package/dist/serialization/types/ConfigValues.d.ts +10 -0
  191. package/dist/serialization/types/ConfigValues.js +41 -0
  192. package/dist/serialization/{resources/entities/client/requests → types}/EntityDefinitionCreate.d.ts +6 -6
  193. package/dist/serialization/{resources/entities/client/requests → types}/EntityDefinitionCreate.js +3 -3
  194. package/dist/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +3 -3
  195. package/dist/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +1 -1
  196. package/dist/serialization/types/EntityRelationCreate.d.ts +15 -0
  197. package/dist/serialization/{resources/entities/client/requests → types}/EntityRelationCreate.js +1 -1
  198. package/dist/serialization/types/SearchResponse.d.ts +17 -0
  199. package/dist/serialization/types/SearchResponse.js +48 -0
  200. package/dist/serialization/types/SearchStatus.d.ts +10 -0
  201. package/dist/serialization/{resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.js → types/SearchStatus.js} +3 -3
  202. package/dist/serialization/types/SourceConnection.d.ts +36 -0
  203. package/dist/serialization/types/SourceConnection.js +67 -0
  204. package/dist/serialization/types/SourceConnectionAuthFields.d.ts +11 -0
  205. package/dist/serialization/types/SourceConnectionAuthFields.js +42 -0
  206. package/dist/serialization/types/SourceConnectionCreate.d.ts +20 -0
  207. package/dist/serialization/types/SourceConnectionCreate.js +51 -0
  208. package/dist/serialization/types/SourceConnectionJob.d.ts +30 -0
  209. package/dist/serialization/types/SourceConnectionJob.js +61 -0
  210. package/dist/serialization/types/SourceConnectionListItem.d.ts +21 -0
  211. package/dist/serialization/types/SourceConnectionListItem.js +52 -0
  212. package/dist/serialization/types/SourceConnectionStatus.d.ts +10 -0
  213. package/dist/serialization/{resources/connections/client/sendOauth2WhiteLabelCode.js → types/SourceConnectionStatus.js} +3 -3
  214. package/dist/serialization/{resources/sync/client/requests → types}/SyncCreate.d.ts +5 -5
  215. package/dist/serialization/{resources/sync/client/requests → types}/SyncCreate.js +2 -2
  216. package/dist/serialization/types/SyncDagCreate.d.ts +18 -0
  217. package/dist/serialization/{resources/dag/client/requests → types}/SyncDagCreate.js +4 -4
  218. package/dist/serialization/types/SyncDagUpdate.d.ts +18 -0
  219. package/dist/serialization/{resources/dag/client/requests → types}/SyncDagUpdate.js +4 -4
  220. package/dist/serialization/types/SyncJob.d.ts +1 -0
  221. package/dist/serialization/types/SyncJob.js +1 -0
  222. package/dist/serialization/{resources/sync/client/requests → types}/SyncUpdate.d.ts +5 -5
  223. package/dist/serialization/{resources/sync/client/requests → types}/SyncUpdate.js +2 -2
  224. package/dist/serialization/{resources/transformers/client/requests → types}/TransformerCreate.d.ts +4 -4
  225. package/dist/serialization/{resources/transformers/client/requests → types}/TransformerCreate.js +1 -1
  226. package/dist/serialization/types/index.d.ts +24 -1
  227. package/dist/serialization/types/index.js +24 -1
  228. package/dist/version.d.ts +1 -1
  229. package/dist/version.js +1 -1
  230. package/package.json +3 -2
  231. package/reference.md +311 -2446
  232. package/serialization/index.d.ts +1 -1
  233. package/serialization/index.js +1 -1
  234. package/serialization/resources/collections/client/index.d.ts +3 -0
  235. package/{dist/serialization/resources/chat → serialization/resources/collections}/client/index.js +3 -2
  236. package/{dist/serialization/resources/chat/client/listChats.d.ts → serialization/resources/collections/client/listCollections.d.ts} +3 -3
  237. package/serialization/resources/{connections/client/listConnectedIntegrations.js → collections/client/listCollections.js} +2 -2
  238. package/{dist/serialization/resources/embeddingModels/client/readEmbeddingModels.d.ts → serialization/resources/collections/client/refreshAllSourceConnections.d.ts} +3 -3
  239. package/{dist/serialization/resources/connections/client/getConnectionCredentials.js → serialization/resources/collections/client/refreshAllSourceConnections.js} +2 -1
  240. package/serialization/resources/{apiKeys/client/requests/ApiKeyCreate.d.ts → collections/client/requests/CollectionCreate.d.ts} +4 -3
  241. package/serialization/resources/collections/client/requests/CollectionCreate.js +44 -0
  242. package/serialization/resources/collections/client/requests/index.d.ts +1 -0
  243. package/serialization/resources/collections/client/requests/index.js +5 -0
  244. package/serialization/resources/connections/client/index.d.ts +0 -5
  245. package/serialization/resources/connections/client/index.js +1 -9
  246. package/serialization/resources/index.d.ts +4 -17
  247. package/serialization/resources/index.js +5 -18
  248. package/serialization/resources/sourceConnections/client/index.d.ts +3 -0
  249. package/{dist/serialization/resources/transformers → serialization/resources/sourceConnections}/client/index.js +3 -2
  250. package/serialization/resources/sourceConnections/client/listSourceConnectionJobs.d.ts +11 -0
  251. package/{dist/serialization/resources/apiKeys/client/readApiKeys.js → serialization/resources/sourceConnections/client/listSourceConnectionJobs.js} +2 -2
  252. package/serialization/resources/sourceConnections/client/listSourceConnections.d.ts +11 -0
  253. package/serialization/resources/sourceConnections/client/listSourceConnections.js +42 -0
  254. package/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +18 -0
  255. package/serialization/resources/sourceConnections/client/requests/SourceConnectionUpdate.js +49 -0
  256. package/serialization/resources/sourceConnections/client/requests/index.d.ts +1 -0
  257. package/serialization/resources/sourceConnections/client/requests/index.js +5 -0
  258. package/serialization/resources/whiteLabels/client/index.d.ts +0 -2
  259. package/serialization/resources/whiteLabels/client/index.js +1 -3
  260. package/serialization/types/ApiKey.d.ts +1 -1
  261. package/serialization/types/ApiKey.js +1 -1
  262. package/serialization/types/ApiKeyCreate.d.ts +12 -0
  263. package/{dist/serialization/resources/apiKeys/client/requests → serialization/types}/ApiKeyCreate.js +1 -1
  264. package/serialization/types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +13 -0
  265. package/serialization/{resources/connections/client/requests → types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +1 -1
  266. package/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.d.ts +14 -0
  267. package/serialization/types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js +45 -0
  268. package/{dist/serialization/resources/chat/client/requests → serialization/types}/ChatCreate.d.ts +4 -4
  269. package/{dist/serialization/resources/chat/client/requests → serialization/types}/ChatCreate.js +1 -1
  270. package/serialization/types/{ApiKeyWithPlainKey.d.ts → Collection.d.ts} +7 -7
  271. package/{dist/serialization/types/ApiKeyWithPlainKey.js → serialization/types/Collection.js} +7 -7
  272. package/serialization/types/CollectionStatus.d.ts +10 -0
  273. package/serialization/types/CollectionStatus.js +41 -0
  274. package/serialization/types/CollectionUpdate.d.ts +12 -0
  275. package/serialization/types/CollectionUpdate.js +43 -0
  276. package/serialization/types/ConfigValues.d.ts +10 -0
  277. package/serialization/types/ConfigValues.js +41 -0
  278. package/serialization/{resources/entities/client/requests → types}/EntityDefinitionCreate.d.ts +6 -6
  279. package/serialization/{resources/entities/client/requests → types}/EntityDefinitionCreate.js +3 -3
  280. package/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +3 -3
  281. package/serialization/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +1 -1
  282. package/serialization/types/EntityRelationCreate.d.ts +15 -0
  283. package/serialization/{resources/entities/client/requests → types}/EntityRelationCreate.js +1 -1
  284. package/serialization/types/SearchResponse.d.ts +17 -0
  285. package/serialization/types/SearchResponse.js +48 -0
  286. package/serialization/types/SearchStatus.d.ts +10 -0
  287. package/{dist/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.js → serialization/types/SearchStatus.js} +3 -3
  288. package/serialization/types/SourceConnection.d.ts +36 -0
  289. package/serialization/types/SourceConnection.js +67 -0
  290. package/serialization/types/SourceConnectionAuthFields.d.ts +11 -0
  291. package/serialization/types/SourceConnectionAuthFields.js +42 -0
  292. package/serialization/types/SourceConnectionCreate.d.ts +20 -0
  293. package/serialization/types/SourceConnectionCreate.js +51 -0
  294. package/serialization/types/SourceConnectionJob.d.ts +30 -0
  295. package/serialization/types/SourceConnectionJob.js +61 -0
  296. package/serialization/types/SourceConnectionListItem.d.ts +21 -0
  297. package/serialization/types/SourceConnectionListItem.js +52 -0
  298. package/serialization/types/SourceConnectionStatus.d.ts +10 -0
  299. package/serialization/types/SourceConnectionStatus.js +41 -0
  300. package/serialization/{resources/sync/client/requests → types}/SyncCreate.d.ts +5 -5
  301. package/serialization/{resources/sync/client/requests → types}/SyncCreate.js +2 -2
  302. package/serialization/types/SyncDagCreate.d.ts +18 -0
  303. package/serialization/{resources/dag/client/requests → types}/SyncDagCreate.js +4 -4
  304. package/serialization/types/SyncDagUpdate.d.ts +18 -0
  305. package/serialization/{resources/dag/client/requests → types}/SyncDagUpdate.js +4 -4
  306. package/serialization/types/SyncJob.d.ts +1 -0
  307. package/serialization/types/SyncJob.js +1 -0
  308. package/serialization/{resources/sync/client/requests → types}/SyncUpdate.d.ts +5 -5
  309. package/serialization/{resources/sync/client/requests → types}/SyncUpdate.js +2 -2
  310. package/serialization/{resources/transformers/client/requests → types}/TransformerCreate.d.ts +4 -4
  311. package/serialization/{resources/transformers/client/requests → types}/TransformerCreate.js +1 -1
  312. package/serialization/types/index.d.ts +24 -1
  313. package/serialization/types/index.js +24 -1
  314. package/version.d.ts +1 -1
  315. package/version.js +1 -1
  316. package/api/resources/apiKeys/client/Client.d.ts +0 -131
  317. package/api/resources/apiKeys/client/Client.js +0 -391
  318. package/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts +0 -12
  319. package/api/resources/apiKeys/client/requests/index.d.ts +0 -3
  320. package/api/resources/chat/client/Client.d.ts +0 -77
  321. package/api/resources/chat/client/Client.js +0 -227
  322. package/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +0 -11
  323. package/api/resources/chat/client/requests/index.d.ts +0 -2
  324. package/api/resources/connections/client/requests/index.d.ts +0 -1
  325. package/api/resources/dag/client/Client.d.ts +0 -81
  326. package/api/resources/dag/client/Client.js +0 -276
  327. package/api/resources/dag/client/requests/SyncDagCreate.d.ts +0 -26
  328. package/api/resources/dag/client/requests/index.d.ts +0 -2
  329. package/api/resources/embeddingModels/client/Client.d.ts +0 -71
  330. package/api/resources/embeddingModels/client/Client.js +0 -211
  331. package/api/resources/embeddingModels/client/index.d.ts +0 -1
  332. package/api/resources/embeddingModels/client/index.js +0 -2
  333. package/api/resources/entities/client/Client.d.ts +0 -119
  334. package/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -12
  335. package/api/resources/entities/client/requests/index.d.ts +0 -3
  336. package/api/resources/entities/client/requests/index.js +0 -2
  337. package/api/resources/entities/index.d.ts +0 -2
  338. package/api/resources/entities/index.js +0 -18
  339. package/api/resources/entities/types/index.d.ts +0 -1
  340. package/api/resources/entities/types/index.js +0 -17
  341. package/api/resources/search/client/Client.d.ts +0 -56
  342. package/api/resources/search/client/Client.js +0 -151
  343. package/api/resources/search/client/index.d.ts +0 -1
  344. package/api/resources/search/client/index.js +0 -17
  345. package/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +0 -25
  346. package/api/resources/search/client/requests/index.d.ts +0 -1
  347. package/api/resources/search/client/requests/index.js +0 -2
  348. package/api/resources/sync/client/Client.d.ts +0 -277
  349. package/api/resources/sync/client/index.d.ts +0 -1
  350. package/api/resources/sync/client/index.js +0 -17
  351. package/api/resources/sync/client/requests/ListSyncsSyncGetRequest.d.ts +0 -12
  352. package/api/resources/sync/client/requests/index.d.ts +0 -5
  353. package/api/resources/sync/client/requests/index.js +0 -2
  354. package/api/resources/sync/index.d.ts +0 -2
  355. package/api/resources/sync/index.js +0 -18
  356. package/api/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -5
  357. package/api/resources/sync/types/index.d.ts +0 -1
  358. package/api/resources/sync/types/index.js +0 -17
  359. package/api/resources/transformers/client/Client.d.ts +0 -58
  360. package/api/resources/transformers/client/Client.js +0 -199
  361. package/api/resources/transformers/client/index.d.ts +0 -1
  362. package/api/resources/transformers/client/index.js +0 -17
  363. package/api/resources/transformers/client/requests/index.d.ts +0 -1
  364. package/api/resources/transformers/client/requests/index.js +0 -2
  365. package/api/resources/users/client/Client.d.ts +0 -48
  366. package/api/resources/users/client/Client.js +0 -135
  367. package/api/resources/users/client/index.d.ts +0 -1
  368. package/api/resources/users/client/index.js +0 -2
  369. package/api/types/ApiKeyWithPlainKey.d.ts +0 -18
  370. package/dist/api/resources/apiKeys/client/Client.d.ts +0 -131
  371. package/dist/api/resources/apiKeys/client/Client.js +0 -391
  372. package/dist/api/resources/apiKeys/client/index.d.ts +0 -1
  373. package/dist/api/resources/apiKeys/client/index.js +0 -17
  374. package/dist/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts +0 -12
  375. package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +0 -11
  376. package/dist/api/resources/apiKeys/client/requests/index.d.ts +0 -3
  377. package/dist/api/resources/apiKeys/client/requests/index.js +0 -2
  378. package/dist/api/resources/chat/client/Client.d.ts +0 -77
  379. package/dist/api/resources/chat/client/Client.js +0 -227
  380. package/dist/api/resources/chat/client/index.d.ts +0 -1
  381. package/dist/api/resources/chat/client/index.js +0 -17
  382. package/dist/api/resources/chat/client/requests/index.d.ts +0 -2
  383. package/dist/api/resources/chat/client/requests/index.js +0 -2
  384. package/dist/api/resources/chat/index.d.ts +0 -1
  385. package/dist/api/resources/chat/index.js +0 -17
  386. package/dist/api/resources/connections/client/requests/index.d.ts +0 -1
  387. package/dist/api/resources/connections/client/requests/index.js +0 -2
  388. package/dist/api/resources/dag/client/Client.d.ts +0 -81
  389. package/dist/api/resources/dag/client/Client.js +0 -276
  390. package/dist/api/resources/dag/client/index.d.ts +0 -1
  391. package/dist/api/resources/dag/client/index.js +0 -17
  392. package/dist/api/resources/dag/client/requests/SyncDagCreate.d.ts +0 -26
  393. package/dist/api/resources/dag/client/requests/index.d.ts +0 -2
  394. package/dist/api/resources/dag/client/requests/index.js +0 -2
  395. package/dist/api/resources/dag/index.d.ts +0 -1
  396. package/dist/api/resources/dag/index.js +0 -17
  397. package/dist/api/resources/embeddingModels/client/Client.d.ts +0 -71
  398. package/dist/api/resources/embeddingModels/client/Client.js +0 -211
  399. package/dist/api/resources/embeddingModels/client/index.d.ts +0 -1
  400. package/dist/api/resources/embeddingModels/client/index.js +0 -2
  401. package/dist/api/resources/embeddingModels/index.d.ts +0 -1
  402. package/dist/api/resources/embeddingModels/index.js +0 -17
  403. package/dist/api/resources/entities/client/Client.d.ts +0 -119
  404. package/dist/api/resources/entities/client/index.d.ts +0 -1
  405. package/dist/api/resources/entities/client/index.js +0 -17
  406. package/dist/api/resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.d.ts +0 -12
  407. package/dist/api/resources/entities/client/requests/index.d.ts +0 -3
  408. package/dist/api/resources/entities/client/requests/index.js +0 -2
  409. package/dist/api/resources/entities/index.d.ts +0 -2
  410. package/dist/api/resources/entities/index.js +0 -18
  411. package/dist/api/resources/entities/types/index.d.ts +0 -1
  412. package/dist/api/resources/entities/types/index.js +0 -17
  413. package/dist/api/resources/search/client/Client.d.ts +0 -56
  414. package/dist/api/resources/search/client/Client.js +0 -151
  415. package/dist/api/resources/search/client/index.d.ts +0 -1
  416. package/dist/api/resources/search/client/index.js +0 -17
  417. package/dist/api/resources/search/client/requests/SearchSearchGetRequest.d.ts +0 -25
  418. package/dist/api/resources/search/client/requests/index.d.ts +0 -1
  419. package/dist/api/resources/search/client/requests/index.js +0 -2
  420. package/dist/api/resources/search/index.d.ts +0 -1
  421. package/dist/api/resources/search/index.js +0 -17
  422. package/dist/api/resources/sync/client/Client.d.ts +0 -277
  423. package/dist/api/resources/sync/client/index.d.ts +0 -1
  424. package/dist/api/resources/sync/client/index.js +0 -17
  425. package/dist/api/resources/sync/client/requests/ListSyncsSyncGetRequest.d.ts +0 -12
  426. package/dist/api/resources/sync/client/requests/index.d.ts +0 -5
  427. package/dist/api/resources/sync/client/requests/index.js +0 -2
  428. package/dist/api/resources/sync/index.d.ts +0 -2
  429. package/dist/api/resources/sync/index.js +0 -18
  430. package/dist/api/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -5
  431. package/dist/api/resources/sync/types/index.d.ts +0 -1
  432. package/dist/api/resources/sync/types/index.js +0 -17
  433. package/dist/api/resources/transformers/client/Client.d.ts +0 -58
  434. package/dist/api/resources/transformers/client/Client.js +0 -199
  435. package/dist/api/resources/transformers/client/index.d.ts +0 -1
  436. package/dist/api/resources/transformers/client/index.js +0 -17
  437. package/dist/api/resources/transformers/client/requests/index.d.ts +0 -1
  438. package/dist/api/resources/transformers/client/requests/index.js +0 -2
  439. package/dist/api/resources/transformers/index.d.ts +0 -1
  440. package/dist/api/resources/transformers/index.js +0 -17
  441. package/dist/api/resources/users/client/Client.d.ts +0 -48
  442. package/dist/api/resources/users/client/Client.js +0 -135
  443. package/dist/api/resources/users/client/index.d.ts +0 -1
  444. package/dist/api/resources/users/client/index.js +0 -2
  445. package/dist/api/resources/users/index.d.ts +0 -1
  446. package/dist/api/resources/users/index.js +0 -17
  447. package/dist/api/types/ApiKeyWithPlainKey.d.ts +0 -18
  448. package/dist/serialization/resources/apiKeys/client/index.d.ts +0 -2
  449. package/dist/serialization/resources/apiKeys/client/requests/index.d.ts +0 -1
  450. package/dist/serialization/resources/apiKeys/client/requests/index.js +0 -5
  451. package/dist/serialization/resources/apiKeys/index.d.ts +0 -1
  452. package/dist/serialization/resources/apiKeys/index.js +0 -17
  453. package/dist/serialization/resources/chat/client/index.d.ts +0 -2
  454. package/dist/serialization/resources/chat/client/requests/index.d.ts +0 -1
  455. package/dist/serialization/resources/chat/client/requests/index.js +0 -5
  456. package/dist/serialization/resources/chat/index.d.ts +0 -1
  457. package/dist/serialization/resources/chat/index.js +0 -17
  458. package/dist/serialization/resources/connections/client/getConnectionCredentials.d.ts +0 -9
  459. package/dist/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.d.ts +0 -9
  460. package/dist/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -13
  461. package/dist/serialization/resources/connections/client/requests/index.d.ts +0 -1
  462. package/dist/serialization/resources/connections/client/requests/index.js +0 -5
  463. package/dist/serialization/resources/connections/client/sendOauth2WhiteLabelCode.d.ts +0 -9
  464. package/dist/serialization/resources/dag/client/index.d.ts +0 -1
  465. package/dist/serialization/resources/dag/client/index.js +0 -17
  466. package/dist/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +0 -18
  467. package/dist/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
  468. package/dist/serialization/resources/dag/client/requests/index.d.ts +0 -2
  469. package/dist/serialization/resources/dag/client/requests/index.js +0 -7
  470. package/dist/serialization/resources/dag/index.d.ts +0 -1
  471. package/dist/serialization/resources/dag/index.js +0 -17
  472. package/dist/serialization/resources/embeddingModels/client/index.d.ts +0 -1
  473. package/dist/serialization/resources/embeddingModels/client/index.js +0 -37
  474. package/dist/serialization/resources/embeddingModels/client/readEmbeddingModels.js +0 -42
  475. package/dist/serialization/resources/embeddingModels/index.d.ts +0 -1
  476. package/dist/serialization/resources/embeddingModels/index.js +0 -17
  477. package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
  478. package/dist/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
  479. package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +0 -11
  480. package/dist/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
  481. package/dist/serialization/resources/entities/client/index.d.ts +0 -5
  482. package/dist/serialization/resources/entities/client/index.js +0 -44
  483. package/dist/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
  484. package/dist/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
  485. package/dist/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
  486. package/dist/serialization/resources/entities/client/listEntityRelations.js +0 -42
  487. package/dist/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -15
  488. package/dist/serialization/resources/entities/client/requests/index.d.ts +0 -2
  489. package/dist/serialization/resources/entities/client/requests/index.js +0 -7
  490. package/dist/serialization/resources/entities/index.d.ts +0 -2
  491. package/dist/serialization/resources/entities/index.js +0 -18
  492. package/dist/serialization/resources/entities/types/index.d.ts +0 -1
  493. package/dist/serialization/resources/entities/types/index.js +0 -17
  494. package/dist/serialization/resources/search/client/index.d.ts +0 -1
  495. package/dist/serialization/resources/search/client/index.js +0 -37
  496. package/dist/serialization/resources/search/client/search.d.ts +0 -9
  497. package/dist/serialization/resources/search/client/search.js +0 -41
  498. package/dist/serialization/resources/search/index.d.ts +0 -1
  499. package/dist/serialization/resources/search/index.js +0 -17
  500. package/dist/serialization/resources/sync/client/index.d.ts +0 -3
  501. package/dist/serialization/resources/sync/client/listAllJobs.d.ts +0 -11
  502. package/dist/serialization/resources/sync/client/listAllJobs.js +0 -42
  503. package/dist/serialization/resources/sync/client/listSyncJobs.d.ts +0 -11
  504. package/dist/serialization/resources/sync/client/listSyncJobs.js +0 -42
  505. package/dist/serialization/resources/sync/client/requests/index.d.ts +0 -2
  506. package/dist/serialization/resources/sync/client/requests/index.js +0 -7
  507. package/dist/serialization/resources/sync/index.d.ts +0 -2
  508. package/dist/serialization/resources/sync/index.js +0 -18
  509. package/dist/serialization/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -12
  510. package/dist/serialization/resources/sync/types/ListSyncsSyncGetResponse.js +0 -46
  511. package/dist/serialization/resources/sync/types/index.d.ts +0 -1
  512. package/dist/serialization/resources/sync/types/index.js +0 -17
  513. package/dist/serialization/resources/transformers/client/index.d.ts +0 -2
  514. package/dist/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
  515. package/dist/serialization/resources/transformers/client/listTransformers.js +0 -42
  516. package/dist/serialization/resources/transformers/client/requests/index.d.ts +0 -1
  517. package/dist/serialization/resources/transformers/client/requests/index.js +0 -5
  518. package/dist/serialization/resources/transformers/index.d.ts +0 -1
  519. package/dist/serialization/resources/transformers/index.js +0 -17
  520. package/dist/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.d.ts +0 -9
  521. package/dist/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.d.ts +0 -9
  522. package/serialization/resources/apiKeys/client/index.d.ts +0 -2
  523. package/serialization/resources/apiKeys/client/index.js +0 -41
  524. package/serialization/resources/apiKeys/client/readApiKeys.d.ts +0 -11
  525. package/serialization/resources/apiKeys/client/readApiKeys.js +0 -42
  526. package/serialization/resources/apiKeys/client/requests/index.d.ts +0 -1
  527. package/serialization/resources/apiKeys/client/requests/index.js +0 -5
  528. package/serialization/resources/apiKeys/index.d.ts +0 -1
  529. package/serialization/resources/apiKeys/index.js +0 -17
  530. package/serialization/resources/chat/client/index.d.ts +0 -2
  531. package/serialization/resources/chat/client/index.js +0 -41
  532. package/serialization/resources/chat/client/listChats.d.ts +0 -11
  533. package/serialization/resources/chat/client/listChats.js +0 -42
  534. package/serialization/resources/chat/client/requests/index.d.ts +0 -1
  535. package/serialization/resources/chat/client/requests/index.js +0 -5
  536. package/serialization/resources/chat/index.d.ts +0 -1
  537. package/serialization/resources/chat/index.js +0 -17
  538. package/serialization/resources/connections/client/getConnectionCredentials.d.ts +0 -9
  539. package/serialization/resources/connections/client/getConnectionCredentials.js +0 -41
  540. package/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.d.ts +0 -9
  541. package/serialization/resources/connections/client/getOauth2WhiteLabelAuthUrl.js +0 -41
  542. package/serialization/resources/connections/client/listConnectedIntegrations.d.ts +0 -11
  543. package/serialization/resources/connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.d.ts +0 -13
  544. package/serialization/resources/connections/client/requests/index.d.ts +0 -1
  545. package/serialization/resources/connections/client/requests/index.js +0 -5
  546. package/serialization/resources/connections/client/sendOauth2WhiteLabelCode.d.ts +0 -9
  547. package/serialization/resources/connections/client/sendOauth2WhiteLabelCode.js +0 -41
  548. package/serialization/resources/dag/client/index.d.ts +0 -1
  549. package/serialization/resources/dag/client/index.js +0 -17
  550. package/serialization/resources/dag/client/requests/SyncDagCreate.d.ts +0 -18
  551. package/serialization/resources/dag/client/requests/SyncDagUpdate.d.ts +0 -18
  552. package/serialization/resources/dag/client/requests/index.d.ts +0 -2
  553. package/serialization/resources/dag/client/requests/index.js +0 -7
  554. package/serialization/resources/dag/index.d.ts +0 -1
  555. package/serialization/resources/dag/index.js +0 -17
  556. package/serialization/resources/embeddingModels/client/index.d.ts +0 -1
  557. package/serialization/resources/embeddingModels/client/index.js +0 -37
  558. package/serialization/resources/embeddingModels/client/readEmbeddingModels.d.ts +0 -11
  559. package/serialization/resources/embeddingModels/client/readEmbeddingModels.js +0 -42
  560. package/serialization/resources/embeddingModels/index.d.ts +0 -1
  561. package/serialization/resources/embeddingModels/index.js +0 -17
  562. package/serialization/resources/entities/client/getEntityDefinitionsByIds.d.ts +0 -15
  563. package/serialization/resources/entities/client/getEntityDefinitionsByIds.js +0 -43
  564. package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.d.ts +0 -11
  565. package/serialization/resources/entities/client/getEntityDefinitionsBySourceShortName.js +0 -42
  566. package/serialization/resources/entities/client/index.d.ts +0 -5
  567. package/serialization/resources/entities/client/index.js +0 -44
  568. package/serialization/resources/entities/client/listEntityDefinitions.d.ts +0 -11
  569. package/serialization/resources/entities/client/listEntityDefinitions.js +0 -42
  570. package/serialization/resources/entities/client/listEntityRelations.d.ts +0 -11
  571. package/serialization/resources/entities/client/listEntityRelations.js +0 -42
  572. package/serialization/resources/entities/client/requests/EntityRelationCreate.d.ts +0 -15
  573. package/serialization/resources/entities/client/requests/index.d.ts +0 -2
  574. package/serialization/resources/entities/client/requests/index.js +0 -7
  575. package/serialization/resources/entities/index.d.ts +0 -2
  576. package/serialization/resources/entities/index.js +0 -18
  577. package/serialization/resources/entities/types/index.d.ts +0 -1
  578. package/serialization/resources/entities/types/index.js +0 -17
  579. package/serialization/resources/search/client/index.d.ts +0 -1
  580. package/serialization/resources/search/client/index.js +0 -37
  581. package/serialization/resources/search/client/search.d.ts +0 -9
  582. package/serialization/resources/search/client/search.js +0 -41
  583. package/serialization/resources/search/index.d.ts +0 -1
  584. package/serialization/resources/search/index.js +0 -17
  585. package/serialization/resources/sync/client/index.d.ts +0 -3
  586. package/serialization/resources/sync/client/index.js +0 -42
  587. package/serialization/resources/sync/client/listAllJobs.d.ts +0 -11
  588. package/serialization/resources/sync/client/listAllJobs.js +0 -42
  589. package/serialization/resources/sync/client/listSyncJobs.d.ts +0 -11
  590. package/serialization/resources/sync/client/listSyncJobs.js +0 -42
  591. package/serialization/resources/sync/client/requests/index.d.ts +0 -2
  592. package/serialization/resources/sync/client/requests/index.js +0 -7
  593. package/serialization/resources/sync/index.d.ts +0 -2
  594. package/serialization/resources/sync/index.js +0 -18
  595. package/serialization/resources/sync/types/ListSyncsSyncGetResponse.d.ts +0 -12
  596. package/serialization/resources/sync/types/ListSyncsSyncGetResponse.js +0 -46
  597. package/serialization/resources/sync/types/index.d.ts +0 -1
  598. package/serialization/resources/sync/types/index.js +0 -17
  599. package/serialization/resources/transformers/client/index.d.ts +0 -2
  600. package/serialization/resources/transformers/client/index.js +0 -41
  601. package/serialization/resources/transformers/client/listTransformers.d.ts +0 -11
  602. package/serialization/resources/transformers/client/listTransformers.js +0 -42
  603. package/serialization/resources/transformers/client/requests/index.d.ts +0 -1
  604. package/serialization/resources/transformers/client/requests/index.js +0 -5
  605. package/serialization/resources/transformers/index.d.ts +0 -1
  606. package/serialization/resources/transformers/index.js +0 -17
  607. package/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.d.ts +0 -9
  608. package/serialization/resources/whiteLabels/client/exchangeWhiteLabelOauth2Code.js +0 -41
  609. package/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.d.ts +0 -9
  610. package/serialization/resources/whiteLabels/client/getWhiteLabelOauth2AuthUrl.js +0 -41
  611. /package/api/resources/{apiKeys → collections}/client/index.d.ts +0 -0
  612. /package/api/resources/{apiKeys → collections}/client/index.js +0 -0
  613. /package/api/resources/{apiKeys/client/requests/ApiKeyCreate.js → collections/client/requests/CollectionCreate.js} +0 -0
  614. /package/api/resources/{apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js → collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.js} +0 -0
  615. /package/api/resources/{apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js → collections/client/requests/ListCollectionsCollectionsGetRequest.js} +0 -0
  616. /package/api/resources/{apiKeys → collections}/client/requests/index.js +0 -0
  617. /package/api/resources/{apiKeys → collections}/index.d.ts +0 -0
  618. /package/api/resources/{apiKeys → collections}/index.js +0 -0
  619. /package/api/resources/{chat → sourceConnections}/client/index.d.ts +0 -0
  620. /package/api/resources/{chat → sourceConnections}/client/index.js +0 -0
  621. /package/api/resources/{chat/client/requests/ChatCreate.js → sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.js} +0 -0
  622. /package/api/resources/{chat/client/requests/ListChatsChatGetRequest.js → sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
  623. /package/api/resources/{connections/client/requests/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.js} +0 -0
  624. /package/api/resources/{dag/client/requests/SyncDagCreate.js → sourceConnections/client/requests/SourceConnectionUpdate.js} +0 -0
  625. /package/api/resources/{chat → sourceConnections}/client/requests/index.js +0 -0
  626. /package/api/resources/{chat → sourceConnections}/index.d.ts +0 -0
  627. /package/api/resources/{chat → sourceConnections}/index.js +0 -0
  628. /package/{dist/api/resources/apiKeys/client/requests → api/types}/ApiKeyCreate.js +0 -0
  629. /package/{dist/api/resources/connections/client/requests → api/types}/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js +0 -0
  630. /package/api/{resources/dag/client/requests/SyncDagUpdate.js → types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js} +0 -0
  631. /package/{dist/api/resources/chat/client/requests → api/types}/ChatCreate.js +0 -0
  632. /package/api/{resources/entities/client/requests/EntityDefinitionCreate.js → types/Collection.js} +0 -0
  633. /package/api/{resources/entities/client/requests/EntityRelationCreate.js → types/CollectionUpdate.js} +0 -0
  634. /package/api/{resources/entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → types/ConfigValues.js} +0 -0
  635. /package/{dist/api/resources/entities/client/requests → api/types}/EntityDefinitionCreate.js +0 -0
  636. /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
  637. /package/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.js +0 -0
  638. /package/{dist/api/resources/entities/client/requests → api/types}/EntityRelationCreate.js +0 -0
  639. /package/api/{resources/search/client/requests/SearchSearchGetRequest.js → types/SearchResponse.js} +0 -0
  640. /package/api/{resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.js → types/SourceConnection.js} +0 -0
  641. /package/api/{resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js → types/SourceConnectionAuthFields.js} +0 -0
  642. /package/api/{resources/sync/client/requests/ListSyncsSyncGetRequest.js → types/SourceConnectionCreate.js} +0 -0
  643. /package/api/{resources/sync/client/requests/SyncCreate.js → types/SourceConnectionJob.js} +0 -0
  644. /package/api/{resources/sync/client/requests/SyncUpdate.js → types/SourceConnectionListItem.js} +0 -0
  645. /package/{dist/api/resources/sync/client/requests → api/types}/SyncCreate.js +0 -0
  646. /package/{dist/api/resources/dag/client/requests → api/types}/SyncDagCreate.js +0 -0
  647. /package/{dist/api/resources/dag/client/requests → api/types}/SyncDagUpdate.js +0 -0
  648. /package/{dist/api/resources/sync/client/requests → api/types}/SyncUpdate.js +0 -0
  649. /package/api/{resources/transformers/client/requests → types}/TransformerCreate.js +0 -0
  650. /package/{api/resources/dag → dist/api/resources/collections}/client/index.d.ts +0 -0
  651. /package/{api/resources/dag → dist/api/resources/collections}/client/index.js +0 -0
  652. /package/{api/resources/sync/types/ListSyncsSyncGetResponse.js → dist/api/resources/collections/client/requests/CollectionCreate.js} +0 -0
  653. /package/{api/types/ApiKeyWithPlainKey.js → dist/api/resources/collections/client/requests/DeleteCollectionCollectionsReadableIdDeleteRequest.js} +0 -0
  654. /package/dist/api/resources/{apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js → collections/client/requests/ListCollectionsCollectionsGetRequest.js} +0 -0
  655. /package/{api/resources/connections → dist/api/resources/collections}/client/requests/index.js +0 -0
  656. /package/{api/resources/dag → dist/api/resources/collections}/index.d.ts +0 -0
  657. /package/{api/resources/dag → dist/api/resources/collections}/index.js +0 -0
  658. /package/{api/resources/entities → dist/api/resources/sourceConnections}/client/index.d.ts +0 -0
  659. /package/{api/resources/entities → dist/api/resources/sourceConnections}/client/index.js +0 -0
  660. /package/dist/api/resources/{apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js → sourceConnections/client/requests/DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest.js} +0 -0
  661. /package/dist/api/resources/{chat/client/requests/ListChatsChatGetRequest.js → sourceConnections/client/requests/GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
  662. /package/dist/api/resources/{entities/client/requests/GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest.js → sourceConnections/client/requests/ListSourceConnectionsSourceConnectionsGetRequest.js} +0 -0
  663. /package/dist/api/resources/{entities/types/EntityDefinitionCreateEntitySchema.js → sourceConnections/client/requests/SourceConnectionUpdate.js} +0 -0
  664. /package/{api/resources/dag → dist/api/resources/sourceConnections}/client/requests/index.js +0 -0
  665. /package/{api/resources/embeddingModels → dist/api/resources/sourceConnections}/index.d.ts +0 -0
  666. /package/{api/resources/embeddingModels → dist/api/resources/sourceConnections}/index.js +0 -0
  667. /package/dist/api/{resources/search/client/requests/SearchSearchGetRequest.js → types/ApiKeyCreate.js} +0 -0
  668. /package/dist/api/{resources/sync/client/requests/DeleteSyncSyncSyncIdDeleteRequest.js → types/BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.js} +0 -0
  669. /package/dist/api/{resources/sync/client/requests/ListAllJobsSyncJobsGetRequest.js → types/BodyCreateSourceConnectionFromOauthConnectionsCreateSourceConnectionFromOauthPost.js} +0 -0
  670. /package/dist/api/{resources/sync/client/requests/ListSyncsSyncGetRequest.js → types/ChatCreate.js} +0 -0
  671. /package/dist/api/{resources/sync/types/ListSyncsSyncGetResponse.js → types/Collection.js} +0 -0
  672. /package/dist/api/{resources/transformers/client/requests/TransformerCreate.js → types/CollectionUpdate.js} +0 -0
  673. /package/dist/api/types/{ApiKeyWithPlainKey.js → ConfigValues.js} +0 -0
  674. /package/dist/api/{resources/entities/types → types}/EntityDefinitionCreateEntitySchema.d.ts +0 -0
  675. /package/{api/resources/search → dist/serialization/resources/collections}/index.d.ts +0 -0
  676. /package/{api/resources/search → dist/serialization/resources/collections}/index.js +0 -0
  677. /package/{api/resources/transformers → dist/serialization/resources/sourceConnections}/index.d.ts +0 -0
  678. /package/{api/resources/transformers → dist/serialization/resources/sourceConnections}/index.js +0 -0
  679. /package/{api/resources/users → serialization/resources/collections}/index.d.ts +0 -0
  680. /package/{api/resources/users → serialization/resources/collections}/index.js +0 -0
  681. /package/{dist/api/resources/apiKeys → serialization/resources/sourceConnections}/index.d.ts +0 -0
  682. /package/{dist/api/resources/apiKeys → serialization/resources/sourceConnections}/index.js +0 -0
package/reference.md CHANGED
@@ -1,2047 +1,8 @@
1
1
  # Reference
2
2
 
3
- ## ApiKeys
4
-
5
- <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKeys</a>({ ...params }) -> AirweaveSDK.ApiKey[]</code></summary>
6
- <dl>
7
- <dd>
8
-
9
- #### 📝 Description
10
-
11
- <dl>
12
- <dd>
13
-
14
- <dl>
15
- <dd>
16
-
17
- Retrieve all API keys for the current user.
18
-
19
- ## Args:
20
-
21
- db (AsyncSession): The database session.
22
- skip (int): Number of records to skip for pagination.
23
- limit (int): Maximum number of records to return.
24
- user (schemas.User): The current user.
25
-
26
- ## Returns:
27
-
28
- List[schemas.APIKey]: A list of API keys.
29
-
30
- </dd>
31
- </dl>
32
- </dd>
33
- </dl>
34
-
35
- #### 🔌 Usage
36
-
37
- <dl>
38
- <dd>
39
-
40
- <dl>
41
- <dd>
42
-
43
- ```typescript
44
- await client.apiKeys.readApiKeys();
45
- ```
46
-
47
- </dd>
48
- </dl>
49
- </dd>
50
- </dl>
51
-
52
- #### ⚙️ Parameters
53
-
54
- <dl>
55
- <dd>
56
-
57
- <dl>
58
- <dd>
59
-
60
- **request:** `AirweaveSDK.ReadApiKeysApiKeysGetRequest`
61
-
62
- </dd>
63
- </dl>
64
-
65
- <dl>
66
- <dd>
67
-
68
- **requestOptions:** `ApiKeys.RequestOptions`
69
-
70
- </dd>
71
- </dl>
72
- </dd>
73
- </dl>
74
-
75
- </dd>
76
- </dl>
77
- </details>
78
-
79
- <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">createApiKey</a>({ ...params }) -> AirweaveSDK.ApiKeyWithPlainKey</code></summary>
80
- <dl>
81
- <dd>
82
-
83
- #### 📝 Description
84
-
85
- <dl>
86
- <dd>
87
-
88
- <dl>
89
- <dd>
90
-
91
- Create a new API key for the current user.
92
-
93
- Returns a temporary plain key for the user to store securely.
94
- This is not stored in the database.
95
-
96
- ## Args:
97
-
98
- db (AsyncSession): The database session.
99
- api_key_in (schemas.APIKeyCreate): The API key creation data.
100
- user (schemas.User): The current user.
101
-
102
- ## Returns:
103
-
104
- schemas.APIKeyWithPlainKey: The created API key object, including the key.
105
-
106
- </dd>
107
- </dl>
108
- </dd>
109
- </dl>
110
-
111
- #### 🔌 Usage
112
-
113
- <dl>
114
- <dd>
115
-
116
- <dl>
117
- <dd>
118
-
119
- ```typescript
120
- await client.apiKeys.createApiKey();
121
- ```
122
-
123
- </dd>
124
- </dl>
125
- </dd>
126
- </dl>
127
-
128
- #### ⚙️ Parameters
129
-
130
- <dl>
131
- <dd>
132
-
133
- <dl>
134
- <dd>
135
-
136
- **request:** `AirweaveSDK.ApiKeyCreate`
137
-
138
- </dd>
139
- </dl>
140
-
141
- <dl>
142
- <dd>
143
-
144
- **requestOptions:** `ApiKeys.RequestOptions`
145
-
146
- </dd>
147
- </dl>
148
- </dd>
149
- </dl>
150
-
151
- </dd>
152
- </dl>
153
- </details>
154
-
155
- <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">deleteApiKey</a>({ ...params }) -> AirweaveSDK.ApiKey</code></summary>
156
- <dl>
157
- <dd>
158
-
159
- #### 📝 Description
160
-
161
- <dl>
162
- <dd>
163
-
164
- <dl>
165
- <dd>
166
-
167
- Delete an API key.
168
-
169
- ## Args:
170
-
171
- db (AsyncSession): The database session.
172
- id (UUID): The ID of the API key.
173
- user (schemas.User): The current user.
174
-
175
- ## Returns:
176
-
177
- schemas.APIKey: The revoked API key object.
178
-
179
- ## Raises:
180
-
181
- HTTPException: If the API key is not found.
182
-
183
- </dd>
184
- </dl>
185
- </dd>
186
- </dl>
187
-
188
- #### 🔌 Usage
189
-
190
- <dl>
191
- <dd>
192
-
193
- <dl>
194
- <dd>
195
-
196
- ```typescript
197
- await client.apiKeys.deleteApiKey({
198
- id: "id",
199
- });
200
- ```
201
-
202
- </dd>
203
- </dl>
204
- </dd>
205
- </dl>
206
-
207
- #### ⚙️ Parameters
208
-
209
- <dl>
210
- <dd>
211
-
212
- <dl>
213
- <dd>
214
-
215
- **request:** `AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest`
216
-
217
- </dd>
218
- </dl>
219
-
220
- <dl>
221
- <dd>
222
-
223
- **requestOptions:** `ApiKeys.RequestOptions`
224
-
225
- </dd>
226
- </dl>
227
- </dd>
228
- </dl>
229
-
230
- </dd>
231
- </dl>
232
- </details>
233
-
234
- <details><summary><code>client.apiKeys.<a href="/src/api/resources/apiKeys/client/Client.ts">readApiKey</a>(id) -> AirweaveSDK.ApiKey</code></summary>
235
- <dl>
236
- <dd>
237
-
238
- #### 📝 Description
239
-
240
- <dl>
241
- <dd>
242
-
243
- <dl>
244
- <dd>
245
-
246
- Retrieve an API key by ID.
247
-
248
- ## Args:
249
-
250
- db (AsyncSession): The database session.
251
- id (UUID): The ID of the API key.
252
- user (schemas.User): The current user.
253
-
254
- ## Returns:
255
-
256
- schemas.APIKey: The API key object.
257
-
258
- ## Raises:
259
-
260
- HTTPException: If the API key is not found.
261
-
262
- </dd>
263
- </dl>
264
- </dd>
265
- </dl>
266
-
267
- #### 🔌 Usage
268
-
269
- <dl>
270
- <dd>
271
-
272
- <dl>
273
- <dd>
274
-
275
- ```typescript
276
- await client.apiKeys.readApiKey("id");
277
- ```
278
-
279
- </dd>
280
- </dl>
281
- </dd>
282
- </dl>
283
-
284
- #### ⚙️ Parameters
285
-
286
- <dl>
287
- <dd>
288
-
289
- <dl>
290
- <dd>
291
-
292
- **id:** `string`
293
-
294
- </dd>
295
- </dl>
296
-
297
- <dl>
298
- <dd>
299
-
300
- **requestOptions:** `ApiKeys.RequestOptions`
301
-
302
- </dd>
303
- </dl>
304
- </dd>
305
- </dl>
306
-
307
- </dd>
308
- </dl>
309
- </details>
310
-
311
- ## Users
312
-
313
- <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">readUser</a>() -> AirweaveSDK.User</code></summary>
314
- <dl>
315
- <dd>
316
-
317
- #### 📝 Description
318
-
319
- <dl>
320
- <dd>
321
-
322
- <dl>
323
- <dd>
324
-
325
- Get current user.
326
-
327
- ## Args:
328
-
329
- current_user (User): The current user.
330
-
331
- ## Returns:
332
-
333
- schemas.User: The user object.
334
-
335
- </dd>
336
- </dl>
337
- </dd>
338
- </dl>
339
-
340
- #### 🔌 Usage
341
-
342
- <dl>
343
- <dd>
344
-
345
- <dl>
346
- <dd>
347
-
348
- ```typescript
349
- await client.users.readUser();
350
- ```
351
-
352
- </dd>
353
- </dl>
354
- </dd>
355
- </dl>
356
-
357
- #### ⚙️ Parameters
358
-
359
- <dl>
360
- <dd>
361
-
362
- <dl>
363
- <dd>
364
-
365
- **requestOptions:** `Users.RequestOptions`
366
-
367
- </dd>
368
- </dl>
369
- </dd>
370
- </dl>
371
-
372
- </dd>
373
- </dl>
374
- </details>
375
-
376
- ## Sources
377
-
378
- <details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithAuthenticationFields</code></summary>
379
- <dl>
380
- <dd>
381
-
382
- #### 📝 Description
383
-
384
- <dl>
385
- <dd>
386
-
387
- <dl>
388
- <dd>
389
-
390
- Get source by id.
391
-
392
- ## Args:
393
-
394
- db (AsyncSession): The database session.
395
- short_name (str): The short name of the source.
396
- user (schemas.User): The current user.
397
-
398
- ## Returns:
399
-
400
- schemas.Source: The source object.
401
-
402
- </dd>
403
- </dl>
404
- </dd>
405
- </dl>
406
-
407
- #### 🔌 Usage
408
-
409
- <dl>
410
- <dd>
411
-
412
- <dl>
413
- <dd>
414
-
415
- ```typescript
416
- await client.sources.readSource("short_name");
417
- ```
418
-
419
- </dd>
420
- </dl>
421
- </dd>
422
- </dl>
423
-
424
- #### ⚙️ Parameters
425
-
426
- <dl>
427
- <dd>
428
-
429
- <dl>
430
- <dd>
431
-
432
- **shortName:** `string`
433
-
434
- </dd>
435
- </dl>
436
-
437
- <dl>
438
- <dd>
439
-
440
- **requestOptions:** `Sources.RequestOptions`
441
-
442
- </dd>
443
- </dl>
444
- </dd>
445
- </dl>
446
-
447
- </dd>
448
- </dl>
449
- </details>
450
-
451
- <details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
452
- <dl>
453
- <dd>
454
-
455
- #### 📝 Description
456
-
457
- <dl>
458
- <dd>
459
-
460
- <dl>
461
- <dd>
462
-
463
- Get all sources for the current user.
464
-
465
- ## Args:
466
-
467
- db: The database session
468
- user: The current user
469
-
470
- ## Returns:
471
-
472
- list[schemas.Source]: The list of sources.
473
-
474
- </dd>
475
- </dl>
476
- </dd>
477
- </dl>
478
-
479
- #### 🔌 Usage
480
-
481
- <dl>
482
- <dd>
483
-
484
- <dl>
485
- <dd>
486
-
487
- ```typescript
488
- await client.sources.readSources();
489
- ```
490
-
491
- </dd>
492
- </dl>
493
- </dd>
494
- </dl>
495
-
496
- #### ⚙️ Parameters
497
-
498
- <dl>
499
- <dd>
500
-
501
- <dl>
502
- <dd>
503
-
504
- **requestOptions:** `Sources.RequestOptions`
505
-
506
- </dd>
507
- </dl>
508
- </dd>
509
- </dl>
510
-
511
- </dd>
512
- </dl>
513
- </details>
514
-
515
- ## EmbeddingModels
516
-
517
- <details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithAuthenticationFields</code></summary>
518
- <dl>
519
- <dd>
520
-
521
- #### 📝 Description
522
-
523
- <dl>
524
- <dd>
525
-
526
- <dl>
527
- <dd>
528
-
529
- Get embedding model by id.
530
-
531
- ## Args:
532
-
533
- db (AsyncSession): The database session.
534
- short_name (str): The short name of the embedding model.
535
- user (schemas.User): The current user.
536
-
537
- ## Returns:
538
-
539
- schemas.EmbeddingModel: The embedding model object.
540
-
541
- </dd>
542
- </dl>
543
- </dd>
544
- </dl>
545
-
546
- #### 🔌 Usage
547
-
548
- <dl>
549
- <dd>
550
-
551
- <dl>
552
- <dd>
553
-
554
- ```typescript
555
- await client.embeddingModels.readEmbeddingModel("short_name");
556
- ```
557
-
558
- </dd>
559
- </dl>
560
- </dd>
561
- </dl>
562
-
563
- #### ⚙️ Parameters
564
-
565
- <dl>
566
- <dd>
567
-
568
- <dl>
569
- <dd>
570
-
571
- **shortName:** `string`
572
-
573
- </dd>
574
- </dl>
575
-
576
- <dl>
577
- <dd>
578
-
579
- **requestOptions:** `EmbeddingModels.RequestOptions`
580
-
581
- </dd>
582
- </dl>
583
- </dd>
584
- </dl>
585
-
586
- </dd>
587
- </dl>
588
- </details>
589
-
590
- <details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModels</a>() -> AirweaveSDK.EmbeddingModel[]</code></summary>
591
- <dl>
592
- <dd>
593
-
594
- #### 📝 Description
595
-
596
- <dl>
597
- <dd>
598
-
599
- <dl>
600
- <dd>
601
-
602
- Get all embedding models.
603
-
604
- ## Args:
605
-
606
- db (AsyncSession): The database session.
607
- user (schemas.User): The current user.
608
-
609
- ## Returns:
610
-
611
- list[schemas.EmbeddingModel]: The list of embedding models.
612
-
613
- </dd>
614
- </dl>
615
- </dd>
616
- </dl>
617
-
618
- #### 🔌 Usage
619
-
620
- <dl>
621
- <dd>
622
-
623
- <dl>
624
- <dd>
625
-
626
- ```typescript
627
- await client.embeddingModels.readEmbeddingModels();
628
- ```
629
-
630
- </dd>
631
- </dl>
632
- </dd>
633
- </dl>
634
-
635
- #### ⚙️ Parameters
636
-
637
- <dl>
638
- <dd>
639
-
640
- <dl>
641
- <dd>
642
-
643
- **requestOptions:** `EmbeddingModels.RequestOptions`
644
-
645
- </dd>
646
- </dl>
647
- </dd>
648
- </dl>
649
-
650
- </dd>
651
- </dl>
652
- </details>
653
-
654
- ## Connections
655
-
656
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
657
- <dl>
658
- <dd>
659
-
660
- #### 📝 Description
661
-
662
- <dl>
663
- <dd>
664
-
665
- <dl>
666
- <dd>
667
-
668
- Get a specific connection.
669
-
670
- ## Args:
671
-
672
- connection_id: The ID of the connection to get.
673
- db: The database session.
674
- user: The current user.
675
-
676
- ## Returns:
677
-
678
- schemas.Connection: The connection.
679
-
680
- </dd>
681
- </dl>
682
- </dd>
683
- </dl>
684
-
685
- #### 🔌 Usage
686
-
687
- <dl>
688
- <dd>
689
-
690
- <dl>
691
- <dd>
692
-
693
- ```typescript
694
- await client.connections.getConnection("connection_id");
695
- ```
696
-
697
- </dd>
698
- </dl>
699
- </dd>
700
- </dl>
701
-
702
- #### ⚙️ Parameters
703
-
704
- <dl>
705
- <dd>
706
-
707
- <dl>
708
- <dd>
709
-
710
- **connectionId:** `string`
711
-
712
- </dd>
713
- </dl>
714
-
715
- <dl>
716
- <dd>
717
-
718
- **requestOptions:** `Connections.RequestOptions`
719
-
720
- </dd>
721
- </dl>
722
- </dd>
723
- </dl>
724
-
725
- </dd>
726
- </dl>
727
- </details>
728
-
729
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
730
- <dl>
731
- <dd>
732
-
733
- #### 📝 Description
734
-
735
- <dl>
736
- <dd>
737
-
738
- <dl>
739
- <dd>
740
-
741
- Get all active connections for the current user across all integration types.
742
-
743
- ## Args:
744
-
745
- db: The database session.
746
- user: The current user.
747
-
748
- ## Returns:
749
-
750
- list[schemas.Connection]: The list of connections.
751
-
752
- </dd>
753
- </dl>
754
- </dd>
755
- </dl>
756
-
757
- #### 🔌 Usage
758
-
759
- <dl>
760
- <dd>
761
-
762
- <dl>
763
- <dd>
764
-
765
- ```typescript
766
- await client.connections.listAllConnectedIntegrations();
767
- ```
768
-
769
- </dd>
770
- </dl>
771
- </dd>
772
- </dl>
773
-
774
- #### ⚙️ Parameters
775
-
776
- <dl>
777
- <dd>
778
-
779
- <dl>
780
- <dd>
781
-
782
- **requestOptions:** `Connections.RequestOptions`
783
-
784
- </dd>
785
- </dl>
786
- </dd>
787
- </dl>
788
-
789
- </dd>
790
- </dl>
791
- </details>
792
-
793
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listConnectedIntegrations</a>(integrationType) -> AirweaveSDK.Connection[]</code></summary>
794
- <dl>
795
- <dd>
796
-
797
- #### 📝 Description
798
-
799
- <dl>
800
- <dd>
801
-
802
- <dl>
803
- <dd>
804
-
805
- Get all integrations of specified type connected to the current user.
806
-
807
- ## Args:
808
-
809
- integration_type (IntegrationType): The type of integration to get connections for.
810
- db (AsyncSession): The database session.
811
- user (schemas.User): The current user.
812
-
813
- ## Returns:
814
-
815
- list[schemas.Connection]: The list of connections.
816
-
817
- </dd>
818
- </dl>
819
- </dd>
820
- </dl>
821
-
822
- #### 🔌 Usage
823
-
824
- <dl>
825
- <dd>
826
-
827
- <dl>
828
- <dd>
829
-
830
- ```typescript
831
- await client.connections.listConnectedIntegrations("source");
832
- ```
833
-
834
- </dd>
835
- </dl>
836
- </dd>
837
- </dl>
838
-
839
- #### ⚙️ Parameters
840
-
841
- <dl>
842
- <dd>
843
-
844
- <dl>
845
- <dd>
846
-
847
- **integrationType:** `AirweaveSDK.IntegrationType`
848
-
849
- </dd>
850
- </dl>
851
-
852
- <dl>
853
- <dd>
854
-
855
- **requestOptions:** `Connections.RequestOptions`
856
-
857
- </dd>
858
- </dl>
859
- </dd>
860
- </dl>
861
-
862
- </dd>
863
- </dl>
864
- </details>
865
-
866
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">connectIntegration</a>(integrationType, shortName, { ...params }) -> AirweaveSDK.Connection</code></summary>
867
- <dl>
868
- <dd>
869
-
870
- #### 📝 Description
871
-
872
- <dl>
873
- <dd>
874
-
875
- <dl>
876
- <dd>
877
-
878
- Connect to a source, destination, or embedding model.
879
-
880
- Expects a POST body with:
881
-
882
- ```json
883
- {
884
- "name": "required connection name",
885
- ... other config fields specific to the integration type ...
886
- }
887
- ```
888
-
889
- ## Args:
890
-
891
- db: The database session.
892
- integration_type: The type of integration to connect to.
893
- short_name: The short name of the integration to connect to.
894
- name: The name of the connection.
895
- auth_fields: The config fields for the integration.
896
- user: The current user.
897
-
898
- ## Returns:
899
-
900
- schemas.Connection: The connection.
901
-
902
- </dd>
903
- </dl>
904
- </dd>
905
- </dl>
906
-
907
- #### 🔌 Usage
908
-
909
- <dl>
910
- <dd>
911
-
912
- <dl>
913
- <dd>
914
-
915
- ```typescript
916
- await client.connections.connectIntegration("source", "short_name", {
917
- authFields: {
918
- key: "value",
919
- },
920
- });
921
- ```
922
-
923
- </dd>
924
- </dl>
925
- </dd>
926
- </dl>
927
-
928
- #### ⚙️ Parameters
929
-
930
- <dl>
931
- <dd>
932
-
933
- <dl>
934
- <dd>
935
-
936
- **integrationType:** `AirweaveSDK.IntegrationType`
937
-
938
- </dd>
939
- </dl>
940
-
941
- <dl>
942
- <dd>
943
-
944
- **shortName:** `string`
945
-
946
- </dd>
947
- </dl>
948
-
949
- <dl>
950
- <dd>
951
-
952
- **request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
953
-
954
- </dd>
955
- </dl>
956
-
957
- <dl>
958
- <dd>
959
-
960
- **requestOptions:** `Connections.RequestOptions`
961
-
962
- </dd>
963
- </dl>
964
- </dd>
965
- </dl>
966
-
967
- </dd>
968
- </dl>
969
- </details>
970
-
971
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnectionCredentials</a>(connectionId) -> Record<string, unknown></code></summary>
972
- <dl>
973
- <dd>
974
-
975
- #### 📝 Description
976
-
977
- <dl>
978
- <dd>
979
-
980
- <dl>
981
- <dd>
982
-
983
- Get the credentials for a connection.
984
-
985
- ## Args:
986
-
987
- connection_id (UUID): The ID of the connection to get credentials for
988
- db (AsyncSession): The database session
989
- user (schemas.User): The current user
990
-
991
- ## Returns:
992
-
993
- decrypted_credentials (dict): The credentials for the connection
994
-
995
- </dd>
996
- </dl>
997
- </dd>
998
- </dl>
999
-
1000
- #### 🔌 Usage
1001
-
1002
- <dl>
1003
- <dd>
1004
-
1005
- <dl>
1006
- <dd>
1007
-
1008
- ```typescript
1009
- await client.connections.getConnectionCredentials("connection_id");
1010
- ```
1011
-
1012
- </dd>
1013
- </dl>
1014
- </dd>
1015
- </dl>
1016
-
1017
- #### ⚙️ Parameters
1018
-
1019
- <dl>
1020
- <dd>
1021
-
1022
- <dl>
1023
- <dd>
1024
-
1025
- **connectionId:** `string`
1026
-
1027
- </dd>
1028
- </dl>
1029
-
1030
- <dl>
1031
- <dd>
1032
-
1033
- **requestOptions:** `Connections.RequestOptions`
1034
-
1035
- </dd>
1036
- </dl>
1037
- </dd>
1038
- </dl>
1039
-
1040
- </dd>
1041
- </dl>
1042
- </details>
1043
-
1044
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">deleteConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
1045
- <dl>
1046
- <dd>
1047
-
1048
- #### 📝 Description
1049
-
1050
- <dl>
1051
- <dd>
1052
-
1053
- <dl>
1054
- <dd>
1055
-
1056
- Delete a connection.
1057
-
1058
- Deletes the connection and integration credential.
1059
-
1060
- ## Args:
1061
-
1062
- db (AsyncSession): The database session
1063
- connection_id (UUID): The ID of the connection to delete
1064
- user (schemas.User): The current user
1065
-
1066
- ## Returns:
1067
-
1068
- connection (schemas.Connection): The deleted connection
1069
-
1070
- </dd>
1071
- </dl>
1072
- </dd>
1073
- </dl>
1074
-
1075
- #### 🔌 Usage
1076
-
1077
- <dl>
1078
- <dd>
1079
-
1080
- <dl>
1081
- <dd>
1082
-
1083
- ```typescript
1084
- await client.connections.deleteConnection("connection_id");
1085
- ```
1086
-
1087
- </dd>
1088
- </dl>
1089
- </dd>
1090
- </dl>
1091
-
1092
- #### ⚙️ Parameters
1093
-
1094
- <dl>
1095
- <dd>
1096
-
1097
- <dl>
1098
- <dd>
1099
-
1100
- **connectionId:** `string`
1101
-
1102
- </dd>
1103
- </dl>
1104
-
1105
- <dl>
1106
- <dd>
1107
-
1108
- **requestOptions:** `Connections.RequestOptions`
1109
-
1110
- </dd>
1111
- </dl>
1112
- </dd>
1113
- </dl>
1114
-
1115
- </dd>
1116
- </dl>
1117
- </details>
1118
-
1119
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectSourceConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
1120
- <dl>
1121
- <dd>
1122
-
1123
- #### 📝 Description
1124
-
1125
- <dl>
1126
- <dd>
1127
-
1128
- <dl>
1129
- <dd>
1130
-
1131
- Disconnect from a source connection.
1132
-
1133
- ## Args:
1134
-
1135
- db (AsyncSession): The database session
1136
- connection_id (UUID): The ID of the connection to disconnect
1137
- user (schemas.User): The current user
1138
-
1139
- ## Returns:
1140
-
1141
- connection (schemas.Connection): The disconnected connection
1142
-
1143
- </dd>
1144
- </dl>
1145
- </dd>
1146
- </dl>
1147
-
1148
- #### 🔌 Usage
1149
-
1150
- <dl>
1151
- <dd>
1152
-
1153
- <dl>
1154
- <dd>
1155
-
1156
- ```typescript
1157
- await client.connections.disconnectSourceConnection("connection_id");
1158
- ```
1159
-
1160
- </dd>
1161
- </dl>
1162
- </dd>
1163
- </dl>
1164
-
1165
- #### ⚙️ Parameters
1166
-
1167
- <dl>
1168
- <dd>
1169
-
1170
- <dl>
1171
- <dd>
1172
-
1173
- **connectionId:** `string`
1174
-
1175
- </dd>
1176
- </dl>
1177
-
1178
- <dl>
1179
- <dd>
1180
-
1181
- **requestOptions:** `Connections.RequestOptions`
1182
-
1183
- </dd>
1184
- </dl>
1185
- </dd>
1186
- </dl>
1187
-
1188
- </dd>
1189
- </dl>
1190
- </details>
1191
-
1192
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2WhiteLabelCode</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
1193
- <dl>
1194
- <dd>
1195
-
1196
- #### 📝 Description
1197
-
1198
- <dl>
1199
- <dd>
1200
-
1201
- <dl>
1202
- <dd>
1203
-
1204
- Exchange the OAuth2 authorization code for a white label integration.
1205
-
1206
- ## Args:
1207
-
1208
- db: The database session
1209
- white_label_id: The ID of the white label integration
1210
- code: The authorization code
1211
- user: The current user
1212
- background_tasks: The background tasks
1213
-
1214
- ## Returns:
1215
-
1216
- connection (schemas.Connection): The created connection
1217
-
1218
- </dd>
1219
- </dl>
1220
- </dd>
1221
- </dl>
1222
-
1223
- #### 🔌 Usage
1224
-
1225
- <dl>
1226
- <dd>
1227
-
1228
- <dl>
1229
- <dd>
1230
-
1231
- ```typescript
1232
- await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
1233
- ```
1234
-
1235
- </dd>
1236
- </dl>
1237
- </dd>
1238
- </dl>
1239
-
1240
- #### ⚙️ Parameters
1241
-
1242
- <dl>
1243
- <dd>
1244
-
1245
- <dl>
1246
- <dd>
1247
-
1248
- **whiteLabelId:** `string`
1249
-
1250
- </dd>
1251
- </dl>
1252
-
1253
- <dl>
1254
- <dd>
1255
-
1256
- **request:** `string`
1257
-
1258
- </dd>
1259
- </dl>
1260
-
1261
- <dl>
1262
- <dd>
1263
-
1264
- **requestOptions:** `Connections.RequestOptions`
1265
-
1266
- </dd>
1267
- </dl>
1268
- </dd>
1269
- </dl>
1270
-
1271
- </dd>
1272
- </dl>
1273
- </details>
1274
-
1275
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2WhiteLabelAuthUrl</a>(whiteLabelId) -> string</code></summary>
1276
- <dl>
1277
- <dd>
1278
-
1279
- #### 📝 Description
1280
-
1281
- <dl>
1282
- <dd>
1283
-
1284
- <dl>
1285
- <dd>
1286
-
1287
- Get the OAuth2 authorization URL for a white label integration.
1288
-
1289
- ## Args:
1290
-
1291
- db: The database session
1292
- white_label_id: The ID of the white label integration
1293
- user: The current user
1294
-
1295
- ## Returns:
1296
-
1297
- str: The OAuth2 authorization URL
1298
-
1299
- </dd>
1300
- </dl>
1301
- </dd>
1302
- </dl>
1303
-
1304
- #### 🔌 Usage
1305
-
1306
- <dl>
1307
- <dd>
1308
-
1309
- <dl>
1310
- <dd>
1311
-
1312
- ```typescript
1313
- await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
1314
- ```
1315
-
1316
- </dd>
1317
- </dl>
1318
- </dd>
1319
- </dl>
1320
-
1321
- #### ⚙️ Parameters
1322
-
1323
- <dl>
1324
- <dd>
1325
-
1326
- <dl>
1327
- <dd>
1328
-
1329
- **whiteLabelId:** `string`
1330
-
1331
- </dd>
1332
- </dl>
1333
-
1334
- <dl>
1335
- <dd>
1336
-
1337
- **requestOptions:** `Connections.RequestOptions`
1338
-
1339
- </dd>
1340
- </dl>
1341
- </dd>
1342
- </dl>
1343
-
1344
- </dd>
1345
- </dl>
1346
- </details>
1347
-
1348
- ## Sync
1349
-
1350
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
1351
- <dl>
1352
- <dd>
1353
-
1354
- #### 📝 Description
1355
-
1356
- <dl>
1357
- <dd>
1358
-
1359
- <dl>
1360
- <dd>
1361
-
1362
- List all syncs for the current user.
1363
-
1364
- ## Args:
1365
-
1366
- db: The database session
1367
- skip: The number of syncs to skip
1368
- limit: The number of syncs to return
1369
- with_source_connection: Whether to include the source connection in the response
1370
- user: The current user
1371
-
1372
- ## Returns:
1373
-
1374
- list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
1375
-
1376
- </dd>
1377
- </dl>
1378
- </dd>
1379
- </dl>
1380
-
1381
- #### 🔌 Usage
1382
-
1383
- <dl>
1384
- <dd>
1385
-
1386
- <dl>
1387
- <dd>
1388
-
1389
- ```typescript
1390
- await client.sync.listSyncs();
1391
- ```
1392
-
1393
- </dd>
1394
- </dl>
1395
- </dd>
1396
- </dl>
1397
-
1398
- #### ⚙️ Parameters
1399
-
1400
- <dl>
1401
- <dd>
1402
-
1403
- <dl>
1404
- <dd>
1405
-
1406
- **request:** `AirweaveSDK.ListSyncsSyncGetRequest`
1407
-
1408
- </dd>
1409
- </dl>
1410
-
1411
- <dl>
1412
- <dd>
1413
-
1414
- **requestOptions:** `Sync.RequestOptions`
1415
-
1416
- </dd>
1417
- </dl>
1418
- </dd>
1419
- </dl>
1420
-
1421
- </dd>
1422
- </dl>
1423
- </details>
1424
-
1425
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">createSync</a>({ ...params }) -> AirweaveSDK.Sync</code></summary>
1426
- <dl>
1427
- <dd>
1428
-
1429
- #### 📝 Description
1430
-
1431
- <dl>
1432
- <dd>
1433
-
1434
- <dl>
1435
- <dd>
1436
-
1437
- Create a new sync configuration.
1438
-
1439
- ## Args:
1440
-
1441
- db: The database session
1442
- sync_in: The sync to create
1443
- user: The current user
1444
- background_tasks: The background tasks
1445
-
1446
- ## Returns:
1447
-
1448
- sync (schemas.Sync): The created sync
1449
-
1450
- </dd>
1451
- </dl>
1452
- </dd>
1453
- </dl>
1454
-
1455
- #### 🔌 Usage
1456
-
1457
- <dl>
1458
- <dd>
1459
-
1460
- <dl>
1461
- <dd>
1462
-
1463
- ```typescript
1464
- await client.sync.createSync({
1465
- name: "name",
1466
- sourceConnectionId: "source_connection_id",
1467
- destinationConnectionIds: ["destination_connection_ids"],
1468
- });
1469
- ```
1470
-
1471
- </dd>
1472
- </dl>
1473
- </dd>
1474
- </dl>
1475
-
1476
- #### ⚙️ Parameters
1477
-
1478
- <dl>
1479
- <dd>
1480
-
1481
- <dl>
1482
- <dd>
1483
-
1484
- **request:** `AirweaveSDK.SyncCreate`
1485
-
1486
- </dd>
1487
- </dl>
1488
-
1489
- <dl>
1490
- <dd>
1491
-
1492
- **requestOptions:** `Sync.RequestOptions`
1493
-
1494
- </dd>
1495
- </dl>
1496
- </dd>
1497
- </dl>
1498
-
1499
- </dd>
1500
- </dl>
1501
- </details>
1502
-
1503
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listAllJobs</a>({ ...params }) -> AirweaveSDK.SyncJob[]</code></summary>
1504
- <dl>
1505
- <dd>
1506
-
1507
- #### 📝 Description
1508
-
1509
- <dl>
1510
- <dd>
1511
-
1512
- <dl>
1513
- <dd>
1514
-
1515
- List all sync jobs across all syncs.
1516
-
1517
- ## Args:
1518
-
1519
- db: The database session
1520
- skip: The number of jobs to skip
1521
- limit: The number of jobs to return
1522
- status: Filter by job status
1523
- user: The current user
1524
-
1525
- ## Returns:
1526
-
1527
- list[schemas.SyncJob]: A list of all sync jobs
1528
-
1529
- </dd>
1530
- </dl>
1531
- </dd>
1532
- </dl>
1533
-
1534
- #### 🔌 Usage
1535
-
1536
- <dl>
1537
- <dd>
1538
-
1539
- <dl>
1540
- <dd>
1541
-
1542
- ```typescript
1543
- await client.sync.listAllJobs();
1544
- ```
1545
-
1546
- </dd>
1547
- </dl>
1548
- </dd>
1549
- </dl>
1550
-
1551
- #### ⚙️ Parameters
1552
-
1553
- <dl>
1554
- <dd>
1555
-
1556
- <dl>
1557
- <dd>
1558
-
1559
- **request:** `AirweaveSDK.ListAllJobsSyncJobsGetRequest`
1560
-
1561
- </dd>
1562
- </dl>
1563
-
1564
- <dl>
1565
- <dd>
1566
-
1567
- **requestOptions:** `Sync.RequestOptions`
1568
-
1569
- </dd>
1570
- </dl>
1571
- </dd>
1572
- </dl>
1573
-
1574
- </dd>
1575
- </dl>
1576
- </details>
1577
-
1578
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
1579
- <dl>
1580
- <dd>
1581
-
1582
- #### 📝 Description
1583
-
1584
- <dl>
1585
- <dd>
1586
-
1587
- <dl>
1588
- <dd>
1589
-
1590
- Get a specific sync by ID.
1591
-
1592
- ## Args:
1593
-
1594
- db: The database session
1595
- sync_id: The ID of the sync to get
1596
- user: The current user
1597
-
1598
- ## Returns:
1599
-
1600
- sync (schemas.Sync): The sync
1601
-
1602
- </dd>
1603
- </dl>
1604
- </dd>
1605
- </dl>
1606
-
1607
- #### 🔌 Usage
1608
-
1609
- <dl>
1610
- <dd>
1611
-
1612
- <dl>
1613
- <dd>
1614
-
1615
- ```typescript
1616
- await client.sync.getSync("sync_id");
1617
- ```
1618
-
1619
- </dd>
1620
- </dl>
1621
- </dd>
1622
- </dl>
1623
-
1624
- #### ⚙️ Parameters
1625
-
1626
- <dl>
1627
- <dd>
1628
-
1629
- <dl>
1630
- <dd>
1631
-
1632
- **syncId:** `string`
1633
-
1634
- </dd>
1635
- </dl>
1636
-
1637
- <dl>
1638
- <dd>
1639
-
1640
- **requestOptions:** `Sync.RequestOptions`
1641
-
1642
- </dd>
1643
- </dl>
1644
- </dd>
1645
- </dl>
1646
-
1647
- </dd>
1648
- </dl>
1649
- </details>
1650
-
1651
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">deleteSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
1652
- <dl>
1653
- <dd>
1654
-
1655
- #### 📝 Description
1656
-
1657
- <dl>
1658
- <dd>
1659
-
1660
- <dl>
1661
- <dd>
1662
-
1663
- Delete a sync configuration and optionally its associated data.
1664
-
1665
- ## Args:
1666
-
1667
- db: The database session
1668
- sync_id: The ID of the sync to delete
1669
- delete_data: Whether to delete the data associated with the sync
1670
- user: The current user
1671
-
1672
- ## Returns:
1673
-
1674
- sync (schemas.Sync): The deleted sync
1675
-
1676
- </dd>
1677
- </dl>
1678
- </dd>
1679
- </dl>
1680
-
1681
- #### 🔌 Usage
1682
-
1683
- <dl>
1684
- <dd>
1685
-
1686
- <dl>
1687
- <dd>
1688
-
1689
- ```typescript
1690
- await client.sync.deleteSync("sync_id");
1691
- ```
1692
-
1693
- </dd>
1694
- </dl>
1695
- </dd>
1696
- </dl>
1697
-
1698
- #### ⚙️ Parameters
1699
-
1700
- <dl>
1701
- <dd>
1702
-
1703
- <dl>
1704
- <dd>
1705
-
1706
- **syncId:** `string`
1707
-
1708
- </dd>
1709
- </dl>
1710
-
1711
- <dl>
1712
- <dd>
1713
-
1714
- **request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
1715
-
1716
- </dd>
1717
- </dl>
1718
-
1719
- <dl>
1720
- <dd>
1721
-
1722
- **requestOptions:** `Sync.RequestOptions`
1723
-
1724
- </dd>
1725
- </dl>
1726
- </dd>
1727
- </dl>
1728
-
1729
- </dd>
1730
- </dl>
1731
- </details>
1732
-
1733
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">updateSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
1734
- <dl>
1735
- <dd>
1736
-
1737
- #### 📝 Description
1738
-
1739
- <dl>
1740
- <dd>
1741
-
1742
- <dl>
1743
- <dd>
1744
-
1745
- Update a sync configuration.
1746
-
1747
- ## Args:
1748
-
1749
- db: The database session
1750
- sync_id: The ID of the sync to update
1751
- sync_update: The sync update data
1752
- user: The current user
1753
-
1754
- ## Returns:
1755
-
1756
- sync (schemas.Sync): The updated sync
1757
-
1758
- </dd>
1759
- </dl>
1760
- </dd>
1761
- </dl>
1762
-
1763
- #### 🔌 Usage
1764
-
1765
- <dl>
1766
- <dd>
1767
-
1768
- <dl>
1769
- <dd>
1770
-
1771
- ```typescript
1772
- await client.sync.updateSync("sync_id");
1773
- ```
1774
-
1775
- </dd>
1776
- </dl>
1777
- </dd>
1778
- </dl>
1779
-
1780
- #### ⚙️ Parameters
1781
-
1782
- <dl>
1783
- <dd>
1784
-
1785
- <dl>
1786
- <dd>
1787
-
1788
- **syncId:** `string`
1789
-
1790
- </dd>
1791
- </dl>
1792
-
1793
- <dl>
1794
- <dd>
1795
-
1796
- **request:** `AirweaveSDK.SyncUpdate`
1797
-
1798
- </dd>
1799
- </dl>
1800
-
1801
- <dl>
1802
- <dd>
1803
-
1804
- **requestOptions:** `Sync.RequestOptions`
1805
-
1806
- </dd>
1807
- </dl>
1808
- </dd>
1809
- </dl>
1810
-
1811
- </dd>
1812
- </dl>
1813
- </details>
1814
-
1815
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">runSync</a>(syncId) -> AirweaveSDK.SyncJob</code></summary>
1816
- <dl>
1817
- <dd>
1818
-
1819
- #### 📝 Description
1820
-
1821
- <dl>
1822
- <dd>
1823
-
1824
- <dl>
1825
- <dd>
1826
-
1827
- Trigger a sync run.
1828
-
1829
- ## Args:
1830
-
1831
- db: The database session
1832
- sync_id: The ID of the sync to run
1833
- user: The current user
1834
- background_tasks: The background tasks
1835
-
1836
- ## Returns:
1837
-
1838
- sync_job (schemas.SyncJob): The sync job
1839
-
1840
- </dd>
1841
- </dl>
1842
- </dd>
1843
- </dl>
1844
-
1845
- #### 🔌 Usage
1846
-
1847
- <dl>
1848
- <dd>
1849
-
1850
- <dl>
1851
- <dd>
1852
-
1853
- ```typescript
1854
- await client.sync.runSync("sync_id");
1855
- ```
1856
-
1857
- </dd>
1858
- </dl>
1859
- </dd>
1860
- </dl>
1861
-
1862
- #### ⚙️ Parameters
1863
-
1864
- <dl>
1865
- <dd>
1866
-
1867
- <dl>
1868
- <dd>
1869
-
1870
- **syncId:** `string`
1871
-
1872
- </dd>
1873
- </dl>
1874
-
1875
- <dl>
1876
- <dd>
1877
-
1878
- **requestOptions:** `Sync.RequestOptions`
1879
-
1880
- </dd>
1881
- </dl>
1882
- </dd>
1883
- </dl>
1884
-
1885
- </dd>
1886
- </dl>
1887
- </details>
1888
-
1889
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncJobs</a>(syncId) -> AirweaveSDK.SyncJob[]</code></summary>
1890
- <dl>
1891
- <dd>
1892
-
1893
- #### 📝 Description
1894
-
1895
- <dl>
1896
- <dd>
1897
-
1898
- <dl>
1899
- <dd>
1900
-
1901
- List all jobs for a specific sync.
1902
-
1903
- ## Args:
1904
-
1905
- db: The database session
1906
- sync_id: The ID of the sync to list jobs for
1907
- user: The current user
1908
-
1909
- ## Returns:
1910
-
1911
- list[schemas.SyncJob]: A list of sync jobs
1912
-
1913
- </dd>
1914
- </dl>
1915
- </dd>
1916
- </dl>
1917
-
1918
- #### 🔌 Usage
1919
-
1920
- <dl>
1921
- <dd>
1922
-
1923
- <dl>
1924
- <dd>
1925
-
1926
- ```typescript
1927
- await client.sync.listSyncJobs("sync_id");
1928
- ```
1929
-
1930
- </dd>
1931
- </dl>
1932
- </dd>
1933
- </dl>
1934
-
1935
- #### ⚙️ Parameters
1936
-
1937
- <dl>
1938
- <dd>
1939
-
1940
- <dl>
1941
- <dd>
1942
-
1943
- **syncId:** `string`
1944
-
1945
- </dd>
1946
- </dl>
1947
-
1948
- <dl>
1949
- <dd>
1950
-
1951
- **requestOptions:** `Sync.RequestOptions`
1952
-
1953
- </dd>
1954
- </dl>
1955
- </dd>
1956
- </dl>
1957
-
1958
- </dd>
1959
- </dl>
1960
- </details>
1961
-
1962
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncJob</a>(syncId, jobId) -> AirweaveSDK.SyncJob</code></summary>
1963
- <dl>
1964
- <dd>
1965
-
1966
- #### 📝 Description
1967
-
1968
- <dl>
1969
- <dd>
1970
-
1971
- <dl>
1972
- <dd>
1973
-
1974
- Get details of a specific sync job.
1975
-
1976
- ## Args:
1977
-
1978
- db: The database session
1979
- sync_id: The ID of the sync to list jobs for
1980
- job_id: The ID of the job to get
1981
- user: The current user
1982
-
1983
- ## Returns:
1984
-
1985
- sync_job (schemas.SyncJob): The sync job
1986
-
1987
- </dd>
1988
- </dl>
1989
- </dd>
1990
- </dl>
1991
-
1992
- #### 🔌 Usage
1993
-
1994
- <dl>
1995
- <dd>
1996
-
1997
- <dl>
1998
- <dd>
1999
-
2000
- ```typescript
2001
- await client.sync.getSyncJob("sync_id", "job_id");
2002
- ```
2003
-
2004
- </dd>
2005
- </dl>
2006
- </dd>
2007
- </dl>
2008
-
2009
- #### ⚙️ Parameters
2010
-
2011
- <dl>
2012
- <dd>
2013
-
2014
- <dl>
2015
- <dd>
2016
-
2017
- **syncId:** `string`
2018
-
2019
- </dd>
2020
- </dl>
2021
-
2022
- <dl>
2023
- <dd>
2024
-
2025
- **jobId:** `string`
2026
-
2027
- </dd>
2028
- </dl>
2029
-
2030
- <dl>
2031
- <dd>
2032
-
2033
- **requestOptions:** `Sync.RequestOptions`
2034
-
2035
- </dd>
2036
- </dl>
2037
- </dd>
2038
- </dl>
2039
-
2040
- </dd>
2041
- </dl>
2042
- </details>
3
+ ## Sources
2043
4
 
2044
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">subscribeSyncJob</a>(jobId) -> unknown</code></summary>
5
+ <details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithAuthenticationFields</code></summary>
2045
6
  <dl>
2046
7
  <dd>
2047
8
 
@@ -2053,80 +14,17 @@ await client.sync.getSyncJob("sync_id", "job_id");
2053
14
  <dl>
2054
15
  <dd>
2055
16
 
2056
- Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
17
+ Get source by id.
2057
18
 
2058
19
  ## Args:
2059
20
 
2060
- job_id: The ID of the job to subscribe to
2061
- request: The request object
2062
- db: The database session
21
+ db (AsyncSession): The database session.
22
+ short_name (str): The short name of the source.
23
+ user (schemas.User): The current user.
2063
24
 
2064
25
  ## Returns:
2065
26
 
2066
- StreamingResponse: The streaming response
2067
-
2068
- </dd>
2069
- </dl>
2070
- </dd>
2071
- </dl>
2072
-
2073
- #### 🔌 Usage
2074
-
2075
- <dl>
2076
- <dd>
2077
-
2078
- <dl>
2079
- <dd>
2080
-
2081
- ```typescript
2082
- await client.sync.subscribeSyncJob("job_id");
2083
- ```
2084
-
2085
- </dd>
2086
- </dl>
2087
- </dd>
2088
- </dl>
2089
-
2090
- #### ⚙️ Parameters
2091
-
2092
- <dl>
2093
- <dd>
2094
-
2095
- <dl>
2096
- <dd>
2097
-
2098
- **jobId:** `string`
2099
-
2100
- </dd>
2101
- </dl>
2102
-
2103
- <dl>
2104
- <dd>
2105
-
2106
- **requestOptions:** `Sync.RequestOptions`
2107
-
2108
- </dd>
2109
- </dl>
2110
- </dd>
2111
- </dl>
2112
-
2113
- </dd>
2114
- </dl>
2115
- </details>
2116
-
2117
- <details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
2118
- <dl>
2119
- <dd>
2120
-
2121
- #### 📝 Description
2122
-
2123
- <dl>
2124
- <dd>
2125
-
2126
- <dl>
2127
- <dd>
2128
-
2129
- Get the DAG for a specific sync.
27
+ schemas.Source: The source object.
2130
28
 
2131
29
  </dd>
2132
30
  </dl>
@@ -2142,7 +40,7 @@ Get the DAG for a specific sync.
2142
40
  <dd>
2143
41
 
2144
42
  ```typescript
2145
- await client.sync.getSyncDag("sync_id");
43
+ await client.sources.readSource("short_name");
2146
44
  ```
2147
45
 
2148
46
  </dd>
@@ -2158,7 +56,7 @@ await client.sync.getSyncDag("sync_id");
2158
56
  <dl>
2159
57
  <dd>
2160
58
 
2161
- **syncId:** `string`
59
+ **shortName:** `string`
2162
60
 
2163
61
  </dd>
2164
62
  </dl>
@@ -2166,7 +64,7 @@ await client.sync.getSyncDag("sync_id");
2166
64
  <dl>
2167
65
  <dd>
2168
66
 
2169
- **requestOptions:** `Sync.RequestOptions`
67
+ **requestOptions:** `Sources.RequestOptions`
2170
68
 
2171
69
  </dd>
2172
70
  </dl>
@@ -2177,9 +75,7 @@ await client.sync.getSyncDag("sync_id");
2177
75
  </dl>
2178
76
  </details>
2179
77
 
2180
- ## Search
2181
-
2182
- <details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>({ ...params }) -> Record<string, unknown></code></summary>
78
+ <details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
2183
79
  <dl>
2184
80
  <dd>
2185
81
 
@@ -2191,19 +87,16 @@ await client.sync.getSyncDag("sync_id");
2191
87
  <dl>
2192
88
  <dd>
2193
89
 
2194
- Search for documents within a specific sync.
90
+ Get all sources for the current user.
2195
91
 
2196
92
  ## Args:
2197
93
 
2198
94
  db: The database session
2199
- sync_id: The ID of the sync to search within
2200
- query: The search query text
2201
- response_type: Type of response (raw results or AI completion)
2202
95
  user: The current user
2203
96
 
2204
97
  ## Returns:
2205
98
 
2206
- dict: A dictionary containing search results or AI completion
99
+ list[schemas.Source]: The list of sources.
2207
100
 
2208
101
  </dd>
2209
102
  </dl>
@@ -2219,10 +112,7 @@ Search for documents within a specific sync.
2219
112
  <dd>
2220
113
 
2221
114
  ```typescript
2222
- await client.search.search({
2223
- syncId: "sync_id",
2224
- query: "query",
2225
- });
115
+ await client.sources.readSources();
2226
116
  ```
2227
117
 
2228
118
  </dd>
@@ -2238,15 +128,7 @@ await client.search.search({
2238
128
  <dl>
2239
129
  <dd>
2240
130
 
2241
- **request:** `AirweaveSDK.SearchSearchGetRequest`
2242
-
2243
- </dd>
2244
- </dl>
2245
-
2246
- <dl>
2247
- <dd>
2248
-
2249
- **requestOptions:** `Search.RequestOptions`
131
+ **requestOptions:** `Sources.RequestOptions`
2250
132
 
2251
133
  </dd>
2252
134
  </dl>
@@ -2257,73 +139,9 @@ await client.search.search({
2257
139
  </dl>
2258
140
  </details>
2259
141
 
2260
- ## WhiteLabels
2261
-
2262
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
2263
- <dl>
2264
- <dd>
2265
-
2266
- #### 📝 Description
2267
-
2268
- <dl>
2269
- <dd>
2270
-
2271
- <dl>
2272
- <dd>
2273
-
2274
- List all white labels for the current user's organization.
2275
-
2276
- ## Args:
2277
-
2278
- db: The database session
2279
- current_user: The current user
2280
-
2281
- ## Returns:
2282
-
2283
- list[schemas.WhiteLabel]: A list of white labels
2284
-
2285
- </dd>
2286
- </dl>
2287
- </dd>
2288
- </dl>
2289
-
2290
- #### 🔌 Usage
2291
-
2292
- <dl>
2293
- <dd>
2294
-
2295
- <dl>
2296
- <dd>
2297
-
2298
- ```typescript
2299
- await client.whiteLabels.listWhiteLabels();
2300
- ```
2301
-
2302
- </dd>
2303
- </dl>
2304
- </dd>
2305
- </dl>
2306
-
2307
- #### ⚙️ Parameters
2308
-
2309
- <dl>
2310
- <dd>
2311
-
2312
- <dl>
2313
- <dd>
2314
-
2315
- **requestOptions:** `WhiteLabels.RequestOptions`
2316
-
2317
- </dd>
2318
- </dl>
2319
- </dd>
2320
- </dl>
2321
-
2322
- </dd>
2323
- </dl>
2324
- </details>
142
+ ## Collections
2325
143
 
2326
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
144
+ <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">listCollections</a>({ ...params }) -> AirweaveSDK.Collection[]</code></summary>
2327
145
  <dl>
2328
146
  <dd>
2329
147
 
@@ -2335,17 +153,7 @@ await client.whiteLabels.listWhiteLabels();
2335
153
  <dl>
2336
154
  <dd>
2337
155
 
2338
- Create new white label integration.
2339
-
2340
- ## Args:
2341
-
2342
- db: The database session
2343
- current_user: The current user
2344
- white_label_in: The white label to create
2345
-
2346
- ## Returns:
2347
-
2348
- white_label (schemas.WhiteLabel): The created white label
156
+ List all collections for the current user's organization.
2349
157
 
2350
158
  </dd>
2351
159
  </dl>
@@ -2361,13 +169,7 @@ Create new white label integration.
2361
169
  <dd>
2362
170
 
2363
171
  ```typescript
2364
- await client.whiteLabels.createWhiteLabel({
2365
- name: "name",
2366
- sourceShortName: "source_short_name",
2367
- redirectUrl: "redirect_url",
2368
- clientId: "client_id",
2369
- clientSecret: "client_secret",
2370
- });
172
+ await client.collections.listCollections();
2371
173
  ```
2372
174
 
2373
175
  </dd>
@@ -2383,7 +185,7 @@ await client.whiteLabels.createWhiteLabel({
2383
185
  <dl>
2384
186
  <dd>
2385
187
 
2386
- **request:** `AirweaveSDK.WhiteLabelCreate`
188
+ **request:** `AirweaveSDK.ListCollectionsCollectionsGetRequest`
2387
189
 
2388
190
  </dd>
2389
191
  </dl>
@@ -2391,7 +193,7 @@ await client.whiteLabels.createWhiteLabel({
2391
193
  <dl>
2392
194
  <dd>
2393
195
 
2394
- **requestOptions:** `WhiteLabels.RequestOptions`
196
+ **requestOptions:** `Collections.RequestOptions`
2395
197
 
2396
198
  </dd>
2397
199
  </dl>
@@ -2402,7 +204,7 @@ await client.whiteLabels.createWhiteLabel({
2402
204
  </dl>
2403
205
  </details>
2404
206
 
2405
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
207
+ <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">createCollection</a>({ ...params }) -> AirweaveSDK.Collection</code></summary>
2406
208
  <dl>
2407
209
  <dd>
2408
210
 
@@ -2414,17 +216,7 @@ await client.whiteLabels.createWhiteLabel({
2414
216
  <dl>
2415
217
  <dd>
2416
218
 
2417
- Get a specific white label integration.
2418
-
2419
- ## Args:
2420
-
2421
- db: The database session
2422
- white_label_id: The ID of the white label to get
2423
- current_user: The current user
2424
-
2425
- ## Returns:
2426
-
2427
- white_label (schemas.WhiteLabel): The white label
219
+ Create a new collection.
2428
220
 
2429
221
  </dd>
2430
222
  </dl>
@@ -2440,7 +232,9 @@ Get a specific white label integration.
2440
232
  <dd>
2441
233
 
2442
234
  ```typescript
2443
- await client.whiteLabels.getWhiteLabel("white_label_id");
235
+ await client.collections.createCollection({
236
+ name: "name",
237
+ });
2444
238
  ```
2445
239
 
2446
240
  </dd>
@@ -2456,7 +250,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
2456
250
  <dl>
2457
251
  <dd>
2458
252
 
2459
- **whiteLabelId:** `string`
253
+ **request:** `AirweaveSDK.CollectionCreate`
2460
254
 
2461
255
  </dd>
2462
256
  </dl>
@@ -2464,7 +258,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
2464
258
  <dl>
2465
259
  <dd>
2466
260
 
2467
- **requestOptions:** `WhiteLabels.RequestOptions`
261
+ **requestOptions:** `Collections.RequestOptions`
2468
262
 
2469
263
  </dd>
2470
264
  </dl>
@@ -2475,7 +269,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
2475
269
  </dl>
2476
270
  </details>
2477
271
 
2478
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
272
+ <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">getCollection</a>(readableId) -> AirweaveSDK.Collection</code></summary>
2479
273
  <dl>
2480
274
  <dd>
2481
275
 
@@ -2487,18 +281,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
2487
281
  <dl>
2488
282
  <dd>
2489
283
 
2490
- Update a white label integration.
2491
-
2492
- ## Args:
2493
-
2494
- db: The database session
2495
- current_user: The current user
2496
- white_label_id: The ID of the white label to update
2497
- white_label_in: The white label to update
2498
-
2499
- ## Returns:
2500
-
2501
- white_label (schemas.WhiteLabel): The updated white label
284
+ Get a specific collection by its readable ID.
2502
285
 
2503
286
  </dd>
2504
287
  </dl>
@@ -2514,7 +297,7 @@ Update a white label integration.
2514
297
  <dd>
2515
298
 
2516
299
  ```typescript
2517
- await client.whiteLabels.updateWhiteLabel("white_label_id");
300
+ await client.collections.getCollection("readable_id");
2518
301
  ```
2519
302
 
2520
303
  </dd>
@@ -2522,23 +305,15 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
2522
305
  </dd>
2523
306
  </dl>
2524
307
 
2525
- #### ⚙️ Parameters
2526
-
2527
- <dl>
2528
- <dd>
308
+ #### ⚙️ Parameters
2529
309
 
2530
310
  <dl>
2531
311
  <dd>
2532
312
 
2533
- **whiteLabelId:** `string`
2534
-
2535
- </dd>
2536
- </dl>
2537
-
2538
313
  <dl>
2539
314
  <dd>
2540
315
 
2541
- **request:** `AirweaveSDK.WhiteLabelUpdate`
316
+ **readableId:** `string`
2542
317
 
2543
318
  </dd>
2544
319
  </dl>
@@ -2546,7 +321,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
2546
321
  <dl>
2547
322
  <dd>
2548
323
 
2549
- **requestOptions:** `WhiteLabels.RequestOptions`
324
+ **requestOptions:** `Collections.RequestOptions`
2550
325
 
2551
326
  </dd>
2552
327
  </dl>
@@ -2557,7 +332,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
2557
332
  </dl>
2558
333
  </details>
2559
334
 
2560
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</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>
2561
336
  <dl>
2562
337
  <dd>
2563
338
 
@@ -2569,17 +344,16 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
2569
344
  <dl>
2570
345
  <dd>
2571
346
 
2572
- Delete a white label integration.
2573
-
2574
- ## Args:
2575
-
2576
- db: The database session
2577
- current_user: The current user
2578
- white_label_id: The ID of the white label to delete
347
+ Delete a collection by its readable ID.
2579
348
 
2580
- ## Returns:
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
2581
354
 
2582
- white_label (schemas.WhiteLabel): The deleted white label
355
+ Returns:
356
+ The deleted collection
2583
357
 
2584
358
  </dd>
2585
359
  </dl>
@@ -2595,7 +369,7 @@ Delete a white label integration.
2595
369
  <dd>
2596
370
 
2597
371
  ```typescript
2598
- await client.whiteLabels.deleteWhiteLabel("white_label_id");
372
+ await client.collections.deleteCollection("readable_id");
2599
373
  ```
2600
374
 
2601
375
  </dd>
@@ -2611,7 +385,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
2611
385
  <dl>
2612
386
  <dd>
2613
387
 
2614
- **whiteLabelId:** `string`
388
+ **readableId:** `string`
2615
389
 
2616
390
  </dd>
2617
391
  </dl>
@@ -2619,7 +393,15 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
2619
393
  <dl>
2620
394
  <dd>
2621
395
 
2622
- **requestOptions:** `WhiteLabels.RequestOptions`
396
+ **request:** `AirweaveSDK.DeleteCollectionCollectionsReadableIdDeleteRequest`
397
+
398
+ </dd>
399
+ </dl>
400
+
401
+ <dl>
402
+ <dd>
403
+
404
+ **requestOptions:** `Collections.RequestOptions`
2623
405
 
2624
406
  </dd>
2625
407
  </dl>
@@ -2630,7 +412,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
2630
412
  </dl>
2631
413
  </details>
2632
414
 
2633
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
415
+ <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">refreshAllSourceConnections</a>(readableId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
2634
416
  <dl>
2635
417
  <dd>
2636
418
 
@@ -2642,17 +424,16 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
2642
424
  <dl>
2643
425
  <dd>
2644
426
 
2645
- Generate the OAuth2 authorization URL by delegating to oauth2_service.
2646
-
2647
- ## Args:
2648
-
2649
- db: The database session
2650
- white_label_id: The ID of the white label to get the auth URL for
2651
- user: The current user
427
+ Start sync jobs for all source connections in the collection.
2652
428
 
2653
- ## Returns:
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
2654
434
 
2655
- str: The OAuth2 authorization URL
435
+ Returns:
436
+ A list of created sync jobs
2656
437
 
2657
438
  </dd>
2658
439
  </dl>
@@ -2668,7 +449,7 @@ Generate the OAuth2 authorization URL by delegating to oauth2_service.
2668
449
  <dd>
2669
450
 
2670
451
  ```typescript
2671
- await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
452
+ await client.collections.refreshAllSourceConnections("readable_id");
2672
453
  ```
2673
454
 
2674
455
  </dd>
@@ -2684,7 +465,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
2684
465
  <dl>
2685
466
  <dd>
2686
467
 
2687
- **whiteLabelId:** `string`
468
+ **readableId:** `string`
2688
469
 
2689
470
  </dd>
2690
471
  </dl>
@@ -2692,7 +473,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
2692
473
  <dl>
2693
474
  <dd>
2694
475
 
2695
- **requestOptions:** `WhiteLabels.RequestOptions`
476
+ **requestOptions:** `Collections.RequestOptions`
2696
477
 
2697
478
  </dd>
2698
479
  </dl>
@@ -2703,7 +484,9 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
2703
484
  </dl>
2704
485
  </details>
2705
486
 
2706
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
487
+ ## Connections
488
+
489
+ <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
2707
490
  <dl>
2708
491
  <dd>
2709
492
 
@@ -2715,18 +498,17 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
2715
498
  <dl>
2716
499
  <dd>
2717
500
 
2718
- Exchange OAuth2 code for tokens and create connection.
501
+ Get a specific connection.
2719
502
 
2720
503
  ## Args:
2721
504
 
2722
- white_label_id: The ID of the white label to exchange the code for
2723
- code: The OAuth2 code
2724
- db: The database session
2725
- user: The current user
505
+ connection_id: The ID of the connection to get.
506
+ db: The database session.
507
+ user: The current user.
2726
508
 
2727
509
  ## Returns:
2728
510
 
2729
- connection (schemas.Connection): The created connection
511
+ schemas.Connection: The connection.
2730
512
 
2731
513
  </dd>
2732
514
  </dl>
@@ -2742,7 +524,7 @@ Exchange OAuth2 code for tokens and create connection.
2742
524
  <dd>
2743
525
 
2744
526
  ```typescript
2745
- await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string");
527
+ await client.connections.getConnection("connection_id");
2746
528
  ```
2747
529
 
2748
530
  </dd>
@@ -2758,15 +540,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
2758
540
  <dl>
2759
541
  <dd>
2760
542
 
2761
- **whiteLabelId:** `string`
2762
-
2763
- </dd>
2764
- </dl>
2765
-
2766
- <dl>
2767
- <dd>
2768
-
2769
- **request:** `string`
543
+ **connectionId:** `string`
2770
544
 
2771
545
  </dd>
2772
546
  </dl>
@@ -2774,7 +548,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
2774
548
  <dl>
2775
549
  <dd>
2776
550
 
2777
- **requestOptions:** `WhiteLabels.RequestOptions`
551
+ **requestOptions:** `Connections.RequestOptions`
2778
552
 
2779
553
  </dd>
2780
554
  </dl>
@@ -2785,7 +559,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
2785
559
  </dl>
2786
560
  </details>
2787
561
 
2788
- <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
562
+ <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
2789
563
  <dl>
2790
564
  <dd>
2791
565
 
@@ -2797,17 +571,16 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
2797
571
  <dl>
2798
572
  <dd>
2799
573
 
2800
- List all syncs for a specific white label.
574
+ Get all active connections for the current user across all integration types.
2801
575
 
2802
576
  ## Args:
2803
577
 
2804
- white_label_id: The ID of the white label to list syncs for
2805
- db: The database session
2806
- current_user: The current user
578
+ db: The database session.
579
+ user: The current user.
2807
580
 
2808
581
  ## Returns:
2809
582
 
2810
- list[schemas.Sync]: A list of syncs
583
+ list[schemas.Connection]: The list of connections.
2811
584
 
2812
585
  </dd>
2813
586
  </dl>
@@ -2823,7 +596,7 @@ List all syncs for a specific white label.
2823
596
  <dd>
2824
597
 
2825
598
  ```typescript
2826
- await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
599
+ await client.connections.listAllConnectedIntegrations();
2827
600
  ```
2828
601
 
2829
602
  </dd>
@@ -2839,15 +612,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
2839
612
  <dl>
2840
613
  <dd>
2841
614
 
2842
- **whiteLabelId:** `string`
2843
-
2844
- </dd>
2845
- </dl>
2846
-
2847
- <dl>
2848
- <dd>
2849
-
2850
- **requestOptions:** `WhiteLabels.RequestOptions`
615
+ **requestOptions:** `Connections.RequestOptions`
2851
616
 
2852
617
  </dd>
2853
618
  </dl>
@@ -2858,9 +623,9 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
2858
623
  </dl>
2859
624
  </details>
2860
625
 
2861
- ## Chat
626
+ ## SourceConnections
2862
627
 
2863
- <details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">listChats</a>({ ...params }) -> AirweaveSDK.Chat[]</code></summary>
628
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listSourceConnections</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
2864
629
  <dl>
2865
630
  <dd>
2866
631
 
@@ -2872,18 +637,17 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
2872
637
  <dl>
2873
638
  <dd>
2874
639
 
2875
- List all chats for the current user.
2876
-
2877
- ## Args:
2878
-
2879
- db: The database session.
2880
- skip: The number of chats to skip.
2881
- limit: The number of chats to return.
2882
- user: The current user.
640
+ List all source connections for the current user.
2883
641
 
2884
- ## Returns:
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
2885
648
 
2886
- list[schemas.Chat]: The list of chats.
649
+ Returns:
650
+ A list of source connection list items with essential information
2887
651
 
2888
652
  </dd>
2889
653
  </dl>
@@ -2899,7 +663,7 @@ List all chats for the current user.
2899
663
  <dd>
2900
664
 
2901
665
  ```typescript
2902
- await client.chat.listChats();
666
+ await client.sourceConnections.listSourceConnections();
2903
667
  ```
2904
668
 
2905
669
  </dd>
@@ -2915,7 +679,7 @@ await client.chat.listChats();
2915
679
  <dl>
2916
680
  <dd>
2917
681
 
2918
- **request:** `AirweaveSDK.ListChatsChatGetRequest`
682
+ **request:** `AirweaveSDK.ListSourceConnectionsSourceConnectionsGetRequest`
2919
683
 
2920
684
  </dd>
2921
685
  </dl>
@@ -2923,7 +687,7 @@ await client.chat.listChats();
2923
687
  <dl>
2924
688
  <dd>
2925
689
 
2926
- **requestOptions:** `Chat.RequestOptions`
690
+ **requestOptions:** `SourceConnections.RequestOptions`
2927
691
 
2928
692
  </dd>
2929
693
  </dl>
@@ -2934,7 +698,7 @@ await client.chat.listChats();
2934
698
  </dl>
2935
699
  </details>
2936
700
 
2937
- <details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">createChat</a>({ ...params }) -> AirweaveSDK.Chat</code></summary>
701
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">createSourceConnection</a>({ ...params }) -> AirweaveSDK.SourceConnection</code></summary>
2938
702
  <dl>
2939
703
  <dd>
2940
704
 
@@ -2946,17 +710,24 @@ await client.chat.listChats();
2946
710
  <dl>
2947
711
  <dd>
2948
712
 
2949
- Create a new chat.
713
+ Create a new source connection.
2950
714
 
2951
- ## Args:
715
+ This endpoint creates:
2952
716
 
2953
- db: The database session.
2954
- chat_in: The chat creation data.
2955
- 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
2956
722
 
2957
- ## Returns:
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
2958
728
 
2959
- schemas.Chat: The created chat.
729
+ Returns:
730
+ The created source connection
2960
731
 
2961
732
  </dd>
2962
733
  </dl>
@@ -2972,9 +743,9 @@ Create a new chat.
2972
743
  <dd>
2973
744
 
2974
745
  ```typescript
2975
- await client.chat.createChat({
746
+ await client.sourceConnections.createSourceConnection({
2976
747
  name: "name",
2977
- syncId: "sync_id",
748
+ shortName: "short_name",
2978
749
  });
2979
750
  ```
2980
751
 
@@ -2991,7 +762,7 @@ await client.chat.createChat({
2991
762
  <dl>
2992
763
  <dd>
2993
764
 
2994
- **request:** `AirweaveSDK.ChatCreate`
765
+ **request:** `AirweaveSDK.SourceConnectionCreate`
2995
766
 
2996
767
  </dd>
2997
768
  </dl>
@@ -2999,7 +770,7 @@ await client.chat.createChat({
2999
770
  <dl>
3000
771
  <dd>
3001
772
 
3002
- **requestOptions:** `Chat.RequestOptions`
773
+ **requestOptions:** `SourceConnections.RequestOptions`
3003
774
 
3004
775
  </dd>
3005
776
  </dl>
@@ -3010,9 +781,7 @@ await client.chat.createChat({
3010
781
  </dl>
3011
782
  </details>
3012
783
 
3013
- ## Dag
3014
-
3015
- <details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
784
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">getSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
3016
785
  <dl>
3017
786
  <dd>
3018
787
 
@@ -3024,7 +793,16 @@ await client.chat.createChat({
3024
793
  <dl>
3025
794
  <dd>
3026
795
 
3027
- Get the DAG definition for a sync.
796
+ Get a specific source connection by ID.
797
+
798
+ Args:
799
+ db: The database session
800
+ source_connection_id: The ID of the source connection
801
+ show_auth_fields: Whether to show the auth fields, default is False
802
+ user: The current user
803
+
804
+ Returns:
805
+ The source connection
3028
806
 
3029
807
  </dd>
3030
808
  </dl>
@@ -3040,7 +818,7 @@ Get the DAG definition for a sync.
3040
818
  <dd>
3041
819
 
3042
820
  ```typescript
3043
- await client.dag.getSyncDag("sync_id");
821
+ await client.sourceConnections.getSourceConnection("source_connection_id");
3044
822
  ```
3045
823
 
3046
824
  </dd>
@@ -3056,7 +834,7 @@ await client.dag.getSyncDag("sync_id");
3056
834
  <dl>
3057
835
  <dd>
3058
836
 
3059
- **syncId:** `string`
837
+ **sourceConnectionId:** `string`
3060
838
 
3061
839
  </dd>
3062
840
  </dl>
@@ -3064,7 +842,15 @@ await client.dag.getSyncDag("sync_id");
3064
842
  <dl>
3065
843
  <dd>
3066
844
 
3067
- **requestOptions:** `Dag.RequestOptions`
845
+ **request:** `AirweaveSDK.GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest`
846
+
847
+ </dd>
848
+ </dl>
849
+
850
+ <dl>
851
+ <dd>
852
+
853
+ **requestOptions:** `SourceConnections.RequestOptions`
3068
854
 
3069
855
  </dd>
3070
856
  </dl>
@@ -3075,7 +861,7 @@ await client.dag.getSyncDag("sync_id");
3075
861
  </dl>
3076
862
  </details>
3077
863
 
3078
- <details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">createSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
864
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">updateSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
3079
865
  <dl>
3080
866
  <dd>
3081
867
 
@@ -3087,7 +873,16 @@ await client.dag.getSyncDag("sync_id");
3087
873
  <dl>
3088
874
  <dd>
3089
875
 
3090
- Create a new DAG definition for a sync.
876
+ Update a source connection.
877
+
878
+ Args:
879
+ db: The database session
880
+ source_connection_id: The ID of the source connection to update
881
+ source_connection_in: The updated source connection data
882
+ user: The current user
883
+
884
+ Returns:
885
+ The updated source connection
3091
886
 
3092
887
  </dd>
3093
888
  </dl>
@@ -3103,22 +898,7 @@ Create a new DAG definition for a sync.
3103
898
  <dd>
3104
899
 
3105
900
  ```typescript
3106
- await client.dag.createSyncDag("sync_id", {
3107
- name: "name",
3108
- syncDagCreateSyncId: "sync_id",
3109
- nodes: [
3110
- {
3111
- type: "source",
3112
- name: "name",
3113
- },
3114
- ],
3115
- edges: [
3116
- {
3117
- fromNodeId: "from_node_id",
3118
- toNodeId: "to_node_id",
3119
- },
3120
- ],
3121
- });
901
+ await client.sourceConnections.updateSourceConnection("source_connection_id");
3122
902
  ```
3123
903
 
3124
904
  </dd>
@@ -3134,7 +914,7 @@ await client.dag.createSyncDag("sync_id", {
3134
914
  <dl>
3135
915
  <dd>
3136
916
 
3137
- **syncId:** `string`
917
+ **sourceConnectionId:** `string`
3138
918
 
3139
919
  </dd>
3140
920
  </dl>
@@ -3142,7 +922,7 @@ await client.dag.createSyncDag("sync_id", {
3142
922
  <dl>
3143
923
  <dd>
3144
924
 
3145
- **request:** `AirweaveSDK.SyncDagCreate`
925
+ **request:** `AirweaveSDK.SourceConnectionUpdate`
3146
926
 
3147
927
  </dd>
3148
928
  </dl>
@@ -3150,7 +930,7 @@ await client.dag.createSyncDag("sync_id", {
3150
930
  <dl>
3151
931
  <dd>
3152
932
 
3153
- **requestOptions:** `Dag.RequestOptions`
933
+ **requestOptions:** `SourceConnections.RequestOptions`
3154
934
 
3155
935
  </dd>
3156
936
  </dl>
@@ -3161,7 +941,7 @@ await client.dag.createSyncDag("sync_id", {
3161
941
  </dl>
3162
942
  </details>
3163
943
 
3164
- <details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">updateSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
944
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">deleteSourceConnection</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
3165
945
  <dl>
3166
946
  <dd>
3167
947
 
@@ -3173,7 +953,16 @@ await client.dag.createSyncDag("sync_id", {
3173
953
  <dl>
3174
954
  <dd>
3175
955
 
3176
- Update a DAG definition for a sync.
956
+ Delete a source connection and all related components.
957
+
958
+ Args:
959
+ db: The database session
960
+ source_connection_id: The ID of the source connection to delete
961
+ delete_data: Whether to delete the associated data in destinations
962
+ user: The current user
963
+
964
+ Returns:
965
+ The deleted source connection
3177
966
 
3178
967
  </dd>
3179
968
  </dl>
@@ -3189,10 +978,7 @@ Update a DAG definition for a sync.
3189
978
  <dd>
3190
979
 
3191
980
  ```typescript
3192
- await client.dag.updateSyncDag("sync_id", {
3193
- name: "name",
3194
- syncDagUpdateSyncId: "sync_id",
3195
- });
981
+ await client.sourceConnections.deleteSourceConnection("source_connection_id");
3196
982
  ```
3197
983
 
3198
984
  </dd>
@@ -3208,7 +994,7 @@ await client.dag.updateSyncDag("sync_id", {
3208
994
  <dl>
3209
995
  <dd>
3210
996
 
3211
- **syncId:** `string`
997
+ **sourceConnectionId:** `string`
3212
998
 
3213
999
  </dd>
3214
1000
  </dl>
@@ -3216,7 +1002,7 @@ await client.dag.updateSyncDag("sync_id", {
3216
1002
  <dl>
3217
1003
  <dd>
3218
1004
 
3219
- **request:** `AirweaveSDK.SyncDagUpdate`
1005
+ **request:** `AirweaveSDK.DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest`
3220
1006
 
3221
1007
  </dd>
3222
1008
  </dl>
@@ -3224,7 +1010,7 @@ await client.dag.updateSyncDag("sync_id", {
3224
1010
  <dl>
3225
1011
  <dd>
3226
1012
 
3227
- **requestOptions:** `Dag.RequestOptions`
1013
+ **requestOptions:** `SourceConnections.RequestOptions`
3228
1014
 
3229
1015
  </dd>
3230
1016
  </dl>
@@ -3235,9 +1021,7 @@ await client.dag.updateSyncDag("sync_id", {
3235
1021
  </dl>
3236
1022
  </details>
3237
1023
 
3238
- ## Entities
3239
-
3240
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityDefinitions</a>() -> AirweaveSDK.EntityDefinition[]</code></summary>
1024
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">runSourceConnection</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob</code></summary>
3241
1025
  <dl>
3242
1026
  <dd>
3243
1027
 
@@ -3249,7 +1033,16 @@ await client.dag.updateSyncDag("sync_id", {
3249
1033
  <dl>
3250
1034
  <dd>
3251
1035
 
3252
- List all entity definitions for the current user's organization.
1036
+ Trigger a sync run for a source connection.
1037
+
1038
+ Args:
1039
+ db: The database session
1040
+ source_connection_id: The ID of the source connection to run
1041
+ user: The current user
1042
+ background_tasks: Background tasks for async operations
1043
+
1044
+ Returns:
1045
+ The created sync job
3253
1046
 
3254
1047
  </dd>
3255
1048
  </dl>
@@ -3265,7 +1058,7 @@ List all entity definitions for the current user's organization.
3265
1058
  <dd>
3266
1059
 
3267
1060
  ```typescript
3268
- await client.entities.listEntityDefinitions();
1061
+ await client.sourceConnections.runSourceConnection("source_connection_id");
3269
1062
  ```
3270
1063
 
3271
1064
  </dd>
@@ -3281,7 +1074,15 @@ await client.entities.listEntityDefinitions();
3281
1074
  <dl>
3282
1075
  <dd>
3283
1076
 
3284
- **requestOptions:** `Entities.RequestOptions`
1077
+ **sourceConnectionId:** `string`
1078
+
1079
+ </dd>
1080
+ </dl>
1081
+
1082
+ <dl>
1083
+ <dd>
1084
+
1085
+ **requestOptions:** `SourceConnections.RequestOptions`
3285
1086
 
3286
1087
  </dd>
3287
1088
  </dl>
@@ -3292,7 +1093,7 @@ await client.entities.listEntityDefinitions();
3292
1093
  </dl>
3293
1094
  </details>
3294
1095
 
3295
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityDefinition</a>({ ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
1096
+ <details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listSourceConnectionJobs</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
3296
1097
  <dl>
3297
1098
  <dd>
3298
1099
 
@@ -3304,7 +1105,15 @@ await client.entities.listEntityDefinitions();
3304
1105
  <dl>
3305
1106
  <dd>
3306
1107
 
3307
- Create a new entity definition.
1108
+ List all sync jobs for a source connection.
1109
+
1110
+ Args:
1111
+ db: The database session
1112
+ source_connection_id: The ID of the source connection
1113
+ user: The current user
1114
+
1115
+ Returns:
1116
+ A list of sync jobs
3308
1117
 
3309
1118
  </dd>
3310
1119
  </dl>
@@ -3320,13 +1129,7 @@ Create a new entity definition.
3320
1129
  <dd>
3321
1130
 
3322
1131
  ```typescript
3323
- await client.entities.createEntityDefinition({
3324
- name: "name",
3325
- type: "file",
3326
- entitySchema: ["entity_schema"],
3327
- moduleName: "module_name",
3328
- className: "class_name",
3329
- });
1132
+ await client.sourceConnections.listSourceConnectionJobs("source_connection_id");
3330
1133
  ```
3331
1134
 
3332
1135
  </dd>
@@ -3342,7 +1145,7 @@ await client.entities.createEntityDefinition({
3342
1145
  <dl>
3343
1146
  <dd>
3344
1147
 
3345
- **request:** `AirweaveSDK.EntityDefinitionCreate`
1148
+ **sourceConnectionId:** `string`
3346
1149
 
3347
1150
  </dd>
3348
1151
  </dl>
@@ -3350,7 +1153,7 @@ await client.entities.createEntityDefinition({
3350
1153
  <dl>
3351
1154
  <dd>
3352
1155
 
3353
- **requestOptions:** `Entities.RequestOptions`
1156
+ **requestOptions:** `SourceConnections.RequestOptions`
3354
1157
 
3355
1158
  </dd>
3356
1159
  </dl>
@@ -3361,7 +1164,9 @@ await client.entities.createEntityDefinition({
3361
1164
  </dl>
3362
1165
  </details>
3363
1166
 
3364
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityRelations</a>() -> AirweaveSDK.EntityRelation[]</code></summary>
1167
+ ## WhiteLabels
1168
+
1169
+ <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
3365
1170
  <dl>
3366
1171
  <dd>
3367
1172
 
@@ -3373,7 +1178,16 @@ await client.entities.createEntityDefinition({
3373
1178
  <dl>
3374
1179
  <dd>
3375
1180
 
3376
- List all entity relations for the current user's organization.
1181
+ List all white labels for the current user's organization.
1182
+
1183
+ ## Args:
1184
+
1185
+ db: The database session
1186
+ current_user: The current user
1187
+
1188
+ ## Returns:
1189
+
1190
+ list[schemas.WhiteLabel]: A list of white labels
3377
1191
 
3378
1192
  </dd>
3379
1193
  </dl>
@@ -3389,7 +1203,7 @@ List all entity relations for the current user's organization.
3389
1203
  <dd>
3390
1204
 
3391
1205
  ```typescript
3392
- await client.entities.listEntityRelations();
1206
+ await client.whiteLabels.listWhiteLabels();
3393
1207
  ```
3394
1208
 
3395
1209
  </dd>
@@ -3405,7 +1219,7 @@ await client.entities.listEntityRelations();
3405
1219
  <dl>
3406
1220
  <dd>
3407
1221
 
3408
- **requestOptions:** `Entities.RequestOptions`
1222
+ **requestOptions:** `WhiteLabels.RequestOptions`
3409
1223
 
3410
1224
  </dd>
3411
1225
  </dl>
@@ -3416,7 +1230,7 @@ await client.entities.listEntityRelations();
3416
1230
  </dl>
3417
1231
  </details>
3418
1232
 
3419
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityRelation</a>({ ...params }) -> AirweaveSDK.EntityRelation</code></summary>
1233
+ <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
3420
1234
  <dl>
3421
1235
  <dd>
3422
1236
 
@@ -3428,7 +1242,17 @@ await client.entities.listEntityRelations();
3428
1242
  <dl>
3429
1243
  <dd>
3430
1244
 
3431
- Create a new entity relation.
1245
+ Create new white label integration.
1246
+
1247
+ ## Args:
1248
+
1249
+ db: The database session
1250
+ current_user: The current user
1251
+ white_label_in: The white label to create
1252
+
1253
+ ## Returns:
1254
+
1255
+ white_label (schemas.WhiteLabel): The created white label
3432
1256
 
3433
1257
  </dd>
3434
1258
  </dl>
@@ -3444,10 +1268,12 @@ Create a new entity relation.
3444
1268
  <dd>
3445
1269
 
3446
1270
  ```typescript
3447
- await client.entities.createEntityRelation({
1271
+ await client.whiteLabels.createWhiteLabel({
3448
1272
  name: "name",
3449
- fromEntityId: "from_entity_id",
3450
- toEntityId: "to_entity_id",
1273
+ sourceShortName: "source_short_name",
1274
+ redirectUrl: "redirect_url",
1275
+ clientId: "client_id",
1276
+ clientSecret: "client_secret",
3451
1277
  });
3452
1278
  ```
3453
1279
 
@@ -3464,7 +1290,7 @@ await client.entities.createEntityRelation({
3464
1290
  <dl>
3465
1291
  <dd>
3466
1292
 
3467
- **request:** `AirweaveSDK.EntityRelationCreate`
1293
+ **request:** `AirweaveSDK.WhiteLabelCreate`
3468
1294
 
3469
1295
  </dd>
3470
1296
  </dl>
@@ -3472,7 +1298,7 @@ await client.entities.createEntityRelation({
3472
1298
  <dl>
3473
1299
  <dd>
3474
1300
 
3475
- **requestOptions:** `Entities.RequestOptions`
1301
+ **requestOptions:** `WhiteLabels.RequestOptions`
3476
1302
 
3477
1303
  </dd>
3478
1304
  </dl>
@@ -3483,7 +1309,7 @@ await client.entities.createEntityRelation({
3483
1309
  </dl>
3484
1310
  </details>
3485
1311
 
3486
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsByIds</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
1312
+ <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
3487
1313
  <dl>
3488
1314
  <dd>
3489
1315
 
@@ -3495,15 +1321,17 @@ await client.entities.createEntityRelation({
3495
1321
  <dl>
3496
1322
  <dd>
3497
1323
 
3498
- Get multiple entity definitions by their IDs.
1324
+ Get a specific white label integration.
3499
1325
 
3500
- Args:
3501
- ids: List of entity definition IDs to fetch
3502
- db: Database session
3503
- current_user: Current authenticated user
1326
+ ## Args:
3504
1327
 
3505
- Returns:
3506
- List of entity definitions matching the provided IDs
1328
+ db: The database session
1329
+ white_label_id: The ID of the white label to get
1330
+ current_user: The current user
1331
+
1332
+ ## Returns:
1333
+
1334
+ white_label (schemas.WhiteLabel): The white label
3507
1335
 
3508
1336
  </dd>
3509
1337
  </dl>
@@ -3519,7 +1347,7 @@ List of entity definitions matching the provided IDs
3519
1347
  <dd>
3520
1348
 
3521
1349
  ```typescript
3522
- await client.entities.getEntityDefinitionsByIds(["string"]);
1350
+ await client.whiteLabels.getWhiteLabel("white_label_id");
3523
1351
  ```
3524
1352
 
3525
1353
  </dd>
@@ -3535,7 +1363,7 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
3535
1363
  <dl>
3536
1364
  <dd>
3537
1365
 
3538
- **request:** `string[]`
1366
+ **whiteLabelId:** `string`
3539
1367
 
3540
1368
  </dd>
3541
1369
  </dl>
@@ -3543,7 +1371,7 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
3543
1371
  <dl>
3544
1372
  <dd>
3545
1373
 
3546
- **requestOptions:** `Entities.RequestOptions`
1374
+ **requestOptions:** `WhiteLabels.RequestOptions`
3547
1375
 
3548
1376
  </dd>
3549
1377
  </dl>
@@ -3554,7 +1382,7 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
3554
1382
  </dl>
3555
1383
  </details>
3556
1384
 
3557
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsBySourceShortName</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
1385
+ <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
3558
1386
  <dl>
3559
1387
  <dd>
3560
1388
 
@@ -3566,7 +1394,18 @@ await client.entities.getEntityDefinitionsByIds(["string"]);
3566
1394
  <dl>
3567
1395
  <dd>
3568
1396
 
3569
- Get all entity definitions for a given source.
1397
+ Update a white label integration.
1398
+
1399
+ ## Args:
1400
+
1401
+ db: The database session
1402
+ current_user: The current user
1403
+ white_label_id: The ID of the white label to update
1404
+ white_label_in: The white label to update
1405
+
1406
+ ## Returns:
1407
+
1408
+ white_label (schemas.WhiteLabel): The updated white label
3570
1409
 
3571
1410
  </dd>
3572
1411
  </dl>
@@ -3582,9 +1421,7 @@ Get all entity definitions for a given source.
3582
1421
  <dd>
3583
1422
 
3584
1423
  ```typescript
3585
- await client.entities.getEntityDefinitionsBySourceShortName({
3586
- sourceShortName: "source_short_name",
3587
- });
1424
+ await client.whiteLabels.updateWhiteLabel("white_label_id");
3588
1425
  ```
3589
1426
 
3590
1427
  </dd>
@@ -3600,7 +1437,15 @@ await client.entities.getEntityDefinitionsBySourceShortName({
3600
1437
  <dl>
3601
1438
  <dd>
3602
1439
 
3603
- **request:** `AirweaveSDK.GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest`
1440
+ **whiteLabelId:** `string`
1441
+
1442
+ </dd>
1443
+ </dl>
1444
+
1445
+ <dl>
1446
+ <dd>
1447
+
1448
+ **request:** `AirweaveSDK.WhiteLabelUpdate`
3604
1449
 
3605
1450
  </dd>
3606
1451
  </dl>
@@ -3608,7 +1453,7 @@ await client.entities.getEntityDefinitionsBySourceShortName({
3608
1453
  <dl>
3609
1454
  <dd>
3610
1455
 
3611
- **requestOptions:** `Entities.RequestOptions`
1456
+ **requestOptions:** `WhiteLabels.RequestOptions`
3612
1457
 
3613
1458
  </dd>
3614
1459
  </dl>
@@ -3619,9 +1464,7 @@ await client.entities.getEntityDefinitionsBySourceShortName({
3619
1464
  </dl>
3620
1465
  </details>
3621
1466
 
3622
- ## Transformers
3623
-
3624
- <details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>() -> AirweaveSDK.Transformer[]</code></summary>
1467
+ <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
3625
1468
  <dl>
3626
1469
  <dd>
3627
1470
 
@@ -3633,7 +1476,17 @@ await client.entities.getEntityDefinitionsBySourceShortName({
3633
1476
  <dl>
3634
1477
  <dd>
3635
1478
 
3636
- List all transformers for the current user's organization.
1479
+ Delete a white label integration.
1480
+
1481
+ ## Args:
1482
+
1483
+ db: The database session
1484
+ current_user: The current user
1485
+ white_label_id: The ID of the white label to delete
1486
+
1487
+ ## Returns:
1488
+
1489
+ white_label (schemas.WhiteLabel): The deleted white label
3637
1490
 
3638
1491
  </dd>
3639
1492
  </dl>
@@ -3649,7 +1502,7 @@ List all transformers for the current user's organization.
3649
1502
  <dd>
3650
1503
 
3651
1504
  ```typescript
3652
- await client.transformers.listTransformers();
1505
+ await client.whiteLabels.deleteWhiteLabel("white_label_id");
3653
1506
  ```
3654
1507
 
3655
1508
  </dd>
@@ -3665,7 +1518,15 @@ await client.transformers.listTransformers();
3665
1518
  <dl>
3666
1519
  <dd>
3667
1520
 
3668
- **requestOptions:** `Transformers.RequestOptions`
1521
+ **whiteLabelId:** `string`
1522
+
1523
+ </dd>
1524
+ </dl>
1525
+
1526
+ <dl>
1527
+ <dd>
1528
+
1529
+ **requestOptions:** `WhiteLabels.RequestOptions`
3669
1530
 
3670
1531
  </dd>
3671
1532
  </dl>
@@ -3676,7 +1537,7 @@ await client.transformers.listTransformers();
3676
1537
  </dl>
3677
1538
  </details>
3678
1539
 
3679
- <details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">createTransformer</a>({ ...params }) -> AirweaveSDK.Transformer</code></summary>
1540
+ <details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
3680
1541
  <dl>
3681
1542
  <dd>
3682
1543
 
@@ -3688,7 +1549,17 @@ await client.transformers.listTransformers();
3688
1549
  <dl>
3689
1550
  <dd>
3690
1551
 
3691
- Create a new transformer.
1552
+ List all syncs for a specific white label.
1553
+
1554
+ ## Args:
1555
+
1556
+ white_label_id: The ID of the white label to list syncs for
1557
+ db: The database session
1558
+ current_user: The current user
1559
+
1560
+ ## Returns:
1561
+
1562
+ list[schemas.Sync]: A list of syncs
3692
1563
 
3693
1564
  </dd>
3694
1565
  </dl>
@@ -3704,13 +1575,7 @@ Create a new transformer.
3704
1575
  <dd>
3705
1576
 
3706
1577
  ```typescript
3707
- await client.transformers.createTransformer({
3708
- name: "name",
3709
- methodName: "method_name",
3710
- moduleName: "module_name",
3711
- inputEntityDefinitionIds: ["input_entity_definition_ids"],
3712
- outputEntityDefinitionIds: ["output_entity_definition_ids"],
3713
- });
1578
+ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
3714
1579
  ```
3715
1580
 
3716
1581
  </dd>
@@ -3726,7 +1591,7 @@ await client.transformers.createTransformer({
3726
1591
  <dl>
3727
1592
  <dd>
3728
1593
 
3729
- **request:** `AirweaveSDK.TransformerCreate`
1594
+ **whiteLabelId:** `string`
3730
1595
 
3731
1596
  </dd>
3732
1597
  </dl>
@@ -3734,7 +1599,7 @@ await client.transformers.createTransformer({
3734
1599
  <dl>
3735
1600
  <dd>
3736
1601
 
3737
- **requestOptions:** `Transformers.RequestOptions`
1602
+ **requestOptions:** `WhiteLabels.RequestOptions`
3738
1603
 
3739
1604
  </dd>
3740
1605
  </dl>