npm - @airweave/sdk - Versions diffs - 0.2.25 → 0.2.26 - Mend

@airweave/sdk 0.2.25 → 0.2.26

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 (380) hide show

package/reference.md CHANGED Viewed

@@ -308,74 +308,9 @@ await client.apiKeys.readApiKey("id");
 </dl>
 </details>
-## Users
-<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">readUser</a>() -> AirweaveSDK.User</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get current user.
-## Args:
-    current_user (User): The current user.
-## Returns:
-    schemas.User: The user object.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.users.readUser();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**requestOptions:** `Users.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
 ## Sources
-<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithAuthenticationFields</code></summary>
+<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.SourceWithConfigFields</code></summary>
 <dl>
 <dd>
@@ -514,7 +449,7 @@ await client.sources.readSources();
 ## EmbeddingModels
-<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithAuthenticationFields</code></summary>
+<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
 <dl>
 <dd>
@@ -892,7 +827,7 @@ Expects a POST body with:
     integration_type: The type of integration to connect to.
     short_name: The short name of the integration to connect to.
     name: The name of the connection.
-    auth_fields: The config fields for the integration.
+    config_fields: The config fields for the integration.
     user: The current user.
 ## Returns:
@@ -914,7 +849,7 @@ Expects a POST body with:
 ```typescript
 await client.connections.connectIntegration("source", "short_name", {
-    authFields: {
+    configFields: {
         key: "value",
     },
 });
@@ -1519,7 +1454,6 @@ List all sync jobs across all syncs.
     db: The database session
     skip: The number of jobs to skip
     limit: The number of jobs to return
-    status: Filter by job status
     user: The current user
 ## Returns:
@@ -2058,8 +1992,7 @@ Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
 ## Args:
     job_id: The ID of the job to subscribe to
-    request: The request object
-    db: The database session
+    user: The current user
 ## Returns:
@@ -2179,7 +2112,7 @@ await client.sync.getSyncDag("sync_id");
 ## Search
-<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>({ ...params }) -> Record<string, unknown></code></summary>
+<details><summary><code>client.search.<a href="/src/api/resources/search/client/Client.ts">search</a>({ ...params }) -> Record<string, unknown>[]</code></summary>
 <dl>
 <dd>
@@ -2198,12 +2131,11 @@ Search for documents within a specific sync.
     db: The database session
     sync_id: The ID of the sync to search within
     query: The search query text
-    response_type: Type of response (raw results or AI completion)
     user: The current user
 ## Returns:
-    dict: A dictionary containing search results or AI completion
+    list[dict]: A list of search results
 </dd>
 </dl>
@@ -2857,890 +2789,3 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
 </dd>
 </dl>
 </details>
-## Chat
-<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">listChats</a>({ ...params }) -> AirweaveSDK.Chat[]</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-List all chats for the current user.
-## Args:
-    db: The database session.
-    skip: The number of chats to skip.
-    limit: The number of chats to return.
-    user: The current user.
-## Returns:
-    list[schemas.Chat]: The list of chats.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.chat.listChats();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `AirweaveSDK.ListChatsChatGetRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Chat.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">createChat</a>({ ...params }) -> AirweaveSDK.Chat</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Create a new chat.
-## Args:
-    db: The database session.
-    chat_in: The chat creation data.
-    user: The current user.
-## Returns:
-    schemas.Chat: The created chat.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.chat.createChat({
-    name: "name",
-    syncId: "sync_id",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `AirweaveSDK.ChatCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Chat.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Dag
-<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">getSyncDag</a>(syncId) -> AirweaveSDK.SyncDag</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get the DAG definition for a sync.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.dag.getSyncDag("sync_id");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**syncId:** `string`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Dag.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">createSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Create a new DAG definition for a sync.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.dag.createSyncDag("sync_id", {
-    name: "name",
-    syncDagCreateSyncId: "sync_id",
-    nodes: [
-        {
-            type: "source",
-            name: "name",
-        },
-    ],
-    edges: [
-        {
-            fromNodeId: "from_node_id",
-            toNodeId: "to_node_id",
-        },
-    ],
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**syncId:** `string`
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `AirweaveSDK.SyncDagCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Dag.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.dag.<a href="/src/api/resources/dag/client/Client.ts">updateSyncDag</a>(syncId, { ...params }) -> AirweaveSDK.SyncDag</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Update a DAG definition for a sync.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.dag.updateSyncDag("sync_id", {
-    name: "name",
-    syncDagUpdateSyncId: "sync_id",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**syncId:** `string`
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `AirweaveSDK.SyncDagUpdate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Dag.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Entities
-<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityDefinitions</a>() -> AirweaveSDK.EntityDefinition[]</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-List all entity definitions for the current user's organization.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.entities.listEntityDefinitions();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**requestOptions:** `Entities.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityDefinition</a>({ ...params }) -> AirweaveSDK.EntityDefinition</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Create a new entity definition.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.entities.createEntityDefinition({
-    name: "name",
-    type: "file",
-    entitySchema: ["entity_schema"],
-    moduleName: "module_name",
-    className: "class_name",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `AirweaveSDK.EntityDefinitionCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Entities.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntityRelations</a>() -> AirweaveSDK.EntityRelation[]</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-List all entity relations for the current user's organization.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.entities.listEntityRelations();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**requestOptions:** `Entities.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntityRelation</a>({ ...params }) -> AirweaveSDK.EntityRelation</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Create a new entity relation.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.entities.createEntityRelation({
-    name: "name",
-    fromEntityId: "from_entity_id",
-    toEntityId: "to_entity_id",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `AirweaveSDK.EntityRelationCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Entities.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsByIds</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get multiple entity definitions by their IDs.
-Args:
-ids: List of entity definition IDs to fetch
-db: Database session
-current_user: Current authenticated user
-Returns:
-List of entity definitions matching the provided IDs
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.entities.getEntityDefinitionsByIds(["string"]);
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `string[]`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Entities.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntityDefinitionsBySourceShortName</a>({ ...params }) -> AirweaveSDK.EntityDefinition[]</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get all entity definitions for a given source.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.entities.getEntityDefinitionsBySourceShortName({
-    sourceShortName: "source_short_name",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `AirweaveSDK.GetEntityDefinitionsBySourceShortNameEntitiesDefinitionsBySourceGetRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Entities.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Transformers
-<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">listTransformers</a>() -> AirweaveSDK.Transformer[]</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-List all transformers for the current user's organization.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.transformers.listTransformers();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**requestOptions:** `Transformers.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.transformers.<a href="/src/api/resources/transformers/client/Client.ts">createTransformer</a>({ ...params }) -> AirweaveSDK.Transformer</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Create a new transformer.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.transformers.createTransformer({
-    name: "name",
-    methodName: "method_name",
-    moduleName: "module_name",
-    inputEntityDefinitionIds: ["input_entity_definition_ids"],
-    outputEntityDefinitionIds: ["output_entity_definition_ids"],
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `AirweaveSDK.TransformerCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Transformers.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>