-
Notifications
You must be signed in to change notification settings - Fork 133
Expand file tree
/
Copy pathtypes.ts
More file actions
2653 lines (2650 loc) · 71.2 KB
/
types.ts
File metadata and controls
2653 lines (2650 loc) · 71.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and run json-schema-to-typescript to regenerate this file.
*/
/**
* A discriminated union of all standard JSON-RPC and A2A-specific error types.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "A2AError".
*/
export type A2AError =
| JSONParseError
| InvalidRequestError
| MethodNotFoundError
| InvalidParamsError
| InternalError
| TaskNotFoundError
| TaskNotCancelableError
| PushNotificationNotSupportedError
| UnsupportedOperationError
| ContentTypeNotSupportedError
| InvalidAgentResponseError
| AuthenticatedExtendedCardNotConfiguredError;
/**
* A discriminated union representing all possible JSON-RPC 2.0 requests supported by the A2A specification.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "A2ARequest".
*/
export type A2ARequest =
| SendMessageRequest
| SendStreamingMessageRequest
| GetTaskRequest
| CancelTaskRequest
| SetTaskPushNotificationConfigRequest
| GetTaskPushNotificationConfigRequest
| TaskResubscriptionRequest
| ListTaskPushNotificationConfigRequest
| DeleteTaskPushNotificationConfigRequest
| GetAuthenticatedExtendedCardRequest;
/**
* A discriminated union representing a part of a message or artifact, which can
* be text, a file, or structured data.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "Part".
*/
export type Part = TextPart | FilePart | DataPart;
/**
* Defines a security scheme that can be used to secure an agent's endpoints.
* This is a discriminated union type based on the OpenAPI 3.0 Security Scheme Object.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SecurityScheme".
*/
export type SecurityScheme =
| APIKeySecurityScheme
| HTTPAuthSecurityScheme
| OAuth2SecurityScheme
| OpenIdConnectSecurityScheme
| MutualTLSSecurityScheme;
/**
* Represents a JSON-RPC response for the `tasks/cancel` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "CancelTaskResponse".
*/
export type CancelTaskResponse = JSONRPCErrorResponse | CancelTaskSuccessResponse;
/**
* Represents a JSON-RPC response for the `tasks/pushNotificationConfig/delete` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "DeleteTaskPushNotificationConfigResponse".
*/
export type DeleteTaskPushNotificationConfigResponse =
| JSONRPCErrorResponse
| DeleteTaskPushNotificationConfigSuccessResponse;
/**
* Represents a JSON-RPC response for the `agent/getAuthenticatedExtendedCard` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "GetAuthenticatedExtendedCardResponse".
*/
export type GetAuthenticatedExtendedCardResponse = JSONRPCErrorResponse | GetAuthenticatedExtendedCardSuccessResponse;
/**
* Represents a JSON-RPC response for the `tasks/pushNotificationConfig/get` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "GetTaskPushNotificationConfigResponse".
*/
export type GetTaskPushNotificationConfigResponse = JSONRPCErrorResponse | GetTaskPushNotificationConfigSuccessResponse;
/**
* Represents a JSON-RPC response for the `tasks/get` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "GetTaskResponse".
*/
export type GetTaskResponse = JSONRPCErrorResponse | GetTaskSuccessResponse;
/**
* A discriminated union representing all possible JSON-RPC 2.0 responses
* for the A2A specification methods.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "JSONRPCResponse".
*/
export type JSONRPCResponse =
| JSONRPCErrorResponse
| SendMessageSuccessResponse
| SendStreamingMessageSuccessResponse
| GetTaskSuccessResponse
| CancelTaskSuccessResponse
| SetTaskPushNotificationConfigSuccessResponse
| GetTaskPushNotificationConfigSuccessResponse
| ListTaskPushNotificationConfigSuccessResponse
| DeleteTaskPushNotificationConfigSuccessResponse
| GetAuthenticatedExtendedCardSuccessResponse;
/**
* Represents a JSON-RPC response for the `tasks/pushNotificationConfig/list` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "ListTaskPushNotificationConfigResponse".
*/
export type ListTaskPushNotificationConfigResponse =
| JSONRPCErrorResponse
| ListTaskPushNotificationConfigSuccessResponse;
/**
* Represents a JSON-RPC response for the `message/send` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SendMessageResponse".
*/
export type SendMessageResponse = JSONRPCErrorResponse | SendMessageSuccessResponse;
/**
* Represents a JSON-RPC response for the `message/stream` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SendStreamingMessageResponse".
*/
export type SendStreamingMessageResponse = JSONRPCErrorResponse | SendStreamingMessageSuccessResponse;
/**
* Represents a JSON-RPC response for the `tasks/pushNotificationConfig/set` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SetTaskPushNotificationConfigResponse".
*/
export type SetTaskPushNotificationConfigResponse = JSONRPCErrorResponse | SetTaskPushNotificationConfigSuccessResponse;
/**
* Defines the lifecycle states of a Task.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TaskState".
*/
export type TaskState =
| "submitted"
| "working"
| "input-required"
| "completed"
| "canceled"
| "failed"
| "rejected"
| "auth-required"
| "unknown";
/**
* Supported A2A transport protocols.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TransportProtocol".
*/
export type TransportProtocol = "JSONRPC" | "GRPC" | "HTTP+JSON";
export interface MySchema {
[k: string]: unknown;
}
/**
* An error indicating that the server received invalid JSON.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "JSONParseError".
*/
export interface JSONParseError {
/**
* The error code for a JSON parse error.
*/
code: -32700;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An error indicating that the JSON sent is not a valid Request object.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "InvalidRequestError".
*/
export interface InvalidRequestError {
/**
* The error code for an invalid request.
*/
code: -32600;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An error indicating that the requested method does not exist or is not available.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "MethodNotFoundError".
*/
export interface MethodNotFoundError {
/**
* The error code for a method not found error.
*/
code: -32601;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An error indicating that the method parameters are invalid.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "InvalidParamsError".
*/
export interface InvalidParamsError {
/**
* The error code for an invalid parameters error.
*/
code: -32602;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An error indicating an internal error on the server.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "InternalError".
*/
export interface InternalError {
/**
* The error code for an internal server error.
*/
code: -32603;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating that the requested task ID was not found.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TaskNotFoundError".
*/
export interface TaskNotFoundError {
/**
* The error code for a task not found error.
*/
code: -32001;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating that the task is in a state where it cannot be canceled.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TaskNotCancelableError".
*/
export interface TaskNotCancelableError {
/**
* The error code for a task that cannot be canceled.
*/
code: -32002;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating that the agent does not support push notifications.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "PushNotificationNotSupportedError".
*/
export interface PushNotificationNotSupportedError {
/**
* The error code for when push notifications are not supported.
*/
code: -32003;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating that the requested operation is not supported by the agent.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "UnsupportedOperationError".
*/
export interface UnsupportedOperationError {
/**
* The error code for an unsupported operation.
*/
code: -32004;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating an incompatibility between the requested
* content types and the agent's capabilities.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "ContentTypeNotSupportedError".
*/
export interface ContentTypeNotSupportedError {
/**
* The error code for an unsupported content type.
*/
code: -32005;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating that the agent returned a response that
* does not conform to the specification for the current method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "InvalidAgentResponseError".
*/
export interface InvalidAgentResponseError {
/**
* The error code for an invalid agent response.
*/
code: -32006;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* An A2A-specific error indicating that the agent does not have an Authenticated Extended Card configured
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "AuthenticatedExtendedCardNotConfiguredError".
*/
export interface AuthenticatedExtendedCardNotConfiguredError {
/**
* The error code for when an authenticated extended card is not configured.
*/
code: -32007;
/**
* A primitive or structured value containing additional information about the error.
* This may be omitted.
*/
data?: {
[k: string]: unknown;
};
/**
* The error message.
*/
message: string;
}
/**
* Represents a JSON-RPC request for the `message/send` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SendMessageRequest".
*/
export interface SendMessageRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'message/send'.
*/
method: "message/send";
params: MessageSendParams;
}
/**
* The parameters for sending a message.
*/
export interface MessageSendParams {
configuration?: MessageSendConfiguration;
message: Message;
/**
* Optional metadata for extensions.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Optional configuration for the send request.
*/
export interface MessageSendConfiguration {
/**
* A list of output MIME types the client is prepared to accept in the response.
*/
acceptedOutputModes?: string[];
/**
* If true, the client will wait for the task to complete. The server may reject this if the task is long-running.
*/
blocking?: boolean;
/**
* The number of most recent messages from the task's history to retrieve in the response.
*/
historyLength?: number;
pushNotificationConfig?: PushNotificationConfig;
}
/**
* Configuration for the agent to send push notifications for updates after the initial response.
*/
export interface PushNotificationConfig {
authentication?: PushNotificationAuthenticationInfo;
/**
* A unique ID for the push notification configuration, set by the client
* to support multiple notification callbacks.
*/
id?: string;
/**
* A unique token for this task or session to validate incoming push notifications.
*/
token?: string;
/**
* The callback URL where the agent should send push notifications.
*/
url: string;
}
/**
* Optional authentication details for the agent to use when calling the notification URL.
*/
export interface PushNotificationAuthenticationInfo {
/**
* Optional credentials required by the push notification endpoint.
*/
credentials?: string;
/**
* A list of supported authentication schemes (e.g., 'Basic', 'Bearer').
*/
schemes: string[];
}
/**
* The message object being sent to the agent.
*/
export interface Message {
/**
* The context identifier for this message, used to group related interactions.
*/
contextId?: string;
/**
* The URIs of extensions that are relevant to this message.
*/
extensions?: string[];
/**
* The type of this object, used as a discriminator. Always 'message' for a Message.
*/
kind: "message";
/**
* A unique identifier for the message, typically a UUID, generated by the sender.
*/
messageId: string;
/**
* Optional metadata for extensions. The key is an extension-specific identifier.
*/
metadata?: {
[k: string]: unknown;
};
/**
* An array of content parts that form the message body. A message can be
* composed of multiple parts of different types (e.g., text and files).
*/
parts: Part[];
/**
* A list of other task IDs that this message references for additional context.
*/
referenceTaskIds?: string[];
/**
* Identifies the sender of the message. `user` for the client, `agent` for the service.
*/
role: "agent" | "user";
/**
* The identifier of the task this message is part of. Can be omitted for the first message of a new task.
*/
taskId?: string;
}
/**
* Represents a text segment within a message or artifact.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TextPart".
*/
export interface TextPart {
/**
* The type of this part, used as a discriminator. Always 'text'.
*/
kind: "text";
/**
* Optional metadata associated with this part.
*/
metadata?: {
[k: string]: unknown;
};
/**
* The string content of the text part.
*/
text: string;
}
/**
* Represents a file segment within a message or artifact. The file content can be
* provided either directly as bytes or as a URI.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "FilePart".
*/
export interface FilePart {
/**
* The file content, represented as either a URI or as base64-encoded bytes.
*/
file: FileWithBytes | FileWithUri;
/**
* The type of this part, used as a discriminator. Always 'file'.
*/
kind: "file";
/**
* Optional metadata associated with this part.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a file with its content provided directly as a base64-encoded string.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "FileWithBytes".
*/
export interface FileWithBytes {
/**
* The base64-encoded content of the file.
*/
bytes: string;
/**
* The MIME type of the file (e.g., "application/pdf").
*/
mimeType?: string;
/**
* An optional name for the file (e.g., "document.pdf").
*/
name?: string;
}
/**
* Represents a file with its content located at a specific URI.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "FileWithUri".
*/
export interface FileWithUri {
/**
* The MIME type of the file (e.g., "application/pdf").
*/
mimeType?: string;
/**
* An optional name for the file (e.g., "document.pdf").
*/
name?: string;
/**
* A URL pointing to the file's content.
*/
uri: string;
}
/**
* Represents a structured data segment (e.g., JSON) within a message or artifact.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "DataPart".
*/
export interface DataPart {
/**
* The structured data content.
*/
data: {
[k: string]: unknown;
};
/**
* The type of this part, used as a discriminator. Always 'data'.
*/
kind: "data";
/**
* Optional metadata associated with this part.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a JSON-RPC request for the `message/stream` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SendStreamingMessageRequest".
*/
export interface SendStreamingMessageRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'message/stream'.
*/
method: "message/stream";
params: MessageSendParams1;
}
/**
* The parameters for sending a message.
*/
export interface MessageSendParams1 {
configuration?: MessageSendConfiguration;
message: Message;
/**
* Optional metadata for extensions.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a JSON-RPC request for the `tasks/get` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "GetTaskRequest".
*/
export interface GetTaskRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'tasks/get'.
*/
method: "tasks/get";
params: TaskQueryParams;
}
/**
* The parameters for querying a task.
*/
export interface TaskQueryParams {
/**
* The number of most recent messages from the task's history to retrieve.
*/
historyLength?: number;
/**
* The unique identifier of the task.
*/
id: string;
/**
* Optional metadata associated with the request.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a JSON-RPC request for the `tasks/cancel` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "CancelTaskRequest".
*/
export interface CancelTaskRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'tasks/cancel'.
*/
method: "tasks/cancel";
params: TaskIdParams;
}
/**
* The parameters identifying the task to cancel.
*/
export interface TaskIdParams {
/**
* The unique identifier of the task.
*/
id: string;
/**
* Optional metadata associated with the request.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a JSON-RPC request for the `tasks/pushNotificationConfig/set` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "SetTaskPushNotificationConfigRequest".
*/
export interface SetTaskPushNotificationConfigRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'tasks/pushNotificationConfig/set'.
*/
method: "tasks/pushNotificationConfig/set";
params: TaskPushNotificationConfig;
}
/**
* The parameters for setting the push notification configuration.
*/
export interface TaskPushNotificationConfig {
pushNotificationConfig: PushNotificationConfig1;
/**
* The ID of the task.
*/
taskId: string;
}
/**
* The push notification configuration for this task.
*/
export interface PushNotificationConfig1 {
authentication?: PushNotificationAuthenticationInfo;
/**
* A unique ID for the push notification configuration, set by the client
* to support multiple notification callbacks.
*/
id?: string;
/**
* A unique token for this task or session to validate incoming push notifications.
*/
token?: string;
/**
* The callback URL where the agent should send push notifications.
*/
url: string;
}
/**
* Represents a JSON-RPC request for the `tasks/pushNotificationConfig/get` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "GetTaskPushNotificationConfigRequest".
*/
export interface GetTaskPushNotificationConfigRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'tasks/pushNotificationConfig/get'.
*/
method: "tasks/pushNotificationConfig/get";
/**
* The parameters for getting a push notification configuration.
*/
params: TaskIdParams1 | GetTaskPushNotificationConfigParams;
}
/**
* Defines parameters containing a task ID, used for simple task operations.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TaskIdParams".
*/
export interface TaskIdParams1 {
/**
* The unique identifier of the task.
*/
id: string;
/**
* Optional metadata associated with the request.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Defines parameters for fetching a specific push notification configuration for a task.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "GetTaskPushNotificationConfigParams".
*/
export interface GetTaskPushNotificationConfigParams {
/**
* The unique identifier of the task.
*/
id: string;
/**
* Optional metadata associated with the request.
*/
metadata?: {
[k: string]: unknown;
};
/**
* The ID of the push notification configuration to retrieve.
*/
pushNotificationConfigId?: string;
}
/**
* Represents a JSON-RPC request for the `tasks/resubscribe` method, used to resume a streaming connection.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "TaskResubscriptionRequest".
*/
export interface TaskResubscriptionRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'tasks/resubscribe'.
*/
method: "tasks/resubscribe";
params: TaskIdParams2;
}
/**
* Defines parameters containing a task ID, used for simple task operations.
*/
export interface TaskIdParams2 {
/**
* The unique identifier of the task.
*/
id: string;
/**
* Optional metadata associated with the request.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a JSON-RPC request for the `tasks/pushNotificationConfig/list` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "ListTaskPushNotificationConfigRequest".
*/
export interface ListTaskPushNotificationConfigRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".
*/
jsonrpc: "2.0";
/**
* The method name. Must be 'tasks/pushNotificationConfig/list'.
*/
method: "tasks/pushNotificationConfig/list";
params: ListTaskPushNotificationConfigParams;
}
/**
* The parameters identifying the task whose configurations are to be listed.
*/
export interface ListTaskPushNotificationConfigParams {
/**
* The unique identifier of the task.
*/
id: string;
/**
* Optional metadata associated with the request.
*/
metadata?: {
[k: string]: unknown;
};
}
/**
* Represents a JSON-RPC request for the `tasks/pushNotificationConfig/delete` method.
*
* This interface was referenced by `MySchema`'s JSON-Schema
* via the `definition` "DeleteTaskPushNotificationConfigRequest".
*/
export interface DeleteTaskPushNotificationConfigRequest {
/**
* The identifier for this request.
*/
id: string | number;
/**
* The version of the JSON-RPC protocol. MUST be exactly "2.0".