@cognigy/rest-api-client 0.13.0 → 0.13.2

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 (77) hide show
  1. package/.eslintConfig.json +117 -0
  2. package/.eslintrc.json +2 -2
  3. package/CHANGELOG.md +22 -0
  4. package/build/apigroups/ResourcesAPIGroup_2_0.js +10 -1
  5. package/build/shared/charts/descriptors/allFields.js +8 -0
  6. package/build/shared/charts/descriptors/apps/getAppSessionPin.js +9 -9
  7. package/build/shared/charts/descriptors/apps/initAppSession.js +36 -53
  8. package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js +5 -18
  9. package/build/shared/charts/descriptors/apps/setAppState.js +6 -6
  10. package/build/shared/charts/descriptors/apps/setHtmlAppState.js +3 -3
  11. package/build/shared/charts/descriptors/apps/utils/buildAppUrl.js +12 -0
  12. package/build/shared/charts/descriptors/index.js +1 -1
  13. package/build/shared/charts/descriptors/logic/switch/switch.js +3 -2
  14. package/build/shared/charts/descriptors/message/question/optionalQuestion.js +8 -1
  15. package/build/shared/charts/descriptors/message/question/question.js +7 -3
  16. package/build/shared/charts/descriptors/message/question/utils/evaluateQuestionAnswer.js +6 -0
  17. package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
  18. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +28 -25
  19. package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +53 -0
  20. package/build/shared/charts/descriptors/voice/nodes/dtmf.js +5 -3
  21. package/build/shared/charts/descriptors/voice/nodes/play.js +10 -3
  22. package/build/shared/charts/descriptors/voice/nodes/transfer.js +4 -0
  23. package/build/shared/charts/descriptors/voicegateway/nodes/handover.js +5 -1
  24. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +17 -5
  25. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +27 -9
  26. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +5 -1
  27. package/build/shared/errors/BadGatewayError.js +2 -1
  28. package/build/shared/errors/BadRequestError.js +2 -1
  29. package/build/shared/errors/ForbiddenError.js +2 -1
  30. package/build/shared/errors/GatewayTimeoutError.js +2 -1
  31. package/build/shared/errors/MethodNotAllowedError.js +2 -1
  32. package/build/shared/errors/NetworkError.js +2 -1
  33. package/build/shared/errors/PayloadTooLargeError.js +2 -1
  34. package/build/shared/errors/PaymentRequiredError.js +2 -1
  35. package/build/shared/errors/ServiceUnavailableError.js +2 -1
  36. package/build/shared/errors/UnauthorizedError.js +2 -1
  37. package/build/shared/errors/baseError.js +27 -4
  38. package/build/shared/errors/conflict.js +2 -1
  39. package/build/shared/errors/databaseConnectError.js +2 -2
  40. package/build/shared/errors/databaseQueryError.js +2 -2
  41. package/build/shared/errors/databaseRead.js +2 -2
  42. package/build/shared/errors/databaseWrite.js +2 -2
  43. package/build/shared/errors/exportError.js +2 -2
  44. package/build/shared/errors/fileRead.js +2 -2
  45. package/build/shared/errors/fileWrite.js +2 -2
  46. package/build/shared/errors/importError.js +1 -1
  47. package/build/shared/errors/inputOutputError.js +2 -2
  48. package/build/shared/errors/internalServerError.js +2 -1
  49. package/build/shared/errors/invalidArgument.js +2 -2
  50. package/build/shared/errors/missingArgument.js +2 -2
  51. package/build/shared/errors/notImplementedError.js +2 -1
  52. package/build/shared/errors/process.js +2 -2
  53. package/build/shared/errors/resourceNotFound.js +5 -1
  54. package/build/shared/errors/smtpConnectError.js +2 -2
  55. package/build/shared/errors/timeoutError.js +2 -2
  56. package/build/shared/interfaces/handover.js +1 -0
  57. package/build/shared/interfaces/resources/IAgentAssistConfig.js +56 -0
  58. package/build/shared/interfaces/resources/ILocale.js +25 -3
  59. package/build/shared/interfaces/resources/INodeDescriptorSet.js +1 -0
  60. package/build/shared/interfaces/resources/TResourceType.js +3 -0
  61. package/build/shared/interfaces/resources/settings/ISharedSettings.js +1 -1
  62. package/build/shared/interfaces/resources/yesNoIntent/IYesNoItem.js +5 -5
  63. package/build/shared/interfaces/restAPI/administration/liveAgent/v2.0/ICognigyLiveAgentMiddleware_2_0.js +3 -0
  64. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/IAgentAssistConfig_2_0.js +3 -0
  65. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/ICreateAgentAssistConfigRest_2_0.js +3 -0
  66. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/IDeleteAgentAssistConfigRest_2_0.js +3 -0
  67. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/IIndexAgentAssistConfigsRest_2_0.js +3 -0
  68. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/IReadAgentAssistConfigRest_2_0.js +3 -0
  69. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/IUpdateAgentAssistConfigRest_2_0.js +3 -0
  70. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/index.js +3 -0
  71. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/ITrainYesNoIntentsProjectRest_2_0.js +3 -0
  72. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IYesNoIntents_2_0.js +4 -4
  73. package/build/shared/interfaces/security/IACL.js +1 -1
  74. package/build/shared/interfaces/security/IPermission.js +2 -0
  75. package/build/shared/interfaces/security/IRole.js +4 -0
  76. package/package.json +2 -2
  77. package/types/index.d.ts +218 -66
package/types/index.d.ts CHANGED
@@ -422,6 +422,7 @@ declare const organisationWidePermissions: readonly [
422
422
  ];
423
423
  export declare type TOrganisationWidePermissions = typeof organisationWidePermissions[number];
424
424
  declare const projectWidePermissions: readonly [
425
+ "agentAssistConfigs",
425
426
  "analytics",
426
427
  "connections",
427
428
  "contactProfiles",
@@ -559,6 +560,15 @@ export interface ISuggestedMetaInfo {
559
560
  /** For other keys */
560
561
  [key: string]: any;
561
562
  }
563
+ declare const logLevels: readonly [
564
+ "fatal",
565
+ "error",
566
+ "warn",
567
+ "info",
568
+ "debug",
569
+ "trace"
570
+ ];
571
+ export declare type TLogLevel = typeof logLevels[number];
562
572
  export interface ILoggerStack {
563
573
  /** A traceId represents one particular trace for one request. */
564
574
  traceId?: string;
@@ -614,6 +624,11 @@ export interface IBaseErrorConstructorOptions {
614
624
  httpStatusText: string;
615
625
  stack: ILoggerStack;
616
626
  meta?: ISuggestedMetaInfo;
627
+ /** `logLevel` parameter indicates the overriding log level for the errors.
628
+ * For eg: `ResourceNotFound` scenario is not actually an error in the
629
+ * system, so this parameter will allow us to log them as info/debug level,
630
+ * but do not change the actual error respose in any way. */
631
+ logLevel?: TLogLevel;
617
632
  details: {
618
633
  [key: string]: any;
619
634
  };
@@ -653,7 +668,8 @@ declare class BaseError extends Error {
653
668
  [key: string]: any;
654
669
  };
655
670
  readonly originalErrorDetails: IOriginalErrorDetails;
656
- constructor({ name, message, code, httpStatusCode, httpStatusText, stack, meta, details }: IBaseErrorConstructorOptions);
671
+ private readonly logLevel;
672
+ constructor({ name, message, code, httpStatusCode, httpStatusText, stack, meta, details, logLevel }: IBaseErrorConstructorOptions);
657
673
  private parseOriginalError;
658
674
  toErrorLogDetails(): IErrorLogDetails;
659
675
  toResponse(): IErrorHandler;
@@ -662,81 +678,70 @@ declare class BaseError extends Error {
662
678
  traceId?: string;
663
679
  }): IErrorResponse;
664
680
  }
665
- declare const logLevels: readonly [
666
- "fatal",
667
- "error",
668
- "warn",
669
- "info",
670
- "debug",
671
- "trace"
672
- ];
673
- export declare type TLogLevel = typeof logLevels[number];
674
- export interface ISuggestedMetaInfo {
675
- }
676
681
  declare class BadGatewayError extends BaseError {
677
682
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
678
683
  [key: string]: any;
679
- });
684
+ }, logLevel?: TLogLevel);
680
685
  }
681
686
  declare class BadRequestError extends BaseError {
682
687
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
683
688
  [key: string]: any;
684
- });
689
+ }, logLevel?: TLogLevel);
685
690
  }
686
691
  declare class ConflictError extends BaseError {
687
692
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
688
693
  [key: string]: any;
689
- });
694
+ }, logLevel?: TLogLevel);
690
695
  }
691
696
  declare class DatabaseConnectError extends BadGatewayError {
692
697
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
693
698
  [key: string]: any;
694
- });
699
+ }, logLevel?: TLogLevel);
695
700
  }
696
701
  declare class InternalServerError extends BaseError {
697
702
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
698
703
  [key: string]: any;
699
- });
704
+ }, logLevel?: TLogLevel);
700
705
  }
701
706
  declare class DatabaseQueryError extends InternalServerError {
702
707
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
703
708
  [key: string]: any;
704
- });
709
+ }, logLevel?: TLogLevel);
705
710
  }
706
711
  declare class DatabaseReadError extends InternalServerError {
707
712
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
708
713
  [key: string]: any;
709
- });
714
+ }, logLevel?: TLogLevel);
710
715
  }
711
716
  declare class DatabaseWriteError extends InternalServerError {
712
717
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
713
718
  [key: string]: any;
714
- });
719
+ }, logLevel?: TLogLevel);
715
720
  }
716
721
  declare class ExportError extends InternalServerError {
717
722
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
718
723
  [key: string]: any;
719
- });
724
+ }, logLevel?: TLogLevel);
720
725
  }
721
726
  declare class FileReadError extends InternalServerError {
722
727
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
723
728
  [key: string]: any;
724
- });
729
+ }, logLevel?: TLogLevel);
725
730
  }
726
731
  declare class FileWriteError extends InternalServerError {
727
732
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
728
733
  [key: string]: any;
729
- });
734
+ }, logLevel?: TLogLevel);
730
735
  }
731
736
  declare class ForbiddenError extends BaseError {
732
737
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
733
738
  [key: string]: any;
734
- });
739
+ }, logLevel?: TLogLevel);
735
740
  }
736
741
  declare class GatewayTimeoutError extends BaseError {
737
742
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
738
743
  [key: string]: any;
739
- });
744
+ }, logLevel?: TLogLevel);
740
745
  }
741
746
  export interface IImportErrorDetails {
742
747
  duplicateSynonyms?: string[][];
@@ -746,77 +751,77 @@ export interface IImportErrorDetails {
746
751
  }
747
752
  declare class ImportError extends InternalServerError {
748
753
  readonly details: IImportErrorDetails;
749
- constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: IImportErrorDetails);
754
+ constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: IImportErrorDetails, logLevel?: TLogLevel);
750
755
  }
751
756
  declare class InputOutputError extends InternalServerError {
752
757
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
753
758
  [key: string]: any;
754
- });
759
+ }, logLevel?: TLogLevel);
755
760
  }
756
761
  declare class InvalidArgumentError extends BadRequestError {
757
762
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
758
763
  [key: string]: any;
759
- });
764
+ }, logLevel?: TLogLevel);
760
765
  }
761
766
  declare class MethodNotAllowedError extends BaseError {
762
767
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
763
768
  [key: string]: any;
764
- });
769
+ }, logLevel?: TLogLevel);
765
770
  }
766
771
  declare class MissingArgumentError extends BadRequestError {
767
772
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
768
773
  [key: string]: any;
769
- });
774
+ }, logLevel?: TLogLevel);
770
775
  }
771
776
  declare class NetworkError extends BaseError {
772
777
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
773
778
  [key: string]: any;
774
- });
779
+ }, logLevel?: TLogLevel);
775
780
  }
776
781
  declare class NotImplementedError extends BaseError {
777
782
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
778
783
  [key: string]: any;
779
- });
784
+ }, logLevel?: TLogLevel);
780
785
  }
781
786
  declare class PayloadTooLargeError extends BaseError {
782
787
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
783
788
  [key: string]: any;
784
- });
789
+ }, logLevel?: TLogLevel);
785
790
  }
786
791
  declare class PaymentRequiredError extends BaseError {
787
792
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
788
793
  [key: string]: any;
789
- });
794
+ }, logLevel?: TLogLevel);
790
795
  }
791
796
  declare class ProcessError extends InternalServerError {
792
797
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
793
798
  [key: string]: any;
794
- });
799
+ }, logLevel?: TLogLevel);
795
800
  }
796
801
  declare class ResourceNotFoundError extends BaseError {
797
802
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
798
803
  [key: string]: any;
799
- });
804
+ }, logLevel?: TLogLevel);
800
805
  }
801
806
  declare class SMTPConnectError extends BadGatewayError {
802
807
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
803
808
  [key: string]: any;
804
- });
809
+ }, logLevel?: TLogLevel);
805
810
  }
806
811
  declare class TimeoutError extends GatewayTimeoutError {
807
812
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
808
813
  [key: string]: any;
809
- });
814
+ }, logLevel?: TLogLevel);
810
815
  }
811
816
  declare class UnauthorizedError extends BaseError {
812
817
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
813
818
  [key: string]: any;
814
- });
819
+ }, logLevel?: TLogLevel);
815
820
  }
816
821
  declare class ServiceUnavailableError extends BaseError {
817
822
  constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
818
823
  [key: string]: any;
819
- });
824
+ }, logLevel?: TLogLevel);
820
825
  }
821
826
  export interface IErrorCollection {
822
827
  [ErrorCode.UNAUTHORIZED_ERROR]: typeof UnauthorizedError;
@@ -858,6 +863,7 @@ export interface IErrorHandler {
858
863
  details?: {
859
864
  [key: string]: any;
860
865
  };
866
+ logLevel?: TLogLevel;
861
867
  };
862
868
  }
863
869
  export interface IBasicPayload {
@@ -915,6 +921,8 @@ declare const organisationWideRoles: readonly [
915
921
  ];
916
922
  export declare type TOrganisationWideRole = typeof organisationWideRoles[number];
917
923
  declare const projectWideRoles: readonly [
924
+ "agentAssistConfigAdmin",
925
+ "agentAssistConfigViewer",
918
926
  "analytics",
919
927
  "basic",
920
928
  "connection_admin",
@@ -1073,6 +1081,8 @@ export interface IOrganisationWideAcl {
1073
1081
  * rights:
1074
1082
  * type: object
1075
1083
  * properties:
1084
+ * agentAssistConfigs:
1085
+ * $ref: '#/components/schemas/ICrudPermissions'
1076
1086
  * analytics:
1077
1087
  * $ref: '#/components/schemas/ICrudPermissions'
1078
1088
  * connections:
@@ -1516,6 +1526,7 @@ export interface IHttpAdapter {
1516
1526
  setConfig(config: IRestAPIClientConfig): void;
1517
1527
  }
1518
1528
  declare const arrayTResourceType: readonly [
1529
+ "agentassistconfig",
1519
1530
  "agentSettings",
1520
1531
  "chart",
1521
1532
  "connection",
@@ -4329,6 +4340,7 @@ export interface ISalesForceHandoverSettings {
4329
4340
  }
4330
4341
  export interface IAgentAssistSettings {
4331
4342
  agentAssistFlowId: string;
4343
+ agentAssistConfigId?: string;
4332
4344
  }
4333
4345
  export interface IGenesysCloudHandoverSettings {
4334
4346
  host: string;
@@ -4654,6 +4666,9 @@ export declare type THandoverStatus = "completed" | "cancelled" | "error" | "age
4654
4666
  * agentAssistFlowId:
4655
4667
  * type: string
4656
4668
  * description: Agent assist flow ID
4669
+ * agentAssistConfigId:
4670
+ * type: string
4671
+ * description: Selected Agent Assist Config ReferenceId
4657
4672
  * orgDataPrivacySettings:
4658
4673
  * $ref: '#/components/schemas/IEndpoitOrgDataPrivacySettings_2_0'
4659
4674
  * IEndpoint_2_0:
@@ -6024,6 +6039,29 @@ export interface IDeleteProjectRestData_2_0 extends IDeleteProjectRestDataParams
6024
6039
  }
6025
6040
  export interface IDeleteProjectRestReturnValue_2_0 extends ICreatedTask_2_0 {
6026
6041
  }
6042
+ export interface IAgentAssistConfig extends IEntityMeta {
6043
+ referenceId: string;
6044
+ name: string;
6045
+ description: string;
6046
+ config: IAgentAssistGridConfig;
6047
+ projectReference: TMongoId;
6048
+ organisationReference: TMongoId;
6049
+ }
6050
+ export interface IAgentAssistGridConfig {
6051
+ [key: string]: {
6052
+ x: number;
6053
+ y: number;
6054
+ columns: number;
6055
+ rows: number;
6056
+ };
6057
+ }
6058
+ export interface IGraphAgentAssistConfig {
6059
+ type: "agentAssistConfig";
6060
+ _id: TMongoId;
6061
+ name: string;
6062
+ referenceId: string;
6063
+ properties: Pick<IAgentAssistConfig, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
6064
+ }
6027
6065
  export interface IConnectionFields {
6028
6066
  [key: string]: string;
6029
6067
  }
@@ -7390,12 +7428,9 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
7390
7428
  parseCognigyScript?: (text: string, condition?: boolean) => string;
7391
7429
  trackAnalyticsStep?: (step: string) => void;
7392
7430
  triggerFunction?: (config: ITriggerFunctionNodeParams["config"]) => Promise<boolean>;
7393
- initAppSession?: (params?: {
7394
- appInterimScreenOverride?: string;
7395
- appConnectScreenOverride?: string;
7396
- }) => Promise<any>;
7397
- setAppState?: (appTemplateId: string, appTemplateData: unknown) => void;
7398
- getAppSessionPin?: () => Promise<string>;
7431
+ initAppSession: () => Promise<string>;
7432
+ setAppState: (appTemplateId: string, appTemplateData: Record<string, unknown>) => void;
7433
+ getAppSessionPin: () => Promise<string>;
7399
7434
  validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
7400
7435
  }
7401
7436
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
@@ -7579,7 +7614,8 @@ declare const nodeFieldTypes: readonly [
7579
7614
  "function",
7580
7615
  "appTemplate",
7581
7616
  "sttSelect",
7582
- "ttsSelect"
7617
+ "ttsSelect",
7618
+ "adaptivecard"
7583
7619
  ];
7584
7620
  export declare type TNodeFieldType = typeof nodeFieldTypes[number];
7585
7621
  export declare type TComparableValue = string | number | boolean;
@@ -7835,6 +7871,12 @@ export interface ILocale extends IEntityMeta {
7835
7871
  fallbackLocaleReference: TMongoId;
7836
7872
  projectReference: TMongoId;
7837
7873
  organisationReference: TMongoId;
7874
+ intentTrainGroupReference: TMongoId;
7875
+ intentTrainGroupReferenceId: string;
7876
+ feedbackReport: Pick<ITrainGroupFeedbackReport, "info" | "findings">;
7877
+ isTrainingOutOfDate: boolean;
7878
+ lastTrainedAt: number;
7879
+ nluOptions: IIntentTrainGroup["nluOptions"];
7838
7880
  }
7839
7881
  export interface IGraphLocale {
7840
7882
  type: "locale";
@@ -7932,7 +7974,7 @@ export interface IGraphPlaybook {
7932
7974
  name: string;
7933
7975
  properties: Pick<IPlaybook, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
7934
7976
  }
7935
- export declare type IGraphResourceWithReferenceId = IGraphConnection | IGraphFlow | IGraphFunction | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet;
7977
+ export declare type IGraphResourceWithReferenceId = IGraphConnection | IGraphFlow | IGraphFunction | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig;
7936
7978
  export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
7937
7979
  export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
7938
7980
  /**
@@ -9754,12 +9796,12 @@ export interface IReadYesNoIntentsRestDataParams_2_0 {
9754
9796
  }
9755
9797
  export interface IReadYesNoIntentsRestReturnValue_2_0 extends IYesNoIntentItem_2_0 {
9756
9798
  }
9757
- declare const arrayYesNoIntentsMode: readonly [
9758
- "smartDetectYesNoIntents",
9759
- "enableYesNoIntents",
9760
- "disableYesNoIntents"
9799
+ declare const arrayYesNoLogic: readonly [
9800
+ "yesNoIntents",
9801
+ "yesNoIntentsWithRules",
9802
+ "confirmationWords"
9761
9803
  ];
9762
- export declare type TYesNoIntentsMode_2_0 = typeof arrayYesNoIntentsMode[number];
9804
+ export declare type TYesNoLogic_2_0 = typeof arrayYesNoLogic[number];
9763
9805
  export interface IUpdateYesNoIntentsRestDataParams_2_0 {
9764
9806
  localeId: string;
9765
9807
  intentId: string;
@@ -9778,10 +9820,10 @@ export interface IDeleteYesNoIntentRestData_2_0 extends IDeleteYesNoIntentRestDa
9778
9820
  }
9779
9821
  export interface IDeleteYesNoIntentRestReturnValue_2_0 {
9780
9822
  }
9781
- export interface ITrainYesNoIntentsRestDataParams_2_0 {
9823
+ export interface ITrainYesNoIntentsRestDataParams_2_0 extends Partial<IProjectScope> {
9782
9824
  localeId?: string;
9783
9825
  }
9784
- export interface ITrainYesNoIntentsRestDataBody_2_0 {
9826
+ export interface ITrainYesNoIntentsRestDataBody_2_0 extends Partial<IProjectScope> {
9785
9827
  }
9786
9828
  export interface ITrainYesNoIntentsRestData_2_0 extends ITrainYesNoIntentsRestDataParams_2_0, ITrainYesNoIntentsRestDataBody_2_0 {
9787
9829
  }
@@ -9839,9 +9881,9 @@ export interface ITrainYesNoIntentsRestReturnValue_2_0 extends ICreatedTask_2_0
9839
9881
  * type: boolean
9840
9882
  * useURLSlots:
9841
9883
  * type: boolean
9842
- * yesNoIntentsMode:
9884
+ * yesNoLogic:
9843
9885
  * type: string
9844
- * enum: [smartDetectYesNoIntents, enableYesNoIntents, disableYesNoIntents]
9886
+ * enum: [yesNoIntents, yesNoIntentsWithRules, confirmationWords]
9845
9887
  * yesNoIntentThreshold:
9846
9888
  * type: integer
9847
9889
  */
@@ -9872,7 +9914,7 @@ export interface ISharedSettings_2_0 {
9872
9914
  learnNewExampleSentences: boolean;
9873
9915
  /** The threshold after which a 'learning sentence' is a learned sentence */
9874
9916
  learnNewExampleSentencesThreshold: number;
9875
- yesNoIntentsMode: TYesNoIntentsMode_2_0;
9917
+ yesNoLogic: TYesNoLogic_2_0;
9876
9918
  yesNoIntentThreshold: number;
9877
9919
  }
9878
9920
  /**
@@ -12660,7 +12702,7 @@ export interface IOptionalQuestionNodeRegexConfig extends IOptionalQuestionNodeS
12660
12702
  regex: string;
12661
12703
  }
12662
12704
  export interface IOptionalQuestionNodeOtherConfig extends IOptionalQuestionNodeSharedConfig {
12663
- type: "email" | "number" | "temperature" | "age" | "date" | "duration" | "yesNo" | "money" | "percentage" | "intent" | "data" | "url";
12705
+ type: "email" | "number" | "temperature" | "age" | "date" | "duration" | "yesNo" | "money" | "percentage" | "intent" | "data" | "url" | "app";
12664
12706
  }
12665
12707
  export interface IContinuousASRParams extends INodeFunctionBaseParams {
12666
12708
  config: {
@@ -12757,9 +12799,14 @@ export interface ITransferParams extends INodeFunctionBaseParams {
12757
12799
  }
12758
12800
  export interface IBargeInParams extends INodeFunctionBaseParams {
12759
12801
  config: {
12802
+ bargeInEnable: boolean;
12760
12803
  bargeInMinWordCount: number;
12761
12804
  bargeInOnSpeech: boolean;
12762
12805
  bargeInOnDtmf: boolean;
12806
+ dtmfEnable: boolean;
12807
+ dtmfInterDigitTimeout: number;
12808
+ dtmfMaxDigits: number;
12809
+ dtmfSubmitDigit: string;
12763
12810
  };
12764
12811
  }
12765
12812
  export interface IVoiceConfigParams {
@@ -12853,7 +12900,7 @@ export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
12853
12900
  export interface ISetAppStateNodeParams extends INodeFunctionBaseParams {
12854
12901
  config: {
12855
12902
  appTemplateId: string;
12856
- appTemplateData: string;
12903
+ appTemplateData: Record<string, unknown>;
12857
12904
  };
12858
12905
  }
12859
12906
  export interface IGetAppSessionPinNodeParams extends INodeFunctionBaseParams {
@@ -13437,6 +13484,101 @@ export interface IIndexYesNoSentencesRestData_2_0 extends IRestPagination<ISente
13437
13484
  }
13438
13485
  export interface IIndexYesNoSentencesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ISentenceIndexItem_2_0> {
13439
13486
  }
13487
+ /**
13488
+ * @openapi
13489
+ *
13490
+ * components:
13491
+ * schemas:
13492
+ * IAgentAssistGridConfig_2_0:
13493
+ * type: object
13494
+ * properties:
13495
+ * any-config-key:
13496
+ * type: object
13497
+ * properties:
13498
+ * x:
13499
+ * type: number
13500
+ * y:
13501
+ * type: number
13502
+ * columns:
13503
+ * type: number
13504
+ * rows:
13505
+ * type: number
13506
+ *
13507
+ * IAgentAssistConfigData_2_0:
13508
+ * type: object
13509
+ * properties:
13510
+ * name:
13511
+ * type: string
13512
+ * description: The human readable name of the config.
13513
+ * description:
13514
+ * type: string
13515
+ * description: The description which can be used to understand what the agent assist config contains in terms of tiles.
13516
+ * config:
13517
+ * type: object
13518
+ * description: The actual grid-config.
13519
+ * $ref: '#/components/schemas/IAgentAssistGridConfig_2_0'
13520
+ *
13521
+ * IAgentAssistConfigGeneratedData_2_0:
13522
+ * type: object
13523
+ * properties:
13524
+ * referenceId:
13525
+ * type: string
13526
+ * format: uuid
13527
+ *
13528
+ * IAgentAssistConfig_2_0:
13529
+ * allOf:
13530
+ * - $ref: '#/components/schemas/IAgentAssistConfigData_2_0'
13531
+ * - $ref: '#/components/schemas/IAgentAssistConfigGeneratedData_2_0'
13532
+ * - $ref: '#/components/schemas/IEntityMeta'
13533
+ */
13534
+ export interface IAgentAssistConfig_2_0 {
13535
+ _id: TMongoId;
13536
+ name: string;
13537
+ description: string;
13538
+ config: IAgentAssistGridConfig;
13539
+ referenceId: string;
13540
+ projectReference: string;
13541
+ organisationReference: string;
13542
+ createdAt: number;
13543
+ lastChanged: number;
13544
+ createdBy: TMongoId;
13545
+ lastChangedBy: TMongoId;
13546
+ }
13547
+ export interface ICreateAgentAssistConfigRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAgentAssistConfig_2_0, keyof IEntityMeta>> {
13548
+ }
13549
+ export interface ICreateAgentAssistConfigRestData_2_0 extends ICreateAgentAssistConfigRestDataBody_2_0 {
13550
+ }
13551
+ export interface ICreateAgentAssistConfigRestReturnValue_2_0 extends IAgentAssistConfig_2_0 {
13552
+ }
13553
+ export interface IUpdateAgentAssistConfigRestDataBody_2_0 extends Partial<Pick<IAgentAssistConfig_2_0, "name" | "description" | "config">> {
13554
+ }
13555
+ export interface IUpdateAgentAssistConfigRestDataParams_2_0 {
13556
+ configId: string;
13557
+ }
13558
+ export interface IUpdateAgentAssistConfigRestData_2_0 extends IUpdateAgentAssistConfigRestDataBody_2_0, IUpdateAgentAssistConfigRestDataParams_2_0 {
13559
+ }
13560
+ export interface IUpdateAgentAssistConfigRestReturnValue_2_0 {
13561
+ }
13562
+ export interface IReadAgentAssistConfigRestDataParams_2_0 {
13563
+ configId: string;
13564
+ projectId?: string;
13565
+ organisationId?: string;
13566
+ }
13567
+ export interface IReadAgentAssistConfigRestData_2_0 extends IReadAgentAssistConfigRestDataParams_2_0 {
13568
+ }
13569
+ export interface IReadAgentAssistConfigRestReturnValue_2_0 extends IAgentAssistConfig_2_0 {
13570
+ }
13571
+ export interface IDeleteAgentAssistConfigRestDataParams_2_0 {
13572
+ configId: string;
13573
+ }
13574
+ export interface IDeleteAgentAssistConfigRestData_2_0 extends IDeleteAgentAssistConfigRestDataParams_2_0 {
13575
+ }
13576
+ export interface IDeleteAgentAssistConfigRestReturnValue_2_0 {
13577
+ }
13578
+ export interface IIndexAgentAssistConfigsRestData_2_0 extends IRestPagination<IAgentAssistConfig_2_0>, IProjectScope {
13579
+ }
13580
+ export interface IIndexAgentAssistConfigsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAgentAssistConfig_2_0> {
13581
+ }
13440
13582
  export interface ResourcesAPIGroup_2_0 {
13441
13583
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
13442
13584
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
@@ -13632,12 +13774,18 @@ export interface ResourcesAPIGroup_2_0 {
13632
13774
  updateYesNoIntents: TRestAPIOperation<IUpdateYesNoIntentRestData_2_0, IUpdateNoIntentsRestReturnValue_2_0>;
13633
13775
  deleteYesNoIntents: TRestAPIOperation<IDeleteYesNoIntentRestData_2_0, IDeleteYesNoIntentRestReturnValue_2_0>;
13634
13776
  trainYesNoIntents: TRestAPIOperation<ITrainYesNoIntentsRestData_2_0, ITrainYesNoIntentsRestReturnValue_2_0>;
13777
+ trainYesNoIntentsProject: TRestAPIOperation<ITrainYesNoIntentsRestData_2_0, ITrainYesNoIntentsRestReturnValue_2_0>;
13635
13778
  indexYesNoSentences: TRestAPIOperation<IIndexYesNoSentencesRestData_2_0, IIndexYesNoSentencesRestReturnValue_2_0>;
13636
13779
  createYesNoSentence: TRestAPIOperation<ICreateYesNoSentenceRestData_2_0, ICreateYesNoSentenceRestReturnValue_2_0>;
13637
13780
  updateYesNoSentence: TRestAPIOperation<IUpdateYesNoSentenceRestData_2_0, IUpdateYesNoSentenceRestReturnValue_2_0>;
13638
13781
  deleteYesNoSentence: TRestAPIOperation<IDeleteYesNoSentenceRestData_2_0, IDeleteYesNoSentenceRestReturnValue_2_0>;
13639
13782
  testVoiceProvider: TRestAPIOperation<ITestVoiceProviderRestData_2_0, ITestVoiceProviderRestReturnValue_2_0>;
13640
13783
  testTranslationSettings: TRestAPIOperation<ITestTranslationSettingsRestData_2_0, ITestTranslationSettingsRestReturnValue_2_0>;
13784
+ indexAgentAssistConfigs: TRestAPIOperation<IIndexAgentAssistConfigsRestData_2_0, IIndexAgentAssistConfigsRestReturnValue_2_0>;
13785
+ createAgentAssistConfig: TRestAPIOperation<ICreateAgentAssistConfigRestData_2_0, ICreateAgentAssistConfigRestReturnValue_2_0>;
13786
+ readAgentAssistConfig: TRestAPIOperation<IReadAgentAssistConfigRestData_2_0, IReadAgentAssistConfigRestReturnValue_2_0>;
13787
+ updateAgentAssistConfig: TRestAPIOperation<IUpdateAgentAssistConfigRestData_2_0, IUpdateAgentAssistConfigRestReturnValue_2_0>;
13788
+ deleteAgentAssistConfig: TRestAPIOperation<IDeleteAgentAssistConfigRestData_2_0, IDeleteAgentAssistConfigRestReturnValue_2_0>;
13641
13789
  }
13642
13790
  declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
13643
13791
  /**
@@ -15443,6 +15591,7 @@ export declare type TActionType = typeof actionTypes[number];
15443
15591
  * description: Additional resource types for audit purposes
15444
15592
  * example: node
15445
15593
  * enum:
15594
+ * - agentassistconfig
15446
15595
  * - apiKey
15447
15596
  * - analytics
15448
15597
  * - connectionField
@@ -15472,7 +15621,7 @@ export declare type TActionType = typeof actionTypes[number];
15472
15621
  * - user
15473
15622
  * - yesNoIntent
15474
15623
  */
15475
- export declare type TResourceTypeAdditional = "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
15624
+ export declare type TResourceTypeAdditional = "agentassistconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
15476
15625
  /**
15477
15626
  * @openapi
15478
15627
  * components:
@@ -16272,14 +16421,14 @@ export interface IResetIdentityProviderRestData_2_0 {
16272
16421
  }
16273
16422
  export interface IResetIdentityProviderRestReturnValue {
16274
16423
  }
16275
- export interface ISetupCognigyLiveAgentRestReturnValue_2_0 {
16424
+ export interface ISetupCognigyLiveAgentRestReturnValue_2_0 extends ICognigyLiveAgentMiddleware_2_0 {
16276
16425
  liveAgentAccount: Number;
16277
16426
  }
16278
16427
  export interface ISetupCognigyLiveAgentInboxRestDataParams_2_0 extends IProjectScope {
16279
16428
  }
16280
16429
  export interface ISetupCognigyLiveAgentInboxRestData_2_0 extends ISetupCognigyLiveAgentInboxRestDataParams_2_0 {
16281
16430
  }
16282
- export interface ISetupCognigyLiveAgentInboxRestReturnValue_2_0 {
16431
+ export interface ISetupCognigyLiveAgentInboxRestReturnValue_2_0 extends ICognigyLiveAgentMiddleware_2_0 {
16283
16432
  liveAgentDefaultInbox: Number;
16284
16433
  }
16285
16434
  export interface IUpdateCognigyLiveAgentInboxRestDataParams_2_0 extends IProjectScope {
@@ -16289,19 +16438,22 @@ export interface IUpdateCognigyLiveAgentInboxRestDataBody_2_0 {
16289
16438
  }
16290
16439
  export interface IUpdateCognigyLiveAgentInboxRestData_2_0 extends IUpdateCognigyLiveAgentInboxRestDataParams_2_0, IUpdateCognigyLiveAgentInboxRestDataBody_2_0 {
16291
16440
  }
16292
- export interface IUpdateCognigyLiveAgentInboxRestReturnValue_2_0 {
16441
+ export interface IUpdateCognigyLiveAgentInboxRestReturnValue_2_0 extends ICognigyLiveAgentMiddleware_2_0 {
16293
16442
  liveAgentDefaultInbox: Number;
16294
16443
  }
16295
16444
  export interface IReadProjectInboxRestDataParams_2_0 extends IProjectScope {
16296
16445
  }
16297
16446
  export interface IReadProjectInboxRestData_2_0 extends IReadProjectInboxRestDataParams_2_0 {
16298
16447
  }
16299
- export interface IReadProjectInboxRestReturnValue_2_0 {
16448
+ export interface IReadProjectInboxRestReturnValue_2_0 extends ICognigyLiveAgentMiddleware_2_0 {
16300
16449
  liveAgentDefaultInbox: Number;
16301
16450
  }
16302
- export interface IReadLiveAgentAccountRestReturnValue_2_0 {
16451
+ export interface IReadLiveAgentAccountRestReturnValue_2_0 extends ICognigyLiveAgentMiddleware_2_0 {
16303
16452
  liveAgentAccount: Number;
16304
16453
  }
16454
+ export interface ICognigyLiveAgentMiddleware_2_0 {
16455
+ error?: string;
16456
+ }
16305
16457
  declare enum EOrganisationDeletionStatus {
16306
16458
  TOKEN_REQUESTED = "TOKEN_REQUESTED",
16307
16459
  IN_PROGRESS = "IN_PROGRESS",