@breign/client 1.0.28 → 1.0.29

package/dist/apis/ConversationsApi.d.ts

@@ -11,10 +11,20 @@
  */
 import * as runtime from '../runtime';
 import type { AttachmentCreateRequestUio, BodyWithMessageUio, ContextUio, FileAttachmentUio } from '../models/index';
+export interface CreateCustomVariableRequest {
+    conversationId: string;
+    requestBody: {
+        [key: string]: string;
+    };
+}
 export interface DeleteAttachmentRequest {
     conversationId: string;
     attachmentId: string;
 }
+export interface DeleteContextCustomVariableKeyRequest {
+    conversationId: string;
+    key: string;
+}
 export interface GetAttachmentRequest {
     conversationId: string;
     attachmentId: string;
@@ -22,6 +32,9 @@ export interface GetAttachmentRequest {
 export interface GetContextRequest {
     conversationId: string;
 }
+export interface GetContextCustomVariableRequest {
+    conversationId: string;
+}
 export interface UpdateAttachmentStatusRequest {
     conversationId: string;
     attachmentId: string;
@@ -34,6 +47,18 @@ export interface UploadAttachmentRequest {
  *
  */
 export declare class ConversationsApi extends runtime.BaseAPI {
+    /**
+     * Create a custom variable in the context of a specific conversation by its ID.
+     * Create a custom variable in the context of a conversation
+     */
+    createCustomVariableRaw(requestParameters: CreateCustomVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Create a custom variable in the context of a specific conversation by its ID.
+     * Create a custom variable in the context of a conversation
+     */
+    createCustomVariable(conversationId: string, requestBody: {
+        [key: string]: string;
+    }, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Remove a specific attachment by its ID from the context of a conversation.
      * Delete an attachment from a conversation context
@@ -44,6 +69,16 @@ export declare class ConversationsApi extends runtime.BaseAPI {
      * Delete an attachment from a conversation context
      */
     deleteAttachment(conversationId: string, attachmentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete a custom variable key from the context of a specific conversation by its ID.
+     * Delete a custom variable key from the context of a conversation
+     */
+    deleteContextCustomVariableKeyRaw(requestParameters: DeleteContextCustomVariableKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a custom variable key from the context of a specific conversation by its ID.
+     * Delete a custom variable key from the context of a conversation
+     */
+    deleteContextCustomVariableKey(conversationId: string, key: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Get a specific attachment by its ID from the context of a conversation.
      * Retrieve an attachment from a conversation context
@@ -64,6 +99,20 @@ export declare class ConversationsApi extends runtime.BaseAPI {
      * Get the context of a conversation
      */
     getContext(conversationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContextUio>;
+    /**
+     * Get a custom variable from the context of a specific conversation by its ID.
+     * Get a custom variable from the context of a conversation
+     */
+    getContextCustomVariableRaw(requestParameters: GetContextCustomVariableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: string;
+    }>>;
+    /**
+     * Get a custom variable from the context of a specific conversation by its ID.
+     * Get a custom variable from the context of a conversation
+     */
+    getContextCustomVariable(conversationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: string;
+    }>;
     /**
      * Change the status of an attachment to \'PROCESSING\' after it has been uploaded.
      * Update the status of an uploaded attachment

package/dist/apis/ConversationsApi.js

@@ -53,6 +53,39 @@ const index_1 = require("../models/index");
  *
  */
 class ConversationsApi extends runtime.BaseAPI {
+    /**
+     * Create a custom variable in the context of a specific conversation by its ID.
+     * Create a custom variable in the context of a conversation
+     */
+    async createCustomVariableRaw(requestParameters, initOverrides) {
+        if (requestParameters['conversationId'] == null) {
+            throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling createCustomVariable().');
+        }
+        if (requestParameters['requestBody'] == null) {
+            throw new runtime.RequiredError('requestBody', 'Required parameter "requestBody" was null or undefined when calling createCustomVariable().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+        const response = await this.request({
+            path: `/conversations/{conversationId}/context/custom`.replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['requestBody'],
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Create a custom variable in the context of a specific conversation by its ID.
+     * Create a custom variable in the context of a conversation
+     */
+    async createCustomVariable(conversationId, requestBody, initOverrides) {
+        await this.createCustomVariableRaw({ conversationId: conversationId, requestBody: requestBody }, initOverrides);
+    }
     /**
      * Remove a specific attachment by its ID from the context of a conversation.
      * Delete an attachment from a conversation context
@@ -84,6 +117,37 @@ class ConversationsApi extends runtime.BaseAPI {
     async deleteAttachment(conversationId, attachmentId, initOverrides) {
         await this.deleteAttachmentRaw({ conversationId: conversationId, attachmentId: attachmentId }, initOverrides);
     }
+    /**
+     * Delete a custom variable key from the context of a specific conversation by its ID.
+     * Delete a custom variable key from the context of a conversation
+     */
+    async deleteContextCustomVariableKeyRaw(requestParameters, initOverrides) {
+        if (requestParameters['conversationId'] == null) {
+            throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling deleteContextCustomVariableKey().');
+        }
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError('key', 'Required parameter "key" was null or undefined when calling deleteContextCustomVariableKey().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+        const response = await this.request({
+            path: `/conversations/{conversationId}/context/custom/{key}`.replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId']))).replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Delete a custom variable key from the context of a specific conversation by its ID.
+     * Delete a custom variable key from the context of a conversation
+     */
+    async deleteContextCustomVariableKey(conversationId, key, initOverrides) {
+        await this.deleteContextCustomVariableKeyRaw({ conversationId: conversationId, key: key }, initOverrides);
+    }
     /**
      * Get a specific attachment by its ID from the context of a conversation.
      * Retrieve an attachment from a conversation context
@@ -145,6 +209,35 @@ class ConversationsApi extends runtime.BaseAPI {
         const response = await this.getContextRaw({ conversationId: conversationId }, initOverrides);
         return await response.value();
     }
+    /**
+     * Get a custom variable from the context of a specific conversation by its ID.
+     * Get a custom variable from the context of a conversation
+     */
+    async getContextCustomVariableRaw(requestParameters, initOverrides) {
+        if (requestParameters['conversationId'] == null) {
+            throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling getContextCustomVariable().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+        const response = await this.request({
+            path: `/conversations/{conversationId}/context/custom`.replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Get a custom variable from the context of a specific conversation by its ID.
+     * Get a custom variable from the context of a conversation
+     */
+    async getContextCustomVariable(conversationId, initOverrides) {
+        const response = await this.getContextCustomVariableRaw({ conversationId: conversationId }, initOverrides);
+        return await response.value();
+    }
     /**
      * Change the status of an attachment to \'PROCESSING\' after it has been uploaded.
      * Update the status of an uploaded attachment

package/dist/openapi.json

@@ -2638,6 +2638,137 @@
         "tags" : [ "contents" ]
       }
     },
+    "/conversations/{conversationId}/context/custom/{key}" : {
+      "delete" : {
+        "description" : "Delete a custom variable key from the context of a specific conversation by its ID.",
+        "operationId" : "deleteContextCustomVariableKey",
+        "parameters" : [ {
+          "description" : "The ID of the conversation",
+          "in" : "path",
+          "name" : "conversationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Key of the custom variable to delete",
+          "in" : "path",
+          "name" : "key",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "Successfully deleted the custom variable key from the context of the conversation."
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User cannot access this conversation"
+          },
+          "404" : {
+            "description" : "Conversation or Custom Variable Key not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Delete a custom variable key from the context of a conversation",
+        "tags" : [ "conversations" ]
+      }
+    },
+    "/conversations/{conversationId}/context/custom" : {
+      "get" : {
+        "description" : "Get a custom variable from the context of a specific conversation by its ID.",
+        "operationId" : "getContextCustomVariable",
+        "parameters" : [ {
+          "description" : "The ID of the conversation",
+          "in" : "path",
+          "name" : "conversationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "additionalProperties" : {
+                    "type" : "string"
+                  },
+                  "type" : "object"
+                }
+              }
+            },
+            "description" : "Successfully retrieved the custom variable from the context of the conversation."
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User cannot access this conversation"
+          },
+          "404" : {
+            "description" : "Conversation not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get a custom variable from the context of a conversation",
+        "tags" : [ "conversations" ]
+      },
+      "post" : {
+        "description" : "Create a custom variable in the context of a specific conversation by its ID.",
+        "operationId" : "createCustomVariable",
+        "parameters" : [ {
+          "description" : "The ID of the conversation",
+          "in" : "path",
+          "name" : "conversationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "additionalProperties" : {
+                  "type" : "string"
+                },
+                "type" : "object"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "description" : "Successfully created the custom variable in the context of the conversation."
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User cannot access this conversation"
+          },
+          "404" : {
+            "description" : "Conversation not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Create a custom variable in the context of a conversation",
+        "tags" : [ "conversations" ]
+      }
+    },
     "/conversations/{conversationId}/context" : {
       "get" : {
         "description" : "Retrieve the context of a specific conversation by its ID.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breign/client",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",