@permute/sdk 0.1.1 → 0.2.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.
@@ -10,7 +10,7 @@ export interface components {
10
10
  sourceId?: string;
11
11
  title?: string;
12
12
  /** @enum {string} */
13
- type: 'text' | 'table' | 'web';
13
+ type: 'text' | 'table' | 'web' | 'fact';
14
14
  url?: string;
15
15
  };
16
16
  AnswerConfidence: {
@@ -46,7 +46,7 @@ export interface components {
46
46
  sourceId?: string;
47
47
  title?: string;
48
48
  /** @enum {string} */
49
- type: 'text' | 'table' | 'web';
49
+ type: 'text' | 'table' | 'web' | 'fact';
50
50
  url?: string;
51
51
  }[];
52
52
  confidence?: {
@@ -86,7 +86,7 @@ export interface components {
86
86
  sourceId?: string;
87
87
  title?: string;
88
88
  /** @enum {string} */
89
- type: 'text' | 'table' | 'web';
89
+ type: 'text' | 'table' | 'web' | 'fact';
90
90
  url?: string;
91
91
  }[];
92
92
  confidence?: {
@@ -151,6 +151,268 @@ export interface components {
151
151
  status: 'pending' | 'processing' | 'completed' | 'failed';
152
152
  };
153
153
  };
154
+ DashboardIdParams: {
155
+ dashboardId: string;
156
+ };
157
+ DashboardSource: {
158
+ dashboardId: string;
159
+ dataRunId: string | null;
160
+ resourceId: string;
161
+ revision: {
162
+ revisionId: string;
163
+ sequence: number;
164
+ } | null;
165
+ source: string;
166
+ };
167
+ DashboardSourceUpdateRequest: {
168
+ expectedDataRunId: string | null;
169
+ expectedRevision: {
170
+ revisionId: string;
171
+ sequence: number;
172
+ } | null;
173
+ source: string;
174
+ };
175
+ Database: {
176
+ createdAt: string;
177
+ id: string;
178
+ key: string;
179
+ name: string;
180
+ /** @enum {string} */
181
+ status: 'provisioning' | 'ready' | 'deleting' | 'failed' | 'deleted';
182
+ updatedAt: string;
183
+ workspaceId: string;
184
+ };
185
+ DatabaseCreateRequest: {
186
+ key: string;
187
+ name: string;
188
+ };
189
+ DatabaseIdParams: {
190
+ databaseId: string;
191
+ };
192
+ DatabaseList: {
193
+ items: {
194
+ createdAt: string;
195
+ id: string;
196
+ key: string;
197
+ name: string;
198
+ /** @enum {string} */
199
+ status: 'provisioning' | 'ready' | 'deleting' | 'failed' | 'deleted';
200
+ updatedAt: string;
201
+ workspaceId: string;
202
+ }[];
203
+ };
204
+ DatabaseRecords: {
205
+ items: {
206
+ [key: string]: unknown;
207
+ }[];
208
+ };
209
+ DatabaseRecordsQuery: {
210
+ /** @default 100 */
211
+ limit: number;
212
+ /** @default 0 */
213
+ offset: number;
214
+ schema?: string;
215
+ };
216
+ DatabaseTableCreated: {
217
+ name: string;
218
+ };
219
+ DatabaseTableCreateRequest: {
220
+ columns: {
221
+ name: string;
222
+ /** @default false */
223
+ nullable: boolean;
224
+ /** @enum {string} */
225
+ type: 'text' | 'boolean' | 'bigint' | 'numeric' | 'uuid' | 'date' | 'timestamptz' | 'jsonb';
226
+ }[];
227
+ name: string;
228
+ primaryKey: string[];
229
+ };
230
+ DatabaseTableParams: {
231
+ databaseId: string;
232
+ table: string;
233
+ };
234
+ DatabaseTables: {
235
+ items: {
236
+ columns: {
237
+ name: string;
238
+ nullable: boolean;
239
+ type: string;
240
+ }[];
241
+ name: string;
242
+ primaryKey: string[];
243
+ schema: string;
244
+ }[];
245
+ };
246
+ DatabaseTransactionReceipt: {
247
+ requestId: string;
248
+ versions: string[];
249
+ };
250
+ DatabaseTransactionRequest: {
251
+ mutations: ({
252
+ table: string;
253
+ /** @enum {string} */
254
+ type: 'insert';
255
+ values: {
256
+ [key: string]: unknown;
257
+ };
258
+ } | {
259
+ /** Format: uuid */
260
+ expectedVersion: string;
261
+ key: {
262
+ [key: string]: unknown;
263
+ };
264
+ table: string;
265
+ /** @enum {string} */
266
+ type: 'update';
267
+ values: {
268
+ [key: string]: unknown;
269
+ };
270
+ } | {
271
+ /** Format: uuid */
272
+ expectedVersion: string;
273
+ key: {
274
+ [key: string]: unknown;
275
+ };
276
+ table: string;
277
+ /** @enum {string} */
278
+ type: 'delete';
279
+ })[];
280
+ requestId: string;
281
+ };
282
+ DataFlow: {
283
+ draftVersion: number;
284
+ edges: {
285
+ fromNodeId: string;
286
+ id: string;
287
+ toNodeId: string;
288
+ }[];
289
+ operation: {
290
+ codeStale: boolean;
291
+ dataSourceIds: string[];
292
+ draft: {
293
+ revisionId: string;
294
+ sequence: number;
295
+ } | null;
296
+ id: string;
297
+ instructions: string;
298
+ isEnabled: boolean;
299
+ kind: string;
300
+ name: string;
301
+ /** Format: date-time */
302
+ nextRunAt: string | null;
303
+ parentDataFlowId: string | null;
304
+ published: {
305
+ revisionId: string;
306
+ sequence: number;
307
+ } | null;
308
+ schedule: ({
309
+ /** @enum {string} */
310
+ type: 'manual';
311
+ } | {
312
+ minute: number;
313
+ /** @enum {string} */
314
+ type: 'hourly';
315
+ } | {
316
+ hour: number;
317
+ minute: number;
318
+ /** @enum {string} */
319
+ type: 'daily';
320
+ } | {
321
+ dayOfWeek: number;
322
+ hour: number;
323
+ minute: number;
324
+ /** @enum {string} */
325
+ type: 'weekly';
326
+ } | {
327
+ dayOfMonth: number;
328
+ hour: number;
329
+ minute: number;
330
+ /** @enum {string} */
331
+ type: 'monthly';
332
+ }) | (never | null);
333
+ status: string;
334
+ };
335
+ operationIds: string[];
336
+ publishedVersion: number | null;
337
+ revision: number;
338
+ sourceIds: string[];
339
+ };
340
+ DataFlowCommandRequest: {
341
+ command: {
342
+ expectedRevision: number;
343
+ patch: {
344
+ description?: string;
345
+ name?: string;
346
+ };
347
+ /** @enum {string} */
348
+ type: 'updateFlow';
349
+ } | {
350
+ expectedRevision: number;
351
+ input: {
352
+ inputIds: string[];
353
+ instruction: string;
354
+ name: string;
355
+ position?: {
356
+ x: number;
357
+ y: number;
358
+ };
359
+ };
360
+ /** @enum {string} */
361
+ type: 'addTransform';
362
+ } | {
363
+ expectedRevision: number;
364
+ nodeId: string;
365
+ patch: {
366
+ instruction?: string;
367
+ locked?: boolean;
368
+ name?: string;
369
+ position?: {
370
+ x: number;
371
+ y: number;
372
+ };
373
+ };
374
+ /** @enum {string} */
375
+ type: 'updateNode';
376
+ } | {
377
+ expectedRevision: number;
378
+ nodeId: string;
379
+ /** @enum {string} */
380
+ type: 'deleteNode';
381
+ } | {
382
+ expectedRevision: number;
383
+ fromNodeId: string;
384
+ toNodeId: string;
385
+ /** @enum {string} */
386
+ type: 'connectNodes';
387
+ } | {
388
+ edgeId: string;
389
+ expectedRevision: number;
390
+ /** @enum {string} */
391
+ type: 'disconnectNodes';
392
+ } | {
393
+ expectedRevision: number;
394
+ /** @enum {string} */
395
+ type: 'publish';
396
+ } | {
397
+ expectedRevision: number;
398
+ /** @enum {string} */
399
+ type: 'deleteFlow';
400
+ };
401
+ };
402
+ DataFlowCommandResponse: {
403
+ dataFlowId: string;
404
+ deleted: boolean;
405
+ };
406
+ DataFlowCreateRequest: {
407
+ /** @default [] */
408
+ dataSourceIds: string[];
409
+ /** @default */
410
+ description: string;
411
+ name: string;
412
+ };
413
+ DataFlowIdParams: {
414
+ dataFlowId: string;
415
+ };
154
416
  DatasetCreateRequest: {
155
417
  context?: string[];
156
418
  key: string;
@@ -164,6 +426,15 @@ export interface components {
164
426
  /** @enum {string} */
165
427
  type: 'file';
166
428
  };
429
+ DatasetDeleteResponse: {
430
+ /** @enum {boolean} */
431
+ deleted: true;
432
+ id: string;
433
+ };
434
+ DatasetDownloadResponse: {
435
+ /** Format: uri */
436
+ url: string;
437
+ };
167
438
  DatasetIdParams: {
168
439
  datasetId: string;
169
440
  };
@@ -315,6 +586,81 @@ export interface components {
315
586
  };
316
587
  };
317
588
  EmptyObject: Record<string, never>;
589
+ Fact: {
590
+ aliases?: string | null;
591
+ createdAt: string;
592
+ definition?: string | null;
593
+ endDate?: string | null;
594
+ formula?: string | null;
595
+ /** @enum {string|null} */
596
+ formulaType?: 'math' | 'sql' | null;
597
+ id: string;
598
+ key: string;
599
+ metadata?: {
600
+ [key: string]: unknown;
601
+ } | null;
602
+ name: string;
603
+ organizationId: string;
604
+ ownerId: string;
605
+ scope?: string | null;
606
+ startDate?: string | null;
607
+ /** @enum {string} */
608
+ type: 'definition' | 'alias' | 'formula' | 'baseline';
609
+ unit?: string | null;
610
+ updatedAt: string;
611
+ usualValue?: number | null;
612
+ usualValueMax?: number | null;
613
+ usualValueMin?: number | null;
614
+ };
615
+ FactIdParams: {
616
+ factId: string;
617
+ };
618
+ FactList: {
619
+ items: {
620
+ aliases?: string | null;
621
+ createdAt: string;
622
+ definition?: string | null;
623
+ endDate?: string | null;
624
+ formula?: string | null;
625
+ /** @enum {string|null} */
626
+ formulaType?: 'math' | 'sql' | null;
627
+ id: string;
628
+ key: string;
629
+ metadata?: {
630
+ [key: string]: unknown;
631
+ } | null;
632
+ name: string;
633
+ organizationId: string;
634
+ ownerId: string;
635
+ scope?: string | null;
636
+ startDate?: string | null;
637
+ /** @enum {string} */
638
+ type: 'definition' | 'alias' | 'formula' | 'baseline';
639
+ unit?: string | null;
640
+ updatedAt: string;
641
+ usualValue?: number | null;
642
+ usualValueMax?: number | null;
643
+ usualValueMin?: number | null;
644
+ }[];
645
+ };
646
+ FactWriteRequest: {
647
+ aliases?: string | null;
648
+ definition?: string | null;
649
+ endDate?: string | null;
650
+ formula?: string | null;
651
+ /** @enum {string|null} */
652
+ formulaType?: 'math' | 'sql' | null;
653
+ metadata?: {
654
+ [key: string]: unknown;
655
+ } | null;
656
+ name: string;
657
+ scope?: string | null;
658
+ startDate?: string | null;
659
+ unit?: string | null;
660
+ usualValue?: number | null;
661
+ usualValueMax?: number | null;
662
+ usualValueMin?: number | null;
663
+ };
318
664
  FileDatasetResponse: {
319
665
  contentType: string;
320
666
  /** Format: date-time */
@@ -348,6 +694,235 @@ export interface components {
348
694
  url: string;
349
695
  };
350
696
  };
697
+ KnowledgeWriteResponse: {
698
+ message: string;
699
+ success: boolean;
700
+ };
701
+ Operation: {
702
+ codeStale: boolean;
703
+ dataSourceIds: string[];
704
+ draft: {
705
+ revisionId: string;
706
+ sequence: number;
707
+ } | null;
708
+ id: string;
709
+ instructions: string;
710
+ isEnabled: boolean;
711
+ kind: string;
712
+ name: string;
713
+ /** Format: date-time */
714
+ nextRunAt: string | null;
715
+ parentDataFlowId: string | null;
716
+ published: {
717
+ revisionId: string;
718
+ sequence: number;
719
+ } | null;
720
+ schedule: ({
721
+ /** @enum {string} */
722
+ type: 'manual';
723
+ } | {
724
+ minute: number;
725
+ /** @enum {string} */
726
+ type: 'hourly';
727
+ } | {
728
+ hour: number;
729
+ minute: number;
730
+ /** @enum {string} */
731
+ type: 'daily';
732
+ } | {
733
+ dayOfWeek: number;
734
+ hour: number;
735
+ minute: number;
736
+ /** @enum {string} */
737
+ type: 'weekly';
738
+ } | {
739
+ dayOfMonth: number;
740
+ hour: number;
741
+ minute: number;
742
+ /** @enum {string} */
743
+ type: 'monthly';
744
+ }) | (never | null);
745
+ status: string;
746
+ };
747
+ OperationIdParams: {
748
+ operationId: string;
749
+ };
750
+ OperationList: {
751
+ items: {
752
+ codeStale: boolean;
753
+ dataSourceIds: string[];
754
+ draft: {
755
+ revisionId: string;
756
+ sequence: number;
757
+ } | null;
758
+ id: string;
759
+ instructions: string;
760
+ isEnabled: boolean;
761
+ kind: string;
762
+ name: string;
763
+ /** Format: date-time */
764
+ nextRunAt: string | null;
765
+ parentDataFlowId: string | null;
766
+ published: {
767
+ revisionId: string;
768
+ sequence: number;
769
+ } | null;
770
+ schedule: ({
771
+ /** @enum {string} */
772
+ type: 'manual';
773
+ } | {
774
+ minute: number;
775
+ /** @enum {string} */
776
+ type: 'hourly';
777
+ } | {
778
+ hour: number;
779
+ minute: number;
780
+ /** @enum {string} */
781
+ type: 'daily';
782
+ } | {
783
+ dayOfWeek: number;
784
+ hour: number;
785
+ minute: number;
786
+ /** @enum {string} */
787
+ type: 'weekly';
788
+ } | {
789
+ dayOfMonth: number;
790
+ hour: number;
791
+ minute: number;
792
+ /** @enum {string} */
793
+ type: 'monthly';
794
+ }) | (never | null);
795
+ status: string;
796
+ }[];
797
+ };
798
+ OperationListQuery: {
799
+ dataFlowId?: string;
800
+ /** @enum {string} */
801
+ kind?: 'dataFlow' | 'dataTable' | 'report' | 'dashboard';
802
+ };
803
+ OperationRunGroup: {
804
+ /** Format: date-time */
805
+ completedAt: string | null;
806
+ completedRuns: number;
807
+ failedRuns: number;
808
+ items: {
809
+ /** Format: date-time */
810
+ completedAt: string | null;
811
+ /** Format: date-time */
812
+ createdAt: string;
813
+ error: string | null;
814
+ id: string;
815
+ operationId: string;
816
+ outputDocId: string | null;
817
+ revisionId: string | null;
818
+ status: string;
819
+ workflowId: string;
820
+ }[];
821
+ pendingRuns: number;
822
+ progressPct: number;
823
+ /** Format: date-time */
824
+ startedAt: string | null;
825
+ /** @enum {string} */
826
+ status: 'running' | 'completed' | 'failed';
827
+ totalRuns: number;
828
+ workflowId: string;
829
+ };
830
+ OperationRunIdParams: {
831
+ operationId: string;
832
+ runId: string;
833
+ };
834
+ OperationRunList: {
835
+ items: {
836
+ /** Format: date-time */
837
+ completedAt: string | null;
838
+ /** Format: date-time */
839
+ createdAt: string;
840
+ error: string | null;
841
+ id: string;
842
+ outputDocId: string | null;
843
+ revisionId: string | null;
844
+ status: string;
845
+ workflowId: string;
846
+ }[];
847
+ };
848
+ OperationRunOutput: {
849
+ names: {
850
+ [key: string]: string;
851
+ };
852
+ revisionId: string | null;
853
+ /** @enum {number} */
854
+ rowLimitPerTable: 1000;
855
+ runId: string;
856
+ schemas: {
857
+ [key: string]: unknown;
858
+ };
859
+ tables: {
860
+ [key: string]: unknown[];
861
+ };
862
+ };
863
+ OperationRunQuery: {
864
+ workflowId: string;
865
+ };
866
+ OperationRunRequest: {
867
+ /** @enum {string} */
868
+ version: 'draft' | 'published';
869
+ };
870
+ OperationRunStarted: {
871
+ runId?: string;
872
+ workflowId: string;
873
+ };
874
+ OperationSource: {
875
+ dataFlowRevision: number | null;
876
+ dataSourceIds: string[];
877
+ dependencyOperationIds: string[];
878
+ instructions: string;
879
+ operationId: string;
880
+ revision: {
881
+ revisionId: string;
882
+ sequence: number;
883
+ } | null;
884
+ source: string;
885
+ /** Format: date-time */
886
+ updatedAt: string;
887
+ };
888
+ OperationSourceUpdateRequest: {
889
+ expectedDataFlowRevision: number | null;
890
+ expectedRevision: {
891
+ revisionId: string;
892
+ sequence: number;
893
+ } | null;
894
+ /** Format: date-time */
895
+ expectedUpdatedAt: string;
896
+ source: string;
897
+ };
898
+ OperationUpdateRequest: {
899
+ isEnabled?: boolean;
900
+ schedule?: ({
901
+ /** @enum {string} */
902
+ type: 'manual';
903
+ } | {
904
+ minute: number;
905
+ /** @enum {string} */
906
+ type: 'hourly';
907
+ } | {
908
+ hour: number;
909
+ minute: number;
910
+ /** @enum {string} */
911
+ type: 'daily';
912
+ } | {
913
+ dayOfWeek: number;
914
+ hour: number;
915
+ minute: number;
916
+ /** @enum {string} */
917
+ type: 'weekly';
918
+ } | {
919
+ dayOfMonth: number;
920
+ hour: number;
921
+ minute: number;
922
+ /** @enum {string} */
923
+ type: 'monthly';
924
+ }) | (never | null);
925
+ };
351
926
  QueryRequest: {
352
927
  limit?: number;
353
928
  sourceIds: string[];
@@ -368,6 +943,77 @@ export interface components {
368
943
  sql: string;
369
944
  truncated: boolean;
370
945
  };
946
+ ResourceRevision: {
947
+ actor: {
948
+ id: string | null;
949
+ /** @enum {string} */
950
+ type: 'user' | 'apiKey' | 'system';
951
+ };
952
+ /** Format: date-time */
953
+ createdAt: string;
954
+ dependencyRevisionIds: string[];
955
+ id: string;
956
+ message: string | null;
957
+ parentRevisionId: string | null;
958
+ resourceId: string;
959
+ value: {
960
+ [key: string]: unknown;
961
+ };
962
+ };
963
+ ResourceRevisionList: {
964
+ capabilities: {
965
+ history: boolean;
966
+ publish: boolean;
967
+ restore: boolean;
968
+ };
969
+ draft: {
970
+ revisionId: string;
971
+ sequence: number;
972
+ } | null;
973
+ items: {
974
+ actor: {
975
+ id: string | null;
976
+ /** @enum {string} */
977
+ type: 'user' | 'apiKey' | 'system';
978
+ };
979
+ /** Format: date-time */
980
+ createdAt: string;
981
+ dependencyRevisionIds: string[];
982
+ id: string;
983
+ message: string | null;
984
+ parentRevisionId: string | null;
985
+ }[];
986
+ published: {
987
+ revisionId: string;
988
+ sequence: number;
989
+ } | null;
990
+ resourceId: string;
991
+ version: string;
992
+ };
993
+ ResourceRevisionParams: {
994
+ resourceId: string;
995
+ revisionId: string;
996
+ };
997
+ ResourceVersionRequest: {
998
+ expectedVersion: string;
999
+ };
1000
+ ResourceVersionState: {
1001
+ capabilities: {
1002
+ history: boolean;
1003
+ publish: boolean;
1004
+ restore: boolean;
1005
+ };
1006
+ draft: {
1007
+ revisionId: string;
1008
+ sequence: number;
1009
+ } | null;
1010
+ published: {
1011
+ revisionId: string;
1012
+ sequence: number;
1013
+ } | null;
1014
+ resourceId: string;
1015
+ version: string;
1016
+ };
371
1017
  SearchRequest: {
372
1018
  limit?: number;
373
1019
  query: string;
@@ -412,7 +1058,31 @@ export interface components {
412
1058
  /** @enum {string} */
413
1059
  type: 'record' | 'document' | 'table' | 'text_block' | 'unknown';
414
1060
  };
1061
+ SkillContent: {
1062
+ content: string;
1063
+ };
1064
+ SkillList: {
1065
+ items: {
1066
+ description: string | null;
1067
+ file: string;
1068
+ lastModified: string | null;
1069
+ }[];
1070
+ };
1071
+ SkillPathParams: {
1072
+ path: string;
1073
+ };
1074
+ SkillWriteRequest: {
1075
+ content: string;
1076
+ };
415
1077
  Source: {
1078
+ availability: {
1079
+ /** Format: date-time */
1080
+ lastSuccessfulAt?: string;
1081
+ reason?: string;
1082
+ /** @enum {string} */
1083
+ status: 'ready' | 'refreshing' | 'degraded' | 'preparing' | 'failed';
1084
+ };
1085
+ capabilities: 'query'[];
416
1086
  context?: string[];
417
1087
  fileType?: string;
418
1088
  id: string;
@@ -420,13 +1090,21 @@ export interface components {
420
1090
  provider?: string;
421
1091
  summary?: string | null;
422
1092
  /** @enum {string} */
423
- type: 'dataset' | 'connector';
1093
+ type: 'dataset' | 'connector' | 'database' | 'report' | 'dashboard' | 'dataFlow' | 'dataTable';
424
1094
  };
425
1095
  SourceDetail: {
426
1096
  metadata?: {
427
1097
  [key: string]: unknown;
428
1098
  };
429
1099
  source: {
1100
+ availability: {
1101
+ /** Format: date-time */
1102
+ lastSuccessfulAt?: string;
1103
+ reason?: string;
1104
+ /** @enum {string} */
1105
+ status: 'ready' | 'refreshing' | 'degraded' | 'preparing' | 'failed';
1106
+ };
1107
+ capabilities: 'query'[];
430
1108
  context?: string[];
431
1109
  fileType?: string;
432
1110
  id: string;
@@ -434,7 +1112,7 @@ export interface components {
434
1112
  provider?: string;
435
1113
  summary?: string | null;
436
1114
  /** @enum {string} */
437
- type: 'dataset' | 'connector';
1115
+ type: 'dataset' | 'connector' | 'database' | 'report' | 'dashboard' | 'dataFlow' | 'dataTable';
438
1116
  };
439
1117
  tables: {
440
1118
  fieldCount?: number;
@@ -456,6 +1134,14 @@ export interface components {
456
1134
  };
457
1135
  SourceList: {
458
1136
  items: {
1137
+ availability: {
1138
+ /** Format: date-time */
1139
+ lastSuccessfulAt?: string;
1140
+ reason?: string;
1141
+ /** @enum {string} */
1142
+ status: 'ready' | 'refreshing' | 'degraded' | 'preparing' | 'failed';
1143
+ };
1144
+ capabilities: 'query'[];
459
1145
  context?: string[];
460
1146
  fileType?: string;
461
1147
  id: string;
@@ -463,7 +1149,7 @@ export interface components {
463
1149
  provider?: string;
464
1150
  summary?: string | null;
465
1151
  /** @enum {string} */
466
- type: 'dataset' | 'connector';
1152
+ type: 'dataset' | 'connector' | 'database' | 'report' | 'dashboard' | 'dataFlow' | 'dataTable';
467
1153
  }[];
468
1154
  };
469
1155
  UploadProgress: {
@@ -483,6 +1169,9 @@ export interface components {
483
1169
  /** Format: uri */
484
1170
  url: string;
485
1171
  };
1172
+ VersionedResourceParams: {
1173
+ resourceId: string;
1174
+ };
486
1175
  Workspace: {
487
1176
  context: string;
488
1177
  /** Format: date-time */