@breign/client 1.0.174 → 1.0.175

package/dist/apis/AppApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AddCustomFiller201ResponseUio, AddCustomFillerRequestUio, AnimationCreateRequestUio, AppChatCreateRequestUio, AppChatCreateResponseUio, AppChatSayRequestUio, AppChatSayResponseUio, AppChatSubmitMessageRequestUio, AppConfigurationUio, AppCreateRequestUio, AppFlowCreateRequestUio, AppInstanceCreateRequestUio, AppInstanceListItemUio, AppLightUio, AppProbeRequestUio, AppProbeResponseUio, AppReplaceRequestUio, AppStatusRequestUio, AppStatusResponseUio, AppSubmitMessageRequestUio, AppTextToSpeechRequestUio, AppTextToSpeechResponseUio, AppUio, AppUpdateRequestUio, AudioFileUio, BodyWithIdUio, BodyWithMessageUio, ConversationUio, DeleteMessageAudio200ResponseUio, FileCreationRequestUio, FileCreationResponseUio, FillersArrayInnerUio, FlowUio, S3UploadBodyUio, STTResponseUio, SequenceCreateRequestUio, UpdateSelectedFillers200ResponseUio, UpdateSelectedFillersRequestUio } from '../models/index';
+import type { AddCustomFiller201ResponseUio, AddCustomFillerRequestUio, AnimationCreateRequestUio, AppChatCreateRequestUio, AppChatCreateResponseUio, AppChatSayRequestUio, AppChatSayResponseUio, AppChatSubmitMessageRequestUio, AppConfigurationUio, AppCreateRequestUio, AppFlowCreateRequestUio, AppInstanceCreateRequestUio, AppInstanceListItemUio, AppLightUio, AppProbeRequestUio, AppProbeResponseUio, AppReplaceRequestUio, AppStatusRequestUio, AppStatusResponseUio, AppSubmitMessageRequestUio, AppTextToSpeechRequestUio, AppTextToSpeechResponseUio, AppUio, AppUpdateRequestUio, AudioFileUio, BodyWithIdUio, BodyWithMessageUio, ConversationUio, DeleteMessageAudio200ResponseUio, EphemeralInstanceTokenUio, FileCreationRequestUio, FileCreationResponseUio, FillersArrayInnerUio, FlowUio, S3UploadBodyUio, STTResponseUio, SequenceCreateRequestUio, UpdateSelectedFillers200ResponseUio, UpdateSelectedFillersRequestUio } from '../models/index';
 export interface AddAnimationRequest {
     appId: string;
     animationCreateRequestUio: AnimationCreateRequestUio;
@@ -134,6 +134,10 @@ export interface RefreshAppProbeRequest {
     appId: string;
     instanceId?: string;
 }
+export interface RefreshInstanceTokenRequest {
+    appId: string;
+    instanceId: string;
+}
 export interface RemoveAnimationRequest {
     appId: string;
     animationId: string;
@@ -476,6 +480,16 @@ export declare class AppApi extends runtime.BaseAPI {
      * Refresh the app probe
      */
     refreshAppProbe(appId: string, instanceId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Issue a new token for an ephemeral instance, authenticated either by the instance\'s own still-valid token or by a user with access to the app. The previous token is revoked. An active instance is simply extended; an inactive one is reactivated (status back to IDLE) only if the app\'s maximum number of active instances is not reached.
+     * Refresh ephemeral instance token
+     */
+    refreshInstanceTokenRaw(requestParameters: RefreshInstanceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EphemeralInstanceTokenUio>>;
+    /**
+     * Issue a new token for an ephemeral instance, authenticated either by the instance\'s own still-valid token or by a user with access to the app. The previous token is revoked. An active instance is simply extended; an inactive one is reactivated (status back to IDLE) only if the app\'s maximum number of active instances is not reached.
+     * Refresh ephemeral instance token
+     */
+    refreshInstanceToken(appId: string, instanceId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EphemeralInstanceTokenUio>;
     /**
      * Remove an animation from an app
      * Remove an animation from an app

package/dist/apis/AppApi.js

@@ -1009,6 +1009,38 @@ class AppApi extends runtime.BaseAPI {
     async refreshAppProbe(appId, instanceId, initOverrides) {
         await this.refreshAppProbeRaw({ appId: appId, instanceId: instanceId }, initOverrides);
     }
+    /**
+     * Issue a new token for an ephemeral instance, authenticated either by the instance\'s own still-valid token or by a user with access to the app. The previous token is revoked. An active instance is simply extended; an inactive one is reactivated (status back to IDLE) only if the app\'s maximum number of active instances is not reached.
+     * Refresh ephemeral instance token
+     */
+    async refreshInstanceTokenRaw(requestParameters, initOverrides) {
+        if (requestParameters['appId'] == null) {
+            throw new runtime.RequiredError('appId', 'Required parameter "appId" was null or undefined when calling refreshInstanceToken().');
+        }
+        if (requestParameters['instanceId'] == null) {
+            throw new runtime.RequiredError('instanceId', 'Required parameter "instanceId" was null or undefined when calling refreshInstanceToken().');
+        }
+        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: `/apps/{appId}/instances/{instanceId}/token`.replace(`{${"appId"}}`, encodeURIComponent(String(requestParameters['appId']))).replace(`{${"instanceId"}}`, encodeURIComponent(String(requestParameters['instanceId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EphemeralInstanceTokenUioFromJSON)(jsonValue));
+    }
+    /**
+     * Issue a new token for an ephemeral instance, authenticated either by the instance\'s own still-valid token or by a user with access to the app. The previous token is revoked. An active instance is simply extended; an inactive one is reactivated (status back to IDLE) only if the app\'s maximum number of active instances is not reached.
+     * Refresh ephemeral instance token
+     */
+    async refreshInstanceToken(appId, instanceId, initOverrides) {
+        const response = await this.refreshInstanceTokenRaw({ appId: appId, instanceId: instanceId }, initOverrides);
+        return await response.value();
+    }
     /**
      * Remove an animation from an app
      * Remove an animation from an app

package/dist/models/EphemeralInstanceTokenUio.d.ts

@@ -0,0 +1,80 @@
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EphemeralInstanceTokenUio
+ */
+export interface EphemeralInstanceTokenUio {
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    appId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    urlWebsite?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    token: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    active: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    lastActivity: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EphemeralInstanceTokenUio
+     */
+    expiresAt: string;
+}
+/**
+ * Check if a given object implements the EphemeralInstanceTokenUio interface.
+ */
+export declare function instanceOfEphemeralInstanceTokenUio(value: object): value is EphemeralInstanceTokenUio;
+export declare function EphemeralInstanceTokenUioFromJSON(json: any): EphemeralInstanceTokenUio;
+export declare function EphemeralInstanceTokenUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): EphemeralInstanceTokenUio;
+export declare function EphemeralInstanceTokenUioToJSON(json: any): EphemeralInstanceTokenUio;
+export declare function EphemeralInstanceTokenUioToJSONTyped(value?: EphemeralInstanceTokenUio | null, ignoreDiscriminator?: boolean): any;

package/dist/models/EphemeralInstanceTokenUio.js

@@ -0,0 +1,80 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfEphemeralInstanceTokenUio = instanceOfEphemeralInstanceTokenUio;
+exports.EphemeralInstanceTokenUioFromJSON = EphemeralInstanceTokenUioFromJSON;
+exports.EphemeralInstanceTokenUioFromJSONTyped = EphemeralInstanceTokenUioFromJSONTyped;
+exports.EphemeralInstanceTokenUioToJSON = EphemeralInstanceTokenUioToJSON;
+exports.EphemeralInstanceTokenUioToJSONTyped = EphemeralInstanceTokenUioToJSONTyped;
+/**
+ * Check if a given object implements the EphemeralInstanceTokenUio interface.
+ */
+function instanceOfEphemeralInstanceTokenUio(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('appId' in value) || value['appId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('token' in value) || value['token'] === undefined)
+        return false;
+    if (!('active' in value) || value['active'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('lastActivity' in value) || value['lastActivity'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    return true;
+}
+function EphemeralInstanceTokenUioFromJSON(json) {
+    return EphemeralInstanceTokenUioFromJSONTyped(json, false);
+}
+function EphemeralInstanceTokenUioFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'appId': json['appId'],
+        'name': json['name'],
+        'urlWebsite': json['urlWebsite'] == null ? undefined : json['urlWebsite'],
+        'token': json['token'],
+        'active': json['active'],
+        'createdAt': json['createdAt'],
+        'lastActivity': json['lastActivity'],
+        'expiresAt': json['expiresAt'],
+    };
+}
+function EphemeralInstanceTokenUioToJSON(json) {
+    return EphemeralInstanceTokenUioToJSONTyped(json, false);
+}
+function EphemeralInstanceTokenUioToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'appId': value['appId'],
+        'name': value['name'],
+        'urlWebsite': value['urlWebsite'],
+        'token': value['token'],
+        'active': value['active'],
+        'createdAt': value['createdAt'],
+        'lastActivity': value['lastActivity'],
+        'expiresAt': value['expiresAt'],
+    };
+}

package/dist/models/index.d.ts

@@ -251,6 +251,7 @@ export * from './EngineOptionsUio';
 export * from './EngineUio';
 export * from './EntityModeUio';
 export * from './EntityTypeRuleUio';
+export * from './EphemeralInstanceTokenUio';
 export * from './EphemeralInstanceUio';
 export * from './EphemeralInstancesMetricsResponseUio';
 export * from './EphemeralInstancesTimeSeriesPointUio';

package/dist/models/index.js

@@ -269,6 +269,7 @@ __exportStar(require("./EngineOptionsUio"), exports);
 __exportStar(require("./EngineUio"), exports);
 __exportStar(require("./EntityModeUio"), exports);
 __exportStar(require("./EntityTypeRuleUio"), exports);
+__exportStar(require("./EphemeralInstanceTokenUio"), exports);
 __exportStar(require("./EphemeralInstanceUio"), exports);
 __exportStar(require("./EphemeralInstancesMetricsResponseUio"), exports);
 __exportStar(require("./EphemeralInstancesTimeSeriesPointUio"), exports);

package/dist/openapi.json

@@ -4157,6 +4157,58 @@
         "tags" : [ "app" ]
       }
     },
+    "/apps/{appId}/instances/{instanceId}/token" : {
+      "post" : {
+        "description" : "Issue a new token for an ephemeral instance, authenticated either by the instance's own still-valid token or by a user with access to the app. The previous token is revoked. An active instance is simply extended; an inactive one is reactivated (status back to IDLE) only if the app's maximum number of active instances is not reached.\n",
+        "operationId" : "refreshInstanceToken",
+        "parameters" : [ {
+          "description" : "ID of the app",
+          "in" : "path",
+          "name" : "appId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Instance identifier",
+          "in" : "path",
+          "name" : "instanceId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/EphemeralInstanceToken"
+                }
+              }
+            },
+            "description" : "Token refreshed"
+          },
+          "400" : {
+            "description" : "Maximum number of active instances reached (MAX_INSTANCES_REACHED)"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - no access to this instance, or ephemeral instances not allowed for this app"
+          },
+          "404" : {
+            "description" : "App or ephemeral instance not found"
+          },
+          "409" : {
+            "description" : "Instance changed during the refresh (e.g. deactivated concurrently), retry (INSTANCE_CHANGED)"
+          }
+        },
+        "summary" : "Refresh ephemeral instance token",
+        "tags" : [ "app" ]
+      }
+    },
     "/instances/{instanceId}/context" : {
       "get" : {
         "description" : "Returns the custom context variables for an app instance.",
@@ -23462,6 +23514,19 @@
         "required" : [ "message" ],
         "type" : "object"
       },
+      "EphemeralInstanceToken" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/EphemeralInstance"
+        }, {
+          "properties" : {
+            "expiresAt" : {
+              "type" : "string"
+            }
+          },
+          "required" : [ "expiresAt" ],
+          "type" : "object"
+        } ]
+      },
       "InstanceContext" : {
         "additionalProperties" : false,
         "properties" : {

package/package.json

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