@airweave/sdk 0.4.12 → 0.4.13

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 (40) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/sourceConnections/client/Client.d.ts +2 -1
  3. package/dist/cjs/api/resources/sourceConnections/client/Client.js +2 -1
  4. package/dist/cjs/api/types/MinuteLevelScheduleConfig.d.ts +10 -0
  5. package/dist/cjs/api/types/MinuteLevelScheduleConfig.js +5 -0
  6. package/dist/cjs/api/types/ScheduleResponse.d.ts +11 -0
  7. package/dist/cjs/api/types/ScheduleResponse.js +5 -0
  8. package/dist/cjs/api/types/SourceConnectionContinuousResponse.d.ts +67 -0
  9. package/dist/cjs/api/types/SourceConnectionContinuousResponse.js +5 -0
  10. package/dist/cjs/api/types/SourceConnectionCreateContinuous.d.ts +31 -0
  11. package/dist/cjs/api/types/SourceConnectionCreateContinuous.js +5 -0
  12. package/dist/cjs/api/types/Sync.d.ts +3 -0
  13. package/dist/cjs/api/types/SyncCreate.d.ts +3 -0
  14. package/dist/cjs/api/types/SyncUpdate.d.ts +3 -0
  15. package/dist/cjs/api/types/SyncWithSourceConnection.d.ts +3 -0
  16. package/dist/cjs/api/types/index.d.ts +4 -0
  17. package/dist/cjs/api/types/index.js +4 -0
  18. package/dist/cjs/version.d.ts +1 -1
  19. package/dist/cjs/version.js +1 -1
  20. package/dist/esm/Client.mjs +2 -2
  21. package/dist/esm/api/resources/sourceConnections/client/Client.d.mts +2 -1
  22. package/dist/esm/api/resources/sourceConnections/client/Client.mjs +2 -1
  23. package/dist/esm/api/types/MinuteLevelScheduleConfig.d.mts +10 -0
  24. package/dist/esm/api/types/MinuteLevelScheduleConfig.mjs +4 -0
  25. package/dist/esm/api/types/ScheduleResponse.d.mts +11 -0
  26. package/dist/esm/api/types/ScheduleResponse.mjs +4 -0
  27. package/dist/esm/api/types/SourceConnectionContinuousResponse.d.mts +67 -0
  28. package/dist/esm/api/types/SourceConnectionContinuousResponse.mjs +4 -0
  29. package/dist/esm/api/types/SourceConnectionCreateContinuous.d.mts +31 -0
  30. package/dist/esm/api/types/SourceConnectionCreateContinuous.mjs +4 -0
  31. package/dist/esm/api/types/Sync.d.mts +3 -0
  32. package/dist/esm/api/types/SyncCreate.d.mts +3 -0
  33. package/dist/esm/api/types/SyncUpdate.d.mts +3 -0
  34. package/dist/esm/api/types/SyncWithSourceConnection.d.mts +3 -0
  35. package/dist/esm/api/types/index.d.mts +4 -0
  36. package/dist/esm/api/types/index.mjs +4 -0
  37. package/dist/esm/version.d.mts +1 -1
  38. package/dist/esm/version.mjs +1 -1
  39. package/package.json +1 -1
  40. package/reference.md +2 -1
@@ -48,8 +48,8 @@ class AirweaveSDKClient {
48
48
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
49
49
  "X-Fern-Language": "JavaScript",
50
50
  "X-Fern-SDK-Name": "@airweave/sdk",
51
- "X-Fern-SDK-Version": "v0.4.12",
52
- "User-Agent": "@airweave/sdk/v0.4.12",
51
+ "X-Fern-SDK-Version": "v0.4.13",
52
+ "User-Agent": "@airweave/sdk/v0.4.13",
53
53
  "X-Fern-Runtime": core.RUNTIME.type,
54
54
  "X-Fern-Runtime-Version": core.RUNTIME.version,
55
55
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -53,7 +53,8 @@ export declare class SourceConnections {
53
53
  *
54
54
  * **This endpoint only works for sources that do not use OAuth2.0.**
55
55
  * Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
56
- * connected through the UI where you can complete the OAuth consent flow.<br/><br/>
56
+ * connected through the UI where you can complete the OAuth consent flow
57
+ * or using Auth Providers (see [Auth Providers](/docs/auth-providers)).<br/><br/>
57
58
  *
58
59
  * Credentials for a source have to be provided using the `auth_fields` field.
59
60
  * Currently, it is not automatically checked if the provided credentials are valid.
@@ -140,7 +140,8 @@ class SourceConnections {
140
140
  *
141
141
  * **This endpoint only works for sources that do not use OAuth2.0.**
142
142
  * Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
143
- * connected through the UI where you can complete the OAuth consent flow.<br/><br/>
143
+ * connected through the UI where you can complete the OAuth consent flow
144
+ * or using Auth Providers (see [Auth Providers](/docs/auth-providers)).<br/><br/>
144
145
  *
145
146
  * Credentials for a source have to be provided using the `auth_fields` field.
146
147
  * Currently, it is not automatically checked if the provided credentials are valid.
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Configuration for minute-level incremental sync schedules.
6
+ */
7
+ export interface MinuteLevelScheduleConfig {
8
+ /** Minute-level cron expression for incremental sync (default: every minute) */
9
+ cron_expression?: string;
10
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Response for schedule operations.
6
+ */
7
+ export interface ScheduleResponse {
8
+ schedule_id: string;
9
+ status: string;
10
+ message: string;
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,67 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as AirweaveSDK from "../index.js";
5
+ /**
6
+ * Response schema for continuous source connection creation.
7
+ */
8
+ export interface SourceConnectionContinuousResponse {
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'). */
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
+ 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
+ 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). */
30
+ created_at: string;
31
+ /** Timestamp when the source connection was last modified (ISO 8601 format). */
32
+ 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?: SourceConnectionContinuousResponse.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
+ /** Information about the created minute-level schedule including schedule ID, cron expression, and current status. */
60
+ minute_level_schedule?: Record<string, unknown>;
61
+ }
62
+ export declare namespace SourceConnectionContinuousResponse {
63
+ /**
64
+ * Authentication credentials for the data source. Returns '********' by default for security.
65
+ */
66
+ type AuthFields = AirweaveSDK.ConfigValues | string;
67
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,31 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as AirweaveSDK from "../index.js";
5
+ /**
6
+ * Schema for creating a continuously syncing source connection (BETA).
7
+ *
8
+ * This endpoint creates a source connection that stays continuously in sync with your
9
+ * data source. Your data will be automatically synchronized every minute, ensuring it's
10
+ * always up-to-date without any manual intervention or sync management.
11
+ */
12
+ export interface SourceConnectionCreateContinuous {
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. */
20
+ 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
+ /** 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. */
24
+ auth_fields?: AirweaveSDK.ConfigValues;
25
+ /** Unique readable ID of a connected auth provider to use for authentication instead of providing auth_fields directly. */
26
+ auth_provider?: string;
27
+ /** Configuration for the auth provider when using auth_provider field. */
28
+ auth_provider_config?: AirweaveSDK.ConfigValues;
29
+ /** Specify which field in the entity should be used as the cursor for incremental syncs. This field must contain a timestamp or incrementing value that indicates when records were last modified. Required for sources without predefined entities (e.g., databases). If not specified, the source's default cursor field will be used if available. */
30
+ cursor_field?: string;
31
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -13,6 +13,9 @@ export interface Sync {
13
13
  description?: string;
14
14
  cron_schedule?: string;
15
15
  next_scheduled_run?: string;
16
+ temporal_schedule_id?: string;
17
+ sync_type?: string;
18
+ minute_level_cron_schedule?: string;
16
19
  sync_metadata?: Record<string, unknown>;
17
20
  status: AirweaveSDK.SyncStatus;
18
21
  id: string;
@@ -13,6 +13,9 @@ export interface SyncCreate {
13
13
  description?: string;
14
14
  cron_schedule?: string;
15
15
  next_scheduled_run?: string;
16
+ temporal_schedule_id?: string;
17
+ sync_type?: string;
18
+ minute_level_cron_schedule?: string;
16
19
  sync_metadata?: Record<string, unknown>;
17
20
  status?: AirweaveSDK.SyncStatus;
18
21
  run_immediately?: boolean;
@@ -11,4 +11,7 @@ export interface SyncUpdate {
11
11
  next_scheduled_run?: string;
12
12
  sync_metadata?: Record<string, unknown>;
13
13
  status?: AirweaveSDK.SyncStatus;
14
+ temporal_schedule_id?: string;
15
+ sync_type?: string;
16
+ minute_level_cron_schedule?: string;
14
17
  }
@@ -13,6 +13,9 @@ export interface SyncWithSourceConnection {
13
13
  description?: string;
14
14
  cron_schedule?: string;
15
15
  next_scheduled_run?: string;
16
+ temporal_schedule_id?: string;
17
+ sync_type?: string;
18
+ minute_level_cron_schedule?: string;
16
19
  sync_metadata?: Record<string, unknown>;
17
20
  status: AirweaveSDK.SyncStatus;
18
21
  id: string;
@@ -60,6 +60,7 @@ export * from "./MatchValue.js";
60
60
  export * from "./MemberResponse.js";
61
61
  export * from "./MessageResponse.js";
62
62
  export * from "./MinShould.js";
63
+ export * from "./MinuteLevelScheduleConfig.js";
63
64
  export * from "./Nested.js";
64
65
  export * from "./NestedCondition.js";
65
66
  export * from "./NodeType.js";
@@ -70,10 +71,13 @@ export * from "./OrganizationWithRole.js";
70
71
  export * from "./PayloadField.js";
71
72
  export * from "./QueryExpansionStrategy.js";
72
73
  export * from "./ResponseType.js";
74
+ export * from "./ScheduleResponse.js";
73
75
  export * from "./SearchResponse.js";
74
76
  export * from "./SearchStatus.js";
75
77
  export * from "./Source.js";
76
78
  export * from "./SourceConnection.js";
79
+ export * from "./SourceConnectionContinuousResponse.js";
80
+ export * from "./SourceConnectionCreateContinuous.js";
77
81
  export * from "./SourceConnectionCreateWithCredential.js";
78
82
  export * from "./SourceConnectionCreateWithWhiteLabel.js";
79
83
  export * from "./SourceConnectionJob.js";
@@ -76,6 +76,7 @@ __exportStar(require("./MatchValue.js"), exports);
76
76
  __exportStar(require("./MemberResponse.js"), exports);
77
77
  __exportStar(require("./MessageResponse.js"), exports);
78
78
  __exportStar(require("./MinShould.js"), exports);
79
+ __exportStar(require("./MinuteLevelScheduleConfig.js"), exports);
79
80
  __exportStar(require("./Nested.js"), exports);
80
81
  __exportStar(require("./NestedCondition.js"), exports);
81
82
  __exportStar(require("./NodeType.js"), exports);
@@ -86,10 +87,13 @@ __exportStar(require("./OrganizationWithRole.js"), exports);
86
87
  __exportStar(require("./PayloadField.js"), exports);
87
88
  __exportStar(require("./QueryExpansionStrategy.js"), exports);
88
89
  __exportStar(require("./ResponseType.js"), exports);
90
+ __exportStar(require("./ScheduleResponse.js"), exports);
89
91
  __exportStar(require("./SearchResponse.js"), exports);
90
92
  __exportStar(require("./SearchStatus.js"), exports);
91
93
  __exportStar(require("./Source.js"), exports);
92
94
  __exportStar(require("./SourceConnection.js"), exports);
95
+ __exportStar(require("./SourceConnectionContinuousResponse.js"), exports);
96
+ __exportStar(require("./SourceConnectionCreateContinuous.js"), exports);
93
97
  __exportStar(require("./SourceConnectionCreateWithCredential.js"), exports);
94
98
  __exportStar(require("./SourceConnectionCreateWithWhiteLabel.js"), exports);
95
99
  __exportStar(require("./SourceConnectionJob.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "v0.4.12";
1
+ export declare const SDK_VERSION = "v0.4.13";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "v0.4.12";
4
+ exports.SDK_VERSION = "v0.4.13";
@@ -12,8 +12,8 @@ export class AirweaveSDKClient {
12
12
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
13
13
  "X-Fern-Language": "JavaScript",
14
14
  "X-Fern-SDK-Name": "@airweave/sdk",
15
- "X-Fern-SDK-Version": "v0.4.12",
16
- "User-Agent": "@airweave/sdk/v0.4.12",
15
+ "X-Fern-SDK-Version": "v0.4.13",
16
+ "User-Agent": "@airweave/sdk/v0.4.13",
17
17
  "X-Fern-Runtime": core.RUNTIME.type,
18
18
  "X-Fern-Runtime-Version": core.RUNTIME.version,
19
19
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -53,7 +53,8 @@ export declare class SourceConnections {
53
53
  *
54
54
  * **This endpoint only works for sources that do not use OAuth2.0.**
55
55
  * Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
56
- * connected through the UI where you can complete the OAuth consent flow.<br/><br/>
56
+ * connected through the UI where you can complete the OAuth consent flow
57
+ * or using Auth Providers (see [Auth Providers](/docs/auth-providers)).<br/><br/>
57
58
  *
58
59
  * Credentials for a source have to be provided using the `auth_fields` field.
59
60
  * Currently, it is not automatically checked if the provided credentials are valid.
@@ -104,7 +104,8 @@ export class SourceConnections {
104
104
  *
105
105
  * **This endpoint only works for sources that do not use OAuth2.0.**
106
106
  * Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
107
- * connected through the UI where you can complete the OAuth consent flow.<br/><br/>
107
+ * connected through the UI where you can complete the OAuth consent flow
108
+ * or using Auth Providers (see [Auth Providers](/docs/auth-providers)).<br/><br/>
108
109
  *
109
110
  * Credentials for a source have to be provided using the `auth_fields` field.
110
111
  * Currently, it is not automatically checked if the provided credentials are valid.
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Configuration for minute-level incremental sync schedules.
6
+ */
7
+ export interface MinuteLevelScheduleConfig {
8
+ /** Minute-level cron expression for incremental sync (default: every minute) */
9
+ cron_expression?: string;
10
+ }
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export {};
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Response for schedule operations.
6
+ */
7
+ export interface ScheduleResponse {
8
+ schedule_id: string;
9
+ status: string;
10
+ message: string;
11
+ }
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export {};
@@ -0,0 +1,67 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as AirweaveSDK from "../index.mjs";
5
+ /**
6
+ * Response schema for continuous source connection creation.
7
+ */
8
+ export interface SourceConnectionContinuousResponse {
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'). */
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
+ 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
+ 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). */
30
+ created_at: string;
31
+ /** Timestamp when the source connection was last modified (ISO 8601 format). */
32
+ 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?: SourceConnectionContinuousResponse.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
+ /** Information about the created minute-level schedule including schedule ID, cron expression, and current status. */
60
+ minute_level_schedule?: Record<string, unknown>;
61
+ }
62
+ export declare namespace SourceConnectionContinuousResponse {
63
+ /**
64
+ * Authentication credentials for the data source. Returns '********' by default for security.
65
+ */
66
+ type AuthFields = AirweaveSDK.ConfigValues | string;
67
+ }
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export {};
@@ -0,0 +1,31 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as AirweaveSDK from "../index.mjs";
5
+ /**
6
+ * Schema for creating a continuously syncing source connection (BETA).
7
+ *
8
+ * This endpoint creates a source connection that stays continuously in sync with your
9
+ * data source. Your data will be automatically synchronized every minute, ensuring it's
10
+ * always up-to-date without any manual intervention or sync management.
11
+ */
12
+ export interface SourceConnectionCreateContinuous {
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. */
20
+ 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
+ /** 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. */
24
+ auth_fields?: AirweaveSDK.ConfigValues;
25
+ /** Unique readable ID of a connected auth provider to use for authentication instead of providing auth_fields directly. */
26
+ auth_provider?: string;
27
+ /** Configuration for the auth provider when using auth_provider field. */
28
+ auth_provider_config?: AirweaveSDK.ConfigValues;
29
+ /** Specify which field in the entity should be used as the cursor for incremental syncs. This field must contain a timestamp or incrementing value that indicates when records were last modified. Required for sources without predefined entities (e.g., databases). If not specified, the source's default cursor field will be used if available. */
30
+ cursor_field?: string;
31
+ }
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export {};
@@ -13,6 +13,9 @@ export interface Sync {
13
13
  description?: string;
14
14
  cron_schedule?: string;
15
15
  next_scheduled_run?: string;
16
+ temporal_schedule_id?: string;
17
+ sync_type?: string;
18
+ minute_level_cron_schedule?: string;
16
19
  sync_metadata?: Record<string, unknown>;
17
20
  status: AirweaveSDK.SyncStatus;
18
21
  id: string;
@@ -13,6 +13,9 @@ export interface SyncCreate {
13
13
  description?: string;
14
14
  cron_schedule?: string;
15
15
  next_scheduled_run?: string;
16
+ temporal_schedule_id?: string;
17
+ sync_type?: string;
18
+ minute_level_cron_schedule?: string;
16
19
  sync_metadata?: Record<string, unknown>;
17
20
  status?: AirweaveSDK.SyncStatus;
18
21
  run_immediately?: boolean;
@@ -11,4 +11,7 @@ export interface SyncUpdate {
11
11
  next_scheduled_run?: string;
12
12
  sync_metadata?: Record<string, unknown>;
13
13
  status?: AirweaveSDK.SyncStatus;
14
+ temporal_schedule_id?: string;
15
+ sync_type?: string;
16
+ minute_level_cron_schedule?: string;
14
17
  }
@@ -13,6 +13,9 @@ export interface SyncWithSourceConnection {
13
13
  description?: string;
14
14
  cron_schedule?: string;
15
15
  next_scheduled_run?: string;
16
+ temporal_schedule_id?: string;
17
+ sync_type?: string;
18
+ minute_level_cron_schedule?: string;
16
19
  sync_metadata?: Record<string, unknown>;
17
20
  status: AirweaveSDK.SyncStatus;
18
21
  id: string;
@@ -60,6 +60,7 @@ export * from "./MatchValue.mjs";
60
60
  export * from "./MemberResponse.mjs";
61
61
  export * from "./MessageResponse.mjs";
62
62
  export * from "./MinShould.mjs";
63
+ export * from "./MinuteLevelScheduleConfig.mjs";
63
64
  export * from "./Nested.mjs";
64
65
  export * from "./NestedCondition.mjs";
65
66
  export * from "./NodeType.mjs";
@@ -70,10 +71,13 @@ export * from "./OrganizationWithRole.mjs";
70
71
  export * from "./PayloadField.mjs";
71
72
  export * from "./QueryExpansionStrategy.mjs";
72
73
  export * from "./ResponseType.mjs";
74
+ export * from "./ScheduleResponse.mjs";
73
75
  export * from "./SearchResponse.mjs";
74
76
  export * from "./SearchStatus.mjs";
75
77
  export * from "./Source.mjs";
76
78
  export * from "./SourceConnection.mjs";
79
+ export * from "./SourceConnectionContinuousResponse.mjs";
80
+ export * from "./SourceConnectionCreateContinuous.mjs";
77
81
  export * from "./SourceConnectionCreateWithCredential.mjs";
78
82
  export * from "./SourceConnectionCreateWithWhiteLabel.mjs";
79
83
  export * from "./SourceConnectionJob.mjs";
@@ -60,6 +60,7 @@ export * from "./MatchValue.mjs";
60
60
  export * from "./MemberResponse.mjs";
61
61
  export * from "./MessageResponse.mjs";
62
62
  export * from "./MinShould.mjs";
63
+ export * from "./MinuteLevelScheduleConfig.mjs";
63
64
  export * from "./Nested.mjs";
64
65
  export * from "./NestedCondition.mjs";
65
66
  export * from "./NodeType.mjs";
@@ -70,10 +71,13 @@ export * from "./OrganizationWithRole.mjs";
70
71
  export * from "./PayloadField.mjs";
71
72
  export * from "./QueryExpansionStrategy.mjs";
72
73
  export * from "./ResponseType.mjs";
74
+ export * from "./ScheduleResponse.mjs";
73
75
  export * from "./SearchResponse.mjs";
74
76
  export * from "./SearchStatus.mjs";
75
77
  export * from "./Source.mjs";
76
78
  export * from "./SourceConnection.mjs";
79
+ export * from "./SourceConnectionContinuousResponse.mjs";
80
+ export * from "./SourceConnectionCreateContinuous.mjs";
77
81
  export * from "./SourceConnectionCreateWithCredential.mjs";
78
82
  export * from "./SourceConnectionCreateWithWhiteLabel.mjs";
79
83
  export * from "./SourceConnectionJob.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "v0.4.12";
1
+ export declare const SDK_VERSION = "v0.4.13";
@@ -1 +1 @@
1
- export const SDK_VERSION = "v0.4.12";
1
+ export const SDK_VERSION = "v0.4.13";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@airweave/sdk",
3
- "version": "v0.4.12",
3
+ "version": "v0.4.13",
4
4
  "private": false,
5
5
  "repository": "github:airweave-ai/typescript-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -796,7 +796,8 @@ Create a new source connection to sync data into your collection.
796
796
 
797
797
  **This endpoint only works for sources that do not use OAuth2.0.**
798
798
  Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
799
- connected through the UI where you can complete the OAuth consent flow.<br/><br/>
799
+ connected through the UI where you can complete the OAuth consent flow
800
+ or using Auth Providers (see [Auth Providers](/docs/auth-providers)).<br/><br/>
800
801
 
801
802
  Credentials for a source have to be provided using the `auth_fields` field.
802
803
  Currently, it is not automatically checked if the provided credentials are valid.