@cognigy/rest-api-client 2025.10.0 → 2025.11.0

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.
@@ -13,23 +13,36 @@ export const organisationDataPrivacySettingsSchema = {
13
13
  maskIPAddress: { type: "boolean" },
14
14
  maskAnalytics: { type: "boolean" },
15
15
  maskLogging: { type: "boolean" },
16
- ignoreList: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 0 }
17
- },
16
+ ignoreList: {
17
+ type: "array",
18
+ items: { type: "string" },
19
+ additionalItems: false,
20
+ minItems: 0
21
+ }
22
+ }
18
23
  };
19
24
  export const organisationPasswordPolicySchema = {
20
25
  title: "organisationPasswordPolicySchema",
21
26
  type: "object",
22
27
  additionalProperties: false,
23
28
  properties: {
24
- maxAmountIdenticalCharacters: { type: "integer", minimum: 0, maximum: 999 },
29
+ maxAmountIdenticalCharacters: {
30
+ type: "integer",
31
+ minimum: 0,
32
+ maximum: 999
33
+ },
25
34
  maxLength: { type: "integer", minimum: 0, maximum: 999 },
26
- minAmountFailedAttemptsAutoDisable: { type: "integer", minimum: 0, maximum: 999 },
35
+ minAmountFailedAttemptsAutoDisable: {
36
+ type: "integer",
37
+ minimum: 0,
38
+ maximum: 999
39
+ },
27
40
  minAmountLowerCase: { type: "integer", minimum: 0, maximum: 999 },
28
41
  minAmountNumbers: { type: "integer", minimum: 0, maximum: 999 },
29
42
  minAmountSpecialCharacters: { type: "integer", minimum: 0, maximum: 999 },
30
43
  minAmountUpperCase: { type: "integer", minimum: 0, maximum: 999 },
31
- minLength: { type: "integer", minimum: 0, maximum: 999 },
32
- },
44
+ minLength: { type: "integer", minimum: 0, maximum: 999 }
45
+ }
33
46
  };
34
47
  export const organisationDataSchema = {
35
48
  title: "organisationDataSchema",
@@ -52,13 +65,24 @@ export const organisationDataSchema = {
52
65
  sessionStateTTLInMinutes: { type: "integer", minimum: 0 },
53
66
  billingTimezone: { type: "string", format: "timezone" },
54
67
  dataPrivacySettings: organisationDataPrivacySettingsSchema,
55
- },
68
+ maxTTLValues: {
69
+ type: "object",
70
+ properties: {
71
+ contactProfileTTLInMinutes: { type: "integer", minimum: 0 },
72
+ conversationTTLInMinutes: { type: "integer", minimum: 0 },
73
+ analyticsTTLInMinutes: { type: "integer", minimum: 0 },
74
+ sessionsTTLInMinutes: { type: "integer", minimum: 0 },
75
+ stepEventsTTLInMinutes: { type: "integer", minimum: 0 },
76
+ sessionStateTTLInMinutes: { type: "integer", minimum: 0 }
77
+ }
78
+ }
79
+ }
56
80
  };
57
81
  export const organisationSchema = {
58
82
  title: "organisationSchema",
59
83
  type: "object",
60
84
  additionalProperties: false,
61
- properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, organisationDataSchema.properties), { liveAgentAccount: { type: "number" }, voiceGatewayAccount: { type: "string" } }),
85
+ properties: Object.assign(Object.assign({ _id: { format: "mongo-id" } }, organisationDataSchema.properties), { liveAgentAccount: { type: "number" }, voiceGatewayAccount: { type: "string" } })
62
86
  };
63
87
  export const organisationQuerySchema = createQuerySchema("organisationQuerySchema", organisationSchema);
64
88
  //# sourceMappingURL=IOrganisation.js.map
@@ -34,7 +34,8 @@ export const endpointTypes = [
34
34
  "niceCXOne",
35
35
  "niceCXOneAAH",
36
36
  "agentAssistVoice",
37
- "webchat3"
37
+ "webchat3",
38
+ "zoomContactCenter",
38
39
  ];
39
40
  const transferTypes = ["dial", "sip:refer"];
40
41
  export const webchatPersistentMenuSchema = {
@@ -699,6 +700,15 @@ export const agentAssistVoiceEndpointSettingsSchema = {
699
700
  },
700
701
  additionalProperties: false
701
702
  };
703
+ export const zoomContactCenterEndpointSettingsSchema = {
704
+ type: "object",
705
+ properties: {
706
+ verifyToken: {
707
+ type: "string"
708
+ },
709
+ },
710
+ additionalProperties: false
711
+ };
702
712
  export const anyEndpointSettingsSchema = {
703
713
  title: "anyEndpointSettingsSchema",
704
714
  type: "object",
@@ -11,6 +11,7 @@ export const webhookChannelTypes = [
11
11
  "whatsapp",
12
12
  "eightByEight",
13
13
  "agentAssistVoice",
14
+ "zoomContactCenter",
14
15
  ];
15
16
  export const webhookChannelDisplayNames = [
16
17
  {
@@ -61,5 +62,9 @@ export const webhookChannelDisplayNames = [
61
62
  channel: "eightByEight",
62
63
  displayName: "8x8"
63
64
  },
65
+ {
66
+ channel: "zoomContactCenter",
67
+ displayName: "Zoom Contact Center"
68
+ }
64
69
  ];
65
70
  //# sourceMappingURL=TWebhookChannelType.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognigy/rest-api-client",
3
- "version": "2025.10.0",
3
+ "version": "2025.11.0",
4
4
  "description": "Cognigy REST-Client",
5
5
  "main": "build/index.js",
6
6
  "module": "dist/esm/index.js",
package/types/index.d.ts CHANGED
@@ -1891,7 +1891,8 @@ declare const webhookChannelTypes: readonly [
1891
1891
  "intercom",
1892
1892
  "whatsapp",
1893
1893
  "eightByEight",
1894
- "agentAssistVoice"
1894
+ "agentAssistVoice",
1895
+ "zoomContactCenter"
1895
1896
  ];
1896
1897
  export declare type TWebhookChannelType = typeof webhookChannelTypes[number];
1897
1898
  declare const restChannelTypes: readonly [
@@ -2554,6 +2555,7 @@ export interface IGraphEndpointDependency {
2554
2555
  * - agentAssistVoice
2555
2556
  * - webchat3
2556
2557
  * - niceCXOneAAH
2558
+ * - zoomContactCenter
2557
2559
  */
2558
2560
  export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
2559
2561
  declare const endpointTypes: readonly [
@@ -2589,7 +2591,8 @@ declare const endpointTypes: readonly [
2589
2591
  "niceCXOne",
2590
2592
  "niceCXOneAAH",
2591
2593
  "agentAssistVoice",
2592
- "webchat3"
2594
+ "webchat3",
2595
+ "zoomContactCenter"
2593
2596
  ];
2594
2597
  export declare type TEndpointType = typeof endpointTypes[number];
2595
2598
  declare const transferTypes: readonly [
@@ -2694,7 +2697,7 @@ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings
2694
2697
  cancelButtonText: string;
2695
2698
  };
2696
2699
  }
2697
- export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
2700
+ export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | IZoomContactCenterEndpointSettings | {};
2698
2701
  export declare type TAvayaVoice = "man" | "woman" | string;
2699
2702
  declare const avayaSttTtsLanguages: readonly [
2700
2703
  "cy-GB",
@@ -4319,6 +4322,9 @@ export interface INiceCXOneEndpointSettings {
4319
4322
  export interface INiceCXOneAAHEndpointSettings {
4320
4323
  niceCXOneAAHConnection: string;
4321
4324
  }
4325
+ export interface IZoomContactCenterEndpointSettings {
4326
+ verifyToken: string;
4327
+ }
4322
4328
  declare const arrayNLUConnectorType_2_0: readonly [
4323
4329
  "alexa",
4324
4330
  "dialogflow",
@@ -9471,7 +9477,6 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
9471
9477
  sendResolveEvent: boolean;
9472
9478
  resolveBehavior: "resetEntrypoint" | "continueEntrypoint";
9473
9479
  allowAgentInject: boolean;
9474
- agentAssistInitMessage: string;
9475
9480
  sendOnQueueEvent: boolean;
9476
9481
  sendOnActiveEvent: boolean;
9477
9482
  getQueuePosition: boolean;
@@ -9717,7 +9722,6 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
9717
9722
  escalateAnswersHandoverEightByEightJSONProps: object;
9718
9723
  escalateAnswersHandoverSendResolveEvent: boolean;
9719
9724
  escalateAnswersHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
9720
- escalateAnswersAgentAssistInitMessage: string;
9721
9725
  escalateAnswersAllowAgentInject: boolean;
9722
9726
  escalateAnswersSendOnQueueEvent: boolean;
9723
9727
  escalateAnswersSendOnActiveEvent: boolean;
@@ -10640,7 +10644,7 @@ export interface IActions {
10640
10644
  removeFromContext?: (key: string, value: string, mode: string) => void;
10641
10645
  rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
10642
10646
  rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
10643
- requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], agentAssistInitMessage?: string, providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
10647
+ requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
10644
10648
  runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
10645
10649
  resetContext?: () => object;
10646
10650
  resetFormBrain?: () => Promise<void>;
@@ -10682,7 +10686,7 @@ export interface IActions {
10682
10686
  knowledgeSearch: (data: IKnowledgeSearchData, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<IKnowledgeSearchReturnValue>;
10683
10687
  matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
10684
10688
  getAgentAssistConfigId: () => string;
10685
- getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
10689
+ getNluEmbeddingCredentials: () => Promise<INluEmbeddingCredentials>;
10686
10690
  getMetadata: () => IGetMetaDataActionValue;
10687
10691
  sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
10688
10692
  getEndpointSettings: () => IEndpointSettings;