@operla-ai/sdk 0.2.0 → 0.3.1

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.
package/dist/index.d.ts CHANGED
@@ -23,7 +23,7 @@
23
23
  * `undefined` in the TS view.
24
24
  */
25
25
  import { type Client } from "./generated/client";
26
- import { Conversations, Entities, Organizations } from "./generated/sdk.gen";
26
+ import { Agents, Conversations, Entities, Kb, Organizations } from "./generated/sdk.gen";
27
27
  type OptionsOf<M extends (...args: never) => unknown> = NonNullable<Parameters<M>[0]>;
28
28
  type BodyOf<M extends (...args: never) => unknown> = OptionsOf<M> extends {
29
29
  body?: infer B;
@@ -42,6 +42,575 @@ export interface OperlaClientConfig {
42
42
  */
43
43
  organizationId?: string;
44
44
  }
45
+ declare class AgentsResource {
46
+ private readonly client;
47
+ constructor(client: Client);
48
+ list(query?: QueryOf<typeof Agents.list>): Promise<{
49
+ agents: Array<{
50
+ name: string;
51
+ label: string;
52
+ scope: {
53
+ level: "global" | "organization" | "entity";
54
+ organizationId?: string;
55
+ entityId?: string;
56
+ };
57
+ version: number;
58
+ hasDraft: boolean;
59
+ }>;
60
+ }>;
61
+ get(name: string, query?: QueryOf<typeof Agents.get>): Promise<{
62
+ name: string;
63
+ label: string;
64
+ scope: {
65
+ level: "global" | "organization" | "entity";
66
+ organizationId?: string;
67
+ entityId?: string;
68
+ };
69
+ resolved: {
70
+ version: number;
71
+ prompt?: string;
72
+ hardRules?: Array<{
73
+ name: string;
74
+ instruction: string;
75
+ triggers?: {
76
+ intents?: Array<string>;
77
+ };
78
+ priority?: number;
79
+ disabled?: boolean;
80
+ }>;
81
+ userContextConfig?: {
82
+ [key: string]: boolean;
83
+ };
84
+ responseConfig?: {
85
+ email?: {
86
+ greeting?: string;
87
+ signature?: string;
88
+ tone?: "empathetic" | "formal" | "friendly";
89
+ addressForm?: "formal" | "informal";
90
+ allowEmojis?: boolean;
91
+ };
92
+ chat?: {
93
+ greeting?: string;
94
+ signature?: string;
95
+ tone?: "empathetic" | "formal" | "friendly";
96
+ addressForm?: "formal" | "informal";
97
+ allowEmojis?: boolean;
98
+ };
99
+ };
100
+ message?: string;
101
+ publishedAt?: string;
102
+ updatedAt?: string;
103
+ };
104
+ draft?: {
105
+ version: number;
106
+ prompt?: string;
107
+ hardRules?: Array<{
108
+ name: string;
109
+ instruction: string;
110
+ triggers?: {
111
+ intents?: Array<string>;
112
+ };
113
+ priority?: number;
114
+ disabled?: boolean;
115
+ }>;
116
+ userContextConfig?: {
117
+ [key: string]: boolean;
118
+ };
119
+ responseConfig?: {
120
+ email?: {
121
+ greeting?: string;
122
+ signature?: string;
123
+ tone?: "empathetic" | "formal" | "friendly";
124
+ addressForm?: "formal" | "informal";
125
+ allowEmojis?: boolean;
126
+ };
127
+ chat?: {
128
+ greeting?: string;
129
+ signature?: string;
130
+ tone?: "empathetic" | "formal" | "friendly";
131
+ addressForm?: "formal" | "informal";
132
+ allowEmojis?: boolean;
133
+ };
134
+ };
135
+ message?: string;
136
+ publishedAt?: string;
137
+ updatedAt?: string;
138
+ };
139
+ }>;
140
+ update(name: string, body: BodyOf<typeof Agents.update>, query?: QueryOf<typeof Agents.update>): Promise<{
141
+ name: string;
142
+ label: string;
143
+ scope: {
144
+ level: "global" | "organization" | "entity";
145
+ organizationId?: string;
146
+ entityId?: string;
147
+ };
148
+ resolved: {
149
+ version: number;
150
+ prompt?: string;
151
+ hardRules?: Array<{
152
+ name: string;
153
+ instruction: string;
154
+ triggers?: {
155
+ intents?: Array<string>;
156
+ };
157
+ priority?: number;
158
+ disabled?: boolean;
159
+ }>;
160
+ userContextConfig?: {
161
+ [key: string]: boolean;
162
+ };
163
+ responseConfig?: {
164
+ email?: {
165
+ greeting?: string;
166
+ signature?: string;
167
+ tone?: "empathetic" | "formal" | "friendly";
168
+ addressForm?: "formal" | "informal";
169
+ allowEmojis?: boolean;
170
+ };
171
+ chat?: {
172
+ greeting?: string;
173
+ signature?: string;
174
+ tone?: "empathetic" | "formal" | "friendly";
175
+ addressForm?: "formal" | "informal";
176
+ allowEmojis?: boolean;
177
+ };
178
+ };
179
+ message?: string;
180
+ publishedAt?: string;
181
+ updatedAt?: string;
182
+ };
183
+ draft?: {
184
+ version: number;
185
+ prompt?: string;
186
+ hardRules?: Array<{
187
+ name: string;
188
+ instruction: string;
189
+ triggers?: {
190
+ intents?: Array<string>;
191
+ };
192
+ priority?: number;
193
+ disabled?: boolean;
194
+ }>;
195
+ userContextConfig?: {
196
+ [key: string]: boolean;
197
+ };
198
+ responseConfig?: {
199
+ email?: {
200
+ greeting?: string;
201
+ signature?: string;
202
+ tone?: "empathetic" | "formal" | "friendly";
203
+ addressForm?: "formal" | "informal";
204
+ allowEmojis?: boolean;
205
+ };
206
+ chat?: {
207
+ greeting?: string;
208
+ signature?: string;
209
+ tone?: "empathetic" | "formal" | "friendly";
210
+ addressForm?: "formal" | "informal";
211
+ allowEmojis?: boolean;
212
+ };
213
+ };
214
+ message?: string;
215
+ publishedAt?: string;
216
+ updatedAt?: string;
217
+ };
218
+ }>;
219
+ create(body: BodyOf<typeof Agents.create>): Promise<{
220
+ name: string;
221
+ label: string;
222
+ scope: {
223
+ level: "global" | "organization" | "entity";
224
+ organizationId?: string;
225
+ entityId?: string;
226
+ };
227
+ resolved: {
228
+ version: number;
229
+ prompt?: string;
230
+ hardRules?: Array<{
231
+ name: string;
232
+ instruction: string;
233
+ triggers?: {
234
+ intents?: Array<string>;
235
+ };
236
+ priority?: number;
237
+ disabled?: boolean;
238
+ }>;
239
+ userContextConfig?: {
240
+ [key: string]: boolean;
241
+ };
242
+ responseConfig?: {
243
+ email?: {
244
+ greeting?: string;
245
+ signature?: string;
246
+ tone?: "empathetic" | "formal" | "friendly";
247
+ addressForm?: "formal" | "informal";
248
+ allowEmojis?: boolean;
249
+ };
250
+ chat?: {
251
+ greeting?: string;
252
+ signature?: string;
253
+ tone?: "empathetic" | "formal" | "friendly";
254
+ addressForm?: "formal" | "informal";
255
+ allowEmojis?: boolean;
256
+ };
257
+ };
258
+ message?: string;
259
+ publishedAt?: string;
260
+ updatedAt?: string;
261
+ };
262
+ draft?: {
263
+ version: number;
264
+ prompt?: string;
265
+ hardRules?: Array<{
266
+ name: string;
267
+ instruction: string;
268
+ triggers?: {
269
+ intents?: Array<string>;
270
+ };
271
+ priority?: number;
272
+ disabled?: boolean;
273
+ }>;
274
+ userContextConfig?: {
275
+ [key: string]: boolean;
276
+ };
277
+ responseConfig?: {
278
+ email?: {
279
+ greeting?: string;
280
+ signature?: string;
281
+ tone?: "empathetic" | "formal" | "friendly";
282
+ addressForm?: "formal" | "informal";
283
+ allowEmojis?: boolean;
284
+ };
285
+ chat?: {
286
+ greeting?: string;
287
+ signature?: string;
288
+ tone?: "empathetic" | "formal" | "friendly";
289
+ addressForm?: "formal" | "informal";
290
+ allowEmojis?: boolean;
291
+ };
292
+ };
293
+ message?: string;
294
+ publishedAt?: string;
295
+ updatedAt?: string;
296
+ };
297
+ }>;
298
+ delete(name: string): Promise<{
299
+ message: string;
300
+ }>;
301
+ deleteOverride(name: string, query?: QueryOf<typeof Agents.deleteOverride>): Promise<{
302
+ message: string;
303
+ }>;
304
+ publish(name: string, body?: BodyOf<typeof Agents.publish>, query?: QueryOf<typeof Agents.publish>): Promise<{
305
+ name: string;
306
+ label: string;
307
+ scope: {
308
+ level: "global" | "organization" | "entity";
309
+ organizationId?: string;
310
+ entityId?: string;
311
+ };
312
+ resolved: {
313
+ version: number;
314
+ prompt?: string;
315
+ hardRules?: Array<{
316
+ name: string;
317
+ instruction: string;
318
+ triggers?: {
319
+ intents?: Array<string>;
320
+ };
321
+ priority?: number;
322
+ disabled?: boolean;
323
+ }>;
324
+ userContextConfig?: {
325
+ [key: string]: boolean;
326
+ };
327
+ responseConfig?: {
328
+ email?: {
329
+ greeting?: string;
330
+ signature?: string;
331
+ tone?: "empathetic" | "formal" | "friendly";
332
+ addressForm?: "formal" | "informal";
333
+ allowEmojis?: boolean;
334
+ };
335
+ chat?: {
336
+ greeting?: string;
337
+ signature?: string;
338
+ tone?: "empathetic" | "formal" | "friendly";
339
+ addressForm?: "formal" | "informal";
340
+ allowEmojis?: boolean;
341
+ };
342
+ };
343
+ message?: string;
344
+ publishedAt?: string;
345
+ updatedAt?: string;
346
+ };
347
+ draft?: {
348
+ version: number;
349
+ prompt?: string;
350
+ hardRules?: Array<{
351
+ name: string;
352
+ instruction: string;
353
+ triggers?: {
354
+ intents?: Array<string>;
355
+ };
356
+ priority?: number;
357
+ disabled?: boolean;
358
+ }>;
359
+ userContextConfig?: {
360
+ [key: string]: boolean;
361
+ };
362
+ responseConfig?: {
363
+ email?: {
364
+ greeting?: string;
365
+ signature?: string;
366
+ tone?: "empathetic" | "formal" | "friendly";
367
+ addressForm?: "formal" | "informal";
368
+ allowEmojis?: boolean;
369
+ };
370
+ chat?: {
371
+ greeting?: string;
372
+ signature?: string;
373
+ tone?: "empathetic" | "formal" | "friendly";
374
+ addressForm?: "formal" | "informal";
375
+ allowEmojis?: boolean;
376
+ };
377
+ };
378
+ message?: string;
379
+ publishedAt?: string;
380
+ updatedAt?: string;
381
+ };
382
+ }>;
383
+ rollback(name: string, body: BodyOf<typeof Agents.rollback>, query?: QueryOf<typeof Agents.rollback>): Promise<{
384
+ name: string;
385
+ label: string;
386
+ scope: {
387
+ level: "global" | "organization" | "entity";
388
+ organizationId?: string;
389
+ entityId?: string;
390
+ };
391
+ resolved: {
392
+ version: number;
393
+ prompt?: string;
394
+ hardRules?: Array<{
395
+ name: string;
396
+ instruction: string;
397
+ triggers?: {
398
+ intents?: Array<string>;
399
+ };
400
+ priority?: number;
401
+ disabled?: boolean;
402
+ }>;
403
+ userContextConfig?: {
404
+ [key: string]: boolean;
405
+ };
406
+ responseConfig?: {
407
+ email?: {
408
+ greeting?: string;
409
+ signature?: string;
410
+ tone?: "empathetic" | "formal" | "friendly";
411
+ addressForm?: "formal" | "informal";
412
+ allowEmojis?: boolean;
413
+ };
414
+ chat?: {
415
+ greeting?: string;
416
+ signature?: string;
417
+ tone?: "empathetic" | "formal" | "friendly";
418
+ addressForm?: "formal" | "informal";
419
+ allowEmojis?: boolean;
420
+ };
421
+ };
422
+ message?: string;
423
+ publishedAt?: string;
424
+ updatedAt?: string;
425
+ };
426
+ draft?: {
427
+ version: number;
428
+ prompt?: string;
429
+ hardRules?: Array<{
430
+ name: string;
431
+ instruction: string;
432
+ triggers?: {
433
+ intents?: Array<string>;
434
+ };
435
+ priority?: number;
436
+ disabled?: boolean;
437
+ }>;
438
+ userContextConfig?: {
439
+ [key: string]: boolean;
440
+ };
441
+ responseConfig?: {
442
+ email?: {
443
+ greeting?: string;
444
+ signature?: string;
445
+ tone?: "empathetic" | "formal" | "friendly";
446
+ addressForm?: "formal" | "informal";
447
+ allowEmojis?: boolean;
448
+ };
449
+ chat?: {
450
+ greeting?: string;
451
+ signature?: string;
452
+ tone?: "empathetic" | "formal" | "friendly";
453
+ addressForm?: "formal" | "informal";
454
+ allowEmojis?: boolean;
455
+ };
456
+ };
457
+ message?: string;
458
+ publishedAt?: string;
459
+ updatedAt?: string;
460
+ };
461
+ }>;
462
+ }
463
+ declare class KbResource {
464
+ private readonly client;
465
+ constructor(client: Client);
466
+ list(query?: QueryOf<typeof Kb.list>): Promise<{
467
+ articles: Array<{
468
+ id: string;
469
+ title: string;
470
+ intents: Array<string>;
471
+ scope: {
472
+ level: "global" | "organization" | "entity";
473
+ organizationId?: string;
474
+ entityId?: string;
475
+ };
476
+ version: number;
477
+ hasDraft: boolean;
478
+ publishedAt?: string;
479
+ updatedAt: string;
480
+ }>;
481
+ total: number;
482
+ limit: number;
483
+ offset: number;
484
+ }>;
485
+ get(id: string): Promise<{
486
+ id: string;
487
+ scope: {
488
+ level: "global" | "organization" | "entity";
489
+ organizationId?: string;
490
+ entityId?: string;
491
+ };
492
+ intents: Array<string>;
493
+ published: {
494
+ version: number;
495
+ title: string;
496
+ content: string;
497
+ publishedAt?: string;
498
+ updatedAt?: string;
499
+ };
500
+ draft?: {
501
+ version: number;
502
+ title: string;
503
+ content: string;
504
+ publishedAt?: string;
505
+ updatedAt?: string;
506
+ };
507
+ createdAt: string;
508
+ updatedAt: string;
509
+ }>;
510
+ create(body: BodyOf<typeof Kb.create>, query?: QueryOf<typeof Kb.create>): Promise<{
511
+ id: string;
512
+ scope: {
513
+ level: "global" | "organization" | "entity";
514
+ organizationId?: string;
515
+ entityId?: string;
516
+ };
517
+ intents: Array<string>;
518
+ published: {
519
+ version: number;
520
+ title: string;
521
+ content: string;
522
+ publishedAt?: string;
523
+ updatedAt?: string;
524
+ };
525
+ draft?: {
526
+ version: number;
527
+ title: string;
528
+ content: string;
529
+ publishedAt?: string;
530
+ updatedAt?: string;
531
+ };
532
+ createdAt: string;
533
+ updatedAt: string;
534
+ }>;
535
+ update(id: string, body: BodyOf<typeof Kb.update>): Promise<{
536
+ id: string;
537
+ scope: {
538
+ level: "global" | "organization" | "entity";
539
+ organizationId?: string;
540
+ entityId?: string;
541
+ };
542
+ intents: Array<string>;
543
+ published: {
544
+ version: number;
545
+ title: string;
546
+ content: string;
547
+ publishedAt?: string;
548
+ updatedAt?: string;
549
+ };
550
+ draft?: {
551
+ version: number;
552
+ title: string;
553
+ content: string;
554
+ publishedAt?: string;
555
+ updatedAt?: string;
556
+ };
557
+ createdAt: string;
558
+ updatedAt: string;
559
+ }>;
560
+ delete(id: string): Promise<{
561
+ message: string;
562
+ }>;
563
+ publish(id: string): Promise<{
564
+ id: string;
565
+ scope: {
566
+ level: "global" | "organization" | "entity";
567
+ organizationId?: string;
568
+ entityId?: string;
569
+ };
570
+ intents: Array<string>;
571
+ published: {
572
+ version: number;
573
+ title: string;
574
+ content: string;
575
+ publishedAt?: string;
576
+ updatedAt?: string;
577
+ };
578
+ draft?: {
579
+ version: number;
580
+ title: string;
581
+ content: string;
582
+ publishedAt?: string;
583
+ updatedAt?: string;
584
+ };
585
+ createdAt: string;
586
+ updatedAt: string;
587
+ }>;
588
+ rollback(id: string, body: BodyOf<typeof Kb.rollback>): Promise<{
589
+ id: string;
590
+ scope: {
591
+ level: "global" | "organization" | "entity";
592
+ organizationId?: string;
593
+ entityId?: string;
594
+ };
595
+ intents: Array<string>;
596
+ published: {
597
+ version: number;
598
+ title: string;
599
+ content: string;
600
+ publishedAt?: string;
601
+ updatedAt?: string;
602
+ };
603
+ draft?: {
604
+ version: number;
605
+ title: string;
606
+ content: string;
607
+ publishedAt?: string;
608
+ updatedAt?: string;
609
+ };
610
+ createdAt: string;
611
+ updatedAt: string;
612
+ }>;
613
+ }
45
614
  declare class EntitiesResource {
46
615
  private readonly client;
47
616
  constructor(client: Client);
@@ -50,43 +619,42 @@ declare class EntitiesResource {
50
619
  id: string;
51
620
  organizationId?: string | null;
52
621
  name: string;
53
- metadata?: {
54
- [key: string]: unknown;
55
- };
56
622
  createdAt: string;
57
623
  updatedAt: string;
58
624
  }>;
59
625
  total: number;
626
+ limit: number;
627
+ offset: number;
60
628
  }>;
61
629
  get(id: string): Promise<{
62
630
  id: string;
63
631
  organizationId?: string | null;
64
632
  name: string;
633
+ createdAt: string;
634
+ updatedAt: string;
65
635
  metadata?: {
66
636
  [key: string]: unknown;
67
637
  };
68
- createdAt: string;
69
- updatedAt: string;
70
638
  }>;
71
639
  create(body: BodyOf<typeof Entities.create>): Promise<{
72
640
  id: string;
73
641
  organizationId?: string | null;
74
642
  name: string;
643
+ createdAt: string;
644
+ updatedAt: string;
75
645
  metadata?: {
76
646
  [key: string]: unknown;
77
647
  };
78
- createdAt: string;
79
- updatedAt: string;
80
648
  }>;
81
649
  update(id: string, body: BodyOf<typeof Entities.update>): Promise<{
82
650
  id: string;
83
651
  organizationId?: string | null;
84
652
  name: string;
653
+ createdAt: string;
654
+ updatedAt: string;
85
655
  metadata?: {
86
656
  [key: string]: unknown;
87
657
  };
88
- createdAt: string;
89
- updatedAt: string;
90
658
  }>;
91
659
  delete(id: string): Promise<{
92
660
  message: string;
@@ -95,47 +663,46 @@ declare class EntitiesResource {
95
663
  declare class OrganizationsResource {
96
664
  private readonly client;
97
665
  constructor(client: Client);
98
- list(): Promise<{
666
+ list(query?: QueryOf<typeof Organizations.list>): Promise<{
99
667
  organizations: Array<{
100
668
  id: string;
101
669
  name: string;
102
- metadata?: {
103
- [key: string]: unknown;
104
- };
105
670
  createdAt: string;
106
671
  updatedAt: string;
107
672
  }>;
108
673
  total: number;
674
+ limit: number;
675
+ offset: number;
109
676
  }>;
110
677
  get(id: string): Promise<{
111
678
  id: string;
112
679
  name: string;
680
+ createdAt: string;
681
+ updatedAt: string;
113
682
  metadata?: {
114
683
  [key: string]: unknown;
115
684
  };
116
- createdAt: string;
117
- updatedAt: string;
118
685
  }>;
119
686
  create(body: BodyOf<typeof Organizations.create>): Promise<{
120
687
  organization: {
121
688
  id: string;
122
689
  name: string;
690
+ createdAt: string;
691
+ updatedAt: string;
123
692
  metadata?: {
124
693
  [key: string]: unknown;
125
694
  };
126
- createdAt: string;
127
- updatedAt: string;
128
695
  };
129
696
  apiKey?: string;
130
697
  }>;
131
698
  update(id: string, body: BodyOf<typeof Organizations.update>): Promise<{
132
699
  id: string;
133
700
  name: string;
701
+ createdAt: string;
702
+ updatedAt: string;
134
703
  metadata?: {
135
704
  [key: string]: unknown;
136
705
  };
137
- createdAt: string;
138
- updatedAt: string;
139
706
  }>;
140
707
  delete(id: string): Promise<{
141
708
  message: string;
@@ -153,9 +720,6 @@ declare class ConversationsResource {
153
720
  user: {
154
721
  userId: string;
155
722
  resolved?: boolean;
156
- data?: {
157
- [key: string]: unknown;
158
- };
159
723
  } | null;
160
724
  entityId?: string;
161
725
  messageCount: number;
@@ -216,9 +780,14 @@ declare class ConversationsResource {
216
780
  error?: string;
217
781
  }>;
218
782
  }>;
783
+ appendMessage(conversationId: string, body: BodyOf<typeof Conversations.appendMessage>): Promise<{
784
+ messageIndex: number;
785
+ }>;
219
786
  }
220
787
  export declare class Operla {
788
+ readonly agents: AgentsResource;
221
789
  readonly entities: EntitiesResource;
790
+ readonly kb: KbResource;
222
791
  readonly organizations: OrganizationsResource;
223
792
  readonly conversations: ConversationsResource;
224
793
  private readonly config;