@malloy-publisher/sdk 0.0.119 → 0.0.121

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.
@@ -1,6 +1,55 @@
1
1
  import { Configuration } from './configuration';
2
2
  import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig, AxiosResponse } from 'axios';
3
3
  import { RequestArgs, BaseAPI } from './base';
4
+ /**
5
+ * Attached DuckDB database
6
+ * @export
7
+ * @interface AttachedDatabase
8
+ */
9
+ export interface AttachedDatabase {
10
+ /**
11
+ * Name of the connection
12
+ * @type {string}
13
+ * @memberof AttachedDatabase
14
+ */
15
+ 'name'?: string;
16
+ /**
17
+ * Type of database connection
18
+ * @type {string}
19
+ * @memberof AttachedDatabase
20
+ */
21
+ 'type'?: AttachedDatabaseTypeEnum;
22
+ /**
23
+ *
24
+ * @type {ConnectionAttributes}
25
+ * @memberof AttachedDatabase
26
+ */
27
+ 'attributes'?: ConnectionAttributes;
28
+ /**
29
+ *
30
+ * @type {BigqueryConnection}
31
+ * @memberof AttachedDatabase
32
+ */
33
+ 'bigqueryConnection'?: BigqueryConnection;
34
+ /**
35
+ *
36
+ * @type {SnowflakeConnection}
37
+ * @memberof AttachedDatabase
38
+ */
39
+ 'snowflakeConnection'?: SnowflakeConnection;
40
+ /**
41
+ *
42
+ * @type {PostgresConnection}
43
+ * @memberof AttachedDatabase
44
+ */
45
+ 'postgresConnection'?: PostgresConnection;
46
+ }
47
+ export declare const AttachedDatabaseTypeEnum: {
48
+ readonly Bigquery: "bigquery";
49
+ readonly Snowflake: "snowflake";
50
+ readonly Postgres: "postgres";
51
+ };
52
+ export type AttachedDatabaseTypeEnum = typeof AttachedDatabaseTypeEnum[keyof typeof AttachedDatabaseTypeEnum];
4
53
  /**
5
54
  * Google BigQuery database connection configuration
6
55
  * @export
@@ -209,6 +258,12 @@ export interface Connection {
209
258
  * @memberof Connection
210
259
  */
211
260
  'mysqlConnection'?: MysqlConnection;
261
+ /**
262
+ *
263
+ * @type {DuckdbConnection}
264
+ * @memberof Connection
265
+ */
266
+ 'duckdbConnection'?: DuckdbConnection;
212
267
  }
213
268
  export declare const ConnectionTypeEnum: {
214
269
  readonly Postgres: "postgres";
@@ -216,6 +271,7 @@ export declare const ConnectionTypeEnum: {
216
271
  readonly Snowflake: "snowflake";
217
272
  readonly Trino: "trino";
218
273
  readonly Mysql: "mysql";
274
+ readonly Duckdb: "duckdb";
219
275
  };
220
276
  export type ConnectionTypeEnum = typeof ConnectionTypeEnum[keyof typeof ConnectionTypeEnum];
221
277
  /**
@@ -309,6 +365,19 @@ export declare const DatabaseTypeEnum: {
309
365
  readonly Materialized: "materialized";
310
366
  };
311
367
  export type DatabaseTypeEnum = typeof DatabaseTypeEnum[keyof typeof DatabaseTypeEnum];
368
+ /**
369
+ * DuckDB database connection configuration
370
+ * @export
371
+ * @interface DuckdbConnection
372
+ */
373
+ export interface DuckdbConnection {
374
+ /**
375
+ *
376
+ * @type {any}
377
+ * @memberof DuckdbConnection
378
+ */
379
+ 'attachedDatabases'?: any;
380
+ }
312
381
  /**
313
382
  * Malloy model metadata and status information
314
383
  * @export
@@ -638,95 +707,83 @@ export interface QueryData {
638
707
  'data'?: string;
639
708
  }
640
709
  /**
641
- * Results from executing a Malloy query
710
+ * Request body for executing a Malloy query
642
711
  * @export
643
- * @interface QueryResult
712
+ * @interface QueryRequest
644
713
  */
645
- export interface QueryResult {
646
- /**
647
- * JSON string containing the query results, metadata, and execution information
648
- * @type {string}
649
- * @memberof QueryResult
650
- */
651
- 'result'?: string;
714
+ export interface QueryRequest {
652
715
  /**
653
- * Resource path to the query result
716
+ * Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
654
717
  * @type {string}
655
- * @memberof QueryResult
718
+ * @memberof QueryRequest
656
719
  */
657
- 'resource'?: string;
658
- }
659
- /**
660
- * Scheduled task configuration and status
661
- * @export
662
- * @interface Schedule
663
- */
664
- export interface Schedule {
720
+ 'query'?: string;
665
721
  /**
666
- * Resource path in the package that the schedule is attached to
722
+ * Name of the source in the model to use for queryName, search, and topValue requests.
667
723
  * @type {string}
668
- * @memberof Schedule
724
+ * @memberof QueryRequest
669
725
  */
670
- 'resource'?: string;
726
+ 'sourceName'?: string;
671
727
  /**
672
- * Schedule expression in cron format for executing the task
728
+ * Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.
673
729
  * @type {string}
674
- * @memberof Schedule
730
+ * @memberof QueryRequest
675
731
  */
676
- 'schedule'?: string;
732
+ 'queryName'?: string;
677
733
  /**
678
- * Action to execute when the schedule triggers
734
+ * Version ID
679
735
  * @type {string}
680
- * @memberof Schedule
736
+ * @memberof QueryRequest
681
737
  */
682
- 'action'?: string;
738
+ 'versionId'?: string;
739
+ }
740
+ /**
741
+ * Results from executing a Malloy query
742
+ * @export
743
+ * @interface QueryResult
744
+ */
745
+ export interface QueryResult {
683
746
  /**
684
- * Name of the connection to perform the action on
747
+ * JSON string containing the query results, metadata, and execution information
685
748
  * @type {string}
686
- * @memberof Schedule
687
- */
688
- 'connection'?: string;
689
- /**
690
- * Unix timestamp in milliseconds of the last execution
691
- * @type {number}
692
- * @memberof Schedule
749
+ * @memberof QueryResult
693
750
  */
694
- 'lastRunTime'?: number;
751
+ 'result'?: string;
695
752
  /**
696
- * Status of the last execution
753
+ * Resource path to the query result
697
754
  * @type {string}
698
- * @memberof Schedule
755
+ * @memberof QueryResult
699
756
  */
700
- 'lastRunStatus'?: string;
757
+ 'resource'?: string;
701
758
  }
702
759
  /**
703
760
  * A schema name in a Connection.
704
761
  * @export
705
- * @interface SchemaName
762
+ * @interface Schema
706
763
  */
707
- export interface SchemaName {
764
+ export interface Schema {
708
765
  /**
709
766
  * Name of the schema
710
767
  * @type {string}
711
- * @memberof SchemaName
768
+ * @memberof Schema
712
769
  */
713
770
  'name'?: string;
714
771
  /**
715
772
  * Description of the schema
716
773
  * @type {string}
717
- * @memberof SchemaName
774
+ * @memberof Schema
718
775
  */
719
776
  'description'?: string;
720
777
  /**
721
778
  * Whether this schema is the default schema
722
779
  * @type {boolean}
723
- * @memberof SchemaName
780
+ * @memberof Schema
724
781
  */
725
782
  'isDefault'?: boolean;
726
783
  /**
727
784
  * Whether this schema is hidden
728
785
  * @type {boolean}
729
- * @memberof SchemaName
786
+ * @memberof Schema
730
787
  */
731
788
  'isHidden'?: boolean;
732
789
  }
@@ -842,6 +899,25 @@ export interface StartWatchRequest {
842
899
  */
843
900
  'projectName': string;
844
901
  }
902
+ /**
903
+ *
904
+ * @export
905
+ * @interface Table
906
+ */
907
+ export interface Table {
908
+ /**
909
+ * Resource path to the table.
910
+ * @type {string}
911
+ * @memberof Table
912
+ */
913
+ 'resource'?: string;
914
+ /**
915
+ * Table fields
916
+ * @type {Array<Column>}
917
+ * @memberof Table
918
+ */
919
+ 'columns'?: Array<Column>;
920
+ }
845
921
  /**
846
922
  * Database table structure and metadata
847
923
  * @export
@@ -1035,6 +1111,17 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1035
1111
  * @throws {RequiredError}
1036
1112
  */
1037
1113
  getSqlsource: (projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1114
+ /**
1115
+ * Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
1116
+ * @summary Get table details from database
1117
+ * @param {string} projectName Name of the project
1118
+ * @param {string} connectionName Name of the connection
1119
+ * @param {string} schemaName Name of the schema
1120
+ * @param {string} tablePath Full path to the table
1121
+ * @param {*} [options] Override http request option.
1122
+ * @throws {RequiredError}
1123
+ */
1124
+ getTable: (projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1038
1125
  /**
1039
1126
  * Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
1040
1127
  * @summary Get table source information
@@ -1043,6 +1130,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1043
1130
  * @param {string} [tableKey] Table key
1044
1131
  * @param {string} [tablePath] Table path
1045
1132
  * @param {*} [options] Override http request option.
1133
+ * @deprecated
1046
1134
  * @throws {RequiredError}
1047
1135
  */
1048
1136
  getTablesource: (projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -1076,7 +1164,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1076
1164
  listSchemas: (projectName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1077
1165
  /**
1078
1166
  * Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
1079
- * @summary List tables in database schema
1167
+ * @summary List tables in database
1080
1168
  * @param {string} projectName Name of the project
1081
1169
  * @param {string} connectionName Name of the connection
1082
1170
  * @param {string} schemaName Name of the schema
@@ -1085,7 +1173,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1085
1173
  */
1086
1174
  listTables: (projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1087
1175
  /**
1088
- * Executes a SQL statement against the specified database connection and returns the results. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. The results include data, metadata, and execution information.
1176
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1089
1177
  * @summary Execute SQL query
1090
1178
  * @param {string} projectName Name of the project
1091
1179
  * @param {string} connectionName Name of the connection
@@ -1096,7 +1184,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1096
1184
  */
1097
1185
  postQuerydata: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1098
1186
  /**
1099
- * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements.
1187
+ * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1100
1188
  * @summary Create SQL source from statement
1101
1189
  * @param {string} projectName Name of the project
1102
1190
  * @param {string} connectionName Name of the connection
@@ -1106,7 +1194,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1106
1194
  */
1107
1195
  postSqlsource: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1108
1196
  /**
1109
- * Creates a temporary table from a SQL statement using the specified database connection. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1197
+ * Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1110
1198
  * @summary Create temporary table
1111
1199
  * @param {string} projectName Name of the project
1112
1200
  * @param {string} connectionName Name of the connection
@@ -1115,23 +1203,6 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
1115
1203
  * @throws {RequiredError}
1116
1204
  */
1117
1205
  postTemporarytable: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1118
- /**
1119
- * Tests the connectivity and configuration of an existing database connection within a project. This endpoint validates that the connection can be established, credentials are valid, and the database is accessible. Useful for monitoring connection health and troubleshooting.
1120
- * @summary Test existing project connection
1121
- * @param {string} projectName Name of the project
1122
- * @param {string} connectionName Name of the connection
1123
- * @param {*} [options] Override http request option.
1124
- * @throws {RequiredError}
1125
- */
1126
- testConnection: (projectName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1127
- /**
1128
- * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1129
- * @summary Test database connection configuration
1130
- * @param {Connection} connection
1131
- * @param {*} [options] Override http request option.
1132
- * @throws {RequiredError}
1133
- */
1134
- testConnectionConfiguration: (connection: Connection, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1135
1206
  };
1136
1207
  /**
1137
1208
  * ConnectionsApi - functional programming interface
@@ -1170,6 +1241,17 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
1170
1241
  * @throws {RequiredError}
1171
1242
  */
1172
1243
  getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
1244
+ /**
1245
+ * Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
1246
+ * @summary Get table details from database
1247
+ * @param {string} projectName Name of the project
1248
+ * @param {string} connectionName Name of the connection
1249
+ * @param {string} schemaName Name of the schema
1250
+ * @param {string} tablePath Full path to the table
1251
+ * @param {*} [options] Override http request option.
1252
+ * @throws {RequiredError}
1253
+ */
1254
+ getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
1173
1255
  /**
1174
1256
  * Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
1175
1257
  * @summary Get table source information
@@ -1178,6 +1260,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
1178
1260
  * @param {string} [tableKey] Table key
1179
1261
  * @param {string} [tablePath] Table path
1180
1262
  * @param {*} [options] Override http request option.
1263
+ * @deprecated
1181
1264
  * @throws {RequiredError}
1182
1265
  */
1183
1266
  getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TableSource>>;
@@ -1208,19 +1291,19 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
1208
1291
  * @param {*} [options] Override http request option.
1209
1292
  * @throws {RequiredError}
1210
1293
  */
1211
- listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SchemaName>>>;
1294
+ listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>>;
1212
1295
  /**
1213
1296
  * Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
1214
- * @summary List tables in database schema
1297
+ * @summary List tables in database
1215
1298
  * @param {string} projectName Name of the project
1216
1299
  * @param {string} connectionName Name of the connection
1217
1300
  * @param {string} schemaName Name of the schema
1218
1301
  * @param {*} [options] Override http request option.
1219
1302
  * @throws {RequiredError}
1220
1303
  */
1221
- listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
1304
+ listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Table>>>;
1222
1305
  /**
1223
- * Executes a SQL statement against the specified database connection and returns the results. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. The results include data, metadata, and execution information.
1306
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1224
1307
  * @summary Execute SQL query
1225
1308
  * @param {string} projectName Name of the project
1226
1309
  * @param {string} connectionName Name of the connection
@@ -1231,7 +1314,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
1231
1314
  */
1232
1315
  postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
1233
1316
  /**
1234
- * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements.
1317
+ * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1235
1318
  * @summary Create SQL source from statement
1236
1319
  * @param {string} projectName Name of the project
1237
1320
  * @param {string} connectionName Name of the connection
@@ -1241,7 +1324,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
1241
1324
  */
1242
1325
  postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
1243
1326
  /**
1244
- * Creates a temporary table from a SQL statement using the specified database connection. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1327
+ * Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1245
1328
  * @summary Create temporary table
1246
1329
  * @param {string} projectName Name of the project
1247
1330
  * @param {string} connectionName Name of the connection
@@ -1250,23 +1333,6 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
1250
1333
  * @throws {RequiredError}
1251
1334
  */
1252
1335
  postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
1253
- /**
1254
- * Tests the connectivity and configuration of an existing database connection within a project. This endpoint validates that the connection can be established, credentials are valid, and the database is accessible. Useful for monitoring connection health and troubleshooting.
1255
- * @summary Test existing project connection
1256
- * @param {string} projectName Name of the project
1257
- * @param {string} connectionName Name of the connection
1258
- * @param {*} [options] Override http request option.
1259
- * @throws {RequiredError}
1260
- */
1261
- testConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionStatus>>;
1262
- /**
1263
- * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1264
- * @summary Test database connection configuration
1265
- * @param {Connection} connection
1266
- * @param {*} [options] Override http request option.
1267
- * @throws {RequiredError}
1268
- */
1269
- testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionStatus>>;
1270
1336
  };
1271
1337
  /**
1272
1338
  * ConnectionsApi - factory interface
@@ -1305,6 +1371,17 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
1305
1371
  * @throws {RequiredError}
1306
1372
  */
1307
1373
  getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
1374
+ /**
1375
+ * Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
1376
+ * @summary Get table details from database
1377
+ * @param {string} projectName Name of the project
1378
+ * @param {string} connectionName Name of the connection
1379
+ * @param {string} schemaName Name of the schema
1380
+ * @param {string} tablePath Full path to the table
1381
+ * @param {*} [options] Override http request option.
1382
+ * @throws {RequiredError}
1383
+ */
1384
+ getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
1308
1385
  /**
1309
1386
  * Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
1310
1387
  * @summary Get table source information
@@ -1313,6 +1390,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
1313
1390
  * @param {string} [tableKey] Table key
1314
1391
  * @param {string} [tablePath] Table path
1315
1392
  * @param {*} [options] Override http request option.
1393
+ * @deprecated
1316
1394
  * @throws {RequiredError}
1317
1395
  */
1318
1396
  getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): AxiosPromise<TableSource>;
@@ -1343,19 +1421,19 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
1343
1421
  * @param {*} [options] Override http request option.
1344
1422
  * @throws {RequiredError}
1345
1423
  */
1346
- listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<SchemaName>>;
1424
+ listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>>;
1347
1425
  /**
1348
1426
  * Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
1349
- * @summary List tables in database schema
1427
+ * @summary List tables in database
1350
1428
  * @param {string} projectName Name of the project
1351
1429
  * @param {string} connectionName Name of the connection
1352
1430
  * @param {string} schemaName Name of the schema
1353
1431
  * @param {*} [options] Override http request option.
1354
1432
  * @throws {RequiredError}
1355
1433
  */
1356
- listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
1434
+ listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Table>>;
1357
1435
  /**
1358
- * Executes a SQL statement against the specified database connection and returns the results. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. The results include data, metadata, and execution information.
1436
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1359
1437
  * @summary Execute SQL query
1360
1438
  * @param {string} projectName Name of the project
1361
1439
  * @param {string} connectionName Name of the connection
@@ -1366,7 +1444,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
1366
1444
  */
1367
1445
  postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
1368
1446
  /**
1369
- * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements.
1447
+ * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1370
1448
  * @summary Create SQL source from statement
1371
1449
  * @param {string} projectName Name of the project
1372
1450
  * @param {string} connectionName Name of the connection
@@ -1376,7 +1454,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
1376
1454
  */
1377
1455
  postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
1378
1456
  /**
1379
- * Creates a temporary table from a SQL statement using the specified database connection. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1457
+ * Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1380
1458
  * @summary Create temporary table
1381
1459
  * @param {string} projectName Name of the project
1382
1460
  * @param {string} connectionName Name of the connection
@@ -1385,23 +1463,6 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
1385
1463
  * @throws {RequiredError}
1386
1464
  */
1387
1465
  postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
1388
- /**
1389
- * Tests the connectivity and configuration of an existing database connection within a project. This endpoint validates that the connection can be established, credentials are valid, and the database is accessible. Useful for monitoring connection health and troubleshooting.
1390
- * @summary Test existing project connection
1391
- * @param {string} projectName Name of the project
1392
- * @param {string} connectionName Name of the connection
1393
- * @param {*} [options] Override http request option.
1394
- * @throws {RequiredError}
1395
- */
1396
- testConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionStatus>;
1397
- /**
1398
- * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1399
- * @summary Test database connection configuration
1400
- * @param {Connection} connection
1401
- * @param {*} [options] Override http request option.
1402
- * @throws {RequiredError}
1403
- */
1404
- testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionStatus>;
1405
1466
  };
1406
1467
  /**
1407
1468
  * ConnectionsApi - object-oriented interface
@@ -1445,6 +1506,18 @@ export declare class ConnectionsApi extends BaseAPI {
1445
1506
  * @memberof ConnectionsApi
1446
1507
  */
1447
1508
  getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
1509
+ /**
1510
+ * Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
1511
+ * @summary Get table details from database
1512
+ * @param {string} projectName Name of the project
1513
+ * @param {string} connectionName Name of the connection
1514
+ * @param {string} schemaName Name of the schema
1515
+ * @param {string} tablePath Full path to the table
1516
+ * @param {*} [options] Override http request option.
1517
+ * @throws {RequiredError}
1518
+ * @memberof ConnectionsApi
1519
+ */
1520
+ getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table, any, {}>>;
1448
1521
  /**
1449
1522
  * Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
1450
1523
  * @summary Get table source information
@@ -1453,6 +1526,7 @@ export declare class ConnectionsApi extends BaseAPI {
1453
1526
  * @param {string} [tableKey] Table key
1454
1527
  * @param {string} [tablePath] Table path
1455
1528
  * @param {*} [options] Override http request option.
1529
+ * @deprecated
1456
1530
  * @throws {RequiredError}
1457
1531
  * @memberof ConnectionsApi
1458
1532
  */
@@ -1487,10 +1561,10 @@ export declare class ConnectionsApi extends BaseAPI {
1487
1561
  * @throws {RequiredError}
1488
1562
  * @memberof ConnectionsApi
1489
1563
  */
1490
- listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SchemaName[], any, {}>>;
1564
+ listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Schema[], any, {}>>;
1491
1565
  /**
1492
1566
  * Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
1493
- * @summary List tables in database schema
1567
+ * @summary List tables in database
1494
1568
  * @param {string} projectName Name of the project
1495
1569
  * @param {string} connectionName Name of the connection
1496
1570
  * @param {string} schemaName Name of the schema
@@ -1498,9 +1572,9 @@ export declare class ConnectionsApi extends BaseAPI {
1498
1572
  * @throws {RequiredError}
1499
1573
  * @memberof ConnectionsApi
1500
1574
  */
1501
- listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<string[], any, {}>>;
1575
+ listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Table[], any, {}>>;
1502
1576
  /**
1503
- * Executes a SQL statement against the specified database connection and returns the results. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. The results include data, metadata, and execution information.
1577
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1504
1578
  * @summary Execute SQL query
1505
1579
  * @param {string} projectName Name of the project
1506
1580
  * @param {string} connectionName Name of the connection
@@ -1512,7 +1586,7 @@ export declare class ConnectionsApi extends BaseAPI {
1512
1586
  */
1513
1587
  postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryData, any, {}>>;
1514
1588
  /**
1515
- * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements.
1589
+ * Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1516
1590
  * @summary Create SQL source from statement
1517
1591
  * @param {string} projectName Name of the project
1518
1592
  * @param {string} connectionName Name of the connection
@@ -1523,7 +1597,7 @@ export declare class ConnectionsApi extends BaseAPI {
1523
1597
  */
1524
1598
  postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<SqlSource, any, {}>>;
1525
1599
  /**
1526
- * Creates a temporary table from a SQL statement using the specified database connection. This is the preferred method over the deprecated GET version as it provides better security and supports larger SQL statements. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1600
+ * Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
1527
1601
  * @summary Create temporary table
1528
1602
  * @param {string} projectName Name of the project
1529
1603
  * @param {string} connectionName Name of the connection
@@ -1533,23 +1607,63 @@ export declare class ConnectionsApi extends BaseAPI {
1533
1607
  * @memberof ConnectionsApi
1534
1608
  */
1535
1609
  postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<TemporaryTable, any, {}>>;
1610
+ }
1611
+ /**
1612
+ * ConnectionsTestApi - axios parameter creator
1613
+ * @export
1614
+ */
1615
+ export declare const ConnectionsTestApiAxiosParamCreator: (configuration?: Configuration) => {
1536
1616
  /**
1537
- * Tests the connectivity and configuration of an existing database connection within a project. This endpoint validates that the connection can be established, credentials are valid, and the database is accessible. Useful for monitoring connection health and troubleshooting.
1538
- * @summary Test existing project connection
1539
- * @param {string} projectName Name of the project
1540
- * @param {string} connectionName Name of the connection
1617
+ * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1618
+ * @summary Test database connection configuration
1619
+ * @param {Connection} connection
1541
1620
  * @param {*} [options] Override http request option.
1542
1621
  * @throws {RequiredError}
1543
- * @memberof ConnectionsApi
1544
1622
  */
1545
- testConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<ConnectionStatus, any, {}>>;
1623
+ testConnectionConfiguration: (connection: Connection, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1624
+ };
1625
+ /**
1626
+ * ConnectionsTestApi - functional programming interface
1627
+ * @export
1628
+ */
1629
+ export declare const ConnectionsTestApiFp: (configuration?: Configuration) => {
1546
1630
  /**
1547
1631
  * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1548
1632
  * @summary Test database connection configuration
1549
1633
  * @param {Connection} connection
1550
1634
  * @param {*} [options] Override http request option.
1551
1635
  * @throws {RequiredError}
1552
- * @memberof ConnectionsApi
1636
+ */
1637
+ testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionStatus>>;
1638
+ };
1639
+ /**
1640
+ * ConnectionsTestApi - factory interface
1641
+ * @export
1642
+ */
1643
+ export declare const ConnectionsTestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1644
+ /**
1645
+ * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1646
+ * @summary Test database connection configuration
1647
+ * @param {Connection} connection
1648
+ * @param {*} [options] Override http request option.
1649
+ * @throws {RequiredError}
1650
+ */
1651
+ testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionStatus>;
1652
+ };
1653
+ /**
1654
+ * ConnectionsTestApi - object-oriented interface
1655
+ * @export
1656
+ * @class ConnectionsTestApi
1657
+ * @extends {BaseAPI}
1658
+ */
1659
+ export declare class ConnectionsTestApi extends BaseAPI {
1660
+ /**
1661
+ * Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
1662
+ * @summary Test database connection configuration
1663
+ * @param {Connection} connection
1664
+ * @param {*} [options] Override http request option.
1665
+ * @throws {RequiredError}
1666
+ * @memberof ConnectionsTestApi
1553
1667
  */
1554
1668
  testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise< AxiosResponse<ConnectionStatus, any, {}>>;
1555
1669
  }
@@ -1625,6 +1739,17 @@ export declare class DatabasesApi extends BaseAPI {
1625
1739
  * @export
1626
1740
  */
1627
1741
  export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration) => {
1742
+ /**
1743
+ * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
1744
+ * @summary Execute Malloy query
1745
+ * @param {string} projectName Name of the project
1746
+ * @param {string} packageName Name of the package
1747
+ * @param {string} path Path to the model within the package
1748
+ * @param {QueryRequest} queryRequest
1749
+ * @param {*} [options] Override http request option.
1750
+ * @throws {RequiredError}
1751
+ */
1752
+ executeQueryModel: (projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1628
1753
  /**
1629
1754
  * Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
1630
1755
  * @summary Get compiled Malloy model
@@ -1652,6 +1777,17 @@ export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration)
1652
1777
  * @export
1653
1778
  */
1654
1779
  export declare const ModelsApiFp: (configuration?: Configuration) => {
1780
+ /**
1781
+ * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
1782
+ * @summary Execute Malloy query
1783
+ * @param {string} projectName Name of the project
1784
+ * @param {string} packageName Name of the package
1785
+ * @param {string} path Path to the model within the package
1786
+ * @param {QueryRequest} queryRequest
1787
+ * @param {*} [options] Override http request option.
1788
+ * @throws {RequiredError}
1789
+ */
1790
+ executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>>;
1655
1791
  /**
1656
1792
  * Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
1657
1793
  * @summary Get compiled Malloy model
@@ -1679,6 +1815,17 @@ export declare const ModelsApiFp: (configuration?: Configuration) => {
1679
1815
  * @export
1680
1816
  */
1681
1817
  export declare const ModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1818
+ /**
1819
+ * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
1820
+ * @summary Execute Malloy query
1821
+ * @param {string} projectName Name of the project
1822
+ * @param {string} packageName Name of the package
1823
+ * @param {string} path Path to the model within the package
1824
+ * @param {QueryRequest} queryRequest
1825
+ * @param {*} [options] Override http request option.
1826
+ * @throws {RequiredError}
1827
+ */
1828
+ executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult>;
1682
1829
  /**
1683
1830
  * Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
1684
1831
  * @summary Get compiled Malloy model
@@ -1708,6 +1855,18 @@ export declare const ModelsApiFactory: (configuration?: Configuration, basePath?
1708
1855
  * @extends {BaseAPI}
1709
1856
  */
1710
1857
  export declare class ModelsApi extends BaseAPI {
1858
+ /**
1859
+ * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
1860
+ * @summary Execute Malloy query
1861
+ * @param {string} projectName Name of the project
1862
+ * @param {string} packageName Name of the package
1863
+ * @param {string} path Path to the model within the package
1864
+ * @param {QueryRequest} queryRequest
1865
+ * @param {*} [options] Override http request option.
1866
+ * @throws {RequiredError}
1867
+ * @memberof ModelsApi
1868
+ */
1869
+ executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryResult, any, {}>>;
1711
1870
  /**
1712
1871
  * Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
1713
1872
  * @summary Get compiled Malloy model
@@ -2313,156 +2472,6 @@ export declare class PublisherApi extends BaseAPI {
2313
2472
  */
2314
2473
  getStatus(options?: RawAxiosRequestConfig): Promise< AxiosResponse<ServerStatus, any, {}>>;
2315
2474
  }
2316
- /**
2317
- * QueryresultsApi - axios parameter creator
2318
- * @export
2319
- */
2320
- export declare const QueryresultsApiAxiosParamCreator: (configuration?: Configuration) => {
2321
- /**
2322
- * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
2323
- * @summary Execute Malloy query
2324
- * @param {string} projectName Name of the project
2325
- * @param {string} packageName Name of the package
2326
- * @param {string} path Path to the model within the package
2327
- * @param {string} [query] Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
2328
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2329
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.
2330
- * @param {string} [versionId] Version ID
2331
- * @param {*} [options] Override http request option.
2332
- * @throws {RequiredError}
2333
- */
2334
- executeQuery: (projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2335
- };
2336
- /**
2337
- * QueryresultsApi - functional programming interface
2338
- * @export
2339
- */
2340
- export declare const QueryresultsApiFp: (configuration?: Configuration) => {
2341
- /**
2342
- * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
2343
- * @summary Execute Malloy query
2344
- * @param {string} projectName Name of the project
2345
- * @param {string} packageName Name of the package
2346
- * @param {string} path Path to the model within the package
2347
- * @param {string} [query] Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
2348
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2349
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.
2350
- * @param {string} [versionId] Version ID
2351
- * @param {*} [options] Override http request option.
2352
- * @throws {RequiredError}
2353
- */
2354
- executeQuery(projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>>;
2355
- };
2356
- /**
2357
- * QueryresultsApi - factory interface
2358
- * @export
2359
- */
2360
- export declare const QueryresultsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2361
- /**
2362
- * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
2363
- * @summary Execute Malloy query
2364
- * @param {string} projectName Name of the project
2365
- * @param {string} packageName Name of the package
2366
- * @param {string} path Path to the model within the package
2367
- * @param {string} [query] Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
2368
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2369
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.
2370
- * @param {string} [versionId] Version ID
2371
- * @param {*} [options] Override http request option.
2372
- * @throws {RequiredError}
2373
- */
2374
- executeQuery(projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult>;
2375
- };
2376
- /**
2377
- * QueryresultsApi - object-oriented interface
2378
- * @export
2379
- * @class QueryresultsApi
2380
- * @extends {BaseAPI}
2381
- */
2382
- export declare class QueryresultsApi extends BaseAPI {
2383
- /**
2384
- * Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
2385
- * @summary Execute Malloy query
2386
- * @param {string} projectName Name of the project
2387
- * @param {string} packageName Name of the package
2388
- * @param {string} path Path to the model within the package
2389
- * @param {string} [query] Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
2390
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2391
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.
2392
- * @param {string} [versionId] Version ID
2393
- * @param {*} [options] Override http request option.
2394
- * @throws {RequiredError}
2395
- * @memberof QueryresultsApi
2396
- */
2397
- executeQuery(projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<QueryResult, any, {}>>;
2398
- }
2399
- /**
2400
- * SchedulesApi - axios parameter creator
2401
- * @export
2402
- */
2403
- export declare const SchedulesApiAxiosParamCreator: (configuration?: Configuration) => {
2404
- /**
2405
- * Retrieves a list of all scheduled tasks associated with the specified package. These schedules define automated operations such as data refresh, report generation, or other recurring tasks. Each schedule includes timing information and execution status.
2406
- * @summary List package schedules
2407
- * @param {string} projectName Name of the project
2408
- * @param {string} packageName Name of the package
2409
- * @param {string} [versionId] Version identifier for the package
2410
- * @param {*} [options] Override http request option.
2411
- * @throws {RequiredError}
2412
- */
2413
- listSchedules: (projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2414
- };
2415
- /**
2416
- * SchedulesApi - functional programming interface
2417
- * @export
2418
- */
2419
- export declare const SchedulesApiFp: (configuration?: Configuration) => {
2420
- /**
2421
- * Retrieves a list of all scheduled tasks associated with the specified package. These schedules define automated operations such as data refresh, report generation, or other recurring tasks. Each schedule includes timing information and execution status.
2422
- * @summary List package schedules
2423
- * @param {string} projectName Name of the project
2424
- * @param {string} packageName Name of the package
2425
- * @param {string} [versionId] Version identifier for the package
2426
- * @param {*} [options] Override http request option.
2427
- * @throws {RequiredError}
2428
- */
2429
- listSchedules(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schedule>>>;
2430
- };
2431
- /**
2432
- * SchedulesApi - factory interface
2433
- * @export
2434
- */
2435
- export declare const SchedulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2436
- /**
2437
- * Retrieves a list of all scheduled tasks associated with the specified package. These schedules define automated operations such as data refresh, report generation, or other recurring tasks. Each schedule includes timing information and execution status.
2438
- * @summary List package schedules
2439
- * @param {string} projectName Name of the project
2440
- * @param {string} packageName Name of the package
2441
- * @param {string} [versionId] Version identifier for the package
2442
- * @param {*} [options] Override http request option.
2443
- * @throws {RequiredError}
2444
- */
2445
- listSchedules(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schedule>>;
2446
- };
2447
- /**
2448
- * SchedulesApi - object-oriented interface
2449
- * @export
2450
- * @class SchedulesApi
2451
- * @extends {BaseAPI}
2452
- */
2453
- export declare class SchedulesApi extends BaseAPI {
2454
- /**
2455
- * Retrieves a list of all scheduled tasks associated with the specified package. These schedules define automated operations such as data refresh, report generation, or other recurring tasks. Each schedule includes timing information and execution status.
2456
- * @summary List package schedules
2457
- * @param {string} projectName Name of the project
2458
- * @param {string} packageName Name of the package
2459
- * @param {string} [versionId] Version identifier for the package
2460
- * @param {*} [options] Override http request option.
2461
- * @throws {RequiredError}
2462
- * @memberof SchedulesApi
2463
- */
2464
- listSchedules(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise< AxiosResponse<Schedule[], any, {}>>;
2465
- }
2466
2475
  /**
2467
2476
  * WatchModeApi - axios parameter creator
2468
2477
  * @export