@magemetrics/core 0.11.0 → 0.11.3
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 +2001 -239
- package/dist/index.js +20 -16
- package/dist/index.js.map +1 -1
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -328,7 +328,34 @@ declare interface components {
|
|
|
328
328
|
}[];
|
|
329
329
|
}[] | null;
|
|
330
330
|
error_message: string | null;
|
|
331
|
+
execution_context?: {
|
|
332
|
+
companyId: number;
|
|
333
|
+
userMetadata: {
|
|
334
|
+
[key: string]: unknown;
|
|
335
|
+
};
|
|
336
|
+
} | null;
|
|
337
|
+
};
|
|
338
|
+
ImpersonateContext: {
|
|
339
|
+
/**
|
|
340
|
+
* @description discriminator enum property added by openapi-typescript
|
|
341
|
+
* @enum {string}
|
|
342
|
+
*/
|
|
343
|
+
mode: "impersonate";
|
|
344
|
+
/** @description The user ID in the customer's system */
|
|
345
|
+
external_user_id: string;
|
|
346
|
+
};
|
|
347
|
+
CustomMetadataContext: {
|
|
348
|
+
/**
|
|
349
|
+
* @description discriminator enum property added by openapi-typescript
|
|
350
|
+
* @enum {string}
|
|
351
|
+
*/
|
|
352
|
+
mode: "custom";
|
|
353
|
+
/** @description Raw metadata key-value pairs for data access rules */
|
|
354
|
+
metadata: {
|
|
355
|
+
[key: string]: unknown;
|
|
356
|
+
};
|
|
331
357
|
};
|
|
358
|
+
ExecutionContextInput: components["schemas"]["ImpersonateContext"] | components["schemas"]["CustomMetadataContext"];
|
|
332
359
|
StartAgentRunRequest: {
|
|
333
360
|
/** Format: uuid */
|
|
334
361
|
agent_id: string;
|
|
@@ -336,6 +363,7 @@ declare interface components {
|
|
|
336
363
|
inputs: {
|
|
337
364
|
[key: string]: unknown;
|
|
338
365
|
};
|
|
366
|
+
execution_context?: components["schemas"]["ExecutionContextInput"];
|
|
339
367
|
};
|
|
340
368
|
Agent: {
|
|
341
369
|
/** Format: uuid */
|
|
@@ -387,6 +415,39 @@ declare interface components {
|
|
|
387
415
|
created_at: string;
|
|
388
416
|
updated_at: string;
|
|
389
417
|
};
|
|
418
|
+
CreateGlobalKnowledgeItem: {
|
|
419
|
+
content: string;
|
|
420
|
+
/** @description Optional identifier from your system, used for lookup and batch operations */
|
|
421
|
+
external_id?: string;
|
|
422
|
+
/** @default true */
|
|
423
|
+
is_active: boolean;
|
|
424
|
+
tags?: string[];
|
|
425
|
+
/** @description IDs of applications this item is scoped to. Empty or omitted means all applications. */
|
|
426
|
+
application_ids?: number[];
|
|
427
|
+
/** @enum {string} */
|
|
428
|
+
type: "global";
|
|
429
|
+
};
|
|
430
|
+
SchemaPath: {
|
|
431
|
+
/** @description Schema or dataset name in the source database */
|
|
432
|
+
dataset: string;
|
|
433
|
+
/** @description Table name in the source database */
|
|
434
|
+
table_name: string;
|
|
435
|
+
/** @description Column name (optional). Omit for table-level items, include for column-level items. */
|
|
436
|
+
column_name?: string;
|
|
437
|
+
};
|
|
438
|
+
CreateSchemaKnowledgeItem: {
|
|
439
|
+
content: string;
|
|
440
|
+
/** @description Optional identifier from your system, used for lookup and batch operations */
|
|
441
|
+
external_id?: string;
|
|
442
|
+
/** @default true */
|
|
443
|
+
is_active: boolean;
|
|
444
|
+
tags?: string[];
|
|
445
|
+
/** @description IDs of applications this item is scoped to. Empty or omitted means all applications. */
|
|
446
|
+
application_ids?: number[];
|
|
447
|
+
/** @enum {string} */
|
|
448
|
+
type: "schema";
|
|
449
|
+
path: components["schemas"]["SchemaPath"];
|
|
450
|
+
};
|
|
390
451
|
};
|
|
391
452
|
responses: never;
|
|
392
453
|
parameters: never;
|
|
@@ -421,6 +482,9 @@ declare type CustomDataParts = {
|
|
|
421
482
|
"node-added": {
|
|
422
483
|
node: NodeBase;
|
|
423
484
|
};
|
|
485
|
+
"report-status": {
|
|
486
|
+
status: string | null;
|
|
487
|
+
};
|
|
424
488
|
};
|
|
425
489
|
|
|
426
490
|
/**
|
|
@@ -521,8 +585,8 @@ declare const FrontendRecentFlowsSchema: z.ZodObject<{
|
|
|
521
585
|
id: z.ZodString;
|
|
522
586
|
request: z.ZodString;
|
|
523
587
|
created_at: z.ZodString;
|
|
524
|
-
user_id: z.ZodNullable<z.ZodString>;
|
|
525
588
|
application_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
589
|
+
user_id: z.ZodNullable<z.ZodString>;
|
|
526
590
|
}, z.core.$strip>;
|
|
527
591
|
|
|
528
592
|
export declare const getPublicApiClient: (apiUrl: string, apiKey: string) => Client<PublicPaths>;
|
|
@@ -659,7 +723,7 @@ export declare class MageMetricsClient {
|
|
|
659
723
|
last_materialized_at: string | null;
|
|
660
724
|
materialized_error_message: string | null;
|
|
661
725
|
materialized_status: "completed" | "running" | "failed" | null;
|
|
662
|
-
};
|
|
726
|
+
} | undefined;
|
|
663
727
|
configuration: {
|
|
664
728
|
type: "bar";
|
|
665
729
|
title: string;
|
|
@@ -667,7 +731,7 @@ export declare class MageMetricsClient {
|
|
|
667
731
|
xAxisLabel: string;
|
|
668
732
|
yAxisLabel: string;
|
|
669
733
|
categoryColumn: string;
|
|
670
|
-
secondaryCategoryColumn?: string;
|
|
734
|
+
secondaryCategoryColumn?: string | undefined;
|
|
671
735
|
valueColumn: string;
|
|
672
736
|
} | {
|
|
673
737
|
type: "line/area";
|
|
@@ -708,29 +772,27 @@ export declare class MageMetricsClient {
|
|
|
708
772
|
title: string;
|
|
709
773
|
request: string | null;
|
|
710
774
|
data_summary: {
|
|
775
|
+
[x: string]: unknown;
|
|
711
776
|
columns: {
|
|
712
|
-
[
|
|
713
|
-
|
|
777
|
+
[x: string]: {
|
|
778
|
+
[x: string]: unknown;
|
|
779
|
+
position?: number | undefined;
|
|
714
780
|
data_type: string;
|
|
715
781
|
null_count: number | null;
|
|
716
782
|
unique_count: number | null;
|
|
717
783
|
unique_percentage: number | null;
|
|
718
|
-
min_value?: number | null;
|
|
719
|
-
max_value?: number | null;
|
|
720
|
-
avg_value?: number | null;
|
|
721
|
-
median_value?: number | null;
|
|
722
|
-
std_value?: number | null;
|
|
723
|
-
min_date?: string | null;
|
|
724
|
-
max_date?: string | null;
|
|
725
|
-
min_length?: number | null;
|
|
726
|
-
max_length?: number | null;
|
|
727
|
-
avg_length?: number | null;
|
|
728
|
-
} & {
|
|
729
|
-
[key: string]: unknown;
|
|
784
|
+
min_value?: number | null | undefined;
|
|
785
|
+
max_value?: number | null | undefined;
|
|
786
|
+
avg_value?: number | null | undefined;
|
|
787
|
+
median_value?: number | null | undefined;
|
|
788
|
+
std_value?: number | null | undefined;
|
|
789
|
+
min_date?: string | null | undefined;
|
|
790
|
+
max_date?: string | null | undefined;
|
|
791
|
+
min_length?: number | null | undefined;
|
|
792
|
+
max_length?: number | null | undefined;
|
|
793
|
+
avg_length?: number | null | undefined;
|
|
730
794
|
};
|
|
731
795
|
};
|
|
732
|
-
} & {
|
|
733
|
-
[key: string]: unknown;
|
|
734
796
|
};
|
|
735
797
|
status: string | null;
|
|
736
798
|
is_removed: boolean;
|
|
@@ -745,7 +807,7 @@ export declare class MageMetricsClient {
|
|
|
745
807
|
request: string;
|
|
746
808
|
title: string | null;
|
|
747
809
|
user_id: string | null;
|
|
748
|
-
application_id?: number | null;
|
|
810
|
+
application_id?: number | null | undefined;
|
|
749
811
|
}>;
|
|
750
812
|
getRecentFlows: (params?: {
|
|
751
813
|
limit?: number;
|
|
@@ -766,7 +828,7 @@ export declare class MageMetricsClient {
|
|
|
766
828
|
request: string;
|
|
767
829
|
title: string | null;
|
|
768
830
|
user_id: string | null;
|
|
769
|
-
application_id?: number | null;
|
|
831
|
+
application_id?: number | null | undefined;
|
|
770
832
|
}[];
|
|
771
833
|
}[]>;
|
|
772
834
|
get: (canvasId: string) => Promise<{
|
|
@@ -798,7 +860,7 @@ export declare class MageMetricsClient {
|
|
|
798
860
|
getChatTransport: (flowId: string, options?: MageMetricsChatTransportOptions) => MageMetricsChatTransport;
|
|
799
861
|
getChatMessages: (flowId: string) => Promise<MMChatUIMessage[]>;
|
|
800
862
|
fetchReportData: (reportId: number, { columns, limit, sorting, filters, cursor }: ReportDataFilters, signal?: AbortSignal) => Promise<{
|
|
801
|
-
[
|
|
863
|
+
[x: string]: unknown;
|
|
802
864
|
}[]>;
|
|
803
865
|
createSpeechToken: () => Promise<{
|
|
804
866
|
token: string;
|
|
@@ -809,15 +871,15 @@ export declare class MageMetricsClient {
|
|
|
809
871
|
name: string;
|
|
810
872
|
data_type: string;
|
|
811
873
|
dataType: string;
|
|
812
|
-
renderType?: string;
|
|
813
|
-
unit?: string;
|
|
814
|
-
canonicalDataType?: "numeric" | "boolean" | "datetime" | "text" | "array" | "json" | "other";
|
|
874
|
+
renderType?: string | undefined;
|
|
875
|
+
unit?: string | undefined;
|
|
876
|
+
canonicalDataType?: "numeric" | "boolean" | "datetime" | "text" | "array" | "json" | "other" | undefined;
|
|
815
877
|
}[];
|
|
816
878
|
rowCount: {
|
|
817
879
|
count: number;
|
|
818
880
|
};
|
|
819
881
|
data: (reportId: number, { columns, limit, sorting, filters, cursor }: ReportDataFilters, signal?: AbortSignal) => Promise<{
|
|
820
|
-
[
|
|
882
|
+
[x: string]: unknown;
|
|
821
883
|
}[]>;
|
|
822
884
|
}>;
|
|
823
885
|
};
|
|
@@ -947,9 +1009,7 @@ declare interface operations {
|
|
|
947
1009
|
};
|
|
948
1010
|
getApiInformation: {
|
|
949
1011
|
parameters: {
|
|
950
|
-
query
|
|
951
|
-
apiKey: string;
|
|
952
|
-
};
|
|
1012
|
+
query?: never;
|
|
953
1013
|
header?: never;
|
|
954
1014
|
path?: never;
|
|
955
1015
|
cookie?: never;
|
|
@@ -1247,8 +1307,8 @@ declare interface operations {
|
|
|
1247
1307
|
retrieveFlow: {
|
|
1248
1308
|
parameters: {
|
|
1249
1309
|
query?: never;
|
|
1250
|
-
header
|
|
1251
|
-
"sp-access-token"
|
|
1310
|
+
header?: {
|
|
1311
|
+
"sp-access-token"?: string;
|
|
1252
1312
|
};
|
|
1253
1313
|
path: {
|
|
1254
1314
|
flowId: string;
|
|
@@ -1302,8 +1362,8 @@ declare interface operations {
|
|
|
1302
1362
|
query?: {
|
|
1303
1363
|
limit?: number;
|
|
1304
1364
|
};
|
|
1305
|
-
header
|
|
1306
|
-
"sp-access-token"
|
|
1365
|
+
header?: {
|
|
1366
|
+
"sp-access-token"?: string;
|
|
1307
1367
|
};
|
|
1308
1368
|
path?: never;
|
|
1309
1369
|
cookie?: never;
|
|
@@ -1342,8 +1402,8 @@ declare interface operations {
|
|
|
1342
1402
|
retrieveFlowDataReports: {
|
|
1343
1403
|
parameters: {
|
|
1344
1404
|
query?: never;
|
|
1345
|
-
header
|
|
1346
|
-
"sp-access-token"
|
|
1405
|
+
header?: {
|
|
1406
|
+
"sp-access-token"?: string;
|
|
1347
1407
|
};
|
|
1348
1408
|
path: {
|
|
1349
1409
|
flowId: string;
|
|
@@ -1426,8 +1486,8 @@ declare interface operations {
|
|
|
1426
1486
|
getDataReportFeedback: {
|
|
1427
1487
|
parameters: {
|
|
1428
1488
|
query?: never;
|
|
1429
|
-
header
|
|
1430
|
-
"sp-access-token"
|
|
1489
|
+
header?: {
|
|
1490
|
+
"sp-access-token"?: string;
|
|
1431
1491
|
};
|
|
1432
1492
|
path: {
|
|
1433
1493
|
report_id: string;
|
|
@@ -1478,8 +1538,8 @@ declare interface operations {
|
|
|
1478
1538
|
upsertReportFeedback: {
|
|
1479
1539
|
parameters: {
|
|
1480
1540
|
query?: never;
|
|
1481
|
-
header
|
|
1482
|
-
"sp-access-token"
|
|
1541
|
+
header?: {
|
|
1542
|
+
"sp-access-token"?: string;
|
|
1483
1543
|
};
|
|
1484
1544
|
path: {
|
|
1485
1545
|
report_id: string;
|
|
@@ -1519,8 +1579,8 @@ declare interface operations {
|
|
|
1519
1579
|
deleteReportFeedback: {
|
|
1520
1580
|
parameters: {
|
|
1521
1581
|
query?: never;
|
|
1522
|
-
header
|
|
1523
|
-
"sp-access-token"
|
|
1582
|
+
header?: {
|
|
1583
|
+
"sp-access-token"?: string;
|
|
1524
1584
|
};
|
|
1525
1585
|
path: {
|
|
1526
1586
|
report_id: string;
|
|
@@ -1560,59 +1620,11 @@ declare interface operations {
|
|
|
1560
1620
|
};
|
|
1561
1621
|
};
|
|
1562
1622
|
};
|
|
1563
|
-
retrieveLatestDataReportStatus: {
|
|
1564
|
-
parameters: {
|
|
1565
|
-
query?: never;
|
|
1566
|
-
header: {
|
|
1567
|
-
"sp-access-token": string;
|
|
1568
|
-
};
|
|
1569
|
-
path: {
|
|
1570
|
-
flowId: string;
|
|
1571
|
-
};
|
|
1572
|
-
cookie?: never;
|
|
1573
|
-
};
|
|
1574
|
-
requestBody?: never;
|
|
1575
|
-
responses: {
|
|
1576
|
-
/** @description The status of the latest flow data for a given flow */
|
|
1577
|
-
200: {
|
|
1578
|
-
headers: {
|
|
1579
|
-
[name: string]: unknown;
|
|
1580
|
-
};
|
|
1581
|
-
content: {
|
|
1582
|
-
"application/json": {
|
|
1583
|
-
status: string | null;
|
|
1584
|
-
};
|
|
1585
|
-
};
|
|
1586
|
-
};
|
|
1587
|
-
/** @description Unable to retrieve status for latest flow data of flow with this id */
|
|
1588
|
-
404: {
|
|
1589
|
-
headers: {
|
|
1590
|
-
[name: string]: unknown;
|
|
1591
|
-
};
|
|
1592
|
-
content: {
|
|
1593
|
-
"application/json": {
|
|
1594
|
-
error: string;
|
|
1595
|
-
};
|
|
1596
|
-
};
|
|
1597
|
-
};
|
|
1598
|
-
/** @description Something wrong happened */
|
|
1599
|
-
500: {
|
|
1600
|
-
headers: {
|
|
1601
|
-
[name: string]: unknown;
|
|
1602
|
-
};
|
|
1603
|
-
content: {
|
|
1604
|
-
"application/json": {
|
|
1605
|
-
error: string;
|
|
1606
|
-
};
|
|
1607
|
-
};
|
|
1608
|
-
};
|
|
1609
|
-
};
|
|
1610
|
-
};
|
|
1611
1623
|
getDataReportExplainability: {
|
|
1612
1624
|
parameters: {
|
|
1613
1625
|
query?: never;
|
|
1614
|
-
header
|
|
1615
|
-
"sp-access-token"
|
|
1626
|
+
header?: {
|
|
1627
|
+
"sp-access-token"?: string;
|
|
1616
1628
|
};
|
|
1617
1629
|
path: {
|
|
1618
1630
|
report_id: string;
|
|
@@ -1699,8 +1711,8 @@ declare interface operations {
|
|
|
1699
1711
|
getColumnLineage: {
|
|
1700
1712
|
parameters: {
|
|
1701
1713
|
query?: never;
|
|
1702
|
-
header
|
|
1703
|
-
"sp-access-token"
|
|
1714
|
+
header?: {
|
|
1715
|
+
"sp-access-token"?: string;
|
|
1704
1716
|
};
|
|
1705
1717
|
path?: never;
|
|
1706
1718
|
cookie?: never;
|
|
@@ -1778,8 +1790,8 @@ declare interface operations {
|
|
|
1778
1790
|
retrieveLatestDataRefresh: {
|
|
1779
1791
|
parameters: {
|
|
1780
1792
|
query?: never;
|
|
1781
|
-
header
|
|
1782
|
-
"sp-access-token"
|
|
1793
|
+
header?: {
|
|
1794
|
+
"sp-access-token"?: string;
|
|
1783
1795
|
};
|
|
1784
1796
|
path?: never;
|
|
1785
1797
|
cookie?: never;
|
|
@@ -1824,8 +1836,8 @@ declare interface operations {
|
|
|
1824
1836
|
exportReportData: {
|
|
1825
1837
|
parameters: {
|
|
1826
1838
|
query?: never;
|
|
1827
|
-
header
|
|
1828
|
-
"sp-access-token"
|
|
1839
|
+
header?: {
|
|
1840
|
+
"sp-access-token"?: string;
|
|
1829
1841
|
};
|
|
1830
1842
|
path: {
|
|
1831
1843
|
report_id: string;
|
|
@@ -1870,8 +1882,8 @@ declare interface operations {
|
|
|
1870
1882
|
getDataReportColumns: {
|
|
1871
1883
|
parameters: {
|
|
1872
1884
|
query?: never;
|
|
1873
|
-
header
|
|
1874
|
-
"sp-access-token"
|
|
1885
|
+
header?: {
|
|
1886
|
+
"sp-access-token"?: string;
|
|
1875
1887
|
};
|
|
1876
1888
|
path: {
|
|
1877
1889
|
report_id: string;
|
|
@@ -1925,8 +1937,8 @@ declare interface operations {
|
|
|
1925
1937
|
/** @example status:eq:active,name:contains:John%20Doe */
|
|
1926
1938
|
filter?: string;
|
|
1927
1939
|
};
|
|
1928
|
-
header
|
|
1929
|
-
"sp-access-token"
|
|
1940
|
+
header?: {
|
|
1941
|
+
"sp-access-token"?: string;
|
|
1930
1942
|
};
|
|
1931
1943
|
path: {
|
|
1932
1944
|
report_id: string;
|
|
@@ -1971,8 +1983,8 @@ declare interface operations {
|
|
|
1971
1983
|
getDataReportRowCount: {
|
|
1972
1984
|
parameters: {
|
|
1973
1985
|
query?: never;
|
|
1974
|
-
header
|
|
1975
|
-
"sp-access-token"
|
|
1986
|
+
header?: {
|
|
1987
|
+
"sp-access-token"?: string;
|
|
1976
1988
|
};
|
|
1977
1989
|
path: {
|
|
1978
1990
|
report_id: string;
|
|
@@ -2020,8 +2032,8 @@ declare interface operations {
|
|
|
2020
2032
|
getDataReport: {
|
|
2021
2033
|
parameters: {
|
|
2022
2034
|
query?: never;
|
|
2023
|
-
header
|
|
2024
|
-
"sp-access-token"
|
|
2035
|
+
header?: {
|
|
2036
|
+
"sp-access-token"?: string;
|
|
2025
2037
|
};
|
|
2026
2038
|
path: {
|
|
2027
2039
|
report_id: string;
|
|
@@ -2104,8 +2116,8 @@ declare interface operations {
|
|
|
2104
2116
|
createFlow: {
|
|
2105
2117
|
parameters: {
|
|
2106
2118
|
query?: never;
|
|
2107
|
-
header
|
|
2108
|
-
"sp-access-token"
|
|
2119
|
+
header?: {
|
|
2120
|
+
"sp-access-token"?: string;
|
|
2109
2121
|
};
|
|
2110
2122
|
path?: never;
|
|
2111
2123
|
cookie?: never;
|
|
@@ -2159,8 +2171,8 @@ declare interface operations {
|
|
|
2159
2171
|
refreshMaterializedViews: {
|
|
2160
2172
|
parameters: {
|
|
2161
2173
|
query?: never;
|
|
2162
|
-
header
|
|
2163
|
-
"sp-access-token"
|
|
2174
|
+
header?: {
|
|
2175
|
+
"sp-access-token"?: string;
|
|
2164
2176
|
};
|
|
2165
2177
|
path?: never;
|
|
2166
2178
|
cookie?: never;
|
|
@@ -2217,8 +2229,8 @@ declare interface operations {
|
|
|
2217
2229
|
/** @description Comma-separated list of flow_data IDs */
|
|
2218
2230
|
ids: string;
|
|
2219
2231
|
};
|
|
2220
|
-
header
|
|
2221
|
-
"sp-access-token"
|
|
2232
|
+
header?: {
|
|
2233
|
+
"sp-access-token"?: string;
|
|
2222
2234
|
};
|
|
2223
2235
|
path?: never;
|
|
2224
2236
|
cookie?: never;
|
|
@@ -2257,8 +2269,8 @@ declare interface operations {
|
|
|
2257
2269
|
query?: {
|
|
2258
2270
|
input?: string;
|
|
2259
2271
|
};
|
|
2260
|
-
header
|
|
2261
|
-
"sp-access-token"
|
|
2272
|
+
header?: {
|
|
2273
|
+
"sp-access-token"?: string;
|
|
2262
2274
|
};
|
|
2263
2275
|
path?: never;
|
|
2264
2276
|
cookie?: never;
|
|
@@ -2292,8 +2304,8 @@ declare interface operations {
|
|
|
2292
2304
|
retrieveChatMessages: {
|
|
2293
2305
|
parameters: {
|
|
2294
2306
|
query?: never;
|
|
2295
|
-
header
|
|
2296
|
-
"sp-access-token"
|
|
2307
|
+
header?: {
|
|
2308
|
+
"sp-access-token"?: string;
|
|
2297
2309
|
};
|
|
2298
2310
|
path: {
|
|
2299
2311
|
flowId: string;
|
|
@@ -2342,8 +2354,8 @@ declare interface operations {
|
|
|
2342
2354
|
createSpeechToken: {
|
|
2343
2355
|
parameters: {
|
|
2344
2356
|
query?: never;
|
|
2345
|
-
header
|
|
2346
|
-
"sp-access-token"
|
|
2357
|
+
header?: {
|
|
2358
|
+
"sp-access-token"?: string;
|
|
2347
2359
|
};
|
|
2348
2360
|
path?: never;
|
|
2349
2361
|
cookie?: never;
|
|
@@ -2385,8 +2397,8 @@ declare interface operations {
|
|
|
2385
2397
|
query?: {
|
|
2386
2398
|
count?: number;
|
|
2387
2399
|
};
|
|
2388
|
-
header
|
|
2389
|
-
"sp-access-token"
|
|
2400
|
+
header?: {
|
|
2401
|
+
"sp-access-token"?: string;
|
|
2390
2402
|
};
|
|
2391
2403
|
path?: never;
|
|
2392
2404
|
cookie?: never;
|
|
@@ -2420,8 +2432,8 @@ declare interface operations {
|
|
|
2420
2432
|
fetchVisualization: {
|
|
2421
2433
|
parameters: {
|
|
2422
2434
|
query?: never;
|
|
2423
|
-
header
|
|
2424
|
-
"sp-access-token"
|
|
2435
|
+
header?: {
|
|
2436
|
+
"sp-access-token"?: string;
|
|
2425
2437
|
};
|
|
2426
2438
|
path: {
|
|
2427
2439
|
visualization_id: string;
|
|
@@ -2479,8 +2491,8 @@ declare interface operations {
|
|
|
2479
2491
|
query?: {
|
|
2480
2492
|
flowDataId?: string;
|
|
2481
2493
|
};
|
|
2482
|
-
header
|
|
2483
|
-
"sp-access-token"
|
|
2494
|
+
header?: {
|
|
2495
|
+
"sp-access-token"?: string;
|
|
2484
2496
|
};
|
|
2485
2497
|
path: {
|
|
2486
2498
|
flowId: string;
|
|
@@ -2597,8 +2609,8 @@ declare interface operations {
|
|
|
2597
2609
|
triggerFlow: {
|
|
2598
2610
|
parameters: {
|
|
2599
2611
|
query?: never;
|
|
2600
|
-
header
|
|
2601
|
-
"sp-access-token"
|
|
2612
|
+
header?: {
|
|
2613
|
+
"sp-access-token"?: string;
|
|
2602
2614
|
};
|
|
2603
2615
|
path?: never;
|
|
2604
2616
|
cookie?: never;
|
|
@@ -2667,8 +2679,8 @@ declare interface operations {
|
|
|
2667
2679
|
retrieveCanvas: {
|
|
2668
2680
|
parameters: {
|
|
2669
2681
|
query?: never;
|
|
2670
|
-
header
|
|
2671
|
-
"sp-access-token"
|
|
2682
|
+
header?: {
|
|
2683
|
+
"sp-access-token"?: string;
|
|
2672
2684
|
};
|
|
2673
2685
|
path: {
|
|
2674
2686
|
canvas_id: components["schemas"]["CanvasId"];
|
|
@@ -2720,8 +2732,8 @@ declare interface operations {
|
|
|
2720
2732
|
updateCanvas: {
|
|
2721
2733
|
parameters: {
|
|
2722
2734
|
query?: never;
|
|
2723
|
-
header
|
|
2724
|
-
"sp-access-token"
|
|
2735
|
+
header?: {
|
|
2736
|
+
"sp-access-token"?: string;
|
|
2725
2737
|
};
|
|
2726
2738
|
path: {
|
|
2727
2739
|
canvas_id: components["schemas"]["CanvasId"];
|
|
@@ -2778,8 +2790,8 @@ declare interface operations {
|
|
|
2778
2790
|
deleteCanvas: {
|
|
2779
2791
|
parameters: {
|
|
2780
2792
|
query?: never;
|
|
2781
|
-
header
|
|
2782
|
-
"sp-access-token"
|
|
2793
|
+
header?: {
|
|
2794
|
+
"sp-access-token"?: string;
|
|
2783
2795
|
};
|
|
2784
2796
|
path: {
|
|
2785
2797
|
canvas_id: components["schemas"]["CanvasId"];
|
|
@@ -2822,8 +2834,8 @@ declare interface operations {
|
|
|
2822
2834
|
createCanvas: {
|
|
2823
2835
|
parameters: {
|
|
2824
2836
|
query?: never;
|
|
2825
|
-
header
|
|
2826
|
-
"sp-access-token"
|
|
2837
|
+
header?: {
|
|
2838
|
+
"sp-access-token"?: string;
|
|
2827
2839
|
};
|
|
2828
2840
|
path?: never;
|
|
2829
2841
|
cookie?: never;
|
|
@@ -2880,8 +2892,8 @@ declare interface operations {
|
|
|
2880
2892
|
query?: {
|
|
2881
2893
|
search?: string;
|
|
2882
2894
|
};
|
|
2883
|
-
header
|
|
2884
|
-
"sp-access-token"
|
|
2895
|
+
header?: {
|
|
2896
|
+
"sp-access-token"?: string;
|
|
2885
2897
|
};
|
|
2886
2898
|
path?: never;
|
|
2887
2899
|
cookie?: never;
|
|
@@ -2928,8 +2940,8 @@ declare interface operations {
|
|
|
2928
2940
|
getCanvasForFlow: {
|
|
2929
2941
|
parameters: {
|
|
2930
2942
|
query?: never;
|
|
2931
|
-
header
|
|
2932
|
-
"sp-access-token"
|
|
2943
|
+
header?: {
|
|
2944
|
+
"sp-access-token"?: string;
|
|
2933
2945
|
};
|
|
2934
2946
|
path: {
|
|
2935
2947
|
flow_id: string;
|
|
@@ -2985,8 +2997,8 @@ declare interface operations {
|
|
|
2985
2997
|
agent_id?: string;
|
|
2986
2998
|
limit?: number;
|
|
2987
2999
|
};
|
|
2988
|
-
header
|
|
2989
|
-
"sp-access-token"
|
|
3000
|
+
header?: {
|
|
3001
|
+
"sp-access-token"?: string;
|
|
2990
3002
|
};
|
|
2991
3003
|
path?: never;
|
|
2992
3004
|
cookie?: never;
|
|
@@ -3018,8 +3030,8 @@ declare interface operations {
|
|
|
3018
3030
|
startAgentRun: {
|
|
3019
3031
|
parameters: {
|
|
3020
3032
|
query?: never;
|
|
3021
|
-
header
|
|
3022
|
-
"sp-access-token"
|
|
3033
|
+
header?: {
|
|
3034
|
+
"sp-access-token"?: string;
|
|
3023
3035
|
};
|
|
3024
3036
|
path?: never;
|
|
3025
3037
|
cookie?: never;
|
|
@@ -3077,8 +3089,8 @@ declare interface operations {
|
|
|
3077
3089
|
getAgentRun: {
|
|
3078
3090
|
parameters: {
|
|
3079
3091
|
query?: never;
|
|
3080
|
-
header
|
|
3081
|
-
"sp-access-token"
|
|
3092
|
+
header?: {
|
|
3093
|
+
"sp-access-token"?: string;
|
|
3082
3094
|
};
|
|
3083
3095
|
path: {
|
|
3084
3096
|
id: string;
|
|
@@ -3123,8 +3135,8 @@ declare interface operations {
|
|
|
3123
3135
|
listAgents: {
|
|
3124
3136
|
parameters: {
|
|
3125
3137
|
query?: never;
|
|
3126
|
-
header
|
|
3127
|
-
"sp-access-token"
|
|
3138
|
+
header?: {
|
|
3139
|
+
"sp-access-token"?: string;
|
|
3128
3140
|
};
|
|
3129
3141
|
path?: never;
|
|
3130
3142
|
cookie?: never;
|
|
@@ -3156,8 +3168,8 @@ declare interface operations {
|
|
|
3156
3168
|
createAgent: {
|
|
3157
3169
|
parameters: {
|
|
3158
3170
|
query?: never;
|
|
3159
|
-
header
|
|
3160
|
-
"sp-access-token"
|
|
3171
|
+
header?: {
|
|
3172
|
+
"sp-access-token"?: string;
|
|
3161
3173
|
};
|
|
3162
3174
|
path?: never;
|
|
3163
3175
|
cookie?: never;
|
|
@@ -3249,8 +3261,8 @@ declare interface operations {
|
|
|
3249
3261
|
getAgent: {
|
|
3250
3262
|
parameters: {
|
|
3251
3263
|
query?: never;
|
|
3252
|
-
header
|
|
3253
|
-
"sp-access-token"
|
|
3264
|
+
header?: {
|
|
3265
|
+
"sp-access-token"?: string;
|
|
3254
3266
|
};
|
|
3255
3267
|
path: {
|
|
3256
3268
|
id: string;
|
|
@@ -3295,8 +3307,8 @@ declare interface operations {
|
|
|
3295
3307
|
updateAgent: {
|
|
3296
3308
|
parameters: {
|
|
3297
3309
|
query?: never;
|
|
3298
|
-
header
|
|
3299
|
-
"sp-access-token"
|
|
3310
|
+
header?: {
|
|
3311
|
+
"sp-access-token"?: string;
|
|
3300
3312
|
};
|
|
3301
3313
|
path: {
|
|
3302
3314
|
id: string;
|
|
@@ -3400,8 +3412,8 @@ declare interface operations {
|
|
|
3400
3412
|
deleteAgent: {
|
|
3401
3413
|
parameters: {
|
|
3402
3414
|
query?: never;
|
|
3403
|
-
header
|
|
3404
|
-
"sp-access-token"
|
|
3415
|
+
header?: {
|
|
3416
|
+
"sp-access-token"?: string;
|
|
3405
3417
|
};
|
|
3406
3418
|
path: {
|
|
3407
3419
|
id: string;
|
|
@@ -3446,106 +3458,1648 @@ declare interface operations {
|
|
|
3446
3458
|
};
|
|
3447
3459
|
};
|
|
3448
3460
|
};
|
|
3449
|
-
|
|
3450
|
-
|
|
3451
|
-
declare type PatchParam<T, Config extends RemoveParamsConfig, P extends keyof Config> = Simplify<T extends {
|
|
3452
|
-
[key in P]: infer H;
|
|
3453
|
-
} ? H extends Partial<Record<string, unknown>> ? Config[P] extends string ? Omit<H, Config[P]> : H : never : never>;
|
|
3454
|
-
|
|
3455
|
-
/**
|
|
3456
|
-
* This file was auto-generated by openapi-typescript.
|
|
3457
|
-
* Do not make direct changes to the file.
|
|
3458
|
-
*/
|
|
3459
|
-
|
|
3460
|
-
declare interface paths {
|
|
3461
|
-
"/api/v1/auth/exchangeExternalToken": {
|
|
3461
|
+
listApplications: {
|
|
3462
3462
|
parameters: {
|
|
3463
3463
|
query?: never;
|
|
3464
|
-
header?:
|
|
3464
|
+
header?: {
|
|
3465
|
+
"sp-access-token"?: string;
|
|
3466
|
+
};
|
|
3465
3467
|
path?: never;
|
|
3466
3468
|
cookie?: never;
|
|
3467
3469
|
};
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
|
|
3470
|
+
requestBody?: never;
|
|
3471
|
+
responses: {
|
|
3472
|
+
/** @description All applications for the company */
|
|
3473
|
+
200: {
|
|
3474
|
+
headers: {
|
|
3475
|
+
[name: string]: unknown;
|
|
3476
|
+
};
|
|
3477
|
+
content: {
|
|
3478
|
+
"application/json": {
|
|
3479
|
+
id: number;
|
|
3480
|
+
name: string;
|
|
3481
|
+
created_at: string;
|
|
3482
|
+
}[];
|
|
3483
|
+
};
|
|
3484
|
+
};
|
|
3485
|
+
/** @description Internal server error */
|
|
3486
|
+
500: {
|
|
3487
|
+
headers: {
|
|
3488
|
+
[name: string]: unknown;
|
|
3489
|
+
};
|
|
3490
|
+
content: {
|
|
3491
|
+
"application/json": {
|
|
3492
|
+
error: string;
|
|
3493
|
+
};
|
|
3494
|
+
};
|
|
3495
|
+
};
|
|
3483
3496
|
};
|
|
3484
|
-
get: operations["getApiInformation"];
|
|
3485
|
-
put?: never;
|
|
3486
|
-
post?: never;
|
|
3487
|
-
delete?: never;
|
|
3488
|
-
options?: never;
|
|
3489
|
-
head?: never;
|
|
3490
|
-
patch?: never;
|
|
3491
|
-
trace?: never;
|
|
3492
3497
|
};
|
|
3493
|
-
|
|
3498
|
+
createApplication: {
|
|
3494
3499
|
parameters: {
|
|
3495
3500
|
query?: never;
|
|
3496
|
-
header?:
|
|
3501
|
+
header?: {
|
|
3502
|
+
"sp-access-token"?: string;
|
|
3503
|
+
};
|
|
3497
3504
|
path?: never;
|
|
3498
3505
|
cookie?: never;
|
|
3499
3506
|
};
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3507
|
+
requestBody: {
|
|
3508
|
+
content: {
|
|
3509
|
+
"application/json": {
|
|
3510
|
+
name: string;
|
|
3511
|
+
};
|
|
3512
|
+
};
|
|
3513
|
+
};
|
|
3514
|
+
responses: {
|
|
3515
|
+
/** @description The created application */
|
|
3516
|
+
201: {
|
|
3517
|
+
headers: {
|
|
3518
|
+
[name: string]: unknown;
|
|
3519
|
+
};
|
|
3520
|
+
content: {
|
|
3521
|
+
"application/json": {
|
|
3522
|
+
id: number;
|
|
3523
|
+
name: string;
|
|
3524
|
+
created_at: string;
|
|
3525
|
+
};
|
|
3526
|
+
};
|
|
3527
|
+
};
|
|
3528
|
+
/** @description Invalid request */
|
|
3529
|
+
400: {
|
|
3530
|
+
headers: {
|
|
3531
|
+
[name: string]: unknown;
|
|
3532
|
+
};
|
|
3533
|
+
content: {
|
|
3534
|
+
"application/json": {
|
|
3535
|
+
error: string;
|
|
3536
|
+
};
|
|
3537
|
+
};
|
|
3538
|
+
};
|
|
3539
|
+
/** @description Application with this name already exists */
|
|
3540
|
+
409: {
|
|
3541
|
+
headers: {
|
|
3542
|
+
[name: string]: unknown;
|
|
3543
|
+
};
|
|
3544
|
+
content: {
|
|
3545
|
+
"application/json": {
|
|
3546
|
+
error: string;
|
|
3547
|
+
};
|
|
3548
|
+
};
|
|
3549
|
+
};
|
|
3550
|
+
/** @description Internal server error */
|
|
3551
|
+
500: {
|
|
3552
|
+
headers: {
|
|
3553
|
+
[name: string]: unknown;
|
|
3554
|
+
};
|
|
3555
|
+
content: {
|
|
3556
|
+
"application/json": {
|
|
3557
|
+
error: string;
|
|
3558
|
+
};
|
|
3559
|
+
};
|
|
3560
|
+
};
|
|
3561
|
+
};
|
|
3508
3562
|
};
|
|
3509
|
-
|
|
3563
|
+
getApplication: {
|
|
3510
3564
|
parameters: {
|
|
3511
3565
|
query?: never;
|
|
3512
|
-
header?:
|
|
3513
|
-
|
|
3566
|
+
header?: {
|
|
3567
|
+
"sp-access-token"?: string;
|
|
3568
|
+
};
|
|
3569
|
+
path: {
|
|
3570
|
+
id: number;
|
|
3571
|
+
};
|
|
3514
3572
|
cookie?: never;
|
|
3515
3573
|
};
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3574
|
+
requestBody?: never;
|
|
3575
|
+
responses: {
|
|
3576
|
+
/** @description The application */
|
|
3577
|
+
200: {
|
|
3578
|
+
headers: {
|
|
3579
|
+
[name: string]: unknown;
|
|
3580
|
+
};
|
|
3581
|
+
content: {
|
|
3582
|
+
"application/json": {
|
|
3583
|
+
id: number;
|
|
3584
|
+
name: string;
|
|
3585
|
+
created_at: string;
|
|
3586
|
+
};
|
|
3587
|
+
};
|
|
3588
|
+
};
|
|
3589
|
+
/** @description Application not found */
|
|
3590
|
+
404: {
|
|
3591
|
+
headers: {
|
|
3592
|
+
[name: string]: unknown;
|
|
3593
|
+
};
|
|
3594
|
+
content: {
|
|
3595
|
+
"application/json": {
|
|
3596
|
+
error: string;
|
|
3597
|
+
};
|
|
3598
|
+
};
|
|
3599
|
+
};
|
|
3600
|
+
/** @description Internal server error */
|
|
3601
|
+
500: {
|
|
3602
|
+
headers: {
|
|
3603
|
+
[name: string]: unknown;
|
|
3604
|
+
};
|
|
3605
|
+
content: {
|
|
3606
|
+
"application/json": {
|
|
3607
|
+
error: string;
|
|
3608
|
+
};
|
|
3609
|
+
};
|
|
3610
|
+
};
|
|
3611
|
+
};
|
|
3524
3612
|
};
|
|
3525
|
-
|
|
3613
|
+
deleteApplication: {
|
|
3526
3614
|
parameters: {
|
|
3527
3615
|
query?: never;
|
|
3528
|
-
header?:
|
|
3529
|
-
|
|
3616
|
+
header?: {
|
|
3617
|
+
"sp-access-token"?: string;
|
|
3618
|
+
};
|
|
3619
|
+
path: {
|
|
3620
|
+
id: number;
|
|
3621
|
+
};
|
|
3530
3622
|
cookie?: never;
|
|
3531
3623
|
};
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3624
|
+
requestBody?: never;
|
|
3625
|
+
responses: {
|
|
3626
|
+
/** @description Deletion result */
|
|
3627
|
+
200: {
|
|
3628
|
+
headers: {
|
|
3629
|
+
[name: string]: unknown;
|
|
3630
|
+
};
|
|
3631
|
+
content: {
|
|
3632
|
+
"application/json": {
|
|
3633
|
+
deleted: boolean;
|
|
3634
|
+
};
|
|
3635
|
+
};
|
|
3636
|
+
};
|
|
3637
|
+
/** @description Application not found */
|
|
3638
|
+
404: {
|
|
3639
|
+
headers: {
|
|
3640
|
+
[name: string]: unknown;
|
|
3641
|
+
};
|
|
3642
|
+
content: {
|
|
3643
|
+
"application/json": {
|
|
3644
|
+
error: string;
|
|
3645
|
+
};
|
|
3646
|
+
};
|
|
3647
|
+
};
|
|
3648
|
+
/** @description Internal server error */
|
|
3649
|
+
500: {
|
|
3650
|
+
headers: {
|
|
3651
|
+
[name: string]: unknown;
|
|
3652
|
+
};
|
|
3653
|
+
content: {
|
|
3654
|
+
"application/json": {
|
|
3655
|
+
error: string;
|
|
3656
|
+
};
|
|
3657
|
+
};
|
|
3658
|
+
};
|
|
3659
|
+
};
|
|
3660
|
+
};
|
|
3661
|
+
updateApplication: {
|
|
3662
|
+
parameters: {
|
|
3663
|
+
query?: never;
|
|
3664
|
+
header?: {
|
|
3665
|
+
"sp-access-token"?: string;
|
|
3666
|
+
};
|
|
3667
|
+
path: {
|
|
3668
|
+
id: number;
|
|
3669
|
+
};
|
|
3670
|
+
cookie?: never;
|
|
3671
|
+
};
|
|
3672
|
+
requestBody: {
|
|
3673
|
+
content: {
|
|
3674
|
+
"application/json": {
|
|
3675
|
+
name?: string;
|
|
3676
|
+
};
|
|
3677
|
+
};
|
|
3678
|
+
};
|
|
3679
|
+
responses: {
|
|
3680
|
+
/** @description Updated application */
|
|
3681
|
+
200: {
|
|
3682
|
+
headers: {
|
|
3683
|
+
[name: string]: unknown;
|
|
3684
|
+
};
|
|
3685
|
+
content: {
|
|
3686
|
+
"application/json": {
|
|
3687
|
+
id: number;
|
|
3688
|
+
name: string;
|
|
3689
|
+
created_at: string;
|
|
3690
|
+
};
|
|
3691
|
+
};
|
|
3692
|
+
};
|
|
3693
|
+
/** @description Invalid request */
|
|
3694
|
+
400: {
|
|
3695
|
+
headers: {
|
|
3696
|
+
[name: string]: unknown;
|
|
3697
|
+
};
|
|
3698
|
+
content: {
|
|
3699
|
+
"application/json": {
|
|
3700
|
+
error: string;
|
|
3701
|
+
};
|
|
3702
|
+
};
|
|
3703
|
+
};
|
|
3704
|
+
/** @description Application not found */
|
|
3705
|
+
404: {
|
|
3706
|
+
headers: {
|
|
3707
|
+
[name: string]: unknown;
|
|
3708
|
+
};
|
|
3709
|
+
content: {
|
|
3710
|
+
"application/json": {
|
|
3711
|
+
error: string;
|
|
3712
|
+
};
|
|
3713
|
+
};
|
|
3714
|
+
};
|
|
3715
|
+
/** @description Application with this name already exists */
|
|
3716
|
+
409: {
|
|
3717
|
+
headers: {
|
|
3718
|
+
[name: string]: unknown;
|
|
3719
|
+
};
|
|
3720
|
+
content: {
|
|
3721
|
+
"application/json": {
|
|
3722
|
+
error: string;
|
|
3723
|
+
};
|
|
3724
|
+
};
|
|
3725
|
+
};
|
|
3726
|
+
/** @description Internal server error */
|
|
3727
|
+
500: {
|
|
3728
|
+
headers: {
|
|
3729
|
+
[name: string]: unknown;
|
|
3730
|
+
};
|
|
3731
|
+
content: {
|
|
3732
|
+
"application/json": {
|
|
3733
|
+
error: string;
|
|
3734
|
+
};
|
|
3735
|
+
};
|
|
3736
|
+
};
|
|
3737
|
+
};
|
|
3738
|
+
};
|
|
3739
|
+
listTables: {
|
|
3740
|
+
parameters: {
|
|
3741
|
+
query?: never;
|
|
3742
|
+
header?: {
|
|
3743
|
+
"sp-access-token"?: string;
|
|
3744
|
+
};
|
|
3745
|
+
path?: never;
|
|
3746
|
+
cookie?: never;
|
|
3747
|
+
};
|
|
3748
|
+
requestBody?: never;
|
|
3749
|
+
responses: {
|
|
3750
|
+
/** @description All tables for the company */
|
|
3751
|
+
200: {
|
|
3752
|
+
headers: {
|
|
3753
|
+
[name: string]: unknown;
|
|
3754
|
+
};
|
|
3755
|
+
content: {
|
|
3756
|
+
"application/json": {
|
|
3757
|
+
id: number;
|
|
3758
|
+
/** @description Schema or dataset name in the source database */
|
|
3759
|
+
dataset: string;
|
|
3760
|
+
table_name: string;
|
|
3761
|
+
description: string | null;
|
|
3762
|
+
is_visible: boolean;
|
|
3763
|
+
created_at: string;
|
|
3764
|
+
updated_at: string;
|
|
3765
|
+
}[];
|
|
3766
|
+
};
|
|
3767
|
+
};
|
|
3768
|
+
/** @description Internal server error */
|
|
3769
|
+
500: {
|
|
3770
|
+
headers: {
|
|
3771
|
+
[name: string]: unknown;
|
|
3772
|
+
};
|
|
3773
|
+
content: {
|
|
3774
|
+
"application/json": {
|
|
3775
|
+
error: string;
|
|
3776
|
+
};
|
|
3777
|
+
};
|
|
3778
|
+
};
|
|
3779
|
+
};
|
|
3780
|
+
};
|
|
3781
|
+
createTable: {
|
|
3782
|
+
parameters: {
|
|
3783
|
+
query?: never;
|
|
3784
|
+
header?: {
|
|
3785
|
+
"sp-access-token"?: string;
|
|
3786
|
+
};
|
|
3787
|
+
path?: never;
|
|
3788
|
+
cookie?: never;
|
|
3789
|
+
};
|
|
3790
|
+
requestBody: {
|
|
3791
|
+
content: {
|
|
3792
|
+
"application/json": {
|
|
3793
|
+
/** @description Schema or dataset name in the source database */
|
|
3794
|
+
dataset: string;
|
|
3795
|
+
table_name: string;
|
|
3796
|
+
/** @default true */
|
|
3797
|
+
is_visible?: boolean;
|
|
3798
|
+
/** @description Optional RLS policy to create alongside the table */
|
|
3799
|
+
rls_policy?: {
|
|
3800
|
+
/** @description SQL condition appended to queries on this table to restrict row access. Use [var:name] for context variables and [table:name] for table references — these are auto-detected and stored as context_variables and depends_on_tables. */
|
|
3801
|
+
condition: string;
|
|
3802
|
+
/** @default true */
|
|
3803
|
+
is_active?: boolean;
|
|
3804
|
+
};
|
|
3805
|
+
/** @description Optional access rules to create alongside the table */
|
|
3806
|
+
access?: {
|
|
3807
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
3808
|
+
context_variable: string;
|
|
3809
|
+
/**
|
|
3810
|
+
* @description Comparison operator. Must be "=" or "!=".
|
|
3811
|
+
* @enum {string}
|
|
3812
|
+
*/
|
|
3813
|
+
operator: "=" | "!=";
|
|
3814
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
3815
|
+
value: string;
|
|
3816
|
+
/** @default true */
|
|
3817
|
+
is_active?: boolean;
|
|
3818
|
+
}[];
|
|
3819
|
+
};
|
|
3820
|
+
};
|
|
3821
|
+
};
|
|
3822
|
+
responses: {
|
|
3823
|
+
/** @description The created table with auto-discovered columns, RLS policy, and access rules */
|
|
3824
|
+
201: {
|
|
3825
|
+
headers: {
|
|
3826
|
+
[name: string]: unknown;
|
|
3827
|
+
};
|
|
3828
|
+
content: {
|
|
3829
|
+
"application/json": {
|
|
3830
|
+
id: number;
|
|
3831
|
+
/** @description Schema or dataset name in the source database */
|
|
3832
|
+
dataset: string;
|
|
3833
|
+
table_name: string;
|
|
3834
|
+
description: string | null;
|
|
3835
|
+
is_visible: boolean;
|
|
3836
|
+
created_at: string;
|
|
3837
|
+
updated_at: string;
|
|
3838
|
+
columns: {
|
|
3839
|
+
id: number;
|
|
3840
|
+
table_id: number;
|
|
3841
|
+
name: string;
|
|
3842
|
+
data_type: string | null;
|
|
3843
|
+
description: string | null;
|
|
3844
|
+
/** @description Whether this column is visible to end users */
|
|
3845
|
+
is_visible: boolean;
|
|
3846
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
3847
|
+
is_indexed: boolean;
|
|
3848
|
+
created_at: string;
|
|
3849
|
+
updated_at: string;
|
|
3850
|
+
}[];
|
|
3851
|
+
rls_policy: {
|
|
3852
|
+
id: number;
|
|
3853
|
+
table_id: number;
|
|
3854
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
3855
|
+
condition: string;
|
|
3856
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
3857
|
+
context_variables: string[];
|
|
3858
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
3859
|
+
depends_on_tables: string[];
|
|
3860
|
+
is_active: boolean;
|
|
3861
|
+
created_at: string;
|
|
3862
|
+
updated_at: string;
|
|
3863
|
+
} | null;
|
|
3864
|
+
access: {
|
|
3865
|
+
id: number;
|
|
3866
|
+
table_id: number;
|
|
3867
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
3868
|
+
context_variable: string;
|
|
3869
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
3870
|
+
operator: string;
|
|
3871
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
3872
|
+
value: string;
|
|
3873
|
+
is_active: boolean;
|
|
3874
|
+
created_at: string;
|
|
3875
|
+
updated_at: string;
|
|
3876
|
+
}[];
|
|
3877
|
+
};
|
|
3878
|
+
};
|
|
3879
|
+
};
|
|
3880
|
+
/** @description Invalid request */
|
|
3881
|
+
400: {
|
|
3882
|
+
headers: {
|
|
3883
|
+
[name: string]: unknown;
|
|
3884
|
+
};
|
|
3885
|
+
content: {
|
|
3886
|
+
"application/json": {
|
|
3887
|
+
error: string;
|
|
3888
|
+
};
|
|
3889
|
+
};
|
|
3890
|
+
};
|
|
3891
|
+
/** @description Table exists in source database but is not queryable (permission issue) */
|
|
3892
|
+
403: {
|
|
3893
|
+
headers: {
|
|
3894
|
+
[name: string]: unknown;
|
|
3895
|
+
};
|
|
3896
|
+
content: {
|
|
3897
|
+
"application/json": {
|
|
3898
|
+
error: string;
|
|
3899
|
+
};
|
|
3900
|
+
};
|
|
3901
|
+
};
|
|
3902
|
+
/** @description Source connector not found, or table not found in source database */
|
|
3903
|
+
404: {
|
|
3904
|
+
headers: {
|
|
3905
|
+
[name: string]: unknown;
|
|
3906
|
+
};
|
|
3907
|
+
content: {
|
|
3908
|
+
"application/json": {
|
|
3909
|
+
error: string;
|
|
3910
|
+
};
|
|
3911
|
+
};
|
|
3912
|
+
};
|
|
3913
|
+
/** @description Table with this dataset and table_name already exists */
|
|
3914
|
+
409: {
|
|
3915
|
+
headers: {
|
|
3916
|
+
[name: string]: unknown;
|
|
3917
|
+
};
|
|
3918
|
+
content: {
|
|
3919
|
+
"application/json": {
|
|
3920
|
+
error: string;
|
|
3921
|
+
};
|
|
3922
|
+
};
|
|
3923
|
+
};
|
|
3924
|
+
/** @description Internal server error */
|
|
3925
|
+
500: {
|
|
3926
|
+
headers: {
|
|
3927
|
+
[name: string]: unknown;
|
|
3928
|
+
};
|
|
3929
|
+
content: {
|
|
3930
|
+
"application/json": {
|
|
3931
|
+
error: string;
|
|
3932
|
+
};
|
|
3933
|
+
};
|
|
3934
|
+
};
|
|
3935
|
+
};
|
|
3936
|
+
};
|
|
3937
|
+
getTable: {
|
|
3938
|
+
parameters: {
|
|
3939
|
+
query?: never;
|
|
3940
|
+
header?: {
|
|
3941
|
+
"sp-access-token"?: string;
|
|
3942
|
+
};
|
|
3943
|
+
path: {
|
|
3944
|
+
id: number;
|
|
3945
|
+
};
|
|
3946
|
+
cookie?: never;
|
|
3947
|
+
};
|
|
3948
|
+
requestBody?: never;
|
|
3949
|
+
responses: {
|
|
3950
|
+
/** @description The table with columns, RLS policy, and access rules */
|
|
3951
|
+
200: {
|
|
3952
|
+
headers: {
|
|
3953
|
+
[name: string]: unknown;
|
|
3954
|
+
};
|
|
3955
|
+
content: {
|
|
3956
|
+
"application/json": {
|
|
3957
|
+
id: number;
|
|
3958
|
+
/** @description Schema or dataset name in the source database */
|
|
3959
|
+
dataset: string;
|
|
3960
|
+
table_name: string;
|
|
3961
|
+
description: string | null;
|
|
3962
|
+
is_visible: boolean;
|
|
3963
|
+
created_at: string;
|
|
3964
|
+
updated_at: string;
|
|
3965
|
+
columns: {
|
|
3966
|
+
id: number;
|
|
3967
|
+
table_id: number;
|
|
3968
|
+
name: string;
|
|
3969
|
+
data_type: string | null;
|
|
3970
|
+
description: string | null;
|
|
3971
|
+
/** @description Whether this column is visible to end users */
|
|
3972
|
+
is_visible: boolean;
|
|
3973
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
3974
|
+
is_indexed: boolean;
|
|
3975
|
+
created_at: string;
|
|
3976
|
+
updated_at: string;
|
|
3977
|
+
}[];
|
|
3978
|
+
rls_policy: {
|
|
3979
|
+
id: number;
|
|
3980
|
+
table_id: number;
|
|
3981
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
3982
|
+
condition: string;
|
|
3983
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
3984
|
+
context_variables: string[];
|
|
3985
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
3986
|
+
depends_on_tables: string[];
|
|
3987
|
+
is_active: boolean;
|
|
3988
|
+
created_at: string;
|
|
3989
|
+
updated_at: string;
|
|
3990
|
+
} | null;
|
|
3991
|
+
access: {
|
|
3992
|
+
id: number;
|
|
3993
|
+
table_id: number;
|
|
3994
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
3995
|
+
context_variable: string;
|
|
3996
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
3997
|
+
operator: string;
|
|
3998
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
3999
|
+
value: string;
|
|
4000
|
+
is_active: boolean;
|
|
4001
|
+
created_at: string;
|
|
4002
|
+
updated_at: string;
|
|
4003
|
+
}[];
|
|
4004
|
+
};
|
|
4005
|
+
};
|
|
4006
|
+
};
|
|
4007
|
+
/** @description Table not found */
|
|
4008
|
+
404: {
|
|
4009
|
+
headers: {
|
|
4010
|
+
[name: string]: unknown;
|
|
4011
|
+
};
|
|
4012
|
+
content: {
|
|
4013
|
+
"application/json": {
|
|
4014
|
+
error: string;
|
|
4015
|
+
};
|
|
4016
|
+
};
|
|
4017
|
+
};
|
|
4018
|
+
/** @description Internal server error */
|
|
4019
|
+
500: {
|
|
4020
|
+
headers: {
|
|
4021
|
+
[name: string]: unknown;
|
|
4022
|
+
};
|
|
4023
|
+
content: {
|
|
4024
|
+
"application/json": {
|
|
4025
|
+
error: string;
|
|
4026
|
+
};
|
|
4027
|
+
};
|
|
4028
|
+
};
|
|
4029
|
+
};
|
|
4030
|
+
};
|
|
4031
|
+
deleteTable: {
|
|
4032
|
+
parameters: {
|
|
4033
|
+
query?: never;
|
|
4034
|
+
header?: {
|
|
4035
|
+
"sp-access-token"?: string;
|
|
4036
|
+
};
|
|
4037
|
+
path: {
|
|
4038
|
+
id: number;
|
|
4039
|
+
};
|
|
4040
|
+
cookie?: never;
|
|
4041
|
+
};
|
|
4042
|
+
requestBody?: never;
|
|
4043
|
+
responses: {
|
|
4044
|
+
/** @description Soft delete: sets is_visible to false. The table remains accessible via GET and LIST. */
|
|
4045
|
+
200: {
|
|
4046
|
+
headers: {
|
|
4047
|
+
[name: string]: unknown;
|
|
4048
|
+
};
|
|
4049
|
+
content: {
|
|
4050
|
+
"application/json": {
|
|
4051
|
+
deleted: boolean;
|
|
4052
|
+
};
|
|
4053
|
+
};
|
|
4054
|
+
};
|
|
4055
|
+
/** @description Table not found */
|
|
4056
|
+
404: {
|
|
4057
|
+
headers: {
|
|
4058
|
+
[name: string]: unknown;
|
|
4059
|
+
};
|
|
4060
|
+
content: {
|
|
4061
|
+
"application/json": {
|
|
4062
|
+
error: string;
|
|
4063
|
+
};
|
|
4064
|
+
};
|
|
4065
|
+
};
|
|
4066
|
+
/** @description Internal server error */
|
|
4067
|
+
500: {
|
|
4068
|
+
headers: {
|
|
4069
|
+
[name: string]: unknown;
|
|
4070
|
+
};
|
|
4071
|
+
content: {
|
|
4072
|
+
"application/json": {
|
|
4073
|
+
error: string;
|
|
4074
|
+
};
|
|
4075
|
+
};
|
|
4076
|
+
};
|
|
4077
|
+
};
|
|
4078
|
+
};
|
|
4079
|
+
updateTable: {
|
|
4080
|
+
parameters: {
|
|
4081
|
+
query?: never;
|
|
4082
|
+
header?: {
|
|
4083
|
+
"sp-access-token"?: string;
|
|
4084
|
+
};
|
|
4085
|
+
path: {
|
|
4086
|
+
id: number;
|
|
4087
|
+
};
|
|
4088
|
+
cookie?: never;
|
|
4089
|
+
};
|
|
4090
|
+
requestBody: {
|
|
4091
|
+
content: {
|
|
4092
|
+
"application/json": {
|
|
4093
|
+
description?: string;
|
|
4094
|
+
/** @description Toggle table visibility. Prefer this over deleting — hidden tables retain their metadata and can be re-enabled later. */
|
|
4095
|
+
is_visible?: boolean;
|
|
4096
|
+
/** @description Upsert the RLS policy: updates existing if found, creates if not (condition required for create) */
|
|
4097
|
+
rls_policy?: {
|
|
4098
|
+
/** @description SQL condition appended to queries on this table to restrict row access. Use [var:name] for context variables and [table:name] for table references — these are auto-detected and stored as context_variables and depends_on_tables. */
|
|
4099
|
+
condition?: string;
|
|
4100
|
+
/** @default true */
|
|
4101
|
+
is_active?: boolean;
|
|
4102
|
+
};
|
|
4103
|
+
/** @description Replace all access rules — existing rules are removed and replaced with these */
|
|
4104
|
+
access?: {
|
|
4105
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4106
|
+
context_variable: string;
|
|
4107
|
+
/**
|
|
4108
|
+
* @description Comparison operator. Must be "=" or "!=".
|
|
4109
|
+
* @enum {string}
|
|
4110
|
+
*/
|
|
4111
|
+
operator: "=" | "!=";
|
|
4112
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4113
|
+
value: string;
|
|
4114
|
+
/** @default true */
|
|
4115
|
+
is_active?: boolean;
|
|
4116
|
+
}[];
|
|
4117
|
+
};
|
|
4118
|
+
};
|
|
4119
|
+
};
|
|
4120
|
+
responses: {
|
|
4121
|
+
/** @description Updated table with columns, RLS policy, and access rules */
|
|
4122
|
+
200: {
|
|
4123
|
+
headers: {
|
|
4124
|
+
[name: string]: unknown;
|
|
4125
|
+
};
|
|
4126
|
+
content: {
|
|
4127
|
+
"application/json": {
|
|
4128
|
+
id: number;
|
|
4129
|
+
/** @description Schema or dataset name in the source database */
|
|
4130
|
+
dataset: string;
|
|
4131
|
+
table_name: string;
|
|
4132
|
+
description: string | null;
|
|
4133
|
+
is_visible: boolean;
|
|
4134
|
+
created_at: string;
|
|
4135
|
+
updated_at: string;
|
|
4136
|
+
columns: {
|
|
4137
|
+
id: number;
|
|
4138
|
+
table_id: number;
|
|
4139
|
+
name: string;
|
|
4140
|
+
data_type: string | null;
|
|
4141
|
+
description: string | null;
|
|
4142
|
+
/** @description Whether this column is visible to end users */
|
|
4143
|
+
is_visible: boolean;
|
|
4144
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
4145
|
+
is_indexed: boolean;
|
|
4146
|
+
created_at: string;
|
|
4147
|
+
updated_at: string;
|
|
4148
|
+
}[];
|
|
4149
|
+
rls_policy: {
|
|
4150
|
+
id: number;
|
|
4151
|
+
table_id: number;
|
|
4152
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
4153
|
+
condition: string;
|
|
4154
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
4155
|
+
context_variables: string[];
|
|
4156
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
4157
|
+
depends_on_tables: string[];
|
|
4158
|
+
is_active: boolean;
|
|
4159
|
+
created_at: string;
|
|
4160
|
+
updated_at: string;
|
|
4161
|
+
} | null;
|
|
4162
|
+
access: {
|
|
4163
|
+
id: number;
|
|
4164
|
+
table_id: number;
|
|
4165
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4166
|
+
context_variable: string;
|
|
4167
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
4168
|
+
operator: string;
|
|
4169
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4170
|
+
value: string;
|
|
4171
|
+
is_active: boolean;
|
|
4172
|
+
created_at: string;
|
|
4173
|
+
updated_at: string;
|
|
4174
|
+
}[];
|
|
4175
|
+
};
|
|
4176
|
+
};
|
|
4177
|
+
};
|
|
4178
|
+
/** @description Invalid request */
|
|
4179
|
+
400: {
|
|
4180
|
+
headers: {
|
|
4181
|
+
[name: string]: unknown;
|
|
4182
|
+
};
|
|
4183
|
+
content: {
|
|
4184
|
+
"application/json": {
|
|
4185
|
+
error: string;
|
|
4186
|
+
};
|
|
4187
|
+
};
|
|
4188
|
+
};
|
|
4189
|
+
/** @description Table not found */
|
|
4190
|
+
404: {
|
|
4191
|
+
headers: {
|
|
4192
|
+
[name: string]: unknown;
|
|
4193
|
+
};
|
|
4194
|
+
content: {
|
|
4195
|
+
"application/json": {
|
|
4196
|
+
error: string;
|
|
4197
|
+
};
|
|
4198
|
+
};
|
|
4199
|
+
};
|
|
4200
|
+
/** @description Internal server error */
|
|
4201
|
+
500: {
|
|
4202
|
+
headers: {
|
|
4203
|
+
[name: string]: unknown;
|
|
4204
|
+
};
|
|
4205
|
+
content: {
|
|
4206
|
+
"application/json": {
|
|
4207
|
+
error: string;
|
|
4208
|
+
};
|
|
4209
|
+
};
|
|
4210
|
+
};
|
|
4211
|
+
};
|
|
4212
|
+
};
|
|
4213
|
+
listTableRls: {
|
|
4214
|
+
parameters: {
|
|
4215
|
+
query?: never;
|
|
4216
|
+
header?: {
|
|
4217
|
+
"sp-access-token"?: string;
|
|
4218
|
+
};
|
|
4219
|
+
path: {
|
|
4220
|
+
id: number;
|
|
4221
|
+
};
|
|
4222
|
+
cookie?: never;
|
|
4223
|
+
};
|
|
4224
|
+
requestBody?: never;
|
|
4225
|
+
responses: {
|
|
4226
|
+
/** @description RLS policies for this table */
|
|
4227
|
+
200: {
|
|
4228
|
+
headers: {
|
|
4229
|
+
[name: string]: unknown;
|
|
4230
|
+
};
|
|
4231
|
+
content: {
|
|
4232
|
+
"application/json": {
|
|
4233
|
+
id: number;
|
|
4234
|
+
table_id: number;
|
|
4235
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
4236
|
+
condition: string;
|
|
4237
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
4238
|
+
context_variables: string[];
|
|
4239
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
4240
|
+
depends_on_tables: string[];
|
|
4241
|
+
is_active: boolean;
|
|
4242
|
+
created_at: string;
|
|
4243
|
+
updated_at: string;
|
|
4244
|
+
}[];
|
|
4245
|
+
};
|
|
4246
|
+
};
|
|
4247
|
+
/** @description Table not found */
|
|
4248
|
+
404: {
|
|
4249
|
+
headers: {
|
|
4250
|
+
[name: string]: unknown;
|
|
4251
|
+
};
|
|
4252
|
+
content: {
|
|
4253
|
+
"application/json": {
|
|
4254
|
+
error: string;
|
|
4255
|
+
};
|
|
4256
|
+
};
|
|
4257
|
+
};
|
|
4258
|
+
/** @description Internal server error */
|
|
4259
|
+
500: {
|
|
4260
|
+
headers: {
|
|
4261
|
+
[name: string]: unknown;
|
|
4262
|
+
};
|
|
4263
|
+
content: {
|
|
4264
|
+
"application/json": {
|
|
4265
|
+
error: string;
|
|
4266
|
+
};
|
|
4267
|
+
};
|
|
4268
|
+
};
|
|
4269
|
+
};
|
|
4270
|
+
};
|
|
4271
|
+
createTableRls: {
|
|
4272
|
+
parameters: {
|
|
4273
|
+
query?: never;
|
|
4274
|
+
header?: {
|
|
4275
|
+
"sp-access-token"?: string;
|
|
4276
|
+
};
|
|
4277
|
+
path: {
|
|
4278
|
+
id: number;
|
|
4279
|
+
};
|
|
4280
|
+
cookie?: never;
|
|
4281
|
+
};
|
|
4282
|
+
requestBody: {
|
|
4283
|
+
content: {
|
|
4284
|
+
"application/json": {
|
|
4285
|
+
/** @description SQL condition appended to queries on this table to restrict row access. Use [var:name] for context variables and [table:name] for table references — these are auto-detected and stored as context_variables and depends_on_tables. */
|
|
4286
|
+
condition: string;
|
|
4287
|
+
/** @default true */
|
|
4288
|
+
is_active?: boolean;
|
|
4289
|
+
};
|
|
4290
|
+
};
|
|
4291
|
+
};
|
|
4292
|
+
responses: {
|
|
4293
|
+
/** @description The created RLS policy */
|
|
4294
|
+
201: {
|
|
4295
|
+
headers: {
|
|
4296
|
+
[name: string]: unknown;
|
|
4297
|
+
};
|
|
4298
|
+
content: {
|
|
4299
|
+
"application/json": {
|
|
4300
|
+
id: number;
|
|
4301
|
+
table_id: number;
|
|
4302
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
4303
|
+
condition: string;
|
|
4304
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
4305
|
+
context_variables: string[];
|
|
4306
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
4307
|
+
depends_on_tables: string[];
|
|
4308
|
+
is_active: boolean;
|
|
4309
|
+
created_at: string;
|
|
4310
|
+
updated_at: string;
|
|
4311
|
+
};
|
|
4312
|
+
};
|
|
4313
|
+
};
|
|
4314
|
+
/** @description Invalid request */
|
|
4315
|
+
400: {
|
|
4316
|
+
headers: {
|
|
4317
|
+
[name: string]: unknown;
|
|
4318
|
+
};
|
|
4319
|
+
content: {
|
|
4320
|
+
"application/json": {
|
|
4321
|
+
error: string;
|
|
4322
|
+
};
|
|
4323
|
+
};
|
|
4324
|
+
};
|
|
4325
|
+
/** @description Table not found */
|
|
4326
|
+
404: {
|
|
4327
|
+
headers: {
|
|
4328
|
+
[name: string]: unknown;
|
|
4329
|
+
};
|
|
4330
|
+
content: {
|
|
4331
|
+
"application/json": {
|
|
4332
|
+
error: string;
|
|
4333
|
+
};
|
|
4334
|
+
};
|
|
4335
|
+
};
|
|
4336
|
+
/** @description Internal server error */
|
|
4337
|
+
500: {
|
|
4338
|
+
headers: {
|
|
4339
|
+
[name: string]: unknown;
|
|
4340
|
+
};
|
|
4341
|
+
content: {
|
|
4342
|
+
"application/json": {
|
|
4343
|
+
error: string;
|
|
4344
|
+
};
|
|
4345
|
+
};
|
|
4346
|
+
};
|
|
4347
|
+
};
|
|
4348
|
+
};
|
|
4349
|
+
getTableRls: {
|
|
4350
|
+
parameters: {
|
|
4351
|
+
query?: never;
|
|
4352
|
+
header?: {
|
|
4353
|
+
"sp-access-token"?: string;
|
|
4354
|
+
};
|
|
4355
|
+
path: {
|
|
4356
|
+
id: number;
|
|
4357
|
+
rlsId: number;
|
|
4358
|
+
};
|
|
4359
|
+
cookie?: never;
|
|
4360
|
+
};
|
|
4361
|
+
requestBody?: never;
|
|
4362
|
+
responses: {
|
|
4363
|
+
/** @description The RLS policy */
|
|
4364
|
+
200: {
|
|
4365
|
+
headers: {
|
|
4366
|
+
[name: string]: unknown;
|
|
4367
|
+
};
|
|
4368
|
+
content: {
|
|
4369
|
+
"application/json": {
|
|
4370
|
+
id: number;
|
|
4371
|
+
table_id: number;
|
|
4372
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
4373
|
+
condition: string;
|
|
4374
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
4375
|
+
context_variables: string[];
|
|
4376
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
4377
|
+
depends_on_tables: string[];
|
|
4378
|
+
is_active: boolean;
|
|
4379
|
+
created_at: string;
|
|
4380
|
+
updated_at: string;
|
|
4381
|
+
};
|
|
4382
|
+
};
|
|
4383
|
+
};
|
|
4384
|
+
/** @description RLS policy not found */
|
|
4385
|
+
404: {
|
|
4386
|
+
headers: {
|
|
4387
|
+
[name: string]: unknown;
|
|
4388
|
+
};
|
|
4389
|
+
content: {
|
|
4390
|
+
"application/json": {
|
|
4391
|
+
error: string;
|
|
4392
|
+
};
|
|
4393
|
+
};
|
|
4394
|
+
};
|
|
4395
|
+
/** @description Internal server error */
|
|
4396
|
+
500: {
|
|
4397
|
+
headers: {
|
|
4398
|
+
[name: string]: unknown;
|
|
4399
|
+
};
|
|
4400
|
+
content: {
|
|
4401
|
+
"application/json": {
|
|
4402
|
+
error: string;
|
|
4403
|
+
};
|
|
4404
|
+
};
|
|
4405
|
+
};
|
|
4406
|
+
};
|
|
4407
|
+
};
|
|
4408
|
+
deleteTableRls: {
|
|
4409
|
+
parameters: {
|
|
4410
|
+
query?: never;
|
|
4411
|
+
header?: {
|
|
4412
|
+
"sp-access-token"?: string;
|
|
4413
|
+
};
|
|
4414
|
+
path: {
|
|
4415
|
+
id: number;
|
|
4416
|
+
rlsId: number;
|
|
4417
|
+
};
|
|
4418
|
+
cookie?: never;
|
|
4419
|
+
};
|
|
4420
|
+
requestBody?: never;
|
|
4421
|
+
responses: {
|
|
4422
|
+
/** @description Deletion result */
|
|
4423
|
+
200: {
|
|
4424
|
+
headers: {
|
|
4425
|
+
[name: string]: unknown;
|
|
4426
|
+
};
|
|
4427
|
+
content: {
|
|
4428
|
+
"application/json": {
|
|
4429
|
+
deleted: boolean;
|
|
4430
|
+
};
|
|
4431
|
+
};
|
|
4432
|
+
};
|
|
4433
|
+
/** @description RLS policy not found */
|
|
4434
|
+
404: {
|
|
4435
|
+
headers: {
|
|
4436
|
+
[name: string]: unknown;
|
|
4437
|
+
};
|
|
4438
|
+
content: {
|
|
4439
|
+
"application/json": {
|
|
4440
|
+
error: string;
|
|
4441
|
+
};
|
|
4442
|
+
};
|
|
4443
|
+
};
|
|
4444
|
+
/** @description Internal server error */
|
|
4445
|
+
500: {
|
|
4446
|
+
headers: {
|
|
4447
|
+
[name: string]: unknown;
|
|
4448
|
+
};
|
|
4449
|
+
content: {
|
|
4450
|
+
"application/json": {
|
|
4451
|
+
error: string;
|
|
4452
|
+
};
|
|
4453
|
+
};
|
|
4454
|
+
};
|
|
4455
|
+
};
|
|
4456
|
+
};
|
|
4457
|
+
updateTableRls: {
|
|
4458
|
+
parameters: {
|
|
4459
|
+
query?: never;
|
|
4460
|
+
header?: {
|
|
4461
|
+
"sp-access-token"?: string;
|
|
4462
|
+
};
|
|
4463
|
+
path: {
|
|
4464
|
+
id: number;
|
|
4465
|
+
rlsId: number;
|
|
4466
|
+
};
|
|
4467
|
+
cookie?: never;
|
|
4468
|
+
};
|
|
4469
|
+
requestBody: {
|
|
4470
|
+
content: {
|
|
4471
|
+
"application/json": {
|
|
4472
|
+
/** @description SQL condition appended to queries on this table to restrict row access. Use [var:name] for context variables and [table:name] for table references — these are auto-detected and stored as context_variables and depends_on_tables. */
|
|
4473
|
+
condition?: string;
|
|
4474
|
+
is_active?: boolean;
|
|
4475
|
+
};
|
|
4476
|
+
};
|
|
4477
|
+
};
|
|
4478
|
+
responses: {
|
|
4479
|
+
/** @description Updated RLS policy */
|
|
4480
|
+
200: {
|
|
4481
|
+
headers: {
|
|
4482
|
+
[name: string]: unknown;
|
|
4483
|
+
};
|
|
4484
|
+
content: {
|
|
4485
|
+
"application/json": {
|
|
4486
|
+
id: number;
|
|
4487
|
+
table_id: number;
|
|
4488
|
+
/** @description SQL condition appended to queries on this table to restrict row access */
|
|
4489
|
+
condition: string;
|
|
4490
|
+
/** @description Variables referenced in the condition, resolved from user context at query time */
|
|
4491
|
+
context_variables: string[];
|
|
4492
|
+
/** @description Other tables referenced by this policy's condition (for query planning) */
|
|
4493
|
+
depends_on_tables: string[];
|
|
4494
|
+
is_active: boolean;
|
|
4495
|
+
created_at: string;
|
|
4496
|
+
updated_at: string;
|
|
4497
|
+
};
|
|
4498
|
+
};
|
|
4499
|
+
};
|
|
4500
|
+
/** @description Invalid request */
|
|
4501
|
+
400: {
|
|
4502
|
+
headers: {
|
|
4503
|
+
[name: string]: unknown;
|
|
4504
|
+
};
|
|
4505
|
+
content: {
|
|
4506
|
+
"application/json": {
|
|
4507
|
+
error: string;
|
|
4508
|
+
};
|
|
4509
|
+
};
|
|
4510
|
+
};
|
|
4511
|
+
/** @description RLS policy not found */
|
|
4512
|
+
404: {
|
|
4513
|
+
headers: {
|
|
4514
|
+
[name: string]: unknown;
|
|
4515
|
+
};
|
|
4516
|
+
content: {
|
|
4517
|
+
"application/json": {
|
|
4518
|
+
error: string;
|
|
4519
|
+
};
|
|
4520
|
+
};
|
|
4521
|
+
};
|
|
4522
|
+
/** @description Internal server error */
|
|
4523
|
+
500: {
|
|
4524
|
+
headers: {
|
|
4525
|
+
[name: string]: unknown;
|
|
4526
|
+
};
|
|
4527
|
+
content: {
|
|
4528
|
+
"application/json": {
|
|
4529
|
+
error: string;
|
|
4530
|
+
};
|
|
4531
|
+
};
|
|
4532
|
+
};
|
|
4533
|
+
};
|
|
4534
|
+
};
|
|
4535
|
+
listTableAccess: {
|
|
4536
|
+
parameters: {
|
|
4537
|
+
query?: never;
|
|
4538
|
+
header?: {
|
|
4539
|
+
"sp-access-token"?: string;
|
|
4540
|
+
};
|
|
4541
|
+
path: {
|
|
4542
|
+
id: number;
|
|
4543
|
+
};
|
|
4544
|
+
cookie?: never;
|
|
4545
|
+
};
|
|
4546
|
+
requestBody?: never;
|
|
4547
|
+
responses: {
|
|
4548
|
+
/** @description Access rules for this table */
|
|
4549
|
+
200: {
|
|
4550
|
+
headers: {
|
|
4551
|
+
[name: string]: unknown;
|
|
4552
|
+
};
|
|
4553
|
+
content: {
|
|
4554
|
+
"application/json": {
|
|
4555
|
+
id: number;
|
|
4556
|
+
table_id: number;
|
|
4557
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4558
|
+
context_variable: string;
|
|
4559
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
4560
|
+
operator: string;
|
|
4561
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4562
|
+
value: string;
|
|
4563
|
+
is_active: boolean;
|
|
4564
|
+
created_at: string;
|
|
4565
|
+
updated_at: string;
|
|
4566
|
+
}[];
|
|
4567
|
+
};
|
|
4568
|
+
};
|
|
4569
|
+
/** @description Table not found */
|
|
4570
|
+
404: {
|
|
4571
|
+
headers: {
|
|
4572
|
+
[name: string]: unknown;
|
|
4573
|
+
};
|
|
4574
|
+
content: {
|
|
4575
|
+
"application/json": {
|
|
4576
|
+
error: string;
|
|
4577
|
+
};
|
|
4578
|
+
};
|
|
4579
|
+
};
|
|
4580
|
+
/** @description Internal server error */
|
|
4581
|
+
500: {
|
|
4582
|
+
headers: {
|
|
4583
|
+
[name: string]: unknown;
|
|
4584
|
+
};
|
|
4585
|
+
content: {
|
|
4586
|
+
"application/json": {
|
|
4587
|
+
error: string;
|
|
4588
|
+
};
|
|
4589
|
+
};
|
|
4590
|
+
};
|
|
4591
|
+
};
|
|
4592
|
+
};
|
|
4593
|
+
createTableAccess: {
|
|
4594
|
+
parameters: {
|
|
4595
|
+
query?: never;
|
|
4596
|
+
header?: {
|
|
4597
|
+
"sp-access-token"?: string;
|
|
4598
|
+
};
|
|
4599
|
+
path: {
|
|
4600
|
+
id: number;
|
|
4601
|
+
};
|
|
4602
|
+
cookie?: never;
|
|
4603
|
+
};
|
|
4604
|
+
requestBody: {
|
|
4605
|
+
content: {
|
|
4606
|
+
"application/json": {
|
|
4607
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4608
|
+
context_variable: string;
|
|
4609
|
+
/**
|
|
4610
|
+
* @description Comparison operator. Must be "=" or "!=".
|
|
4611
|
+
* @enum {string}
|
|
4612
|
+
*/
|
|
4613
|
+
operator: "=" | "!=";
|
|
4614
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4615
|
+
value: string;
|
|
4616
|
+
/** @default true */
|
|
4617
|
+
is_active?: boolean;
|
|
4618
|
+
};
|
|
4619
|
+
};
|
|
4620
|
+
};
|
|
4621
|
+
responses: {
|
|
4622
|
+
/** @description The created access rule */
|
|
4623
|
+
201: {
|
|
4624
|
+
headers: {
|
|
4625
|
+
[name: string]: unknown;
|
|
4626
|
+
};
|
|
4627
|
+
content: {
|
|
4628
|
+
"application/json": {
|
|
4629
|
+
id: number;
|
|
4630
|
+
table_id: number;
|
|
4631
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4632
|
+
context_variable: string;
|
|
4633
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
4634
|
+
operator: string;
|
|
4635
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4636
|
+
value: string;
|
|
4637
|
+
is_active: boolean;
|
|
4638
|
+
created_at: string;
|
|
4639
|
+
updated_at: string;
|
|
4640
|
+
};
|
|
4641
|
+
};
|
|
4642
|
+
};
|
|
4643
|
+
/** @description Invalid request */
|
|
4644
|
+
400: {
|
|
4645
|
+
headers: {
|
|
4646
|
+
[name: string]: unknown;
|
|
4647
|
+
};
|
|
4648
|
+
content: {
|
|
4649
|
+
"application/json": {
|
|
4650
|
+
error: string;
|
|
4651
|
+
};
|
|
4652
|
+
};
|
|
4653
|
+
};
|
|
4654
|
+
/** @description Table not found */
|
|
4655
|
+
404: {
|
|
4656
|
+
headers: {
|
|
4657
|
+
[name: string]: unknown;
|
|
4658
|
+
};
|
|
4659
|
+
content: {
|
|
4660
|
+
"application/json": {
|
|
4661
|
+
error: string;
|
|
4662
|
+
};
|
|
4663
|
+
};
|
|
4664
|
+
};
|
|
4665
|
+
/** @description Internal server error */
|
|
4666
|
+
500: {
|
|
4667
|
+
headers: {
|
|
4668
|
+
[name: string]: unknown;
|
|
4669
|
+
};
|
|
4670
|
+
content: {
|
|
4671
|
+
"application/json": {
|
|
4672
|
+
error: string;
|
|
4673
|
+
};
|
|
4674
|
+
};
|
|
4675
|
+
};
|
|
4676
|
+
};
|
|
4677
|
+
};
|
|
4678
|
+
getTableAccess: {
|
|
4679
|
+
parameters: {
|
|
4680
|
+
query?: never;
|
|
4681
|
+
header?: {
|
|
4682
|
+
"sp-access-token"?: string;
|
|
4683
|
+
};
|
|
4684
|
+
path: {
|
|
4685
|
+
id: number;
|
|
4686
|
+
accessId: number;
|
|
4687
|
+
};
|
|
4688
|
+
cookie?: never;
|
|
4689
|
+
};
|
|
4690
|
+
requestBody?: never;
|
|
4691
|
+
responses: {
|
|
4692
|
+
/** @description The access rule */
|
|
4693
|
+
200: {
|
|
4694
|
+
headers: {
|
|
4695
|
+
[name: string]: unknown;
|
|
4696
|
+
};
|
|
4697
|
+
content: {
|
|
4698
|
+
"application/json": {
|
|
4699
|
+
id: number;
|
|
4700
|
+
table_id: number;
|
|
4701
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4702
|
+
context_variable: string;
|
|
4703
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
4704
|
+
operator: string;
|
|
4705
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4706
|
+
value: string;
|
|
4707
|
+
is_active: boolean;
|
|
4708
|
+
created_at: string;
|
|
4709
|
+
updated_at: string;
|
|
4710
|
+
};
|
|
4711
|
+
};
|
|
4712
|
+
};
|
|
4713
|
+
/** @description Access rule not found */
|
|
4714
|
+
404: {
|
|
4715
|
+
headers: {
|
|
4716
|
+
[name: string]: unknown;
|
|
4717
|
+
};
|
|
4718
|
+
content: {
|
|
4719
|
+
"application/json": {
|
|
4720
|
+
error: string;
|
|
4721
|
+
};
|
|
4722
|
+
};
|
|
4723
|
+
};
|
|
4724
|
+
/** @description Internal server error */
|
|
4725
|
+
500: {
|
|
4726
|
+
headers: {
|
|
4727
|
+
[name: string]: unknown;
|
|
4728
|
+
};
|
|
4729
|
+
content: {
|
|
4730
|
+
"application/json": {
|
|
4731
|
+
error: string;
|
|
4732
|
+
};
|
|
4733
|
+
};
|
|
4734
|
+
};
|
|
4735
|
+
};
|
|
4736
|
+
};
|
|
4737
|
+
deleteTableAccess: {
|
|
4738
|
+
parameters: {
|
|
4739
|
+
query?: never;
|
|
4740
|
+
header?: {
|
|
4741
|
+
"sp-access-token"?: string;
|
|
4742
|
+
};
|
|
4743
|
+
path: {
|
|
4744
|
+
id: number;
|
|
4745
|
+
accessId: number;
|
|
4746
|
+
};
|
|
4747
|
+
cookie?: never;
|
|
4748
|
+
};
|
|
4749
|
+
requestBody?: never;
|
|
4750
|
+
responses: {
|
|
4751
|
+
/** @description Deletion result */
|
|
4752
|
+
200: {
|
|
4753
|
+
headers: {
|
|
4754
|
+
[name: string]: unknown;
|
|
4755
|
+
};
|
|
4756
|
+
content: {
|
|
4757
|
+
"application/json": {
|
|
4758
|
+
deleted: boolean;
|
|
4759
|
+
};
|
|
4760
|
+
};
|
|
4761
|
+
};
|
|
4762
|
+
/** @description Access rule not found */
|
|
4763
|
+
404: {
|
|
4764
|
+
headers: {
|
|
4765
|
+
[name: string]: unknown;
|
|
4766
|
+
};
|
|
4767
|
+
content: {
|
|
4768
|
+
"application/json": {
|
|
4769
|
+
error: string;
|
|
4770
|
+
};
|
|
4771
|
+
};
|
|
4772
|
+
};
|
|
4773
|
+
/** @description Internal server error */
|
|
4774
|
+
500: {
|
|
4775
|
+
headers: {
|
|
4776
|
+
[name: string]: unknown;
|
|
4777
|
+
};
|
|
4778
|
+
content: {
|
|
4779
|
+
"application/json": {
|
|
4780
|
+
error: string;
|
|
4781
|
+
};
|
|
4782
|
+
};
|
|
4783
|
+
};
|
|
4784
|
+
};
|
|
4785
|
+
};
|
|
4786
|
+
updateTableAccess: {
|
|
4787
|
+
parameters: {
|
|
4788
|
+
query?: never;
|
|
4789
|
+
header?: {
|
|
4790
|
+
"sp-access-token"?: string;
|
|
4791
|
+
};
|
|
4792
|
+
path: {
|
|
4793
|
+
id: number;
|
|
4794
|
+
accessId: number;
|
|
4795
|
+
};
|
|
4796
|
+
cookie?: never;
|
|
4797
|
+
};
|
|
4798
|
+
requestBody: {
|
|
4799
|
+
content: {
|
|
4800
|
+
"application/json": {
|
|
4801
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4802
|
+
context_variable?: string;
|
|
4803
|
+
/**
|
|
4804
|
+
* @description Comparison operator. Must be "=" or "!=".
|
|
4805
|
+
* @enum {string}
|
|
4806
|
+
*/
|
|
4807
|
+
operator?: "=" | "!=";
|
|
4808
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4809
|
+
value?: string;
|
|
4810
|
+
is_active?: boolean;
|
|
4811
|
+
};
|
|
4812
|
+
};
|
|
4813
|
+
};
|
|
4814
|
+
responses: {
|
|
4815
|
+
/** @description Updated access rule */
|
|
4816
|
+
200: {
|
|
4817
|
+
headers: {
|
|
4818
|
+
[name: string]: unknown;
|
|
4819
|
+
};
|
|
4820
|
+
content: {
|
|
4821
|
+
"application/json": {
|
|
4822
|
+
id: number;
|
|
4823
|
+
table_id: number;
|
|
4824
|
+
/** @description Top-level field name in the user metadata (e.g., company_id, department_name) */
|
|
4825
|
+
context_variable: string;
|
|
4826
|
+
/** @description Comparison operator. Must be "=" or "!=". */
|
|
4827
|
+
operator: string;
|
|
4828
|
+
/** @description Static value to compare against, e.g. `user_123`. */
|
|
4829
|
+
value: string;
|
|
4830
|
+
is_active: boolean;
|
|
4831
|
+
created_at: string;
|
|
4832
|
+
updated_at: string;
|
|
4833
|
+
};
|
|
4834
|
+
};
|
|
4835
|
+
};
|
|
4836
|
+
/** @description Invalid request */
|
|
4837
|
+
400: {
|
|
4838
|
+
headers: {
|
|
4839
|
+
[name: string]: unknown;
|
|
4840
|
+
};
|
|
4841
|
+
content: {
|
|
4842
|
+
"application/json": {
|
|
4843
|
+
error: string;
|
|
4844
|
+
};
|
|
4845
|
+
};
|
|
4846
|
+
};
|
|
4847
|
+
/** @description Access rule not found */
|
|
4848
|
+
404: {
|
|
4849
|
+
headers: {
|
|
4850
|
+
[name: string]: unknown;
|
|
4851
|
+
};
|
|
4852
|
+
content: {
|
|
4853
|
+
"application/json": {
|
|
4854
|
+
error: string;
|
|
4855
|
+
};
|
|
4856
|
+
};
|
|
4857
|
+
};
|
|
4858
|
+
/** @description Internal server error */
|
|
4859
|
+
500: {
|
|
4860
|
+
headers: {
|
|
4861
|
+
[name: string]: unknown;
|
|
4862
|
+
};
|
|
4863
|
+
content: {
|
|
4864
|
+
"application/json": {
|
|
4865
|
+
error: string;
|
|
4866
|
+
};
|
|
4867
|
+
};
|
|
4868
|
+
};
|
|
4869
|
+
};
|
|
4870
|
+
};
|
|
4871
|
+
listTableColumns: {
|
|
4872
|
+
parameters: {
|
|
4873
|
+
query?: never;
|
|
4874
|
+
header?: {
|
|
4875
|
+
"sp-access-token"?: string;
|
|
4876
|
+
};
|
|
4877
|
+
path: {
|
|
4878
|
+
id: number;
|
|
4879
|
+
};
|
|
4880
|
+
cookie?: never;
|
|
4881
|
+
};
|
|
4882
|
+
requestBody?: never;
|
|
4883
|
+
responses: {
|
|
4884
|
+
/** @description Columns for the given table */
|
|
4885
|
+
200: {
|
|
4886
|
+
headers: {
|
|
4887
|
+
[name: string]: unknown;
|
|
4888
|
+
};
|
|
4889
|
+
content: {
|
|
4890
|
+
"application/json": {
|
|
4891
|
+
id: number;
|
|
4892
|
+
table_id: number;
|
|
4893
|
+
name: string;
|
|
4894
|
+
data_type: string | null;
|
|
4895
|
+
description: string | null;
|
|
4896
|
+
/** @description Whether this column is visible to end users */
|
|
4897
|
+
is_visible: boolean;
|
|
4898
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
4899
|
+
is_indexed: boolean;
|
|
4900
|
+
created_at: string;
|
|
4901
|
+
updated_at: string;
|
|
4902
|
+
}[];
|
|
4903
|
+
};
|
|
4904
|
+
};
|
|
4905
|
+
/** @description Table not found */
|
|
4906
|
+
404: {
|
|
4907
|
+
headers: {
|
|
4908
|
+
[name: string]: unknown;
|
|
4909
|
+
};
|
|
4910
|
+
content: {
|
|
4911
|
+
"application/json": {
|
|
4912
|
+
error: string;
|
|
4913
|
+
};
|
|
4914
|
+
};
|
|
4915
|
+
};
|
|
4916
|
+
/** @description Internal server error */
|
|
4917
|
+
500: {
|
|
4918
|
+
headers: {
|
|
4919
|
+
[name: string]: unknown;
|
|
4920
|
+
};
|
|
4921
|
+
content: {
|
|
4922
|
+
"application/json": {
|
|
4923
|
+
error: string;
|
|
4924
|
+
};
|
|
4925
|
+
};
|
|
4926
|
+
};
|
|
4927
|
+
};
|
|
4928
|
+
};
|
|
4929
|
+
getTableColumn: {
|
|
4930
|
+
parameters: {
|
|
4931
|
+
query?: never;
|
|
4932
|
+
header?: {
|
|
4933
|
+
"sp-access-token"?: string;
|
|
4934
|
+
};
|
|
4935
|
+
path: {
|
|
4936
|
+
id: number;
|
|
4937
|
+
columnId: number;
|
|
4938
|
+
};
|
|
4939
|
+
cookie?: never;
|
|
4940
|
+
};
|
|
4941
|
+
requestBody?: never;
|
|
4942
|
+
responses: {
|
|
4943
|
+
/** @description The column */
|
|
4944
|
+
200: {
|
|
4945
|
+
headers: {
|
|
4946
|
+
[name: string]: unknown;
|
|
4947
|
+
};
|
|
4948
|
+
content: {
|
|
4949
|
+
"application/json": {
|
|
4950
|
+
id: number;
|
|
4951
|
+
table_id: number;
|
|
4952
|
+
name: string;
|
|
4953
|
+
data_type: string | null;
|
|
4954
|
+
description: string | null;
|
|
4955
|
+
/** @description Whether this column is visible to end users */
|
|
4956
|
+
is_visible: boolean;
|
|
4957
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
4958
|
+
is_indexed: boolean;
|
|
4959
|
+
created_at: string;
|
|
4960
|
+
updated_at: string;
|
|
4961
|
+
};
|
|
4962
|
+
};
|
|
4963
|
+
};
|
|
4964
|
+
/** @description Column not found */
|
|
4965
|
+
404: {
|
|
4966
|
+
headers: {
|
|
4967
|
+
[name: string]: unknown;
|
|
4968
|
+
};
|
|
4969
|
+
content: {
|
|
4970
|
+
"application/json": {
|
|
4971
|
+
error: string;
|
|
4972
|
+
};
|
|
4973
|
+
};
|
|
4974
|
+
};
|
|
4975
|
+
/** @description Internal server error */
|
|
4976
|
+
500: {
|
|
4977
|
+
headers: {
|
|
4978
|
+
[name: string]: unknown;
|
|
4979
|
+
};
|
|
4980
|
+
content: {
|
|
4981
|
+
"application/json": {
|
|
4982
|
+
error: string;
|
|
4983
|
+
};
|
|
4984
|
+
};
|
|
4985
|
+
};
|
|
4986
|
+
};
|
|
4987
|
+
};
|
|
4988
|
+
updateTableColumn: {
|
|
4989
|
+
parameters: {
|
|
4990
|
+
query?: never;
|
|
4991
|
+
header?: {
|
|
4992
|
+
"sp-access-token"?: string;
|
|
4993
|
+
};
|
|
4994
|
+
path: {
|
|
4995
|
+
id: number;
|
|
4996
|
+
columnId: number;
|
|
4997
|
+
};
|
|
4998
|
+
cookie?: never;
|
|
4999
|
+
};
|
|
5000
|
+
requestBody: {
|
|
5001
|
+
content: {
|
|
5002
|
+
"application/json": {
|
|
5003
|
+
/** @description Whether this column is visible to end users */
|
|
5004
|
+
is_visible?: boolean;
|
|
5005
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
5006
|
+
is_indexed?: boolean;
|
|
5007
|
+
};
|
|
5008
|
+
};
|
|
5009
|
+
};
|
|
5010
|
+
responses: {
|
|
5011
|
+
/** @description Updated column */
|
|
5012
|
+
200: {
|
|
5013
|
+
headers: {
|
|
5014
|
+
[name: string]: unknown;
|
|
5015
|
+
};
|
|
5016
|
+
content: {
|
|
5017
|
+
"application/json": {
|
|
5018
|
+
id: number;
|
|
5019
|
+
table_id: number;
|
|
5020
|
+
name: string;
|
|
5021
|
+
data_type: string | null;
|
|
5022
|
+
description: string | null;
|
|
5023
|
+
/** @description Whether this column is visible to end users */
|
|
5024
|
+
is_visible: boolean;
|
|
5025
|
+
/** @description Whether this column is indexed for search and filtering */
|
|
5026
|
+
is_indexed: boolean;
|
|
5027
|
+
created_at: string;
|
|
5028
|
+
updated_at: string;
|
|
5029
|
+
};
|
|
5030
|
+
};
|
|
5031
|
+
};
|
|
5032
|
+
/** @description Invalid request */
|
|
5033
|
+
400: {
|
|
5034
|
+
headers: {
|
|
5035
|
+
[name: string]: unknown;
|
|
5036
|
+
};
|
|
5037
|
+
content: {
|
|
5038
|
+
"application/json": {
|
|
5039
|
+
error: string;
|
|
5040
|
+
};
|
|
5041
|
+
};
|
|
5042
|
+
};
|
|
5043
|
+
/** @description Column not found */
|
|
5044
|
+
404: {
|
|
5045
|
+
headers: {
|
|
5046
|
+
[name: string]: unknown;
|
|
5047
|
+
};
|
|
5048
|
+
content: {
|
|
5049
|
+
"application/json": {
|
|
5050
|
+
error: string;
|
|
5051
|
+
};
|
|
5052
|
+
};
|
|
5053
|
+
};
|
|
5054
|
+
/** @description Internal server error */
|
|
5055
|
+
500: {
|
|
5056
|
+
headers: {
|
|
5057
|
+
[name: string]: unknown;
|
|
5058
|
+
};
|
|
5059
|
+
content: {
|
|
5060
|
+
"application/json": {
|
|
5061
|
+
error: string;
|
|
5062
|
+
};
|
|
5063
|
+
};
|
|
5064
|
+
};
|
|
5065
|
+
};
|
|
5066
|
+
};
|
|
5067
|
+
}
|
|
5068
|
+
|
|
5069
|
+
declare type PatchParam<T, Config extends RemoveParamsConfig, P extends keyof Config> = Simplify<T extends {
|
|
5070
|
+
[key in P]: infer H;
|
|
5071
|
+
} ? H extends Partial<Record<string, unknown>> ? Config[P] extends string ? Omit<H, Config[P]> : H : never : never>;
|
|
5072
|
+
|
|
5073
|
+
/**
|
|
5074
|
+
* This file was auto-generated by openapi-typescript.
|
|
5075
|
+
* Do not make direct changes to the file.
|
|
5076
|
+
*/
|
|
5077
|
+
|
|
5078
|
+
declare interface paths {
|
|
5079
|
+
"/api/v1/auth/exchangeExternalToken": {
|
|
3542
5080
|
parameters: {
|
|
3543
5081
|
query?: never;
|
|
3544
5082
|
header?: never;
|
|
3545
5083
|
path?: never;
|
|
3546
5084
|
cookie?: never;
|
|
3547
5085
|
};
|
|
3548
|
-
get
|
|
5086
|
+
get?: never;
|
|
5087
|
+
put?: never;
|
|
5088
|
+
post: operations["exchangeExternalToken"];
|
|
5089
|
+
delete?: never;
|
|
5090
|
+
options?: never;
|
|
5091
|
+
head?: never;
|
|
5092
|
+
patch?: never;
|
|
5093
|
+
trace?: never;
|
|
5094
|
+
};
|
|
5095
|
+
"/api/v1/auth/apiInformation": {
|
|
5096
|
+
parameters: {
|
|
5097
|
+
query?: never;
|
|
5098
|
+
header?: never;
|
|
5099
|
+
path?: never;
|
|
5100
|
+
cookie?: never;
|
|
5101
|
+
};
|
|
5102
|
+
get: operations["getApiInformation"];
|
|
3549
5103
|
put?: never;
|
|
3550
5104
|
post?: never;
|
|
3551
5105
|
delete?: never;
|
|
@@ -3554,14 +5108,14 @@ declare interface paths {
|
|
|
3554
5108
|
patch?: never;
|
|
3555
5109
|
trace?: never;
|
|
3556
5110
|
};
|
|
3557
|
-
"/api/v1/public/canvas/{canvas_id}/
|
|
5111
|
+
"/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/columns": {
|
|
3558
5112
|
parameters: {
|
|
3559
5113
|
query?: never;
|
|
3560
5114
|
header?: never;
|
|
3561
5115
|
path?: never;
|
|
3562
5116
|
cookie?: never;
|
|
3563
5117
|
};
|
|
3564
|
-
get: operations["
|
|
5118
|
+
get: operations["getPublicCanvasDataReportColumns"];
|
|
3565
5119
|
put?: never;
|
|
3566
5120
|
post?: never;
|
|
3567
5121
|
delete?: never;
|
|
@@ -3570,14 +5124,14 @@ declare interface paths {
|
|
|
3570
5124
|
patch?: never;
|
|
3571
5125
|
trace?: never;
|
|
3572
5126
|
};
|
|
3573
|
-
"/api/v1/
|
|
5127
|
+
"/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/data": {
|
|
3574
5128
|
parameters: {
|
|
3575
5129
|
query?: never;
|
|
3576
5130
|
header?: never;
|
|
3577
5131
|
path?: never;
|
|
3578
5132
|
cookie?: never;
|
|
3579
5133
|
};
|
|
3580
|
-
get: operations["
|
|
5134
|
+
get: operations["getPublicCanvasDataReportData"];
|
|
3581
5135
|
put?: never;
|
|
3582
5136
|
post?: never;
|
|
3583
5137
|
delete?: never;
|
|
@@ -3586,14 +5140,14 @@ declare interface paths {
|
|
|
3586
5140
|
patch?: never;
|
|
3587
5141
|
trace?: never;
|
|
3588
5142
|
};
|
|
3589
|
-
"/api/v1/
|
|
5143
|
+
"/api/v1/public/canvas/{canvas_id}/data-reports/{report_id}/count": {
|
|
3590
5144
|
parameters: {
|
|
3591
5145
|
query?: never;
|
|
3592
5146
|
header?: never;
|
|
3593
5147
|
path?: never;
|
|
3594
5148
|
cookie?: never;
|
|
3595
5149
|
};
|
|
3596
|
-
get: operations["
|
|
5150
|
+
get: operations["getPublicCanvasDataReportRowCount"];
|
|
3597
5151
|
put?: never;
|
|
3598
5152
|
post?: never;
|
|
3599
5153
|
delete?: never;
|
|
@@ -3602,14 +5156,14 @@ declare interface paths {
|
|
|
3602
5156
|
patch?: never;
|
|
3603
5157
|
trace?: never;
|
|
3604
5158
|
};
|
|
3605
|
-
"/api/v1/
|
|
5159
|
+
"/api/v1/public/canvas/{canvas_id}": {
|
|
3606
5160
|
parameters: {
|
|
3607
5161
|
query?: never;
|
|
3608
5162
|
header?: never;
|
|
3609
5163
|
path?: never;
|
|
3610
5164
|
cookie?: never;
|
|
3611
5165
|
};
|
|
3612
|
-
get: operations["
|
|
5166
|
+
get: operations["retrievePublicCanvas"];
|
|
3613
5167
|
put?: never;
|
|
3614
5168
|
post?: never;
|
|
3615
5169
|
delete?: never;
|
|
@@ -3618,30 +5172,62 @@ declare interface paths {
|
|
|
3618
5172
|
patch?: never;
|
|
3619
5173
|
trace?: never;
|
|
3620
5174
|
};
|
|
3621
|
-
"/api/v1/
|
|
5175
|
+
"/api/v1/public/canvas/{canvas_id}/visualizations/{visualization_id}": {
|
|
3622
5176
|
parameters: {
|
|
3623
5177
|
query?: never;
|
|
3624
5178
|
header?: never;
|
|
3625
5179
|
path?: never;
|
|
3626
5180
|
cookie?: never;
|
|
3627
5181
|
};
|
|
3628
|
-
get: operations["
|
|
5182
|
+
get: operations["PublicCanvasFetchVisualization"];
|
|
3629
5183
|
put?: never;
|
|
3630
|
-
post
|
|
3631
|
-
delete
|
|
5184
|
+
post?: never;
|
|
5185
|
+
delete?: never;
|
|
5186
|
+
options?: never;
|
|
5187
|
+
head?: never;
|
|
5188
|
+
patch?: never;
|
|
5189
|
+
trace?: never;
|
|
5190
|
+
};
|
|
5191
|
+
"/api/v1/flows/{flowId}": {
|
|
5192
|
+
parameters: {
|
|
5193
|
+
query?: never;
|
|
5194
|
+
header?: never;
|
|
5195
|
+
path?: never;
|
|
5196
|
+
cookie?: never;
|
|
5197
|
+
};
|
|
5198
|
+
get: operations["retrieveFlow"];
|
|
5199
|
+
put?: never;
|
|
5200
|
+
post?: never;
|
|
5201
|
+
delete?: never;
|
|
5202
|
+
options?: never;
|
|
5203
|
+
head?: never;
|
|
5204
|
+
patch?: never;
|
|
5205
|
+
trace?: never;
|
|
5206
|
+
};
|
|
5207
|
+
"/api/v1/recent-flows": {
|
|
5208
|
+
parameters: {
|
|
5209
|
+
query?: never;
|
|
5210
|
+
header?: never;
|
|
5211
|
+
path?: never;
|
|
5212
|
+
cookie?: never;
|
|
5213
|
+
};
|
|
5214
|
+
get: operations["retrieveRecentFlows"];
|
|
5215
|
+
put?: never;
|
|
5216
|
+
post?: never;
|
|
5217
|
+
delete?: never;
|
|
3632
5218
|
options?: never;
|
|
3633
5219
|
head?: never;
|
|
3634
5220
|
patch?: never;
|
|
3635
5221
|
trace?: never;
|
|
3636
5222
|
};
|
|
3637
|
-
"/api/v1/flows/{flowId}/data-reports
|
|
5223
|
+
"/api/v1/flows/{flowId}/data-reports": {
|
|
3638
5224
|
parameters: {
|
|
3639
5225
|
query?: never;
|
|
3640
5226
|
header?: never;
|
|
3641
5227
|
path?: never;
|
|
3642
5228
|
cookie?: never;
|
|
3643
5229
|
};
|
|
3644
|
-
get: operations["
|
|
5230
|
+
get: operations["retrieveFlowDataReports"];
|
|
3645
5231
|
put?: never;
|
|
3646
5232
|
post?: never;
|
|
3647
5233
|
delete?: never;
|
|
@@ -3650,6 +5236,22 @@ declare interface paths {
|
|
|
3650
5236
|
patch?: never;
|
|
3651
5237
|
trace?: never;
|
|
3652
5238
|
};
|
|
5239
|
+
"/api/v1/data-reports/{report_id}/feedback": {
|
|
5240
|
+
parameters: {
|
|
5241
|
+
query?: never;
|
|
5242
|
+
header?: never;
|
|
5243
|
+
path?: never;
|
|
5244
|
+
cookie?: never;
|
|
5245
|
+
};
|
|
5246
|
+
get: operations["getDataReportFeedback"];
|
|
5247
|
+
put?: never;
|
|
5248
|
+
post: operations["upsertReportFeedback"];
|
|
5249
|
+
delete: operations["deleteReportFeedback"];
|
|
5250
|
+
options?: never;
|
|
5251
|
+
head?: never;
|
|
5252
|
+
patch?: never;
|
|
5253
|
+
trace?: never;
|
|
5254
|
+
};
|
|
3653
5255
|
"/api/v1/data-reports/{report_id}/explainability": {
|
|
3654
5256
|
parameters: {
|
|
3655
5257
|
query?: never;
|
|
@@ -4066,6 +5668,166 @@ declare interface paths {
|
|
|
4066
5668
|
patch?: never;
|
|
4067
5669
|
trace?: never;
|
|
4068
5670
|
};
|
|
5671
|
+
"/api/v1/applications": {
|
|
5672
|
+
parameters: {
|
|
5673
|
+
query?: never;
|
|
5674
|
+
header?: never;
|
|
5675
|
+
path?: never;
|
|
5676
|
+
cookie?: never;
|
|
5677
|
+
};
|
|
5678
|
+
get: operations["listApplications"];
|
|
5679
|
+
put?: never;
|
|
5680
|
+
post: operations["createApplication"];
|
|
5681
|
+
delete?: never;
|
|
5682
|
+
options?: never;
|
|
5683
|
+
head?: never;
|
|
5684
|
+
patch?: never;
|
|
5685
|
+
trace?: never;
|
|
5686
|
+
};
|
|
5687
|
+
"/api/v1/applications/{id}": {
|
|
5688
|
+
parameters: {
|
|
5689
|
+
query?: never;
|
|
5690
|
+
header?: never;
|
|
5691
|
+
path?: never;
|
|
5692
|
+
cookie?: never;
|
|
5693
|
+
};
|
|
5694
|
+
get: operations["getApplication"];
|
|
5695
|
+
put?: never;
|
|
5696
|
+
post?: never;
|
|
5697
|
+
delete: operations["deleteApplication"];
|
|
5698
|
+
options?: never;
|
|
5699
|
+
head?: never;
|
|
5700
|
+
patch: operations["updateApplication"];
|
|
5701
|
+
trace?: never;
|
|
5702
|
+
};
|
|
5703
|
+
"/api/v1/tables": {
|
|
5704
|
+
parameters: {
|
|
5705
|
+
query?: never;
|
|
5706
|
+
header?: never;
|
|
5707
|
+
path?: never;
|
|
5708
|
+
cookie?: never;
|
|
5709
|
+
};
|
|
5710
|
+
get: operations["listTables"];
|
|
5711
|
+
put?: never;
|
|
5712
|
+
post: operations["createTable"];
|
|
5713
|
+
delete?: never;
|
|
5714
|
+
options?: never;
|
|
5715
|
+
head?: never;
|
|
5716
|
+
patch?: never;
|
|
5717
|
+
trace?: never;
|
|
5718
|
+
};
|
|
5719
|
+
"/api/v1/tables/{id}": {
|
|
5720
|
+
parameters: {
|
|
5721
|
+
query?: never;
|
|
5722
|
+
header?: never;
|
|
5723
|
+
path?: never;
|
|
5724
|
+
cookie?: never;
|
|
5725
|
+
};
|
|
5726
|
+
get: operations["getTable"];
|
|
5727
|
+
put?: never;
|
|
5728
|
+
post?: never;
|
|
5729
|
+
delete: operations["deleteTable"];
|
|
5730
|
+
options?: never;
|
|
5731
|
+
head?: never;
|
|
5732
|
+
patch: operations["updateTable"];
|
|
5733
|
+
trace?: never;
|
|
5734
|
+
};
|
|
5735
|
+
"/api/v1/tables/{id}/rls": {
|
|
5736
|
+
parameters: {
|
|
5737
|
+
query?: never;
|
|
5738
|
+
header?: never;
|
|
5739
|
+
path?: never;
|
|
5740
|
+
cookie?: never;
|
|
5741
|
+
};
|
|
5742
|
+
get: operations["listTableRls"];
|
|
5743
|
+
put?: never;
|
|
5744
|
+
post: operations["createTableRls"];
|
|
5745
|
+
delete?: never;
|
|
5746
|
+
options?: never;
|
|
5747
|
+
head?: never;
|
|
5748
|
+
patch?: never;
|
|
5749
|
+
trace?: never;
|
|
5750
|
+
};
|
|
5751
|
+
"/api/v1/tables/{id}/rls/{rlsId}": {
|
|
5752
|
+
parameters: {
|
|
5753
|
+
query?: never;
|
|
5754
|
+
header?: never;
|
|
5755
|
+
path?: never;
|
|
5756
|
+
cookie?: never;
|
|
5757
|
+
};
|
|
5758
|
+
get: operations["getTableRls"];
|
|
5759
|
+
put?: never;
|
|
5760
|
+
post?: never;
|
|
5761
|
+
delete: operations["deleteTableRls"];
|
|
5762
|
+
options?: never;
|
|
5763
|
+
head?: never;
|
|
5764
|
+
patch: operations["updateTableRls"];
|
|
5765
|
+
trace?: never;
|
|
5766
|
+
};
|
|
5767
|
+
"/api/v1/tables/{id}/access": {
|
|
5768
|
+
parameters: {
|
|
5769
|
+
query?: never;
|
|
5770
|
+
header?: never;
|
|
5771
|
+
path?: never;
|
|
5772
|
+
cookie?: never;
|
|
5773
|
+
};
|
|
5774
|
+
get: operations["listTableAccess"];
|
|
5775
|
+
put?: never;
|
|
5776
|
+
post: operations["createTableAccess"];
|
|
5777
|
+
delete?: never;
|
|
5778
|
+
options?: never;
|
|
5779
|
+
head?: never;
|
|
5780
|
+
patch?: never;
|
|
5781
|
+
trace?: never;
|
|
5782
|
+
};
|
|
5783
|
+
"/api/v1/tables/{id}/access/{accessId}": {
|
|
5784
|
+
parameters: {
|
|
5785
|
+
query?: never;
|
|
5786
|
+
header?: never;
|
|
5787
|
+
path?: never;
|
|
5788
|
+
cookie?: never;
|
|
5789
|
+
};
|
|
5790
|
+
get: operations["getTableAccess"];
|
|
5791
|
+
put?: never;
|
|
5792
|
+
post?: never;
|
|
5793
|
+
delete: operations["deleteTableAccess"];
|
|
5794
|
+
options?: never;
|
|
5795
|
+
head?: never;
|
|
5796
|
+
patch: operations["updateTableAccess"];
|
|
5797
|
+
trace?: never;
|
|
5798
|
+
};
|
|
5799
|
+
"/api/v1/tables/{id}/columns": {
|
|
5800
|
+
parameters: {
|
|
5801
|
+
query?: never;
|
|
5802
|
+
header?: never;
|
|
5803
|
+
path?: never;
|
|
5804
|
+
cookie?: never;
|
|
5805
|
+
};
|
|
5806
|
+
get: operations["listTableColumns"];
|
|
5807
|
+
put?: never;
|
|
5808
|
+
post?: never;
|
|
5809
|
+
delete?: never;
|
|
5810
|
+
options?: never;
|
|
5811
|
+
head?: never;
|
|
5812
|
+
patch?: never;
|
|
5813
|
+
trace?: never;
|
|
5814
|
+
};
|
|
5815
|
+
"/api/v1/tables/{id}/columns/{columnId}": {
|
|
5816
|
+
parameters: {
|
|
5817
|
+
query?: never;
|
|
5818
|
+
header?: never;
|
|
5819
|
+
path?: never;
|
|
5820
|
+
cookie?: never;
|
|
5821
|
+
};
|
|
5822
|
+
get: operations["getTableColumn"];
|
|
5823
|
+
put?: never;
|
|
5824
|
+
post?: never;
|
|
5825
|
+
delete?: never;
|
|
5826
|
+
options?: never;
|
|
5827
|
+
head?: never;
|
|
5828
|
+
patch: operations["updateTableColumn"];
|
|
5829
|
+
trace?: never;
|
|
5830
|
+
};
|
|
4069
5831
|
}
|
|
4070
5832
|
|
|
4071
5833
|
declare type PublicApiClient = Simplify<Client<PublicPaths, `${string}/${string}`>>;
|