@cognigy/rest-api-client 4.93.0 → 4.95.0

package/types/index.d.ts

@@ -1888,7 +1888,8 @@ declare const restChannelTypes: readonly [
 	"nonConversational",
 	"amazonLex",
 	"genesysBotConnector",
-	"niceCXOne"
+	"niceCXOne",
+	"niceCXOneAAH"
 ];
 export declare type TRestChannelType = typeof restChannelTypes[number];
 declare const socketChannelTypes: readonly [
@@ -2250,7 +2251,8 @@ export interface IAgentAssistSettings {
 	enableTranscriptTile?: boolean;
 	enableTranscriptTileChatInput?: boolean;
 	redactTranscriptTileMessages?: boolean;
-	oAuth2Connection?: string;
+	enableAgentCopilotAuthentication?: boolean;
+	agentCopilotAuthentication?: string;
 }
 export interface IGenesysCloudHandoverSettings {
 	host: string;
@@ -2449,6 +2451,7 @@ export interface IGraphEndpointDependency {
  *         - niceCXOne
  *         - agentAssistVoice
  *         - webchat3
+ *         - niceCXOneAAH
  */
 export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
 declare const endpointTypes: readonly [
@@ -2482,6 +2485,7 @@ declare const endpointTypes: readonly [
 	"bandwidth",
 	"genesysBotConnector",
 	"niceCXOne",
+	"niceCXOneAAH",
 	"agentAssistVoice",
 	"webchat3"
 ];
@@ -6979,6 +6983,12 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
  *                 redactTranscriptTileMessages:
  *                   type: boolean
  *                   description: Enable redaction of messages in transcript tile
+ *                 enableAgentCopilotAuthentication:
+ *                   type: boolean
+ *                   description: Enable authentication for agent copilot
+ *                 agentCopilotAuthentication:
+ *                   type: string
+ *                   description: Authentication connection reference Id for agent copilot
  *         orgDataPrivacySettings:
  *           $ref: '#/components/schemas/IEndpoitOrgDataPrivacySettings_2_0'
  *     IEndpoint_2_0:
@@ -8404,10 +8414,85 @@ export interface IGraphAgentAssistConfig {
 	referenceId: string;
 	properties: Pick<IAgentAssistConfig, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
 }
+/**
+ * @openapi
+ * components:
+ *   parameters:
+ *     globalResourceQueryParam:
+ *       in: query
+ *       name: resourceLevel
+ *       description: Scope of the resource (global "organisation" or project).
+ *       required: false
+ *       schema:
+ *         $ref: '#/components/schemas/ResourceLevel'
+ *   schemas:
+ *     ResourceLevel:
+ *       type: string
+ *       enum:
+ *         - organisation
+ *         - project
+ *       description: General scope of the resource.
+ *       default: project
+ *
+ *     ProjectScopedResource:
+ *       type: object
+ *       properties:
+ *         resourceLevel:
+ *           type: string
+ *           enum:
+ *             - project
+ *           description: Scope for project-level resources.
+ *
+ *     GlobalScopedResource:
+ *       type: object
+ *       properties:
+ *         resourceLevel:
+ *           type: string
+ *           enum:
+ *             - organisation
+ *           description: Scope for globally scoped resources.
+ *       required:
+ *         - resourceLevel
+ *
+ *     AssignedToProjects:
+ *       type: object
+ *       properties:
+ *         assignedToProjects:
+ *           type: array
+ *           items:
+ *             type: string
+ *             description: MongoDB ObjectId representing a project
+ *
+ *     IGlobalResourceFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/GlobalScopedResource'
+ *         - $ref: '#/components/schemas/AssignedToProjects'
+ *
+ *     IProjectResourceFields_2_0:
+ *        $ref: '#/components/schemas/ProjectScopedResource'
+ *
+ *     IGlobalResourceData:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
+ *         - type: object
+ *           properties:
+ *             id:
+ *               type: string
+ *               description: The unique identifier for the resource.
+ *               example: 507f191e810c19729de860eb
+ *
+ *     IGlobalResource:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalResourceData'
+ */
+export interface IGlobalResource {
+	resourceLevel?: "organisation" | "project";
+	assignedToProjects?: TMongoId[];
+}
 export interface IConnectionFields {
 	[key: string]: string;
 }
-export interface IConnection extends IEntityMeta {
+export interface IConnection extends IEntityMeta, Pick<IGlobalResource, "resourceLevel"> {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -8473,7 +8558,7 @@ export declare type TLLMFallback = {
 		emailNotificationList: string[];
 	};
 };
-export interface ILargeLanguageModel extends IEntityMeta {
+export interface ILargeLanguageModel extends IEntityMeta, IGlobalResource {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -8485,7 +8570,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
 	provider: TGenerativeAIProviders;
 	connectionId: string;
 	isDefault: boolean;
-	projectReference: TMongoId;
+	projectReference?: TMongoId;
 	organisationReference: TMongoId;
 	azureOpenAI?: IAzureOpenAIMeta;
 	googleVertexAI?: IGoogleVertexAIMeta;
@@ -10266,8 +10351,8 @@ export interface IActions {
 	parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
 	parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
 	parseCognigyScriptResultLocation?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => any;
-	output?: (text: string, data: any, settings?: ISayNodeSettings) => void;
-	outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata, settings?: ISayNodeSettings) => void;
+	output?: (text: string, data: any, settings?: ISayNodeSettings) => Promise<void>;
+	outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata, settings?: ISayNodeSettings) => Promise<void>;
 	reloadBrainFlow?: (flowReferenceId: string) => Promise<void>;
 	removeFromContext?: (key: string, value: string, mode: string) => void;
 	rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
@@ -10277,7 +10362,7 @@ export interface IActions {
 	resetContext?: () => object;
 	resetFormBrain?: () => Promise<void>;
 	resetState?: () => Promise<string>;
-	say?: (text: string, data?: any, settings?: ISayNodeSettings) => void;
+	say?: (text: string, data?: any, settings?: ISayNodeSettings) => Promise<void>;
 	sendHttpRequest?: (httpRequestParams: IHttpRequestNodeParams) => Promise<void>;
 	sendTileUpdateToAgentAssistWorkspace: (params: ISendTileUpdateParams) => Promise<void>;
 	sendConfigUpdateToAgentAssistWorkspace: (params: ISendConfigUpdateParams) => Promise<void>;
@@ -11120,6 +11205,7 @@ declare const nodeFieldTypes: readonly [
 	"checkbox",
 	"chipInput",
 	"code",
+	"cognigyLLMText",
 	"cognigyText",
 	"cognigyTextArray",
 	"condition",
@@ -14485,7 +14571,7 @@ export interface IComposeSnapshotDownloadLinkRestReturnValue_2_0 {
  *                   description: The type of connection.
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface IConnectionIndexItem_2_0 {
+export interface IConnectionIndexItem_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	_id: TMongoId;
 	referenceId: string;
 	name: string;
@@ -14568,7 +14654,7 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
  *         - $ref: '#/components/schemas/IConnectionData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface IConnection_2_0 {
+export interface IConnection_2_0 extends Pick<IGlobalResource, "resourceLevel"> {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16622,103 +16708,111 @@ export interface IGoogleGeminiMeta_2_0 {
  *
  * components:
  *   schemas:
- *     ILargeLanguageModelFields_2_0:
- *       allOf:
- *         - type: object
- *           required: ['name', 'modelType', 'provider', 'connectionId']
+ *     ILargeLanguageModelFieldsBase_2_0:
+ *       type: object
+ *       required: ['name', 'modelType', 'provider', 'connectionId']
+ *       properties:
+ *         name:
+ *           type: string
+ *           example: "LLM Name"
+ *         description:
+ *           type: string
+ *           example: "LLM meaningful description"
+ *         modelType:
+ *           $ref: '#/components/schemas/TGenerativeAIModels'
+ *         modelGroup:
+ *           $ref: '#/components/schemas/TModelGroups'
+ *         isCustomModel:
+ *           type: boolean
+ *           example: true
+ *         provider:
+ *           $ref: '#/components/schemas/TGenerativeAIProviders'
+ *         connectionId:
+ *           type: string
+ *           description: The reference id of the GenerativeAI Provider Connection
+ *           format: uuid
+ *         openAI:
+ *           type: object
+ *           description: OpenAI specific meta data
  *           properties:
- *             name:
+ *             customModel:
  *               type: string
- *               example: "LLM Name"
- *             description:
+ *               example: gpt-4-32k-0613
+ *               description: The custom model name. This does not work with embedding models
+ *         anthropic:
+ *           type: object
+ *           description: Anthropic specific meta data
+ *           properties:
+ *             customModel:
  *               type: string
- *               example: "LLM meaningful description"
- *             modelType:
- *               $ref: '#/components/schemas/TGenerativeAIModels'
- *             modelGroup:
- *               $ref: '#/components/schemas/TModelGroups'
- *             isCustomModel:
- *               type: boolean
- *               example: true
- *             provider:
- *               $ref: '#/components/schemas/TGenerativeAIProviders'
- *             connectionId:
+ *               example: claude-3-opus-20240229
+ *               description: The custom model name. This does not work with embedding models
+ *         azureOpenAI:
+ *           type: object
+ *           description: Azure OpenAI specific meta data
+ *           properties:
+ *             resourceName:
  *               type: string
- *               description: The reference id of the GenerativeAI Provider Connection
- *               format: uuid
+ *             deploymentName:
+ *               type: string
+ *             apiVersion:
+ *               type: string
+ *             baseCustomUrl:
+ *               type: string
+ *               example:
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
+ *                 - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
+ *         googleVertexAI:
+ *           type: object
+ *           description: Google VertexAI specific meta data
+ *           properties:
+ *             location:
+ *               type: string
+ *             apiEndpoint:
+ *               type: string
+ *             publisher:
+ *               type: string
+ *         googleGemini:
+ *           type: object
+ *           description: Google Gemini specific meta data
+ *           properties:
+ *             location:
+ *               type: string
+ *         alephAlpha:
+ *           type: object
+ *           description: Aleph Alpha specific meta data
+ *           properties:
+ *             customModel:
+ *               type: string
+ *               example: luminous-003
+ *               description: The custom model name. This does not work with embedding models
+ *             baseCustomUrl:
+ *               type: string
+ *               example: https://api.aleph-alpha.com
+ *
+ *     ILargeLanguageModelFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
+ *         - $ref: '#/components/schemas/IProjectResourceFields_2_0'
+ *         - type: object
+ *           properties:
  *             isDefault:
  *               type: boolean
  *               description: Sets the LLM to default (fallback) if no other LLM is set
  *               example: false
- *             openAI:
- *               type: object
- *               description: OpenAI specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: gpt-4-32k-0613
- *                   description: The custom model name. This does not work with embedding models
- *             anthropic:
- *               type: object
- *               description: Anthropic specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: claude-3-opus-20240229
- *                   description: The custom model name. This does not work with embedding models
- *             azureOpenAI:
- *               type: object
- *               description: Azure OpenAI specific meta data
- *               properties:
- *                 resourceName:
- *                   type: string
- *                 deploymentName:
- *                   type: string
- *                 apiVersion:
- *                   type: string
- *                 baseCustomUrl:
- *                   type: string
- *                   example:
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>
- *                     - https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>
- *             googleVertexAI:
- *               type: object
- *               description: Google VertexAI specific meta data
- *               properties:
- *                 location:
- *                   type: string
- *                 apiEndpoint:
- *                   type: string
- *                 publisher:
- *                   type: string
- *             googleGemini:
- *               type: object
- *               description: Google Gemini specific meta data
- *               properties:
- *                 location:
- *                   type: string
- *             alephAlpha:
- *               type: object
- *               description: Aleph Alpha specific meta data
- *               properties:
- *                 customModel:
- *                   type: string
- *                   example: luminous-003
- *                   description: The custom model name. This does not work with embedding models
- *                 baseCustomUrl:
- *                   type: string
- *                   example: https://api.aleph-alpha.com
  *             fallbacks:
  *               type: array
  *               description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
  *               items:
  *                 $ref: '#/components/schemas/ILLMFallback_2_0'
- *
+ *     IGlobalLargeLanguageModelFields_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/ILargeLanguageModelFieldsBase_2_0'
+ *         - $ref: '#/components/schemas/IGlobalResourceFields_2_0'
  *     ILargeLanguageModelCreate_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
- *
  *     ILargeLanguageModelData_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelFields_2_0'
@@ -16728,13 +16822,25 @@ export interface IGoogleGeminiMeta_2_0 {
  *               type: string
  *               description: The reference id of the LargeLanguageModel
  *               format: uuid
- *
+ *     IGlobalLargeLanguageModelData_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelFields_2_0'
+ *         - type: object
+ *           properties:
+ *             referenceId:
+ *               type: string
+ *               description: The reference id of the LargeLanguageModel
+ *               format: uuid
+ *     IGlobalLargeLanguageModel_2_0:
+ *       allOf:
+ *         - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
+ *         - $ref: '#/components/schemas/IEntityMeta'
  *     ILargeLanguageModel_2_0:
  *       allOf:
  *         - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface ILargeLanguageModel_2_0 {
+export interface ILargeLanguageModel_2_0 extends IGlobalResource {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -16800,7 +16906,7 @@ export interface ILargeLanguageModel_2_0 {
  *               example: false
  *         - $ref: '#/components/schemas/IEntityMeta'
  */
-export interface ILargeLanguageModelIndexItem_2_0 {
+export interface ILargeLanguageModelIndexItem_2_0 extends IGlobalResource {
 	referenceId: string;
 	_id: TMongoId;
 	name: string;
@@ -21509,6 +21615,7 @@ export interface IImpersonateUserRestManagementReturnValue_2_0 {
 	access_token: string;
 	expires_in: number;
 	refresh_token: string;
+	login_token: string;
 	token_type: "Bearer";
 }
 export interface ManagementAPIGroup_2_0 {

package/build/shared/interfaces/license.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"license.js","sourceRoot":"","sources":["../../../src/shared/interfaces/license.ts"],"names":[],"mappings":";;;AAuBA;;;;;;;;;;;;;;;GAeG;AACU,QAAA,aAAa,GAAU;IACnC,SAAS;IACT,OAAO;IACP,kBAAkB;IAClB,gBAAgB;IAChB,sBAAsB;IACtB,SAAS,CAAC,wEAAwE;CAClF,CAAC;AAcW,QAAA,0BAA0B,GAAU,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjF,QAAA,0BAA0B,GAA8D;IACpG,EAAE,EAAE,YAAY;IAChB,QAAQ,EAAE,kBAAkB;IAC5B,SAAS,EAAE,mBAAmB;IAC9B,SAAS,EAAE,mBAAmB;CAC9B,CAAC"}

package/build/test.js

@@ -1 +0,0 @@
-//# sourceMappingURL=test.js.map

package/dist/esm/shared/interfaces/license.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"license.js","sourceRoot":"","sources":["../../../../src/shared/interfaces/license.ts"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,aAAa,GAAU;IACnC,SAAS;IACT,OAAO;IACP,kBAAkB;IAClB,gBAAgB;IAChB,sBAAsB;IACtB,SAAS,CAAC,wEAAwE;CAClF,CAAC;AAcF,MAAM,CAAC,MAAM,0BAA0B,GAAU,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AAG9F,MAAM,CAAC,MAAM,0BAA0B,GAA8D;IACpG,EAAE,EAAE,YAAY;IAChB,QAAQ,EAAE,kBAAkB;IAC5B,SAAS,EAAE,mBAAmB;IAC9B,SAAS,EAAE,mBAAmB;CAC9B,CAAC"}

package/dist/esm/test.js

@@ -1 +0,0 @@
-//# sourceMappingURL=test.js.map