@airweave/sdk 0.6.0 → 0.6.3

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 (184) hide show
  1. package/dist/cjs/Client.d.ts +0 -3
  2. package/dist/cjs/Client.js +2 -7
  3. package/dist/cjs/api/resources/index.d.ts +0 -2
  4. package/dist/cjs/api/resources/index.js +1 -3
  5. package/dist/cjs/api/resources/sourceConnections/client/Client.d.ts +31 -82
  6. package/dist/cjs/api/resources/sourceConnections/client/Client.js +45 -190
  7. package/dist/cjs/api/resources/sourceConnections/client/requests/GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.d.ts +10 -0
  8. package/dist/cjs/api/resources/sourceConnections/client/requests/ListSourceConnectionsGetRequest.d.ts +1 -7
  9. package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.ts +21 -20
  10. package/dist/cjs/api/resources/sourceConnections/client/requests/index.d.ts +1 -3
  11. package/dist/cjs/api/types/ActionCheckRequest.d.ts +10 -0
  12. package/dist/cjs/api/types/ActionCheckResponse.d.ts +4 -16
  13. package/dist/cjs/api/types/ActionCheckResponse.js +0 -8
  14. package/dist/cjs/api/types/AuthProvider.d.ts +0 -2
  15. package/dist/cjs/api/types/AuthProviderAuthentication.d.ts +12 -0
  16. package/dist/cjs/api/types/AuthenticationDetails.d.ts +19 -0
  17. package/dist/cjs/api/types/AuthenticationMethod.d.ts +14 -0
  18. package/dist/cjs/api/types/AuthenticationMethod.js +13 -0
  19. package/dist/cjs/api/types/Destination.d.ts +0 -2
  20. package/dist/cjs/api/types/DestinationWithAuthenticationFields.d.ts +0 -1
  21. package/dist/cjs/api/types/DirectAuthentication.d.ts +10 -0
  22. package/dist/cjs/api/types/EmbeddingModel.d.ts +0 -2
  23. package/dist/cjs/api/types/EmbeddingModelWithAuthenticationFields.d.ts +0 -1
  24. package/dist/cjs/api/types/EntityCountWithDefinition.d.ts +1 -0
  25. package/dist/cjs/api/types/EntitySummary.d.ts +12 -0
  26. package/dist/cjs/api/types/EntityTypeStats.d.ts +10 -0
  27. package/dist/cjs/api/types/IntegrationCredentialInDb.d.ts +2 -1
  28. package/dist/cjs/api/types/IntegrationCredentialRawCreate.d.ts +2 -1
  29. package/dist/cjs/api/types/OAuthBrowserAuthentication.d.ts +14 -0
  30. package/dist/cjs/api/types/OAuthTokenAuthentication.d.ts +14 -0
  31. package/dist/cjs/api/types/OAuthType.d.ts +12 -0
  32. package/dist/cjs/api/types/OAuthType.js +11 -0
  33. package/dist/cjs/api/types/ScheduleConfig.d.ts +14 -0
  34. package/dist/cjs/api/types/ScheduleDetails.d.ts +13 -0
  35. package/dist/cjs/api/types/SingleActionCheckResponse.d.ts +23 -0
  36. package/dist/cjs/api/types/SingleActionCheckResponse.js +13 -0
  37. package/dist/cjs/api/types/Source.d.ts +11 -7
  38. package/dist/cjs/api/types/SourceConnection.d.ts +9 -52
  39. package/dist/cjs/api/types/SourceConnectionJob.d.ts +9 -34
  40. package/dist/cjs/api/types/SourceConnectionListItem.d.ts +13 -16
  41. package/dist/cjs/api/types/SourceConnectionStatus.d.ts +7 -4
  42. package/dist/cjs/api/types/SourceConnectionStatus.js +5 -2
  43. package/dist/cjs/api/types/SourceConnectionUpdate.d.ts +16 -0
  44. package/dist/cjs/api/types/SyncDetails.d.ts +13 -0
  45. package/dist/cjs/api/types/SyncJobDetails.d.ts +20 -0
  46. package/dist/cjs/api/types/SyncJobStatus.d.ts +2 -2
  47. package/dist/cjs/api/types/SyncJobStatus.js +1 -1
  48. package/dist/cjs/api/types/SyncSummary.d.ts +11 -0
  49. package/dist/cjs/api/types/SyncSummary.js +5 -0
  50. package/dist/cjs/api/types/index.d.ts +17 -9
  51. package/dist/cjs/api/types/index.js +17 -9
  52. package/dist/cjs/version.d.ts +1 -1
  53. package/dist/cjs/version.js +1 -1
  54. package/dist/esm/Client.d.mts +0 -3
  55. package/dist/esm/Client.mjs +2 -7
  56. package/dist/esm/api/resources/index.d.mts +0 -2
  57. package/dist/esm/api/resources/index.mjs +0 -2
  58. package/dist/esm/api/resources/sourceConnections/client/Client.d.mts +31 -82
  59. package/dist/esm/api/resources/sourceConnections/client/Client.mjs +45 -190
  60. package/dist/esm/api/resources/sourceConnections/client/requests/GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.d.mts +10 -0
  61. package/dist/esm/api/resources/sourceConnections/client/requests/ListSourceConnectionsGetRequest.d.mts +1 -7
  62. package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.mts +21 -20
  63. package/dist/esm/api/resources/sourceConnections/client/requests/index.d.mts +1 -3
  64. package/dist/esm/api/types/ActionCheckRequest.d.mts +10 -0
  65. package/dist/esm/api/types/ActionCheckResponse.d.mts +4 -16
  66. package/dist/esm/api/types/ActionCheckResponse.mjs +1 -7
  67. package/dist/esm/api/types/AuthProvider.d.mts +0 -2
  68. package/dist/esm/api/types/AuthProviderAuthentication.d.mts +12 -0
  69. package/dist/esm/api/types/AuthenticationDetails.d.mts +19 -0
  70. package/dist/esm/api/types/AuthenticationMethod.d.mts +14 -0
  71. package/dist/esm/api/types/AuthenticationMethod.mjs +10 -0
  72. package/dist/esm/api/types/Destination.d.mts +0 -2
  73. package/dist/esm/api/types/DestinationWithAuthenticationFields.d.mts +0 -1
  74. package/dist/esm/api/types/DirectAuthentication.d.mts +10 -0
  75. package/dist/esm/api/types/EmbeddingModel.d.mts +0 -2
  76. package/dist/esm/api/types/EmbeddingModelWithAuthenticationFields.d.mts +0 -1
  77. package/dist/esm/api/types/EntityCountWithDefinition.d.mts +1 -0
  78. package/dist/esm/api/types/EntitySummary.d.mts +12 -0
  79. package/dist/esm/api/types/EntityTypeStats.d.mts +10 -0
  80. package/dist/esm/api/types/IntegrationCredentialInDb.d.mts +2 -1
  81. package/dist/esm/api/types/IntegrationCredentialRawCreate.d.mts +2 -1
  82. package/dist/esm/api/types/OAuthBrowserAuthentication.d.mts +14 -0
  83. package/dist/esm/api/types/OAuthTokenAuthentication.d.mts +14 -0
  84. package/dist/esm/api/types/OAuthType.d.mts +12 -0
  85. package/dist/esm/api/types/OAuthType.mjs +8 -0
  86. package/dist/esm/api/types/ScheduleConfig.d.mts +14 -0
  87. package/dist/esm/api/types/ScheduleDetails.d.mts +13 -0
  88. package/dist/esm/api/types/SingleActionCheckResponse.d.mts +23 -0
  89. package/dist/esm/api/types/SingleActionCheckResponse.mjs +10 -0
  90. package/dist/esm/api/types/Source.d.mts +11 -7
  91. package/dist/esm/api/types/SourceConnection.d.mts +9 -52
  92. package/dist/esm/api/types/SourceConnectionJob.d.mts +9 -34
  93. package/dist/esm/api/types/SourceConnectionListItem.d.mts +13 -16
  94. package/dist/esm/api/types/SourceConnectionStatus.d.mts +7 -4
  95. package/dist/esm/api/types/SourceConnectionStatus.mjs +5 -2
  96. package/dist/esm/api/types/SourceConnectionUpdate.d.mts +16 -0
  97. package/dist/esm/api/types/SyncDetails.d.mts +13 -0
  98. package/dist/esm/api/types/SyncJobDetails.d.mts +20 -0
  99. package/dist/esm/api/types/SyncJobStatus.d.mts +2 -2
  100. package/dist/esm/api/types/SyncJobStatus.mjs +1 -1
  101. package/dist/esm/api/types/SyncSummary.d.mts +11 -0
  102. package/dist/esm/api/types/SyncSummary.mjs +4 -0
  103. package/dist/esm/api/types/index.d.mts +17 -9
  104. package/dist/esm/api/types/index.mjs +17 -9
  105. package/dist/esm/version.d.mts +1 -1
  106. package/dist/esm/version.mjs +1 -1
  107. package/package.json +1 -1
  108. package/reference.md +30 -763
  109. package/dist/cjs/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionsSourceConnectionIdRunPost.d.ts +0 -11
  110. package/dist/cjs/api/resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.d.ts +0 -13
  111. package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +0 -34
  112. package/dist/cjs/api/resources/whiteLabels/client/Client.d.ts +0 -189
  113. package/dist/cjs/api/resources/whiteLabels/client/Client.js +0 -585
  114. package/dist/cjs/api/resources/whiteLabels/client/index.d.ts +0 -2
  115. package/dist/cjs/api/resources/whiteLabels/client/index.js +0 -17
  116. package/dist/cjs/api/resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.ts +0 -16
  117. package/dist/cjs/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts +0 -28
  118. package/dist/cjs/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts +0 -23
  119. package/dist/cjs/api/resources/whiteLabels/client/requests/index.d.ts +0 -3
  120. package/dist/cjs/api/resources/whiteLabels/client/requests/index.js +0 -2
  121. package/dist/cjs/api/resources/whiteLabels/index.d.ts +0 -1
  122. package/dist/cjs/api/resources/whiteLabels/index.js +0 -17
  123. package/dist/cjs/api/types/AuthType.d.ts +0 -27
  124. package/dist/cjs/api/types/AuthType.js +0 -16
  125. package/dist/cjs/api/types/BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.d.ts +0 -13
  126. package/dist/cjs/api/types/OAuth2AuthUrl.d.ts +0 -13
  127. package/dist/cjs/api/types/SourceConnectionContinuousResponse.d.ts +0 -67
  128. package/dist/cjs/api/types/SourceConnectionCreateContinuous.d.ts +0 -33
  129. package/dist/cjs/api/types/SourceConnectionCreateWithCredential.d.ts +0 -25
  130. package/dist/cjs/api/types/SourceConnectionCreateWithWhiteLabel.d.ts +0 -29
  131. package/dist/cjs/api/types/SourceConnectionMakeContinuous.d.ts +0 -14
  132. package/dist/cjs/api/types/WhiteLabel.d.ts +0 -32
  133. package/dist/esm/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionsSourceConnectionIdRunPost.d.mts +0 -11
  134. package/dist/esm/api/resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.d.mts +0 -13
  135. package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.mts +0 -34
  136. package/dist/esm/api/resources/whiteLabels/client/Client.d.mts +0 -189
  137. package/dist/esm/api/resources/whiteLabels/client/Client.mjs +0 -548
  138. package/dist/esm/api/resources/whiteLabels/client/index.d.mts +0 -2
  139. package/dist/esm/api/resources/whiteLabels/client/index.mjs +0 -1
  140. package/dist/esm/api/resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.mts +0 -16
  141. package/dist/esm/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.mts +0 -28
  142. package/dist/esm/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.mts +0 -23
  143. package/dist/esm/api/resources/whiteLabels/client/requests/index.d.mts +0 -3
  144. package/dist/esm/api/resources/whiteLabels/client/requests/index.mjs +0 -1
  145. package/dist/esm/api/resources/whiteLabels/index.d.mts +0 -1
  146. package/dist/esm/api/resources/whiteLabels/index.mjs +0 -1
  147. package/dist/esm/api/types/AuthType.d.mts +0 -27
  148. package/dist/esm/api/types/AuthType.mjs +0 -13
  149. package/dist/esm/api/types/BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.d.mts +0 -13
  150. package/dist/esm/api/types/OAuth2AuthUrl.d.mts +0 -13
  151. package/dist/esm/api/types/SourceConnectionContinuousResponse.d.mts +0 -67
  152. package/dist/esm/api/types/SourceConnectionCreateContinuous.d.mts +0 -33
  153. package/dist/esm/api/types/SourceConnectionCreateWithCredential.d.mts +0 -25
  154. package/dist/esm/api/types/SourceConnectionCreateWithWhiteLabel.d.mts +0 -29
  155. package/dist/esm/api/types/SourceConnectionMakeContinuous.d.mts +0 -14
  156. package/dist/esm/api/types/WhiteLabel.d.mts +0 -32
  157. /package/dist/cjs/api/resources/sourceConnections/client/requests/{BodyRunSourceConnectionsSourceConnectionIdRunPost.js → GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.js} +0 -0
  158. /package/dist/cjs/api/{resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.js → types/ActionCheckRequest.js} +0 -0
  159. /package/dist/cjs/api/{resources/sourceConnections/client/requests/SourceConnectionUpdate.js → types/AuthProviderAuthentication.js} +0 -0
  160. /package/dist/cjs/api/{resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js → types/AuthenticationDetails.js} +0 -0
  161. /package/dist/cjs/api/{resources/whiteLabels/client/requests/WhiteLabelCreate.js → types/DirectAuthentication.js} +0 -0
  162. /package/dist/cjs/api/{resources/whiteLabels/client/requests/WhiteLabelUpdate.js → types/EntitySummary.js} +0 -0
  163. /package/dist/cjs/api/types/{BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.js → EntityTypeStats.js} +0 -0
  164. /package/dist/cjs/api/types/{OAuth2AuthUrl.js → OAuthBrowserAuthentication.js} +0 -0
  165. /package/dist/cjs/api/types/{SourceConnectionContinuousResponse.js → OAuthTokenAuthentication.js} +0 -0
  166. /package/dist/cjs/api/types/{SourceConnectionCreateContinuous.js → ScheduleConfig.js} +0 -0
  167. /package/dist/cjs/api/types/{SourceConnectionCreateWithCredential.js → ScheduleDetails.js} +0 -0
  168. /package/dist/cjs/api/types/{SourceConnectionCreateWithWhiteLabel.js → SourceConnectionUpdate.js} +0 -0
  169. /package/dist/cjs/api/types/{SourceConnectionMakeContinuous.js → SyncDetails.js} +0 -0
  170. /package/dist/cjs/api/types/{WhiteLabel.js → SyncJobDetails.js} +0 -0
  171. /package/dist/esm/api/resources/sourceConnections/client/requests/{BodyRunSourceConnectionsSourceConnectionIdRunPost.mjs → GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.mjs} +0 -0
  172. /package/dist/esm/api/{resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.mjs → types/ActionCheckRequest.mjs} +0 -0
  173. /package/dist/esm/api/{resources/sourceConnections/client/requests/SourceConnectionUpdate.mjs → types/AuthProviderAuthentication.mjs} +0 -0
  174. /package/dist/esm/api/{resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.mjs → types/AuthenticationDetails.mjs} +0 -0
  175. /package/dist/esm/api/{resources/whiteLabels/client/requests/WhiteLabelCreate.mjs → types/DirectAuthentication.mjs} +0 -0
  176. /package/dist/esm/api/{resources/whiteLabels/client/requests/WhiteLabelUpdate.mjs → types/EntitySummary.mjs} +0 -0
  177. /package/dist/esm/api/types/{BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.mjs → EntityTypeStats.mjs} +0 -0
  178. /package/dist/esm/api/types/{OAuth2AuthUrl.mjs → OAuthBrowserAuthentication.mjs} +0 -0
  179. /package/dist/esm/api/types/{SourceConnectionContinuousResponse.mjs → OAuthTokenAuthentication.mjs} +0 -0
  180. /package/dist/esm/api/types/{SourceConnectionCreateContinuous.mjs → ScheduleConfig.mjs} +0 -0
  181. /package/dist/esm/api/types/{SourceConnectionCreateWithCredential.mjs → ScheduleDetails.mjs} +0 -0
  182. /package/dist/esm/api/types/{SourceConnectionCreateWithWhiteLabel.mjs → SourceConnectionUpdate.mjs} +0 -0
  183. /package/dist/esm/api/types/{SourceConnectionMakeContinuous.mjs → SyncDetails.mjs} +0 -0
  184. /package/dist/esm/api/types/{WhiteLabel.mjs → SyncJobDetails.mjs} +0 -0
@@ -5,29 +5,30 @@ import * as AirweaveSDK from "../../../../index.js";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * name: "Production Stripe Account",
9
- * short_name: "stripe"
8
+ * short_name: "short_name",
9
+ * readable_collection_id: "readable_collection_id"
10
10
  * }
11
11
  */
12
12
  export interface SourceConnectionCreate {
13
- /** Human-readable name for the source connection. This helps you identify the connection in the UI and should clearly describe what data it connects to. */
14
- name: string;
15
- /** Optional detailed description of what this source connection provides. Use this to document the purpose, data types, or any special considerations for this connection. */
16
- description?: string;
17
- /** Source-specific configuration parameters required for data extraction. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
18
- config_fields?: AirweaveSDK.ConfigValues;
19
- /** Technical identifier of the source type that determines which connector to use for data synchronization. */
13
+ /** Connection name (defaults to '{Source Name} Connection') */
14
+ name?: string;
15
+ /** Source identifier (e.g., 'slack', 'github') */
20
16
  short_name: string;
21
- /** Readable ID of the collection where synced data will be stored. If not provided, a new collection will be automatically created. */
22
- collection?: string;
23
- /** Cron expression for automatic data synchronization schedule. If not provided, data will only sync when manually triggered. Use standard cron format: minute hour day month weekday. */
24
- cron_schedule?: string;
25
- /** Authentication credentials required to access the data source. The required fields vary by source type. Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
26
- auth_fields?: AirweaveSDK.ConfigValues;
27
- /** Unique readable ID of a connected auth provider to use for authentication instead of providing auth_fields directly. When specified, credentials for the source will be obtained and refreshed automatically by Airweave interaction with the auth provider. To see which auth providers are supported and learn more about how to use them, check [this page](https://docs.airweave.ai/docs/auth-providers). */
28
- auth_provider?: string;
29
- /** Configuration for the auth provider when using auth_provider field. Required fields vary by auth provider. For Composio, use auth_config_id and account_id to specify which integration and account from Composio you want to use to connect to the source. */
30
- auth_provider_config?: AirweaveSDK.ConfigValues;
31
- /** Whether to start an initial data synchronization immediately after creating the connection. */
17
+ /** Collection readable ID */
18
+ readable_collection_id: string;
19
+ /** Connection description */
20
+ description?: string;
21
+ /** Source-specific configuration */
22
+ config?: Record<string, unknown>;
23
+ schedule?: AirweaveSDK.ScheduleConfig;
24
+ /** Run initial sync after creation */
32
25
  sync_immediately?: boolean;
26
+ /** Authentication config (defaults to OAuth browser flow for OAuth sources) */
27
+ authentication?: SourceConnectionCreate.Authentication;
28
+ }
29
+ export declare namespace SourceConnectionCreate {
30
+ /**
31
+ * Authentication config (defaults to OAuth browser flow for OAuth sources)
32
+ */
33
+ type Authentication = AirweaveSDK.DirectAuthentication | AirweaveSDK.OAuthTokenAuthentication | AirweaveSDK.OAuthBrowserAuthentication | AirweaveSDK.AuthProviderAuthentication;
33
34
  }
@@ -1,5 +1,3 @@
1
1
  export { type ListSourceConnectionsGetRequest } from "./ListSourceConnectionsGetRequest.js";
2
2
  export { type SourceConnectionCreate } from "./SourceConnectionCreate.js";
3
- export { type GetSourceConnectionsSourceConnectionIdGetRequest } from "./GetSourceConnectionsSourceConnectionIdGetRequest.js";
4
- export { type SourceConnectionUpdate } from "./SourceConnectionUpdate.js";
5
- export { type BodyRunSourceConnectionsSourceConnectionIdRunPost } from "./BodyRunSourceConnectionsSourceConnectionIdRunPost.js";
3
+ export { type GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest } from "./GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.js";
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Request schema for checking multiple actions.
6
+ */
7
+ export interface ActionCheckRequest {
8
+ /** Dictionary of action types to check with their amounts */
9
+ actions: Record<string, number>;
10
+ }
@@ -1,23 +1,11 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import * as AirweaveSDK from "../index.js";
4
5
  /**
5
- * Response schema for action permission checks.
6
+ * Response schema for multiple action checks.
6
7
  */
7
8
  export interface ActionCheckResponse {
8
- /** Whether the action is allowed for the organization */
9
- allowed: boolean;
10
- /** The action type that was checked */
11
- action: string;
12
- /** Reason why the action is not allowed (if applicable) */
13
- reason?: ActionCheckResponse.Reason;
14
- /** Additional details about why the action is not allowed */
15
- details?: Record<string, unknown>;
16
- }
17
- export declare namespace ActionCheckResponse {
18
- type Reason = "payment_required" | "usage_limit_exceeded";
19
- const Reason: {
20
- readonly PaymentRequired: "payment_required";
21
- readonly UsageLimitExceeded: "usage_limit_exceeded";
22
- };
9
+ /** Dictionary of action check results keyed by action type */
10
+ results: Record<string, AirweaveSDK.SingleActionCheckResponse>;
23
11
  }
@@ -3,11 +3,3 @@
3
3
  * This file was auto-generated by Fern from our API Definition.
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.ActionCheckResponse = void 0;
7
- var ActionCheckResponse;
8
- (function (ActionCheckResponse) {
9
- ActionCheckResponse.Reason = {
10
- PaymentRequired: "payment_required",
11
- UsageLimitExceeded: "usage_limit_exceeded",
12
- };
13
- })(ActionCheckResponse || (exports.ActionCheckResponse = ActionCheckResponse = {}));
@@ -16,8 +16,6 @@ export interface AuthProvider {
16
16
  auth_config_class: string;
17
17
  /** Python class name that defines the auth provider-specific configuration */
18
18
  config_class: string;
19
- /** Type of authentication mechanism used by this provider */
20
- auth_type: AirweaveSDK.AuthType;
21
19
  /** Detailed description explaining what this auth provider offers */
22
20
  description?: string;
23
21
  /** Organization identifier for custom auth providers. System providers have this set to null. */
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Authentication via external provider.
6
+ */
7
+ export interface AuthProviderAuthentication {
8
+ /** Auth provider identifier */
9
+ provider_name: string;
10
+ /** Provider-specific configuration */
11
+ provider_config?: Record<string, unknown>;
12
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as AirweaveSDK from "../index.js";
5
+ /**
6
+ * Authentication information.
7
+ */
8
+ export interface AuthenticationDetails {
9
+ method: AirweaveSDK.AuthenticationMethod;
10
+ authenticated: boolean;
11
+ authenticated_at?: string;
12
+ expires_at?: string;
13
+ /** For pending OAuth flows */
14
+ auth_url?: string;
15
+ auth_url_expires?: string;
16
+ redirect_url?: string;
17
+ provider_name?: string;
18
+ provider_id?: string;
19
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Authentication methods for source connections.
6
+ */
7
+ export type AuthenticationMethod = "direct" | "oauth_browser" | "oauth_token" | "oauth_byoc" | "auth_provider";
8
+ export declare const AuthenticationMethod: {
9
+ readonly Direct: "direct";
10
+ readonly OauthBrowser: "oauth_browser";
11
+ readonly OauthToken: "oauth_token";
12
+ readonly OauthByoc: "oauth_byoc";
13
+ readonly AuthProvider: "auth_provider";
14
+ };
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.AuthenticationMethod = void 0;
7
+ exports.AuthenticationMethod = {
8
+ Direct: "direct",
9
+ OauthBrowser: "oauth_browser",
10
+ OauthToken: "oauth_token",
11
+ OauthByoc: "oauth_byoc",
12
+ AuthProvider: "auth_provider",
13
+ };
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- import * as AirweaveSDK from "../index.js";
5
4
  /**
6
5
  * Schema for Destination.
7
6
  */
@@ -10,7 +9,6 @@ export interface Destination {
10
9
  description?: string;
11
10
  short_name: string;
12
11
  class_name: string;
13
- auth_type?: AirweaveSDK.AuthType;
14
12
  auth_config_class?: string;
15
13
  input_entity_definition_ids?: string[];
16
14
  organization_id?: string;
@@ -10,7 +10,6 @@ export interface DestinationWithAuthenticationFields {
10
10
  description?: string;
11
11
  short_name: string;
12
12
  class_name: string;
13
- auth_type?: AirweaveSDK.AuthType;
14
13
  auth_config_class?: string;
15
14
  input_entity_definition_ids?: string[];
16
15
  organization_id?: string;
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Direct authentication with API keys or passwords.
6
+ */
7
+ export interface DirectAuthentication {
8
+ /** Authentication credentials */
9
+ credentials: Record<string, unknown>;
10
+ }
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- import * as AirweaveSDK from "../index.js";
5
4
  /**
6
5
  * Schema for EmbeddingModel.
7
6
  */
@@ -12,7 +11,6 @@ export interface EmbeddingModel {
12
11
  provider: string;
13
12
  model_name?: string;
14
13
  model_version?: string;
15
- auth_type?: AirweaveSDK.AuthType;
16
14
  auth_config_class?: string;
17
15
  id: string;
18
16
  created_at: string;
@@ -12,7 +12,6 @@ export interface EmbeddingModelWithAuthenticationFields {
12
12
  provider: string;
13
13
  model_name?: string;
14
14
  model_version?: string;
15
- auth_type?: AirweaveSDK.AuthType;
16
15
  auth_config_class?: string;
17
16
  id: string;
18
17
  created_at: string;
@@ -10,4 +10,5 @@ export interface EntityCountWithDefinition {
10
10
  entity_definition_name: string;
11
11
  entity_definition_type: string;
12
12
  entity_definition_description?: string;
13
+ modified_at: string;
13
14
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as AirweaveSDK from "../index.js";
5
+ /**
6
+ * Entity state summary.
7
+ */
8
+ export interface EntitySummary {
9
+ total_entities?: number;
10
+ by_type?: Record<string, AirweaveSDK.EntityTypeStats>;
11
+ last_updated?: string;
12
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Statistics for a specific entity type.
6
+ */
7
+ export interface EntityTypeStats {
8
+ count: number;
9
+ last_updated?: string;
10
+ }
@@ -10,7 +10,8 @@ export interface IntegrationCredentialInDb {
10
10
  integration_short_name: string;
11
11
  description?: string;
12
12
  integration_type: AirweaveSDK.IntegrationType;
13
- auth_type: AirweaveSDK.AuthType;
13
+ authentication_method: AirweaveSDK.AuthenticationMethod;
14
+ oauth_type?: AirweaveSDK.OAuthType;
14
15
  auth_config_class?: string;
15
16
  id: string;
16
17
  organization_id: string;
@@ -13,7 +13,8 @@ export interface IntegrationCredentialRawCreate {
13
13
  integration_short_name: string;
14
14
  description?: string;
15
15
  integration_type: AirweaveSDK.IntegrationType;
16
- auth_type: AirweaveSDK.AuthType;
16
+ authentication_method: AirweaveSDK.AuthenticationMethod;
17
+ oauth_type?: AirweaveSDK.OAuthType;
17
18
  auth_config_class?: string;
18
19
  auth_fields: Record<string, unknown>;
19
20
  }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * OAuth authentication via browser flow.
6
+ */
7
+ export interface OAuthBrowserAuthentication {
8
+ /** OAuth redirect URI */
9
+ redirect_uri?: string;
10
+ /** OAuth client ID (for custom apps) */
11
+ client_id?: string;
12
+ /** OAuth client secret (for custom apps) */
13
+ client_secret?: string;
14
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * OAuth authentication with pre-obtained token.
6
+ */
7
+ export interface OAuthTokenAuthentication {
8
+ /** OAuth access token */
9
+ access_token: string;
10
+ /** OAuth refresh token */
11
+ refresh_token?: string;
12
+ /** Token expiry time */
13
+ expires_at?: string;
14
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * OAuth token types for sources.
6
+ */
7
+ export type OAuthType = "access_only" | "with_refresh" | "with_rotating_refresh";
8
+ export declare const OAuthType: {
9
+ readonly AccessOnly: "access_only";
10
+ readonly WithRefresh: "with_refresh";
11
+ readonly WithRotatingRefresh: "with_rotating_refresh";
12
+ };
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.OAuthType = void 0;
7
+ exports.OAuthType = {
8
+ AccessOnly: "access_only",
9
+ WithRefresh: "with_refresh",
10
+ WithRotatingRefresh: "with_rotating_refresh",
11
+ };
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Schedule configuration for syncs.
6
+ */
7
+ export interface ScheduleConfig {
8
+ /** Cron expression for scheduled syncs */
9
+ cron?: string;
10
+ /** Enable continuous sync mode */
11
+ continuous?: boolean;
12
+ /** Field for incremental sync */
13
+ cursor_field?: string;
14
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Schedule information.
6
+ */
7
+ export interface ScheduleDetails {
8
+ cron?: string;
9
+ next_run?: string;
10
+ continuous?: boolean;
11
+ cursor_field?: string;
12
+ cursor_value?: unknown;
13
+ }
@@ -0,0 +1,23 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Response schema for single action permission check.
6
+ */
7
+ export interface SingleActionCheckResponse {
8
+ /** Whether the action is allowed for the organization */
9
+ allowed: boolean;
10
+ /** The action type that was checked */
11
+ action: string;
12
+ /** Reason why the action is not allowed (if applicable) */
13
+ reason?: SingleActionCheckResponse.Reason;
14
+ /** Additional details about why the action is not allowed */
15
+ details?: Record<string, unknown>;
16
+ }
17
+ export declare namespace SingleActionCheckResponse {
18
+ type Reason = "payment_required" | "usage_limit_exceeded";
19
+ const Reason: {
20
+ readonly PaymentRequired: "payment_required";
21
+ readonly UsageLimitExceeded: "usage_limit_exceeded";
22
+ };
23
+ }
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.SingleActionCheckResponse = void 0;
7
+ var SingleActionCheckResponse;
8
+ (function (SingleActionCheckResponse) {
9
+ SingleActionCheckResponse.Reason = {
10
+ PaymentRequired: "payment_required",
11
+ UsageLimitExceeded: "usage_limit_exceeded",
12
+ };
13
+ })(SingleActionCheckResponse || (exports.SingleActionCheckResponse = SingleActionCheckResponse = {}));
@@ -10,12 +10,16 @@ export interface Source {
10
10
  name: string;
11
11
  /** Detailed description explaining what data this source can extract and its typical use cases. */
12
12
  description?: string;
13
- /** Type of authentication mechanism required by this source (e.g., 'oauth2'). */
14
- auth_type?: AirweaveSDK.AuthType;
15
- /** Python class name that defines the authentication configuration fields required for this source. */
16
- auth_config_class: string;
13
+ /** List of supported authentication methods (e.g., 'direct', 'oauth_browser'). */
14
+ auth_methods?: string[];
15
+ /** OAuth token type for OAuth sources (e.g., 'access_only', 'with_refresh'). */
16
+ oauth_type?: string;
17
+ /** Whether this OAuth source requires users to bring their own client. */
18
+ requires_byoc?: boolean;
19
+ /** Python class name that defines the authentication configuration fields required for this source (only for DIRECT auth). */
20
+ auth_config_class?: string;
17
21
  /** Python class name that defines the source-specific configuration options and parameters. */
18
- config_class: string;
22
+ config_class?: string;
19
23
  /** Technical identifier used internally to reference this source type. Must be unique across all sources. */
20
24
  short_name: string;
21
25
  /** Python class name of the source implementation that handles data extraction logic. */
@@ -32,8 +36,8 @@ export interface Source {
32
36
  created_at: string;
33
37
  /** Timestamp when this source type was last updated (ISO 8601 format). */
34
38
  modified_at: string;
35
- /** Schema definition for authentication fields required to connect to this source. Describes field types, validation rules, and user interface hints. */
36
- auth_fields: AirweaveSDK.Fields;
39
+ /** Schema definition for authentication fields required to connect to this source. Only present for sources using DIRECT authentication. OAuth sources handle authentication through browser flows. */
40
+ auth_fields?: AirweaveSDK.Fields;
37
41
  /** Schema definition for configuration fields required to customize this source. Describes field types, validation rules, and user interface hints. */
38
42
  config_fields: AirweaveSDK.Fields;
39
43
  }
@@ -3,63 +3,20 @@
3
3
  */
4
4
  import * as AirweaveSDK from "../index.js";
5
5
  /**
6
- * Complete source connection representation returned by the API.
6
+ * Complete source connection details.
7
7
  */
8
8
  export interface SourceConnection {
9
- /** Human-readable display name for the source connection. This helps you identify the connection in the UI and should clearly describe what data it connects to (e.g., 'Production Stripe Account', 'Customer Support Database'). */
9
+ id: string;
10
10
  name: string;
11
- /** Optional additional context about the data this connection provides. Use this to document the purpose, data types, or any special considerations for this connection. */
12
11
  description?: string;
13
- /** Source-specific configuration options that control data retrieval behavior. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
14
- config_fields?: AirweaveSDK.ConfigValues;
15
- /** Technical identifier of the source type (e.g., 'github', 'stripe', 'postgresql', 'slack'). This determines which connector Airweave uses to sync data. */
16
12
  short_name: string;
17
- /** Identifier for custom OAuth integrations. Only present for connections created through white label OAuth flows. */
18
- white_label_id?: string;
19
- /** Readable ID of the auth provider used to create this connection. Present only if the connection was created through an auth provider. */
20
- auth_provider?: string;
21
- /** Configuration used with the auth provider to create this connection. Present only if the connection was created through an auth provider. */
22
- auth_provider_config?: Record<string, unknown>;
23
- /** Unique system identifier for this source connection. This UUID is generated automatically and used for API operations. */
24
- id: string;
25
- /** Internal identifier for the sync configuration associated with this source connection. Managed automatically by the system. */
26
- sync_id?: string;
27
- /** Identifier of the organization that owns this source connection. Source connections are isolated per organization. */
28
- organization_id: string;
29
- /** Timestamp when the source connection was created (ISO 8601 format). */
13
+ readable_collection_id: string;
14
+ status: AirweaveSDK.SourceConnectionStatus;
30
15
  created_at: string;
31
- /** Timestamp when the source connection was last modified (ISO 8601 format). */
32
16
  modified_at: string;
33
- /** Internal identifier for the underlying connection object that manages authentication and configuration. */
34
- connection_id?: string;
35
- /** Readable ID of the collection where this source connection syncs its data. This creates the link between your data source and searchable content. */
36
- collection: string;
37
- /** Email address of the user who created this source connection. */
38
- created_by_email?: string;
39
- /** Email address of the user who last modified this source connection. */
40
- modified_by_email?: string;
41
- /** Authentication credentials for the data source. Returns '********' by default for security. */
42
- auth_fields?: SourceConnection.AuthFields;
43
- /** Current operational status of the source connection:<br/>• **active**: Connection is healthy and ready for data synchronization<br/>• **in_progress**: Currently syncing data from the source<br/>• **failing**: Recent sync attempts have failed and require attention */
44
- status?: AirweaveSDK.SourceConnectionStatus;
45
- /** Status of the most recent data synchronization job:<br/>• **completed**: Last sync finished successfully<br/>• **failed**: Last sync encountered errors<br/>• **in_progress**: Currently running a sync job<br/>• **pending**: Sync job is queued and waiting to start */
46
- latest_sync_job_status?: AirweaveSDK.SyncJobStatus;
47
- /** Unique identifier of the most recent sync job. Use this to track sync progress or retrieve detailed job information. */
48
- latest_sync_job_id?: string;
49
- /** Timestamp when the most recent sync job started (ISO 8601 format). */
50
- latest_sync_job_started_at?: string;
51
- /** Timestamp when the most recent sync job completed (ISO 8601 format). Null if the job is still running or failed. */
52
- latest_sync_job_completed_at?: string;
53
- /** Error message from the most recent sync job if it failed. Use this to diagnose and resolve sync issues. */
54
- latest_sync_job_error?: string;
55
- /** Cron expression defining when automatic data synchronization occurs. Null if automatic syncing is disabled and syncs must be triggered manually. */
56
- cron_schedule?: string;
57
- /** Timestamp when the next automatic sync is scheduled to run (ISO 8601 format). Null if no automatic schedule is configured. */
58
- next_scheduled_run?: string;
59
- }
60
- export declare namespace SourceConnection {
61
- /**
62
- * Authentication credentials for the data source. Returns '********' by default for security.
63
- */
64
- type AuthFields = AirweaveSDK.ConfigValues | string;
17
+ auth: AirweaveSDK.AuthenticationDetails;
18
+ config?: Record<string, unknown>;
19
+ schedule?: AirweaveSDK.ScheduleDetails;
20
+ sync?: AirweaveSDK.SyncDetails;
21
+ entities?: AirweaveSDK.EntitySummary;
65
22
  }
@@ -3,45 +3,20 @@
3
3
  */
4
4
  import * as AirweaveSDK from "../index.js";
5
5
  /**
6
- * Data synchronization job for a specific source connection.
6
+ * Individual sync job for a source connection.
7
7
  */
8
8
  export interface SourceConnectionJob {
9
- /** Unique identifier of the source connection for which this data refresh is running. */
10
- source_connection_id: string;
11
- /** Unique identifier for this specific data refresh operation. */
12
9
  id: string;
13
- /** Identifier of the organization that owns this data refresh operation. */
14
- organization_id: string;
15
- /** Email address of the user who initiated this data refresh (for manually triggered operations). */
16
- created_by_email?: string;
17
- /** Email address of the user who last modified this data refresh operation. */
18
- modified_by_email?: string;
19
- /** Timestamp when this data refresh was created and queued (ISO 8601 format). */
20
- created_at?: string;
21
- /** Timestamp when this data refresh was last modified (ISO 8601 format). */
22
- modified_at?: string;
23
- /** Current execution status of the data refresh:<br/>• **created**: Operation has been created but not yet queued<br/>• **pending**: Operation is queued and waiting to start<br/>• **in_progress**: Currently running and processing data<br/>• **completed**: Finished successfully with all data processed<br/>• **failed**: Encountered errors and could not complete<br/>• **cancelled**: Manually cancelled before completion */
24
- status?: AirweaveSDK.SyncJobStatus;
25
- /** Whether this data refresh was triggered by a schedule (true) or manually (false). */
26
- scheduled?: boolean;
27
- /** Number of new data entities that were added to the collection during this refresh. */
10
+ source_connection_id: string;
11
+ status: AirweaveSDK.SyncJobStatus;
12
+ started_at?: string;
13
+ completed_at?: string;
14
+ duration_seconds?: number;
15
+ entities_processed?: number;
28
16
  entities_inserted?: number;
29
- /** Number of existing entities that were modified and updated during this refresh. */
30
17
  entities_updated?: number;
31
- /** Number of entities that were removed from the collection because they no longer exist in the source. */
32
18
  entities_deleted?: number;
33
- /** Number of entities that were checked but required no changes because they were already up-to-date. */
34
- entities_kept?: number;
35
- /** Number of entities that were intentionally skipped due to filtering rules or processing decisions. */
36
- entities_skipped?: number;
37
- /** Detailed breakdown of entities processed by type or category. */
38
- entities_encountered?: Record<string, number | undefined>;
39
- /** Timestamp when the data refresh began active processing (ISO 8601 format). */
40
- started_at?: string;
41
- /** Timestamp when the data refresh finished successfully (ISO 8601 format). */
42
- completed_at?: string;
43
- /** Timestamp when the data refresh failed (ISO 8601 format). */
44
- failed_at?: string;
45
- /** Detailed error message if the data refresh failed. */
19
+ entities_failed?: number;
46
20
  error?: string;
21
+ error_details?: Record<string, unknown>;
47
22
  }
@@ -3,27 +3,24 @@
3
3
  */
4
4
  import * as AirweaveSDK from "../index.js";
5
5
  /**
6
- * Simplified source connection representation for list operations.
6
+ * Minimal source connection for list views with computed fields.
7
7
  */
8
8
  export interface SourceConnectionListItem {
9
- /** Unique identifier for the source connection. */
10
9
  id: string;
11
- /** Human-readable name of the source connection. */
12
10
  name: string;
13
- /** Brief description of what data this connection provides. */
14
- description?: string;
15
- /** Technical identifier of the source type (e.g., 'stripe', 'postgresql'). */
16
11
  short_name: string;
17
- /** Current operational status: active, in_progress, or failing. */
18
- status: AirweaveSDK.SourceConnectionStatus;
19
- /** When the source connection was created (ISO 8601 format). */
12
+ readable_collection_id: string;
20
13
  created_at: string;
21
- /** When the source connection was last modified (ISO 8601 format). */
22
14
  modified_at: string;
23
- /** Internal identifier for the sync configuration. */
24
- sync_id: string;
25
- /** Readable ID of the collection where this connection syncs data. */
26
- collection: string;
27
- /** Identifier for custom OAuth integrations, if applicable. */
28
- white_label_id?: string;
15
+ is_authenticated: boolean;
16
+ readable_auth_provider_id?: string;
17
+ connection_init_session_id?: string;
18
+ is_active?: boolean;
19
+ last_sync?: AirweaveSDK.SyncSummary;
20
+ entity_count?: number;
21
+ last_job_status?: AirweaveSDK.SyncJobStatus;
22
+ /** Compute authentication method from database fields. */
23
+ auth_method: AirweaveSDK.AuthenticationMethod;
24
+ /** Compute connection status from current state. */
25
+ status: AirweaveSDK.SourceConnectionStatus;
29
26
  }