@caitlyn-ai/sdk 0.0.1 → 0.1.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.
Files changed (43) hide show
  1. package/README.md +39 -7
  2. package/dist-browser/sdk/index.mjs +59 -33
  3. package/dist-browser/sdk/index.mjs.map +3 -3
  4. package/dist-cjs/sdk/index.cjs +59 -32
  5. package/dist-cjs/sdk/index.cjs.map +3 -3
  6. package/dist-es/sdk/index.mjs +59 -33
  7. package/dist-es/sdk/index.mjs.map +3 -3
  8. package/dist-types/sdk/index.d.ts +5376 -8
  9. package/package.json +2 -3
  10. package/dist-types/Caitlyn.d.ts +0 -76
  11. package/dist-types/CaitlynClient.d.ts +0 -160
  12. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +0 -29
  13. package/dist-types/auth/httpAuthSchemeProvider.d.ts +0 -81
  14. package/dist-types/commandBuilder.d.ts +0 -18
  15. package/dist-types/commands/CreateDocumentCommand.d.ts +0 -190
  16. package/dist-types/commands/CreateUploadCommand.d.ts +0 -165
  17. package/dist-types/commands/GetAgentVersionCommand.d.ts +0 -177
  18. package/dist-types/commands/ListDocumentsCommand.d.ts +0 -176
  19. package/dist-types/commands/ResumeConversationStreamCommand.d.ts +0 -146
  20. package/dist-types/commands/SendMessageCommand.d.ts +0 -183
  21. package/dist-types/commands/UpdateDraftVersionCommand.d.ts +0 -202
  22. package/dist-types/commands/index.d.ts +0 -7
  23. package/dist-types/endpoint/EndpointParameters.d.ts +0 -32
  24. package/dist-types/endpoint/bdd.d.ts +0 -2
  25. package/dist-types/endpoint/endpointResolver.d.ts +0 -8
  26. package/dist-types/extensionConfiguration.d.ts +0 -8
  27. package/dist-types/index.d.ts +0 -22
  28. package/dist-types/models/CaitlynServiceException.d.ts +0 -15
  29. package/dist-types/models/enums.d.ts +0 -148
  30. package/dist-types/models/errors.d.ts +0 -659
  31. package/dist-types/models/models_0.d.ts +0 -754
  32. package/dist-types/pagination/Interfaces.d.ts +0 -8
  33. package/dist-types/pagination/ListDocumentsPaginator.d.ts +0 -7
  34. package/dist-types/pagination/index.d.ts +0 -2
  35. package/dist-types/runtimeConfig.browser.d.ts +0 -50
  36. package/dist-types/runtimeConfig.d.ts +0 -50
  37. package/dist-types/runtimeConfig.native.d.ts +0 -49
  38. package/dist-types/runtimeConfig.shared.d.ts +0 -36
  39. package/dist-types/runtimeExtensions.d.ts +0 -17
  40. package/dist-types/schemas/schemas_0.d.ts +0 -51
  41. package/dist-types/sdk/client.d.ts +0 -47
  42. package/dist-types/sdk/events.d.ts +0 -163
  43. package/dist-types/sdk/operations.d.ts +0 -70
@@ -1,659 +0,0 @@
1
- import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
2
- import { CaitlynServiceException as __BaseException } from "./CaitlynServiceException";
3
- import type { FieldError } from "./models_0";
4
- /**
5
- * An unexpected server failure. Not retried by the SDKs.
6
- * @public
7
- */
8
- export declare class InternalError extends __BaseException {
9
- static readonly shapeId: string;
10
- readonly name: "InternalError";
11
- readonly $fault: "server";
12
- /**
13
- * A stable URI for the code: its page in the public error reference,
14
- * `https://build.caitlyn.ai/errors/\{code\}`.
15
- * @public
16
- */
17
- type: string;
18
- /**
19
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
20
- * @public
21
- */
22
- title: string;
23
- /**
24
- * The HTTP status code, repeated from the response.
25
- * @public
26
- */
27
- status: number;
28
- /**
29
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
30
- * renamed; callers match on it.
31
- * @public
32
- */
33
- code: string;
34
- /**
35
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
36
- * storage keys or another person's data.
37
- * @public
38
- */
39
- detail?: string | undefined;
40
- /**
41
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
42
- * support.
43
- * @public
44
- */
45
- requestId: string;
46
- /**
47
- * Field-level problems, one per member or parameter at fault. Present only on 400
48
- * `VALIDATION_FAILED`.
49
- * @public
50
- */
51
- errors?: FieldError[] | undefined;
52
- /**
53
- * @internal
54
- */
55
- constructor(opts: __ExceptionOptionType<InternalError, __BaseException>);
56
- }
57
- /**
58
- * The record does not exist, or the caller may not see it. The two are deliberately the same, so
59
- * identifiers cannot be probed.
60
- * @public
61
- */
62
- export declare class NotFoundError extends __BaseException {
63
- static readonly shapeId: string;
64
- readonly name: "NotFoundError";
65
- readonly $fault: "client";
66
- /**
67
- * A stable URI for the code: its page in the public error reference,
68
- * `https://build.caitlyn.ai/errors/\{code\}`.
69
- * @public
70
- */
71
- type: string;
72
- /**
73
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
74
- * @public
75
- */
76
- title: string;
77
- /**
78
- * The HTTP status code, repeated from the response.
79
- * @public
80
- */
81
- status: number;
82
- /**
83
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
84
- * renamed; callers match on it.
85
- * @public
86
- */
87
- code: string;
88
- /**
89
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
90
- * storage keys or another person's data.
91
- * @public
92
- */
93
- detail?: string | undefined;
94
- /**
95
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
96
- * support.
97
- * @public
98
- */
99
- requestId: string;
100
- /**
101
- * Field-level problems, one per member or parameter at fault. Present only on 400
102
- * `VALIDATION_FAILED`.
103
- * @public
104
- */
105
- errors?: FieldError[] | undefined;
106
- /**
107
- * @internal
108
- */
109
- constructor(opts: __ExceptionOptionType<NotFoundError, __BaseException>);
110
- }
111
- /**
112
- * The caller may not call this operation: it lacks the permission, its credential type may not
113
- * call it, or the operation is served only on the organisation's primary workspace. Decided before
114
- * any record is read. A record the caller may not see is 404 instead.
115
- * @public
116
- */
117
- export declare class PermissionDeniedError extends __BaseException {
118
- static readonly shapeId: string;
119
- readonly name: "PermissionDeniedError";
120
- readonly $fault: "client";
121
- /**
122
- * A stable URI for the code: its page in the public error reference,
123
- * `https://build.caitlyn.ai/errors/\{code\}`.
124
- * @public
125
- */
126
- type: string;
127
- /**
128
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
129
- * @public
130
- */
131
- title: string;
132
- /**
133
- * The HTTP status code, repeated from the response.
134
- * @public
135
- */
136
- status: number;
137
- /**
138
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
139
- * renamed; callers match on it.
140
- * @public
141
- */
142
- code: string;
143
- /**
144
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
145
- * storage keys or another person's data.
146
- * @public
147
- */
148
- detail?: string | undefined;
149
- /**
150
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
151
- * support.
152
- * @public
153
- */
154
- requestId: string;
155
- /**
156
- * Field-level problems, one per member or parameter at fault. Present only on 400
157
- * `VALIDATION_FAILED`.
158
- * @public
159
- */
160
- errors?: FieldError[] | undefined;
161
- /**
162
- * @internal
163
- */
164
- constructor(opts: __ExceptionOptionType<PermissionDeniedError, __BaseException>);
165
- }
166
- /**
167
- * `If-Match` does not match the resource's current ETag: it changed since the caller read it.
168
- * @public
169
- */
170
- export declare class PreconditionFailedError extends __BaseException {
171
- static readonly shapeId: string;
172
- readonly name: "PreconditionFailedError";
173
- readonly $fault: "client";
174
- /**
175
- * A stable URI for the code: its page in the public error reference,
176
- * `https://build.caitlyn.ai/errors/\{code\}`.
177
- * @public
178
- */
179
- type: string;
180
- /**
181
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
182
- * @public
183
- */
184
- title: string;
185
- /**
186
- * The HTTP status code, repeated from the response.
187
- * @public
188
- */
189
- status: number;
190
- /**
191
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
192
- * renamed; callers match on it.
193
- * @public
194
- */
195
- code: string;
196
- /**
197
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
198
- * storage keys or another person's data.
199
- * @public
200
- */
201
- detail?: string | undefined;
202
- /**
203
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
204
- * support.
205
- * @public
206
- */
207
- requestId: string;
208
- /**
209
- * Field-level problems, one per member or parameter at fault. Present only on 400
210
- * `VALIDATION_FAILED`.
211
- * @public
212
- */
213
- errors?: FieldError[] | undefined;
214
- /**
215
- * @internal
216
- */
217
- constructor(opts: __ExceptionOptionType<PreconditionFailedError, __BaseException>);
218
- }
219
- /**
220
- * The update sent no `If-Match` header; read the resource and send its ETag.
221
- * @public
222
- */
223
- export declare class PreconditionRequiredError extends __BaseException {
224
- static readonly shapeId: string;
225
- readonly name: "PreconditionRequiredError";
226
- readonly $fault: "client";
227
- /**
228
- * A stable URI for the code: its page in the public error reference,
229
- * `https://build.caitlyn.ai/errors/\{code\}`.
230
- * @public
231
- */
232
- type: string;
233
- /**
234
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
235
- * @public
236
- */
237
- title: string;
238
- /**
239
- * The HTTP status code, repeated from the response.
240
- * @public
241
- */
242
- status: number;
243
- /**
244
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
245
- * renamed; callers match on it.
246
- * @public
247
- */
248
- code: string;
249
- /**
250
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
251
- * storage keys or another person's data.
252
- * @public
253
- */
254
- detail?: string | undefined;
255
- /**
256
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
257
- * support.
258
- * @public
259
- */
260
- requestId: string;
261
- /**
262
- * Field-level problems, one per member or parameter at fault. Present only on 400
263
- * `VALIDATION_FAILED`.
264
- * @public
265
- */
266
- errors?: FieldError[] | undefined;
267
- /**
268
- * @internal
269
- */
270
- constructor(opts: __ExceptionOptionType<PreconditionRequiredError, __BaseException>);
271
- }
272
- /**
273
- * A dependency is briefly unavailable, or the request's audit event could not be recorded; wait for
274
- * `Retry-After` and try again.
275
- * @public
276
- */
277
- export declare class ServiceUnavailableError extends __BaseException {
278
- static readonly shapeId: string;
279
- readonly name: "ServiceUnavailableError";
280
- readonly $fault: "server";
281
- $retryable: {};
282
- /**
283
- * A stable URI for the code: its page in the public error reference,
284
- * `https://build.caitlyn.ai/errors/\{code\}`.
285
- * @public
286
- */
287
- type: string;
288
- /**
289
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
290
- * @public
291
- */
292
- title: string;
293
- /**
294
- * The HTTP status code, repeated from the response.
295
- * @public
296
- */
297
- status: number;
298
- /**
299
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
300
- * renamed; callers match on it.
301
- * @public
302
- */
303
- code: string;
304
- /**
305
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
306
- * storage keys or another person's data.
307
- * @public
308
- */
309
- detail?: string | undefined;
310
- /**
311
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
312
- * support.
313
- * @public
314
- */
315
- requestId: string;
316
- /**
317
- * Field-level problems, one per member or parameter at fault. Present only on 400
318
- * `VALIDATION_FAILED`.
319
- * @public
320
- */
321
- errors?: FieldError[] | undefined;
322
- /**
323
- * Seconds to wait before trying again, from the `Retry-After` header.
324
- * @public
325
- */
326
- retryAfterSeconds?: number | undefined;
327
- /**
328
- * @internal
329
- */
330
- constructor(opts: __ExceptionOptionType<ServiceUnavailableError, __BaseException>);
331
- }
332
- /**
333
- * Too many requests; wait for `Retry-After` and try again.
334
- * @public
335
- */
336
- export declare class TooManyRequestsError extends __BaseException {
337
- static readonly shapeId: string;
338
- readonly name: "TooManyRequestsError";
339
- readonly $fault: "client";
340
- $retryable: {
341
- throttling: boolean;
342
- };
343
- /**
344
- * A stable URI for the code: its page in the public error reference,
345
- * `https://build.caitlyn.ai/errors/\{code\}`.
346
- * @public
347
- */
348
- type: string;
349
- /**
350
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
351
- * @public
352
- */
353
- title: string;
354
- /**
355
- * The HTTP status code, repeated from the response.
356
- * @public
357
- */
358
- status: number;
359
- /**
360
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
361
- * renamed; callers match on it.
362
- * @public
363
- */
364
- code: string;
365
- /**
366
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
367
- * storage keys or another person's data.
368
- * @public
369
- */
370
- detail?: string | undefined;
371
- /**
372
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
373
- * support.
374
- * @public
375
- */
376
- requestId: string;
377
- /**
378
- * Field-level problems, one per member or parameter at fault. Present only on 400
379
- * `VALIDATION_FAILED`.
380
- * @public
381
- */
382
- errors?: FieldError[] | undefined;
383
- /**
384
- * Seconds to wait before trying again, from the `Retry-After` header.
385
- * @public
386
- */
387
- retryAfterSeconds?: number | undefined;
388
- /**
389
- * @internal
390
- */
391
- constructor(opts: __ExceptionOptionType<TooManyRequestsError, __BaseException>);
392
- }
393
- /**
394
- * No credential was sent, or it is expired or not valid.
395
- * @public
396
- */
397
- export declare class UnauthenticatedError extends __BaseException {
398
- static readonly shapeId: string;
399
- readonly name: "UnauthenticatedError";
400
- readonly $fault: "client";
401
- /**
402
- * A stable URI for the code: its page in the public error reference,
403
- * `https://build.caitlyn.ai/errors/\{code\}`.
404
- * @public
405
- */
406
- type: string;
407
- /**
408
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
409
- * @public
410
- */
411
- title: string;
412
- /**
413
- * The HTTP status code, repeated from the response.
414
- * @public
415
- */
416
- status: number;
417
- /**
418
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
419
- * renamed; callers match on it.
420
- * @public
421
- */
422
- code: string;
423
- /**
424
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
425
- * storage keys or another person's data.
426
- * @public
427
- */
428
- detail?: string | undefined;
429
- /**
430
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
431
- * support.
432
- * @public
433
- */
434
- requestId: string;
435
- /**
436
- * Field-level problems, one per member or parameter at fault. Present only on 400
437
- * `VALIDATION_FAILED`.
438
- * @public
439
- */
440
- errors?: FieldError[] | undefined;
441
- /**
442
- * @internal
443
- */
444
- constructor(opts: __ExceptionOptionType<UnauthenticatedError, __BaseException>);
445
- }
446
- /**
447
- * The request is malformed: a member is missing, the wrong type or out of range; it has a member,
448
- * filter or sort field the operation does not define; or its cursor is not valid for this list.
449
- * @public
450
- */
451
- export declare class ValidationError extends __BaseException {
452
- static readonly shapeId: string;
453
- readonly name: "ValidationError";
454
- readonly $fault: "client";
455
- /**
456
- * A stable URI for the code: its page in the public error reference,
457
- * `https://build.caitlyn.ai/errors/\{code\}`.
458
- * @public
459
- */
460
- type: string;
461
- /**
462
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
463
- * @public
464
- */
465
- title: string;
466
- /**
467
- * The HTTP status code, repeated from the response.
468
- * @public
469
- */
470
- status: number;
471
- /**
472
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
473
- * renamed; callers match on it.
474
- * @public
475
- */
476
- code: string;
477
- /**
478
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
479
- * storage keys or another person's data.
480
- * @public
481
- */
482
- detail?: string | undefined;
483
- /**
484
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
485
- * support.
486
- * @public
487
- */
488
- requestId: string;
489
- /**
490
- * Field-level problems, one per member or parameter at fault. Present only on 400
491
- * `VALIDATION_FAILED`.
492
- * @public
493
- */
494
- errors?: FieldError[] | undefined;
495
- /**
496
- * @internal
497
- */
498
- constructor(opts: __ExceptionOptionType<ValidationError, __BaseException>);
499
- }
500
- /**
501
- * The resource's state does not allow the request, a unique name is taken, or a request with the
502
- * same idempotency key is still in progress.
503
- * @public
504
- */
505
- export declare class ConflictError extends __BaseException {
506
- static readonly shapeId: string;
507
- readonly name: "ConflictError";
508
- readonly $fault: "client";
509
- /**
510
- * A stable URI for the code: its page in the public error reference,
511
- * `https://build.caitlyn.ai/errors/\{code\}`.
512
- * @public
513
- */
514
- type: string;
515
- /**
516
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
517
- * @public
518
- */
519
- title: string;
520
- /**
521
- * The HTTP status code, repeated from the response.
522
- * @public
523
- */
524
- status: number;
525
- /**
526
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
527
- * renamed; callers match on it.
528
- * @public
529
- */
530
- code: string;
531
- /**
532
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
533
- * storage keys or another person's data.
534
- * @public
535
- */
536
- detail?: string | undefined;
537
- /**
538
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
539
- * support.
540
- * @public
541
- */
542
- requestId: string;
543
- /**
544
- * Field-level problems, one per member or parameter at fault. Present only on 400
545
- * `VALIDATION_FAILED`.
546
- * @public
547
- */
548
- errors?: FieldError[] | undefined;
549
- /**
550
- * @internal
551
- */
552
- constructor(opts: __ExceptionOptionType<ConflictError, __BaseException>);
553
- }
554
- /**
555
- * The body, a file or the send `context` is over its documented limit.
556
- * @public
557
- */
558
- export declare class PayloadTooLargeError extends __BaseException {
559
- static readonly shapeId: string;
560
- readonly name: "PayloadTooLargeError";
561
- readonly $fault: "client";
562
- /**
563
- * A stable URI for the code: its page in the public error reference,
564
- * `https://build.caitlyn.ai/errors/\{code\}`.
565
- * @public
566
- */
567
- type: string;
568
- /**
569
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
570
- * @public
571
- */
572
- title: string;
573
- /**
574
- * The HTTP status code, repeated from the response.
575
- * @public
576
- */
577
- status: number;
578
- /**
579
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
580
- * renamed; callers match on it.
581
- * @public
582
- */
583
- code: string;
584
- /**
585
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
586
- * storage keys or another person's data.
587
- * @public
588
- */
589
- detail?: string | undefined;
590
- /**
591
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
592
- * support.
593
- * @public
594
- */
595
- requestId: string;
596
- /**
597
- * Field-level problems, one per member or parameter at fault. Present only on 400
598
- * `VALIDATION_FAILED`.
599
- * @public
600
- */
601
- errors?: FieldError[] | undefined;
602
- /**
603
- * @internal
604
- */
605
- constructor(opts: __ExceptionOptionType<PayloadTooLargeError, __BaseException>);
606
- }
607
- /**
608
- * The idempotency key was already used with a different request body.
609
- * @public
610
- */
611
- export declare class UnprocessableContentError extends __BaseException {
612
- static readonly shapeId: string;
613
- readonly name: "UnprocessableContentError";
614
- readonly $fault: "client";
615
- /**
616
- * A stable URI for the code: its page in the public error reference,
617
- * `https://build.caitlyn.ai/errors/\{code\}`.
618
- * @public
619
- */
620
- type: string;
621
- /**
622
- * A short, human-readable summary of the problem, the same for every occurrence of the code.
623
- * @public
624
- */
625
- title: string;
626
- /**
627
- * The HTTP status code, repeated from the response.
628
- * @public
629
- */
630
- status: number;
631
- /**
632
- * The stable code, for example `NOT_FOUND`. Once shipped a code keeps its meaning and is never
633
- * renamed; callers match on it.
634
- * @public
635
- */
636
- code: string;
637
- /**
638
- * What went wrong in this occurrence, written for the integrator. Never holds stack traces,
639
- * storage keys or another person's data.
640
- * @public
641
- */
642
- detail?: string | undefined;
643
- /**
644
- * The request's identifier, the same value as the `Caitlyn-Request-Id` header. Quote it to
645
- * support.
646
- * @public
647
- */
648
- requestId: string;
649
- /**
650
- * Field-level problems, one per member or parameter at fault. Present only on 400
651
- * `VALIDATION_FAILED`.
652
- * @public
653
- */
654
- errors?: FieldError[] | undefined;
655
- /**
656
- * @internal
657
- */
658
- constructor(opts: __ExceptionOptionType<UnprocessableContentError, __BaseException>);
659
- }