@epam/ai-dial-chat-api-client 1.2.0-dev.11 → 1.2.0-dev.112

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.
@@ -5,7 +5,7 @@
5
5
  */
6
6
  export interface AcceptInvitationResponseDto {
7
7
  /**
8
- * Identifier (DIAL Core resource path) of the entity the invitation grants access to.
8
+ * Identifier (DIAL Core resource path) of the entity the invitation grants access to. A prompt path is returned decoded, matching the id its listing endpoints report.
9
9
  * @type {string}
10
10
  * @memberof AcceptInvitationResponseDto
11
11
  */
@@ -432,6 +432,95 @@ export interface ApplicationDto {
432
432
  */
433
433
  maxInputAttachments?: number;
434
434
  }
435
+ /**
436
+ *
437
+ * @export
438
+ * @interface ApplicationExternalServiceDto
439
+ */
440
+ export interface ApplicationExternalServiceDto {
441
+ /**
442
+ *
443
+ * @type {string}
444
+ * @memberof ApplicationExternalServiceDto
445
+ */
446
+ displayName: string;
447
+ /**
448
+ *
449
+ * @type {string}
450
+ * @memberof ApplicationExternalServiceDto
451
+ */
452
+ description?: string;
453
+ /**
454
+ *
455
+ * @type {string}
456
+ * @memberof ApplicationExternalServiceDto
457
+ */
458
+ authenticationType: ApplicationExternalServiceDtoAuthenticationTypeEnum;
459
+ /**
460
+ * USER-level credential status ('SIGNED_IN' | 'SIGNED_OUT' | 'FAILED'), when Core reports one.
461
+ * @type {string}
462
+ * @memberof ApplicationExternalServiceDto
463
+ */
464
+ userLevelAuthStatus?: string;
465
+ /**
466
+ * APPLICATION-level status. For DIAL_NATIVE, indicates application consent managed by an administrator.
467
+ * @type {string}
468
+ * @memberof ApplicationExternalServiceDto
469
+ */
470
+ appLevelAuthStatus?: string;
471
+ /**
472
+ * GLOBAL-level credential status ('SIGNED_IN' | 'SIGNED_OUT' | 'FAILED'), when Core reports one.
473
+ * @type {string}
474
+ * @memberof ApplicationExternalServiceDto
475
+ */
476
+ globalAuthStatus?: string;
477
+ /**
478
+ *
479
+ * @type {string}
480
+ * @memberof ApplicationExternalServiceDto
481
+ */
482
+ clientId?: string;
483
+ /**
484
+ *
485
+ * @type {string}
486
+ * @memberof ApplicationExternalServiceDto
487
+ */
488
+ authorizationEndpoint?: string;
489
+ /**
490
+ *
491
+ * @type {Array<string>}
492
+ * @memberof ApplicationExternalServiceDto
493
+ */
494
+ scopesSupported?: Array<string>;
495
+ /**
496
+ *
497
+ * @type {string}
498
+ * @memberof ApplicationExternalServiceDto
499
+ */
500
+ codeChallenge?: string;
501
+ /**
502
+ *
503
+ * @type {string}
504
+ * @memberof ApplicationExternalServiceDto
505
+ */
506
+ codeChallengeMethod?: string;
507
+ /**
508
+ * External-service identifier within the application
509
+ * @type {string}
510
+ * @memberof ApplicationExternalServiceDto
511
+ */
512
+ id: string;
513
+ }
514
+ /**
515
+ * @export
516
+ */
517
+ export declare const ApplicationExternalServiceDtoAuthenticationTypeEnum: {
518
+ readonly None: "NONE";
519
+ readonly ApiKey: "API_KEY";
520
+ readonly Oauth: "OAUTH";
521
+ readonly DialNative: "DIAL_NATIVE";
522
+ };
523
+ export type ApplicationExternalServiceDtoAuthenticationTypeEnum = (typeof ApplicationExternalServiceDtoAuthenticationTypeEnum)[keyof typeof ApplicationExternalServiceDtoAuthenticationTypeEnum];
435
524
  /**
436
525
  *
437
526
  * @export
@@ -488,6 +577,79 @@ export interface ApplicationSchemasResponseDto {
488
577
  */
489
578
  schemas: Array<ApplicationSchemaSummaryDto>;
490
579
  }
580
+ /**
581
+ *
582
+ * @export
583
+ * @interface ApplicationVisualizerDto
584
+ */
585
+ export interface ApplicationVisualizerDto {
586
+ /**
587
+ * The postMessage protocol namespace, NOT a display label. Every message exchanged with the iframe is prefixed "${title}/…", and the visualizer application must be constructed with this identical string as its appName. A mismatch is a silent failure — the iframe loads but never receives data. Also used as the inline frame's header text.
588
+ * @type {string}
589
+ * @memberof ApplicationVisualizerDto
590
+ */
591
+ title: string;
592
+ /**
593
+ * Human-readable description of the visualizer. Accepted for schema parity; not consumed by the host UI.
594
+ * @type {string}
595
+ * @memberof ApplicationVisualizerDto
596
+ */
597
+ description?: string;
598
+ /**
599
+ * Icon URL or identifier for the visualizer. Accepted for schema parity; not consumed by the host UI.
600
+ * @type {string}
601
+ * @memberof ApplicationVisualizerDto
602
+ */
603
+ icon?: string;
604
+ /**
605
+ * MIME type(s) this entry claims, as a comma-separated list (e.g. "application/vnd.plotly.v1+json, application/vnd.vega.v5+json"). Optional, unlike the required field of the same name on CustomVisualizerDto: when omitted, the entry claims every attachment of the message that carries a URL. Attachments it does not claim render as ordinary attachment tiles.
606
+ * @type {string}
607
+ * @memberof ApplicationVisualizerDto
608
+ */
609
+ contentType?: string;
610
+ /**
611
+ * Absolute HTTP(S) URL of the visualizer iframe.
612
+ * @type {string}
613
+ * @memberof ApplicationVisualizerDto
614
+ */
615
+ url: string;
616
+ /**
617
+ * Milliseconds to wait for a send() request response before rejecting. Defaults to 10000 when unset. Does not bound the initial READY_TO_INTERACT handshake.
618
+ * @type {number}
619
+ * @memberof ApplicationVisualizerDto
620
+ */
621
+ requestTimeout?: number;
622
+ /**
623
+ * Suggested initial width of the visualizer surface in pixels.
624
+ * @type {number}
625
+ * @memberof ApplicationVisualizerDto
626
+ */
627
+ width?: number;
628
+ /**
629
+ * Suggested initial height of the visualizer surface in pixels. Also used by the host to size the inline frame in the message.
630
+ * @type {number}
631
+ * @memberof ApplicationVisualizerDto
632
+ */
633
+ height?: number;
634
+ /**
635
+ * Suggested height on mobile-sized screens in pixels. Also used by the host to size the inline frame on a mobile viewport.
636
+ * @type {number}
637
+ * @memberof ApplicationVisualizerDto
638
+ */
639
+ mobileHeight?: number;
640
+ /**
641
+ * Whether the host should pass auth info to the visualizer. Accepted for schema parity; inert, because 1.0 auth is server-side and the browser holds no access token.
642
+ * @type {boolean}
643
+ * @memberof ApplicationVisualizerDto
644
+ */
645
+ passAuthInfo?: boolean;
646
+ /**
647
+ * Whether the host should pass an explicit access token. Accepted for schema parity; inert, because 1.0 auth is server-side and the browser holds no access token.
648
+ * @type {boolean}
649
+ * @memberof ApplicationVisualizerDto
650
+ */
651
+ passExplicitToken?: boolean;
652
+ }
491
653
  /**
492
654
  *
493
655
  * @export
@@ -825,6 +987,12 @@ export interface ClientConfigDto {
825
987
  * @memberof ClientConfigDto
826
988
  */
827
989
  mcpAppUserAgent?: string | null;
990
+ /**
991
+ * Host application identifier sent to every mounted MCP App as hostInfo.name during its ui/initialize handshake. Null when MCP_APP_HOST_NAME is not configured — defaults to "ai-dial-chat" on the client.
992
+ * @type {string}
993
+ * @memberof ClientConfigDto
994
+ */
995
+ mcpAppHostName?: string | null;
828
996
  /**
829
997
  * Which File Manager tabs are shown to users. Defaults to all three currently-supported tabs.
830
998
  * @type {Array<string>}
@@ -891,6 +1059,14 @@ export interface ClientConfigDto {
891
1059
  * @memberof ClientConfigDto
892
1060
  */
893
1061
  customVisualizers: Array<CustomVisualizerDto>;
1062
+ /**
1063
+ * Registry of application id → grouped visualizer mappings, keyed by a message's effective deployment id. Sourced from APPLICATION_VISUALIZERS. Every attachment an entry claims is delivered to one iframe together; an entry takes precedence over customVisualizers for the attachments it claims. The origin of each entry URL must also appear in ALLOWED_IFRAME_ORIGINS or the browser blocks the iframe. Each entry's passAuthInfo and passExplicitToken are accepted for configuration parity and are not consumed — auth is server-side and the browser holds no access token. Empty when unset — the feature is dark by default.
1064
+ * @type {{ [key: string]: ApplicationVisualizerDto; }}
1065
+ * @memberof ClientConfigDto
1066
+ */
1067
+ applicationVisualizers: {
1068
+ [key: string]: ApplicationVisualizerDto;
1069
+ };
894
1070
  /**
895
1071
  * Public client-owned variables from CUSTOM_CLIENT_VARIABLES. Arbitrary JSON object; empty when unset or invalid. The BFF does not interpret its keys. Never put secrets here.
896
1072
  * @type {{ [key: string]: unknown }}
@@ -905,6 +1081,12 @@ export interface ClientConfigDto {
905
1081
  * @memberof ClientConfigDto
906
1082
  */
907
1083
  publicationFilterSources: Array<string>;
1084
+ /**
1085
+ * Maximum attachment/upload file size in bytes. Sourced from FILE_UPLOAD_MAX_BYTES — the same variable that bounds the POST /api/v1/files Multer limit — so the client can reject an oversized file before attempting to upload it.
1086
+ * @type {number}
1087
+ * @memberof ClientConfigDto
1088
+ */
1089
+ maxAttachmentFileSizeBytes: number;
908
1090
  }
909
1091
  /**
910
1092
  * @export
@@ -1845,11 +2027,17 @@ export interface CreateScheduledTaskBodyDto {
1845
2027
  */
1846
2028
  model: string;
1847
2029
  /**
1848
- *
2030
+ * Instructions; may be empty when the effective task has a skill.
1849
2031
  * @type {string}
1850
2032
  * @memberof CreateScheduledTaskBodyDto
1851
2033
  */
1852
2034
  prompt: string;
2035
+ /**
2036
+ * DIAL skill reference with a path of at most 1024 decoded characters. Omission preserves the saved skill on update; null removes it.
2037
+ * @type {string}
2038
+ * @memberof CreateScheduledTaskBodyDto
2039
+ */
2040
+ skillUrl?: string | null;
1853
2041
  /**
1854
2042
  *
1855
2043
  * @type {string}
@@ -2007,6 +2195,12 @@ export interface CreatedScheduledTaskDto {
2007
2195
  * @memberof CreatedScheduledTaskDto
2008
2196
  */
2009
2197
  prompt?: string;
2198
+ /**
2199
+ *
2200
+ * @type {string}
2201
+ * @memberof CreatedScheduledTaskDto
2202
+ */
2203
+ skillUrl?: string;
2010
2204
  }
2011
2205
  /**
2012
2206
  * @export
@@ -3977,6 +4171,12 @@ export interface GetExternalServiceResponseDto {
3977
4171
  * @memberof GetExternalServiceResponseDto
3978
4172
  */
3979
4173
  userLevelAuthStatus?: string;
4174
+ /**
4175
+ * APPLICATION-level status. For DIAL_NATIVE, indicates application consent managed by an administrator.
4176
+ * @type {string}
4177
+ * @memberof GetExternalServiceResponseDto
4178
+ */
4179
+ appLevelAuthStatus?: string;
3980
4180
  /**
3981
4181
  * GLOBAL-level credential status ('SIGNED_IN' | 'SIGNED_OUT' | 'FAILED'), when Core reports one.
3982
4182
  * @type {string}
@@ -4021,6 +4221,7 @@ export declare const GetExternalServiceResponseDtoAuthenticationTypeEnum: {
4021
4221
  readonly None: "NONE";
4022
4222
  readonly ApiKey: "API_KEY";
4023
4223
  readonly Oauth: "OAUTH";
4224
+ readonly DialNative: "DIAL_NATIVE";
4024
4225
  };
4025
4226
  export type GetExternalServiceResponseDtoAuthenticationTypeEnum = (typeof GetExternalServiceResponseDtoAuthenticationTypeEnum)[keyof typeof GetExternalServiceResponseDtoAuthenticationTypeEnum];
4026
4227
  /**
@@ -5138,6 +5339,12 @@ export interface PublishCatalogEntityDto {
5138
5339
  * @memberof PublishCatalogEntityDto
5139
5340
  */
5140
5341
  rules?: Array<PublishRuleDto>;
5342
+ /**
5343
+ * Publish the entity together with the publisher's own credentials for it. DIAL Core honours it by copying the credential onto the published copy, so members of the organization use the entity without authorising individually. Omitted or `false` sends exactly the request every caller sent before this field existed. The flag grants no additional authorization: Core still derives the actor from the bearer token, enforces target-folder write access, and holds the publication `PENDING` until an administrator approves it. No credential value ever crosses the wire — only this boolean.
5344
+ * @type {boolean}
5345
+ * @memberof PublishCatalogEntityDto
5346
+ */
5347
+ publishCredentials?: boolean;
5141
5348
  }
5142
5349
  /**
5143
5350
  *
@@ -5237,6 +5444,12 @@ export interface PublishHistoryEntryDto {
5237
5444
  * @memberof PublishHistoryEntryDto
5238
5445
  */
5239
5446
  publishedBy: string;
5447
+ /**
5448
+ * Whether this publication requested that the publisher's own credential for the entity be published alongside it. Reports what was requested, not what DIAL Core ultimately applied — Core is the authority on that. A publication that predates the field reports `false`.
5449
+ * @type {boolean}
5450
+ * @memberof PublishHistoryEntryDto
5451
+ */
5452
+ publishCredentials: boolean;
5240
5453
  }
5241
5454
  /**
5242
5455
  * @export
@@ -5796,6 +6009,12 @@ export interface ScheduledTaskDto {
5796
6009
  * @memberof ScheduledTaskDto
5797
6010
  */
5798
6011
  prompt?: string;
6012
+ /**
6013
+ *
6014
+ * @type {string}
6015
+ * @memberof ScheduledTaskDto
6016
+ */
6017
+ skillUrl?: string;
5799
6018
  }
5800
6019
  /**
5801
6020
  * @export
@@ -5805,6 +6024,16 @@ export declare const ScheduledTaskDtoTriggerTypeEnum: {
5805
6024
  readonly Date: "date";
5806
6025
  };
5807
6026
  export type ScheduledTaskDtoTriggerTypeEnum = (typeof ScheduledTaskDtoTriggerTypeEnum)[keyof typeof ScheduledTaskDtoTriggerTypeEnum];
6027
+ /**
6028
+ *
6029
+ * @export
6030
+ */
6031
+ export declare const ScheduledTaskErrorCode: {
6032
+ readonly ScheduledTaskSkillUnsupported: "scheduledTaskSkillUnsupported";
6033
+ readonly ScheduledTaskInstructionsOrSkillRequired: "scheduledTaskInstructionsOrSkillRequired";
6034
+ readonly ScheduledTaskDeploymentUnavailable: "scheduledTaskDeploymentUnavailable";
6035
+ };
6036
+ export type ScheduledTaskErrorCode = (typeof ScheduledTaskErrorCode)[keyof typeof ScheduledTaskErrorCode];
5808
6037
  /**
5809
6038
  *
5810
6039
  * @export
@@ -5858,6 +6087,49 @@ export declare const ScheduledTaskRunDtoStatusEnum: {
5858
6087
  readonly Missed: "Missed";
5859
6088
  };
5860
6089
  export type ScheduledTaskRunDtoStatusEnum = (typeof ScheduledTaskRunDtoStatusEnum)[keyof typeof ScheduledTaskRunDtoStatusEnum];
6090
+ /**
6091
+ *
6092
+ * @export
6093
+ * @interface ScheduledTaskValidationErrorDto
6094
+ */
6095
+ export interface ScheduledTaskValidationErrorDto {
6096
+ /**
6097
+ *
6098
+ * @type {number}
6099
+ * @memberof ScheduledTaskValidationErrorDto
6100
+ */
6101
+ statusCode: number;
6102
+ /**
6103
+ *
6104
+ * @type {ScheduledTaskValidationErrorDtoMessage}
6105
+ * @memberof ScheduledTaskValidationErrorDto
6106
+ */
6107
+ message: ScheduledTaskValidationErrorDtoMessage;
6108
+ /**
6109
+ *
6110
+ * @type {string}
6111
+ * @memberof ScheduledTaskValidationErrorDto
6112
+ */
6113
+ error: string;
6114
+ /**
6115
+ *
6116
+ * @type {ScheduledTaskErrorCode}
6117
+ * @memberof ScheduledTaskValidationErrorDto
6118
+ */
6119
+ code?: ScheduledTaskErrorCode;
6120
+ /**
6121
+ *
6122
+ * @type {string}
6123
+ * @memberof ScheduledTaskValidationErrorDto
6124
+ */
6125
+ field?: string;
6126
+ }
6127
+ /**
6128
+ * @type ScheduledTaskValidationErrorDtoMessage
6129
+ *
6130
+ * @export
6131
+ */
6132
+ export type ScheduledTaskValidationErrorDtoMessage = Array<string> | string;
5861
6133
  /**
5862
6134
  *
5863
6135
  * @export
@@ -6314,7 +6586,7 @@ export interface StageDto {
6314
6586
  */
6315
6587
  index?: number;
6316
6588
  /**
6317
- * Stage title
6589
+ * Stage title. `null` on the chunk that opens the stage, before the name streams in
6318
6590
  * @type {string}
6319
6591
  * @memberof StageDto
6320
6592
  */
@@ -6325,6 +6597,18 @@ export interface StageDto {
6325
6597
  * @memberof StageDto
6326
6598
  */
6327
6599
  content?: string;
6600
+ /**
6601
+ * Terminal state of the stage. Absent or `null` while the stage is still running
6602
+ * @type {string}
6603
+ * @memberof StageDto
6604
+ */
6605
+ status?: StageDtoStatusEnum | null;
6606
+ /**
6607
+ * Short source/category label shown beside the stage name (e.g. `MCP`)
6608
+ * @type {string}
6609
+ * @memberof StageDto
6610
+ */
6611
+ tag?: string;
6328
6612
  /**
6329
6613
  * Files produced or referenced by this stage
6330
6614
  * @type {Array<StageAttachmentDto>}
@@ -6332,6 +6616,14 @@ export interface StageDto {
6332
6616
  */
6333
6617
  attachments?: Array<StageAttachmentDto>;
6334
6618
  }
6619
+ /**
6620
+ * @export
6621
+ */
6622
+ export declare const StageDtoStatusEnum: {
6623
+ readonly Completed: "completed";
6624
+ readonly Failed: "failed";
6625
+ };
6626
+ export type StageDtoStatusEnum = (typeof StageDtoStatusEnum)[keyof typeof StageDtoStatusEnum];
6335
6627
  /**
6336
6628
  *
6337
6629
  * @export
@@ -7278,11 +7570,17 @@ export interface UpdateScheduledTaskBodyDto {
7278
7570
  */
7279
7571
  model: string;
7280
7572
  /**
7281
- *
7573
+ * Instructions; may be empty when the effective task has a skill.
7282
7574
  * @type {string}
7283
7575
  * @memberof UpdateScheduledTaskBodyDto
7284
7576
  */
7285
7577
  prompt: string;
7578
+ /**
7579
+ * DIAL skill reference with a path of at most 1024 decoded characters. Omission preserves the saved skill on update; null removes it.
7580
+ * @type {string}
7581
+ * @memberof UpdateScheduledTaskBodyDto
7582
+ */
7583
+ skillUrl?: string | null;
7286
7584
  /**
7287
7585
  *
7288
7586
  * @type {string}
@@ -7418,6 +7716,12 @@ export interface UpdatedScheduledTaskDto {
7418
7716
  * @memberof UpdatedScheduledTaskDto
7419
7717
  */
7420
7718
  prompt?: string;
7719
+ /**
7720
+ *
7721
+ * @type {string}
7722
+ * @memberof UpdatedScheduledTaskDto
7723
+ */
7724
+ skillUrl?: string;
7421
7725
  }
7422
7726
  /**
7423
7727
  * @export