@malloydata/db-publisher 0.0.315 → 0.0.316

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/client/api.d.ts +1594 -528
  2. package/dist/client/api.js +1820 -553
  3. package/dist/client/api.js.map +1 -1
  4. package/dist/client/base.d.ts +1 -1
  5. package/dist/client/base.js +1 -1
  6. package/dist/client/common.d.ts +1 -1
  7. package/dist/client/common.js +1 -1
  8. package/dist/client/configuration.d.ts +1 -1
  9. package/dist/client/configuration.js +1 -1
  10. package/dist/client/index.d.ts +1 -1
  11. package/dist/client/index.js +1 -1
  12. package/dist/publisher_connection.d.ts +4 -1
  13. package/dist/publisher_connection.integration.spec.js +208 -0
  14. package/dist/publisher_connection.integration.spec.js.map +1 -0
  15. package/dist/publisher_connection.js +42 -11
  16. package/dist/publisher_connection.js.map +1 -1
  17. package/dist/publisher_connection.unit.spec.d.ts +1 -0
  18. package/dist/{publisher_connection.spec.js → publisher_connection.unit.spec.js} +214 -175
  19. package/dist/publisher_connection.unit.spec.js.map +1 -0
  20. package/package.json +2 -2
  21. package/publisher-api-doc.yaml +1434 -449
  22. package/src/client/.openapi-generator/FILES +0 -1
  23. package/src/client/api.ts +2513 -754
  24. package/src/client/base.ts +1 -1
  25. package/src/client/common.ts +1 -1
  26. package/src/client/configuration.ts +1 -1
  27. package/src/client/index.ts +1 -1
  28. package/src/publisher_connection.integration.spec.ts +200 -0
  29. package/src/publisher_connection.ts +67 -19
  30. package/src/{publisher_connection.spec.ts → publisher_connection.unit.spec.ts} +260 -175
  31. package/dist/publisher_connection.spec.js.map +0 -1
  32. /package/dist/{publisher_connection.spec.d.ts → publisher_connection.integration.spec.d.ts} +0 -0
package/src/client/api.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Malloy Publisher - Semantic Model Serving API
5
- * The Malloy Publisher - Semantic Model Serving API serves Malloy packages. A Malloy package is a directory of Malloy models (.malloy files), Malloy notebooks (.malloynb files), and embedded datbases (.parque files) with a malloy-publisher.json manifest at the package\'s root directory. For example, see the Malloy samples packages (https://github.com/malloydata/malloy-samples) repo.
5
+ * The Malloy Publisher - Semantic Model Serving API provides comprehensive access to Malloy packages and their associated resources. A Malloy package is a directory containing Malloy models (.malloy files), Malloy notebooks (.malloynb files), and embedded databases (.parquet files) with a malloy-publisher.json manifest at the package\'s root directory. ## Key Features - **Project Management**: Create and manage projects with their associated packages and connections - **Package Lifecycle**: Full CRUD operations for Malloy packages and their versions - **Model & Notebook Access**: Retrieve and execute Malloy models and notebooks - **Connection Management**: Secure database connection configuration and testing - **Query Execution**: Execute queries against models and retrieve results - **Watch Mode**: Real-time file watching for development workflows ## Resource Hierarchy The API follows a hierarchical resource structure: ``` Projects ├── Connections └── Packages ├── Models ├── Notebooks └── Databases ``` For examples, see the Malloy samples packages (https://github.com/malloydata/malloy-samples) repository.
6
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -24,144 +24,225 @@ import type { RequestArgs } from './base';
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
26
  /**
27
- *
27
+ * Attached DuckDB database
28
28
  * @export
29
- * @interface About
29
+ * @interface AttachedDatabase
30
30
  */
31
- export interface About {
31
+ export interface AttachedDatabase {
32
32
  /**
33
- * Readme markdown.
33
+ * Name of the connection
34
34
  * @type {string}
35
- * @memberof About
35
+ * @memberof AttachedDatabase
36
36
  */
37
- 'readme'?: string;
37
+ 'name'?: string;
38
+ /**
39
+ * Type of database connection
40
+ * @type {string}
41
+ * @memberof AttachedDatabase
42
+ */
43
+ 'type'?: AttachedDatabaseTypeEnum;
44
+ /**
45
+ *
46
+ * @type {ConnectionAttributes}
47
+ * @memberof AttachedDatabase
48
+ */
49
+ 'attributes'?: ConnectionAttributes;
50
+ /**
51
+ *
52
+ * @type {BigqueryConnection}
53
+ * @memberof AttachedDatabase
54
+ */
55
+ 'bigqueryConnection'?: BigqueryConnection;
56
+ /**
57
+ *
58
+ * @type {SnowflakeConnection}
59
+ * @memberof AttachedDatabase
60
+ */
61
+ 'snowflakeConnection'?: SnowflakeConnection;
62
+ /**
63
+ *
64
+ * @type {PostgresConnection}
65
+ * @memberof AttachedDatabase
66
+ */
67
+ 'postgresConnection'?: PostgresConnection;
38
68
  }
69
+
70
+ export const AttachedDatabaseTypeEnum = {
71
+ Bigquery: 'bigquery',
72
+ Snowflake: 'snowflake',
73
+ Postgres: 'postgres'
74
+ } as const;
75
+
76
+ export type AttachedDatabaseTypeEnum = typeof AttachedDatabaseTypeEnum[keyof typeof AttachedDatabaseTypeEnum];
77
+
39
78
  /**
40
- *
79
+ * Google BigQuery database connection configuration
41
80
  * @export
42
81
  * @interface BigqueryConnection
43
82
  */
44
83
  export interface BigqueryConnection {
45
84
  /**
46
- *
85
+ * Default BigQuery project ID for queries
47
86
  * @type {string}
48
87
  * @memberof BigqueryConnection
49
88
  */
50
89
  'defaultProjectId'?: string;
51
90
  /**
52
- *
91
+ * BigQuery project ID for billing purposes
53
92
  * @type {string}
54
93
  * @memberof BigqueryConnection
55
94
  */
56
95
  'billingProjectId'?: string;
57
96
  /**
58
- *
97
+ * BigQuery dataset location/region
59
98
  * @type {string}
60
99
  * @memberof BigqueryConnection
61
100
  */
62
101
  'location'?: string;
63
102
  /**
64
- *
103
+ * JSON string containing Google Cloud service account credentials
65
104
  * @type {string}
66
105
  * @memberof BigqueryConnection
67
106
  */
68
107
  'serviceAccountKeyJson'?: string;
69
108
  /**
70
- *
109
+ * Maximum bytes to bill for query execution (prevents runaway costs)
71
110
  * @type {string}
72
111
  * @memberof BigqueryConnection
73
112
  */
74
113
  'maximumBytesBilled'?: string;
75
114
  /**
76
- *
115
+ * Query timeout in milliseconds
77
116
  * @type {string}
78
117
  * @memberof BigqueryConnection
79
118
  */
80
119
  'queryTimeoutMilliseconds'?: string;
81
120
  }
82
121
  /**
83
- * Malloy model def and result data. Malloy model def and result data is Malloy version depdendent.
122
+ * Database column definition
84
123
  * @export
85
- * @interface CompiledModel
124
+ * @interface Column
86
125
  */
87
- export interface CompiledModel {
126
+ export interface Column {
88
127
  /**
89
- * Model\'s package Name
128
+ * Name of the column
90
129
  * @type {string}
91
- * @memberof CompiledModel
130
+ * @memberof Column
92
131
  */
93
- 'packageName'?: string;
132
+ 'name'?: string;
133
+ /**
134
+ * Data type of the column
135
+ * @type {string}
136
+ * @memberof Column
137
+ */
138
+ 'type'?: string;
139
+ }
140
+ /**
141
+ * Compiled Malloy model with sources, queries, and metadata
142
+ * @export
143
+ * @interface CompiledModel
144
+ */
145
+ export interface CompiledModel {
94
146
  /**
95
- * Model\'s relative path in its package directory.
147
+ * Resource path to the model
96
148
  * @type {string}
97
149
  * @memberof CompiledModel
98
150
  */
99
- 'path'?: string;
151
+ 'resource'?: string;
100
152
  /**
101
- * Type of malloy model file -- source file or notebook file.
153
+ * Name of the package containing this model
102
154
  * @type {string}
103
155
  * @memberof CompiledModel
104
156
  */
105
- 'type'?: CompiledModelTypeEnum;
157
+ 'packageName'?: string;
106
158
  /**
107
- * Version of the Malloy compiler that generated the model def and results fields.
159
+ * Relative path to the model file within its package directory
108
160
  * @type {string}
109
161
  * @memberof CompiledModel
110
162
  */
111
- 'malloyVersion'?: string;
163
+ 'path'?: string;
112
164
  /**
113
- * Data style for rendering query results.
165
+ * Version of the Malloy compiler used to generate the model data
114
166
  * @type {string}
115
167
  * @memberof CompiledModel
116
168
  */
117
- 'dataStyles'?: string;
169
+ 'malloyVersion'?: string;
118
170
  /**
119
- * Malloy model def.
171
+ * JSON string containing model metadata and structure information
120
172
  * @type {string}
121
173
  * @memberof CompiledModel
122
174
  */
123
- 'modelDef'?: string;
175
+ 'modelInfo'?: string;
124
176
  /**
125
- * Array of model sources.
126
- * @type {Array<Source>}
177
+ * Array of JSON strings containing source information for each data source
178
+ * @type {Array<string>}
127
179
  * @memberof CompiledModel
128
180
  */
129
- 'sources'?: Array<Source>;
181
+ 'sourceInfos'?: Array<string>;
130
182
  /**
131
- *
183
+ * Array of named queries defined in the model
132
184
  * @type {Array<Query>}
133
185
  * @memberof CompiledModel
134
186
  */
135
187
  'queries'?: Array<Query>;
188
+ }
189
+ /**
190
+ * Compiled Malloy notebook with cells, results, and execution data
191
+ * @export
192
+ * @interface CompiledNotebook
193
+ */
194
+ export interface CompiledNotebook {
195
+ /**
196
+ * Resource path to the notebook
197
+ * @type {string}
198
+ * @memberof CompiledNotebook
199
+ */
200
+ 'resource'?: string;
201
+ /**
202
+ * Name of the package containing this notebook
203
+ * @type {string}
204
+ * @memberof CompiledNotebook
205
+ */
206
+ 'packageName'?: string;
207
+ /**
208
+ * Relative path to the notebook file within its package directory
209
+ * @type {string}
210
+ * @memberof CompiledNotebook
211
+ */
212
+ 'path'?: string;
213
+ /**
214
+ * Version of the Malloy compiler used to generate the notebook data
215
+ * @type {string}
216
+ * @memberof CompiledNotebook
217
+ */
218
+ 'malloyVersion'?: string;
136
219
  /**
137
- * Array of notebook cells.
220
+ * Array of notebook cells containing code, markdown, and execution results
138
221
  * @type {Array<NotebookCell>}
139
- * @memberof CompiledModel
222
+ * @memberof CompiledNotebook
140
223
  */
141
224
  'notebookCells'?: Array<NotebookCell>;
142
225
  }
143
-
144
- export const CompiledModelTypeEnum = {
145
- Source: 'source',
146
- Notebook: 'notebook'
147
- } as const;
148
-
149
- export type CompiledModelTypeEnum = typeof CompiledModelTypeEnum[keyof typeof CompiledModelTypeEnum];
150
-
151
226
  /**
152
- *
227
+ * Database connection configuration and metadata
153
228
  * @export
154
229
  * @interface Connection
155
230
  */
156
231
  export interface Connection {
157
232
  /**
158
- *
233
+ * Resource path to the connection
234
+ * @type {string}
235
+ * @memberof Connection
236
+ */
237
+ 'resource'?: string;
238
+ /**
239
+ * Name of the connection
159
240
  * @type {string}
160
241
  * @memberof Connection
161
242
  */
162
243
  'name'?: string;
163
244
  /**
164
- *
245
+ * Type of database connection
165
246
  * @type {string}
166
247
  * @memberof Connection
167
248
  */
@@ -196,68 +277,115 @@ export interface Connection {
196
277
  * @memberof Connection
197
278
  */
198
279
  'trinoConnection'?: TrinoConnection;
280
+ /**
281
+ *
282
+ * @type {MysqlConnection}
283
+ * @memberof Connection
284
+ */
285
+ 'mysqlConnection'?: MysqlConnection;
286
+ /**
287
+ *
288
+ * @type {DuckdbConnection}
289
+ * @memberof Connection
290
+ */
291
+ 'duckdbConnection'?: DuckdbConnection;
199
292
  }
200
293
 
201
294
  export const ConnectionTypeEnum = {
202
295
  Postgres: 'postgres',
203
296
  Bigquery: 'bigquery',
204
297
  Snowflake: 'snowflake',
205
- Trino: 'trino'
298
+ Trino: 'trino',
299
+ Mysql: 'mysql',
300
+ Duckdb: 'duckdb'
206
301
  } as const;
207
302
 
208
303
  export type ConnectionTypeEnum = typeof ConnectionTypeEnum[keyof typeof ConnectionTypeEnum];
209
304
 
210
305
  /**
211
- *
306
+ * Connection capabilities and configuration attributes
212
307
  * @export
213
308
  * @interface ConnectionAttributes
214
309
  */
215
310
  export interface ConnectionAttributes {
216
311
  /**
217
- *
312
+ * SQL dialect name for the connection
218
313
  * @type {string}
219
314
  * @memberof ConnectionAttributes
220
315
  */
221
316
  'dialectName'?: string;
222
317
  /**
223
- *
318
+ * Whether the connection uses connection pooling
224
319
  * @type {boolean}
225
320
  * @memberof ConnectionAttributes
226
321
  */
227
322
  'isPool'?: boolean;
228
323
  /**
229
- *
324
+ * Whether the connection supports persistent storage operations
230
325
  * @type {boolean}
231
326
  * @memberof ConnectionAttributes
232
327
  */
233
328
  'canPersist'?: boolean;
234
329
  /**
235
- *
330
+ * Whether the connection supports streaming query results
236
331
  * @type {boolean}
237
332
  * @memberof ConnectionAttributes
238
333
  */
239
334
  'canStream'?: boolean;
240
335
  }
241
336
  /**
242
- * An in-memory DuckDB database embedded in the package.
337
+ * Result of testing a database connection
338
+ * @export
339
+ * @interface ConnectionStatus
340
+ */
341
+ export interface ConnectionStatus {
342
+ /**
343
+ * Connection test result status
344
+ * @type {string}
345
+ * @memberof ConnectionStatus
346
+ */
347
+ 'status'?: ConnectionStatusStatusEnum;
348
+ /**
349
+ * Error message if the connection test failed, null if successful
350
+ * @type {string}
351
+ * @memberof ConnectionStatus
352
+ */
353
+ 'errorMessage'?: string;
354
+ }
355
+
356
+ export const ConnectionStatusStatusEnum = {
357
+ Ok: 'ok',
358
+ Failed: 'failed'
359
+ } as const;
360
+
361
+ export type ConnectionStatusStatusEnum = typeof ConnectionStatusStatusEnum[keyof typeof ConnectionStatusStatusEnum];
362
+
363
+ /**
364
+ * Embedded database within a Malloy package
243
365
  * @export
244
366
  * @interface Database
245
367
  */
246
368
  export interface Database {
247
369
  /**
248
- * Database\'s relative path in its package directory.
370
+ * Resource path to the database
371
+ * @type {string}
372
+ * @memberof Database
373
+ */
374
+ 'resource'?: string;
375
+ /**
376
+ * Relative path to the database file within its package directory
249
377
  * @type {string}
250
378
  * @memberof Database
251
379
  */
252
380
  'path'?: string;
253
381
  /**
254
- * Size of the embedded database in bytes.
255
- * @type {number}
382
+ *
383
+ * @type {TableDescription}
256
384
  * @memberof Database
257
385
  */
258
- 'size'?: number;
386
+ 'info'?: TableDescription;
259
387
  /**
260
- * Type of database.
388
+ * Type of embedded database
261
389
  * @type {string}
262
390
  * @memberof Database
263
391
  */
@@ -272,87 +400,166 @@ export const DatabaseTypeEnum = {
272
400
  export type DatabaseTypeEnum = typeof DatabaseTypeEnum[keyof typeof DatabaseTypeEnum];
273
401
 
274
402
  /**
275
- * Malloy model def and result data. Malloy model def and result data is Malloy version depdendent.
403
+ * DuckDB database connection configuration
404
+ * @export
405
+ * @interface DuckdbConnection
406
+ */
407
+ export interface DuckdbConnection {
408
+ /**
409
+ *
410
+ * @type {any}
411
+ * @memberof DuckdbConnection
412
+ */
413
+ 'attachedDatabases'?: any;
414
+ }
415
+ /**
416
+ * Malloy model metadata and status information
276
417
  * @export
277
418
  * @interface Model
278
419
  */
279
420
  export interface Model {
280
421
  /**
281
- * Model\'s package Name
422
+ * Resource path to the model
423
+ * @type {string}
424
+ * @memberof Model
425
+ */
426
+ 'resource'?: string;
427
+ /**
428
+ * Name of the package containing this model
282
429
  * @type {string}
283
430
  * @memberof Model
284
431
  */
285
432
  'packageName'?: string;
286
433
  /**
287
- * Model\'s relative path in its package directory.
434
+ * Relative path to the model file within its package directory
288
435
  * @type {string}
289
436
  * @memberof Model
290
437
  */
291
438
  'path'?: string;
292
439
  /**
293
- * Type of malloy model file -- source file or notebook file.
440
+ * Error message if the model failed to compile or load
294
441
  * @type {string}
295
442
  * @memberof Model
296
443
  */
297
- 'type'?: ModelTypeEnum;
444
+ 'error'?: string;
298
445
  }
299
-
300
- export const ModelTypeEnum = {
301
- Source: 'source',
302
- Notebook: 'notebook'
303
- } as const;
304
-
305
- export type ModelTypeEnum = typeof ModelTypeEnum[keyof typeof ModelTypeEnum];
306
-
307
446
  /**
308
- *
447
+ * Standard error response format
309
448
  * @export
310
449
  * @interface ModelError
311
450
  */
312
451
  export interface ModelError {
313
452
  /**
314
- *
453
+ * Human-readable error message describing what went wrong
315
454
  * @type {string}
316
455
  * @memberof ModelError
317
456
  */
318
- 'code'?: string;
457
+ 'message': string;
319
458
  /**
320
- *
459
+ * Additional error details or context
321
460
  * @type {string}
322
461
  * @memberof ModelError
323
462
  */
324
- 'message'?: string;
463
+ 'details'?: string;
464
+ }
465
+ /**
466
+ * MySQL database connection configuration
467
+ * @export
468
+ * @interface MysqlConnection
469
+ */
470
+ export interface MysqlConnection {
471
+ /**
472
+ * MySQL server hostname or IP address
473
+ * @type {string}
474
+ * @memberof MysqlConnection
475
+ */
476
+ 'host'?: string;
477
+ /**
478
+ * MySQL server port number
479
+ * @type {number}
480
+ * @memberof MysqlConnection
481
+ */
482
+ 'port'?: number;
483
+ /**
484
+ * Name of the MySQL database
485
+ * @type {string}
486
+ * @memberof MysqlConnection
487
+ */
488
+ 'database'?: string;
489
+ /**
490
+ * MySQL username for authentication
491
+ * @type {string}
492
+ * @memberof MysqlConnection
493
+ */
494
+ 'user'?: string;
495
+ /**
496
+ * MySQL password for authentication
497
+ * @type {string}
498
+ * @memberof MysqlConnection
499
+ */
500
+ 'password'?: string;
501
+ }
502
+ /**
503
+ * Malloy notebook metadata and status information
504
+ * @export
505
+ * @interface Notebook
506
+ */
507
+ export interface Notebook {
508
+ /**
509
+ * Resource path to the notebook
510
+ * @type {string}
511
+ * @memberof Notebook
512
+ */
513
+ 'resource'?: string;
514
+ /**
515
+ * Name of the package containing this notebook
516
+ * @type {string}
517
+ * @memberof Notebook
518
+ */
519
+ 'packageName'?: string;
520
+ /**
521
+ * Relative path to the notebook file within its package directory
522
+ * @type {string}
523
+ * @memberof Notebook
524
+ */
525
+ 'path'?: string;
526
+ /**
527
+ * Error message if the notebook failed to compile or load
528
+ * @type {string}
529
+ * @memberof Notebook
530
+ */
531
+ 'error'?: string;
325
532
  }
326
533
  /**
327
- * Notebook cell.
534
+ * Individual cell within a Malloy notebook
328
535
  * @export
329
536
  * @interface NotebookCell
330
537
  */
331
538
  export interface NotebookCell {
332
539
  /**
333
- * Type of notebook cell.
540
+ * Type of notebook cell
334
541
  * @type {string}
335
542
  * @memberof NotebookCell
336
543
  */
337
544
  'type'?: NotebookCellTypeEnum;
338
545
  /**
339
- * Text contents of the notebook cell.
546
+ * Text contents of the notebook cell
340
547
  * @type {string}
341
548
  * @memberof NotebookCell
342
549
  */
343
550
  'text'?: string;
344
551
  /**
345
- * Name of query, if this is a named query. Otherwise, empty.
552
+ * JSON string containing the execution result for this cell
346
553
  * @type {string}
347
554
  * @memberof NotebookCell
348
555
  */
349
- 'queryName'?: string;
556
+ 'result'?: string;
350
557
  /**
351
- * Malloy query results. Populated only if a code cell.
352
- * @type {string}
558
+ * Array of JSON strings containing SourceInfo objects made available in this cell
559
+ * @type {Array<string>}
353
560
  * @memberof NotebookCell
354
561
  */
355
- 'queryResult'?: string;
562
+ 'newSources'?: Array<string>;
356
563
  }
357
564
 
358
565
  export const NotebookCellTypeEnum = {
@@ -363,94 +570,155 @@ export const NotebookCellTypeEnum = {
363
570
  export type NotebookCellTypeEnum = typeof NotebookCellTypeEnum[keyof typeof NotebookCellTypeEnum];
364
571
 
365
572
  /**
366
- *
573
+ * Represents a Malloy package containing models, notebooks, and embedded databases
367
574
  * @export
368
575
  * @interface Package
369
576
  */
370
577
  export interface Package {
371
578
  /**
372
- * Package name.
579
+ * Resource path to the package
580
+ * @type {string}
581
+ * @memberof Package
582
+ */
583
+ 'resource'?: string;
584
+ /**
585
+ * Package name
373
586
  * @type {string}
374
587
  * @memberof Package
375
588
  */
376
589
  'name'?: string;
377
590
  /**
378
- * Package description.
591
+ * Package description
379
592
  * @type {string}
380
593
  * @memberof Package
381
594
  */
382
595
  'description'?: string;
596
+ /**
597
+ * Package location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
598
+ * @type {string}
599
+ * @memberof Package
600
+ */
601
+ 'location'?: string;
383
602
  }
384
603
  /**
385
604
  *
386
605
  * @export
606
+ * @interface PostSqlsourceRequest
607
+ */
608
+ export interface PostSqlsourceRequest {
609
+ /**
610
+ *
611
+ * @type {string}
612
+ * @memberof PostSqlsourceRequest
613
+ */
614
+ 'sqlStatement'?: string;
615
+ }
616
+ /**
617
+ * PostgreSQL database connection configuration
618
+ * @export
387
619
  * @interface PostgresConnection
388
620
  */
389
621
  export interface PostgresConnection {
390
622
  /**
391
- *
623
+ * PostgreSQL server hostname or IP address
392
624
  * @type {string}
393
625
  * @memberof PostgresConnection
394
626
  */
395
627
  'host'?: string;
396
628
  /**
397
- *
629
+ * PostgreSQL server port number
398
630
  * @type {number}
399
631
  * @memberof PostgresConnection
400
632
  */
401
633
  'port'?: number;
402
634
  /**
403
- *
635
+ * Name of the PostgreSQL database
404
636
  * @type {string}
405
637
  * @memberof PostgresConnection
406
638
  */
407
639
  'databaseName'?: string;
408
640
  /**
409
- *
641
+ * PostgreSQL username for authentication
410
642
  * @type {string}
411
643
  * @memberof PostgresConnection
412
644
  */
413
645
  'userName'?: string;
414
646
  /**
415
- *
647
+ * PostgreSQL password for authentication
416
648
  * @type {string}
417
649
  * @memberof PostgresConnection
418
650
  */
419
651
  'password'?: string;
420
652
  /**
421
- *
653
+ * Complete PostgreSQL connection string (alternative to individual parameters)
422
654
  * @type {string}
423
655
  * @memberof PostgresConnection
424
656
  */
425
657
  'connectionString'?: string;
426
658
  }
427
659
  /**
428
- *
660
+ * Represents a Malloy project containing packages, connections, and other resources
429
661
  * @export
430
662
  * @interface Project
431
663
  */
432
664
  export interface Project {
433
665
  /**
434
- * Project name.
666
+ * Resource path to the project
667
+ * @type {string}
668
+ * @memberof Project
669
+ */
670
+ 'resource'?: string;
671
+ /**
672
+ * Project name
435
673
  * @type {string}
436
674
  * @memberof Project
437
675
  */
438
676
  'name'?: string;
677
+ /**
678
+ * Project README content
679
+ * @type {string}
680
+ * @memberof Project
681
+ */
682
+ 'readme'?: string;
683
+ /**
684
+ * Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
685
+ * @type {string}
686
+ * @memberof Project
687
+ */
688
+ 'location'?: string;
689
+ /**
690
+ * List of database connections configured for this project
691
+ * @type {Array<Connection>}
692
+ * @memberof Project
693
+ */
694
+ 'connections'?: Array<Connection>;
695
+ /**
696
+ * List of Malloy packages in this project
697
+ * @type {Array<Package>}
698
+ * @memberof Project
699
+ */
700
+ 'packages'?: Array<Package>;
439
701
  }
440
702
  /**
441
- * Named model query.
703
+ * Named model query definition
442
704
  * @export
443
705
  * @interface Query
444
706
  */
445
707
  export interface Query {
446
708
  /**
447
- * Query\'s name.
709
+ * Name of the query
448
710
  * @type {string}
449
711
  * @memberof Query
450
712
  */
451
713
  'name'?: string;
452
714
  /**
453
- * Annotations attached to query.
715
+ * Name of the source this query operates on
716
+ * @type {string}
717
+ * @memberof Query
718
+ */
719
+ 'sourceName'?: string;
720
+ /**
721
+ * Annotations attached to the query
454
722
  * @type {Array<string>}
455
723
  * @memberof Query
456
724
  */
@@ -462,6 +730,12 @@ export interface Query {
462
730
  * @interface QueryData
463
731
  */
464
732
  export interface QueryData {
733
+ /**
734
+ * Resource path to the query data.
735
+ * @type {string}
736
+ * @memberof QueryData
737
+ */
738
+ 'resource'?: string;
465
739
  /**
466
740
  *
467
741
  * @type {string}
@@ -470,159 +744,241 @@ export interface QueryData {
470
744
  'data'?: string;
471
745
  }
472
746
  /**
473
- * A Malloy query\'s results, its model def, and its data styles.
747
+ * Request body for executing a Malloy query
474
748
  * @export
475
- * @interface QueryResult
749
+ * @interface QueryRequest
476
750
  */
477
- export interface QueryResult {
751
+ export interface QueryRequest {
478
752
  /**
479
- * Data style for rendering query results.
753
+ * Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
480
754
  * @type {string}
481
- * @memberof QueryResult
755
+ * @memberof QueryRequest
482
756
  */
483
- 'dataStyles'?: string;
757
+ 'query'?: string;
484
758
  /**
485
- * Malloy model def.
759
+ * Name of the source in the model to use for queryName, search, and topValue requests.
486
760
  * @type {string}
487
- * @memberof QueryResult
761
+ * @memberof QueryRequest
488
762
  */
489
- 'modelDef'?: string;
763
+ 'sourceName'?: string;
490
764
  /**
491
- * Malloy query results. Populated only if a code cell.
765
+ * 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.
492
766
  * @type {string}
493
- * @memberof QueryResult
767
+ * @memberof QueryRequest
494
768
  */
495
- 'queryResult'?: string;
496
- }
497
- /**
498
- * A scheduled task.
769
+ 'queryName'?: string;
770
+ /**
771
+ * Version ID
772
+ * @type {string}
773
+ * @memberof QueryRequest
774
+ */
775
+ 'versionId'?: string;
776
+ }
777
+ /**
778
+ * Results from executing a Malloy query
499
779
  * @export
500
- * @interface Schedule
780
+ * @interface QueryResult
501
781
  */
502
- export interface Schedule {
782
+ export interface QueryResult {
503
783
  /**
504
- * Resource in the package that the schedule is attached to.
784
+ * JSON string containing the query results, metadata, and execution information
505
785
  * @type {string}
506
- * @memberof Schedule
786
+ * @memberof QueryResult
507
787
  */
508
- 'resource'?: string;
788
+ 'result'?: string;
509
789
  /**
510
- * Schedule (cron format) for executing task.
790
+ * Resource path to the query result
511
791
  * @type {string}
512
- * @memberof Schedule
792
+ * @memberof QueryResult
513
793
  */
514
- 'schedule'?: string;
794
+ 'resource'?: string;
795
+ }
796
+ /**
797
+ * A schema name in a Connection.
798
+ * @export
799
+ * @interface Schema
800
+ */
801
+ export interface Schema {
515
802
  /**
516
- * Action to execute.
803
+ * Name of the schema
517
804
  * @type {string}
518
- * @memberof Schedule
805
+ * @memberof Schema
519
806
  */
520
- 'action'?: string;
807
+ 'name'?: string;
521
808
  /**
522
- * Connection to perform action on.
809
+ * Description of the schema
523
810
  * @type {string}
524
- * @memberof Schedule
811
+ * @memberof Schema
812
+ */
813
+ 'description'?: string;
814
+ /**
815
+ * Whether this schema is the default schema
816
+ * @type {boolean}
817
+ * @memberof Schema
818
+ */
819
+ 'isDefault'?: boolean;
820
+ /**
821
+ * Whether this schema is hidden
822
+ * @type {boolean}
823
+ * @memberof Schema
525
824
  */
526
- 'connection'?: string;
825
+ 'isHidden'?: boolean;
826
+ }
827
+ /**
828
+ * Current server status and health information
829
+ * @export
830
+ * @interface ServerStatus
831
+ */
832
+ export interface ServerStatus {
527
833
  /**
528
- * Timestamp in milliseconds of the last run.
834
+ * Unix timestamp of the status check
529
835
  * @type {number}
530
- * @memberof Schedule
836
+ * @memberof ServerStatus
531
837
  */
532
- 'lastRunTime'?: number;
838
+ 'timestamp'?: number;
533
839
  /**
534
- * Status of the last run.
535
- * @type {string}
536
- * @memberof Schedule
840
+ * List of available projects
841
+ * @type {Array<Project>}
842
+ * @memberof ServerStatus
843
+ */
844
+ 'projects'?: Array<Project>;
845
+ /**
846
+ * Whether the server is fully initialized and ready to serve requests
847
+ * @type {boolean}
848
+ * @memberof ServerStatus
537
849
  */
538
- 'lastRunStatus'?: string;
850
+ 'initialized'?: boolean;
539
851
  }
540
852
  /**
541
- *
853
+ * Snowflake database connection configuration
542
854
  * @export
543
855
  * @interface SnowflakeConnection
544
856
  */
545
857
  export interface SnowflakeConnection {
546
858
  /**
547
- *
859
+ * Snowflake account identifier
548
860
  * @type {string}
549
861
  * @memberof SnowflakeConnection
550
862
  */
551
863
  'account'?: string;
552
864
  /**
553
- *
865
+ * Snowflake username for authentication
554
866
  * @type {string}
555
867
  * @memberof SnowflakeConnection
556
868
  */
557
869
  'username'?: string;
558
870
  /**
559
- *
871
+ * Snowflake password for authentication
560
872
  * @type {string}
561
873
  * @memberof SnowflakeConnection
562
874
  */
563
875
  'password'?: string;
564
876
  /**
565
- *
877
+ * Snowflake warehouse name
566
878
  * @type {string}
567
879
  * @memberof SnowflakeConnection
568
880
  */
569
881
  'warehouse'?: string;
570
882
  /**
571
- *
883
+ * Snowflake database name
572
884
  * @type {string}
573
885
  * @memberof SnowflakeConnection
574
886
  */
575
887
  'database'?: string;
576
888
  /**
577
- *
889
+ * Snowflake schema name
578
890
  * @type {string}
579
891
  * @memberof SnowflakeConnection
580
892
  */
581
893
  'schema'?: string;
582
894
  /**
583
- *
895
+ * Snowflake role name
896
+ * @type {string}
897
+ * @memberof SnowflakeConnection
898
+ */
899
+ 'role'?: string;
900
+ /**
901
+ * Query response timeout in milliseconds
584
902
  * @type {number}
585
903
  * @memberof SnowflakeConnection
586
904
  */
587
905
  'responseTimeoutMilliseconds'?: number;
588
906
  }
589
907
  /**
590
- * Model source.
908
+ *
591
909
  * @export
592
- * @interface Source
910
+ * @interface SqlSource
593
911
  */
594
- export interface Source {
912
+ export interface SqlSource {
595
913
  /**
596
- * Source\'s name.
914
+ * Resource path to the sql source.
597
915
  * @type {string}
598
- * @memberof Source
916
+ * @memberof SqlSource
599
917
  */
600
- 'name'?: string;
918
+ 'resource'?: string;
601
919
  /**
602
- * Annotations attached to source.
603
- * @type {Array<string>}
604
- * @memberof Source
920
+ *
921
+ * @type {string}
922
+ * @memberof SqlSource
605
923
  */
606
- 'annotations'?: Array<string>;
924
+ 'source'?: string;
925
+ }
926
+ /**
927
+ * Request to start file watching for a project
928
+ * @export
929
+ * @interface StartWatchRequest
930
+ */
931
+ export interface StartWatchRequest {
607
932
  /**
608
- * List of views in the source.\\
609
- * @type {Array<View>}
610
- * @memberof Source
933
+ * Name of the project to start watching for file changes
934
+ * @type {string}
935
+ * @memberof StartWatchRequest
611
936
  */
612
- 'views'?: Array<View>;
937
+ 'projectName': string;
613
938
  }
614
939
  /**
615
940
  *
616
941
  * @export
617
- * @interface SqlSource
942
+ * @interface Table
618
943
  */
619
- export interface SqlSource {
944
+ export interface Table {
620
945
  /**
621
- *
946
+ * Resource path to the table.
622
947
  * @type {string}
623
- * @memberof SqlSource
948
+ * @memberof Table
624
949
  */
625
- 'source'?: string;
950
+ 'resource'?: string;
951
+ /**
952
+ * Table fields
953
+ * @type {Array<Column>}
954
+ * @memberof Table
955
+ */
956
+ 'columns'?: Array<Column>;
957
+ }
958
+ /**
959
+ * Database table structure and metadata
960
+ * @export
961
+ * @interface TableDescription
962
+ */
963
+ export interface TableDescription {
964
+ /**
965
+ * Name of the table
966
+ * @type {string}
967
+ * @memberof TableDescription
968
+ */
969
+ 'name'?: string;
970
+ /**
971
+ * Number of rows in the table
972
+ * @type {number}
973
+ * @memberof TableDescription
974
+ */
975
+ 'rowCount'?: number;
976
+ /**
977
+ * List of columns in the table
978
+ * @type {Array<Column>}
979
+ * @memberof TableDescription
980
+ */
981
+ 'columns'?: Array<Column>;
626
982
  }
627
983
  /**
628
984
  *
@@ -630,12 +986,24 @@ export interface SqlSource {
630
986
  * @interface TableSource
631
987
  */
632
988
  export interface TableSource {
989
+ /**
990
+ * Resource path to the table source.
991
+ * @type {string}
992
+ * @memberof TableSource
993
+ */
994
+ 'resource'?: string;
633
995
  /**
634
996
  *
635
997
  * @type {string}
636
998
  * @memberof TableSource
637
999
  */
638
1000
  'source'?: string;
1001
+ /**
1002
+ * Table fields
1003
+ * @type {Array<Column>}
1004
+ * @memberof TableSource
1005
+ */
1006
+ 'columns'?: Array<Column>;
639
1007
  }
640
1008
  /**
641
1009
  *
@@ -643,6 +1011,12 @@ export interface TableSource {
643
1011
  * @interface TemporaryTable
644
1012
  */
645
1013
  export interface TemporaryTable {
1014
+ /**
1015
+ * Resource path to the temporary table.
1016
+ * @type {string}
1017
+ * @memberof TemporaryTable
1018
+ */
1019
+ 'resource'?: string;
646
1020
  /**
647
1021
  *
648
1022
  * @type {string}
@@ -651,67 +1025,92 @@ export interface TemporaryTable {
651
1025
  'table'?: string;
652
1026
  }
653
1027
  /**
654
- *
1028
+ * Trino database connection configuration
655
1029
  * @export
656
1030
  * @interface TrinoConnection
657
1031
  */
658
1032
  export interface TrinoConnection {
659
1033
  /**
660
- *
1034
+ * Trino server hostname or IP address
661
1035
  * @type {string}
662
1036
  * @memberof TrinoConnection
663
1037
  */
664
1038
  'server'?: string;
665
1039
  /**
666
- *
1040
+ * Trino server port number
667
1041
  * @type {number}
668
1042
  * @memberof TrinoConnection
669
1043
  */
670
1044
  'port'?: number;
671
1045
  /**
672
- *
1046
+ * Trino catalog name
673
1047
  * @type {string}
674
1048
  * @memberof TrinoConnection
675
1049
  */
676
1050
  'catalog'?: string;
677
1051
  /**
678
- *
1052
+ * Trino schema name
679
1053
  * @type {string}
680
1054
  * @memberof TrinoConnection
681
1055
  */
682
1056
  'schema'?: string;
683
1057
  /**
684
- *
1058
+ * Trino username for authentication
685
1059
  * @type {string}
686
1060
  * @memberof TrinoConnection
687
1061
  */
688
1062
  'user'?: string;
689
1063
  /**
690
- *
1064
+ * Trino password for authentication
691
1065
  * @type {string}
692
1066
  * @memberof TrinoConnection
693
1067
  */
694
1068
  'password'?: string;
695
1069
  }
696
1070
  /**
697
- * Named model view.
1071
+ * Named model view definition
698
1072
  * @export
699
1073
  * @interface View
700
1074
  */
701
1075
  export interface View {
702
1076
  /**
703
- * View\'s name.
1077
+ * Name of the view
704
1078
  * @type {string}
705
1079
  * @memberof View
706
1080
  */
707
1081
  'name'?: string;
708
1082
  /**
709
- * Annotations attached to view.
1083
+ * Annotations attached to the view
710
1084
  * @type {Array<string>}
711
1085
  * @memberof View
712
1086
  */
713
1087
  'annotations'?: Array<string>;
714
1088
  }
1089
+ /**
1090
+ * Current file watching status and configuration
1091
+ * @export
1092
+ * @interface WatchStatus
1093
+ */
1094
+ export interface WatchStatus {
1095
+ /**
1096
+ * Whether file watching is currently active
1097
+ * @type {boolean}
1098
+ * @memberof WatchStatus
1099
+ */
1100
+ 'enabled'?: boolean;
1101
+ /**
1102
+ * Name of the project being watched for file changes
1103
+ * @type {string}
1104
+ * @memberof WatchStatus
1105
+ */
1106
+ 'projectName'?: string;
1107
+ /**
1108
+ * The file system path being monitored for changes, null if not watching
1109
+ * @type {string}
1110
+ * @memberof WatchStatus
1111
+ */
1112
+ 'watchingPath'?: string;
1113
+ }
715
1114
 
716
1115
  /**
717
1116
  * ConnectionsApi - axios parameter creator
@@ -720,10 +1119,10 @@ export interface View {
720
1119
  export const ConnectionsApiAxiosParamCreator = function (configuration?: Configuration) {
721
1120
  return {
722
1121
  /**
723
- *
724
- * @summary Returns a connection.
725
- * @param {string} projectName Name of project
726
- * @param {string} connectionName Name of connection
1122
+ * Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
1123
+ * @summary Get connection details
1124
+ * @param {string} projectName Name of the project
1125
+ * @param {string} connectionName Name of the connection
727
1126
  * @param {*} [options] Override http request option.
728
1127
  * @throws {RequiredError}
729
1128
  */
@@ -758,13 +1157,14 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
758
1157
  };
759
1158
  },
760
1159
  /**
761
- *
762
- * @summary Returns a query and its results.
763
- * @param {string} projectName Name of project
764
- * @param {string} connectionName Name of connection
1160
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
1161
+ * @summary Execute SQL query (deprecated)
1162
+ * @param {string} projectName Name of the project
1163
+ * @param {string} connectionName Name of the connection
765
1164
  * @param {string} [sqlStatement] SQL statement
766
1165
  * @param {string} [_options] Options
767
1166
  * @param {*} [options] Override http request option.
1167
+ * @deprecated
768
1168
  * @throws {RequiredError}
769
1169
  */
770
1170
  getQuerydata: async (projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -806,12 +1206,13 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
806
1206
  };
807
1207
  },
808
1208
  /**
809
- *
810
- * @summary Returns a SQL source.
811
- * @param {string} projectName Name of project
812
- * @param {string} connectionName Name of connection
1209
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1210
+ * @summary Get SQL source (deprecated)
1211
+ * @param {string} projectName Name of the project
1212
+ * @param {string} connectionName Name of the connection
813
1213
  * @param {string} [sqlStatement] SQL statement
814
1214
  * @param {*} [options] Override http request option.
1215
+ * @deprecated
815
1216
  * @throws {RequiredError}
816
1217
  */
817
1218
  getSqlsource: async (projectName: string, connectionName: string, sqlStatement?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -849,13 +1250,60 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
849
1250
  };
850
1251
  },
851
1252
  /**
852
- *
853
- * @summary Returns a table source.
854
- * @param {string} projectName Name of project
855
- * @param {string} connectionName Name of connection
1253
+ * 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.
1254
+ * @summary Get table details from database
1255
+ * @param {string} projectName Name of the project
1256
+ * @param {string} connectionName Name of the connection
1257
+ * @param {string} schemaName Name of the schema
1258
+ * @param {string} tablePath Full path to the table
1259
+ * @param {*} [options] Override http request option.
1260
+ * @throws {RequiredError}
1261
+ */
1262
+ getTable: async (projectName: string, connectionName: string, schemaName: string, tablePath: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1263
+ // verify required parameter 'projectName' is not null or undefined
1264
+ assertParamExists('getTable', 'projectName', projectName)
1265
+ // verify required parameter 'connectionName' is not null or undefined
1266
+ assertParamExists('getTable', 'connectionName', connectionName)
1267
+ // verify required parameter 'schemaName' is not null or undefined
1268
+ assertParamExists('getTable', 'schemaName', schemaName)
1269
+ // verify required parameter 'tablePath' is not null or undefined
1270
+ assertParamExists('getTable', 'tablePath', tablePath)
1271
+ const localVarPath = `/projects/{projectName}/connections/{connectionName}/schemas/{schemaName}/tables/{tablePath}`
1272
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1273
+ .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)))
1274
+ .replace(`{${"schemaName"}}`, encodeURIComponent(String(schemaName)))
1275
+ .replace(`{${"tablePath"}}`, encodeURIComponent(String(tablePath)));
1276
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1277
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1278
+ let baseOptions;
1279
+ if (configuration) {
1280
+ baseOptions = configuration.baseOptions;
1281
+ }
1282
+
1283
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1284
+ const localVarHeaderParameter = {} as any;
1285
+ const localVarQueryParameter = {} as any;
1286
+
1287
+
1288
+
1289
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1290
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1291
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1292
+
1293
+ return {
1294
+ url: toPathString(localVarUrlObj),
1295
+ options: localVarRequestOptions,
1296
+ };
1297
+ },
1298
+ /**
1299
+ * 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.
1300
+ * @summary Get table source information
1301
+ * @param {string} projectName Name of the project
1302
+ * @param {string} connectionName Name of the connection
856
1303
  * @param {string} [tableKey] Table key
857
1304
  * @param {string} [tablePath] Table path
858
1305
  * @param {*} [options] Override http request option.
1306
+ * @deprecated
859
1307
  * @throws {RequiredError}
860
1308
  */
861
1309
  getTablesource: async (projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -897,12 +1345,13 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
897
1345
  };
898
1346
  },
899
1347
  /**
900
- *
901
- * @summary Returns a temporary table.
902
- * @param {string} projectName Name of project
903
- * @param {string} connectionName Name of connection
1348
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
1349
+ * @summary Create temporary table (deprecated)
1350
+ * @param {string} projectName Name of the project
1351
+ * @param {string} connectionName Name of the connection
904
1352
  * @param {string} [sqlStatement] SQL statement
905
1353
  * @param {*} [options] Override http request option.
1354
+ * @deprecated
906
1355
  * @throws {RequiredError}
907
1356
  */
908
1357
  getTemporarytable: async (projectName: string, connectionName: string, sqlStatement?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -940,21 +1389,17 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
940
1389
  };
941
1390
  },
942
1391
  /**
943
- *
944
- * @summary Returns a test.
945
- * @param {string} projectName Name of project
946
- * @param {string} connectionName Name of connection
1392
+ * Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
1393
+ * @summary List project database connections
1394
+ * @param {string} projectName Name of the project
947
1395
  * @param {*} [options] Override http request option.
948
1396
  * @throws {RequiredError}
949
1397
  */
950
- getTest: async (projectName: string, connectionName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1398
+ listConnections: async (projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
951
1399
  // verify required parameter 'projectName' is not null or undefined
952
- assertParamExists('getTest', 'projectName', projectName)
953
- // verify required parameter 'connectionName' is not null or undefined
954
- assertParamExists('getTest', 'connectionName', connectionName)
955
- const localVarPath = `/projects/{projectName}/connections/{connectionName}/test`
956
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
957
- .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)));
1400
+ assertParamExists('listConnections', 'projectName', projectName)
1401
+ const localVarPath = `/projects/{projectName}/connections`
1402
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
958
1403
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
959
1404
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
960
1405
  let baseOptions;
@@ -978,17 +1423,21 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
978
1423
  };
979
1424
  },
980
1425
  /**
981
- *
982
- * @summary Returns a list of the connections in the project.
983
- * @param {string} projectName Name of project
1426
+ * Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
1427
+ * @summary List database schemas
1428
+ * @param {string} projectName Name of the project
1429
+ * @param {string} connectionName Name of the connection
984
1430
  * @param {*} [options] Override http request option.
985
1431
  * @throws {RequiredError}
986
1432
  */
987
- listConnections: async (projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1433
+ listSchemas: async (projectName: string, connectionName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
988
1434
  // verify required parameter 'projectName' is not null or undefined
989
- assertParamExists('listConnections', 'projectName', projectName)
990
- const localVarPath = `/projects/{projectName}/connections`
991
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
1435
+ assertParamExists('listSchemas', 'projectName', projectName)
1436
+ // verify required parameter 'connectionName' is not null or undefined
1437
+ assertParamExists('listSchemas', 'connectionName', connectionName)
1438
+ const localVarPath = `/projects/{projectName}/connections/{connectionName}/schemas`
1439
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1440
+ .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)));
992
1441
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
993
1442
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
994
1443
  let baseOptions;
@@ -1011,110 +1460,295 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
1011
1460
  options: localVarRequestOptions,
1012
1461
  };
1013
1462
  },
1014
- }
1015
- };
1016
-
1017
- /**
1018
- * ConnectionsApi - functional programming interface
1019
- * @export
1020
- */
1021
- export const ConnectionsApiFp = function(configuration?: Configuration) {
1022
- const localVarAxiosParamCreator = ConnectionsApiAxiosParamCreator(configuration)
1023
- return {
1024
1463
  /**
1025
- *
1026
- * @summary Returns a connection.
1027
- * @param {string} projectName Name of project
1028
- * @param {string} connectionName Name of connection
1464
+ * 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.
1465
+ * @summary List tables in database
1466
+ * @param {string} projectName Name of the project
1467
+ * @param {string} connectionName Name of the connection
1468
+ * @param {string} schemaName Name of the schema
1029
1469
  * @param {*} [options] Override http request option.
1030
1470
  * @throws {RequiredError}
1031
1471
  */
1032
- async getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>> {
1033
- const localVarAxiosArgs = await localVarAxiosParamCreator.getConnection(projectName, connectionName, options);
1034
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1035
- const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getConnection']?.[localVarOperationServerIndex]?.url;
1036
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1472
+ listTables: async (projectName: string, connectionName: string, schemaName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1473
+ // verify required parameter 'projectName' is not null or undefined
1474
+ assertParamExists('listTables', 'projectName', projectName)
1475
+ // verify required parameter 'connectionName' is not null or undefined
1476
+ assertParamExists('listTables', 'connectionName', connectionName)
1477
+ // verify required parameter 'schemaName' is not null or undefined
1478
+ assertParamExists('listTables', 'schemaName', schemaName)
1479
+ const localVarPath = `/projects/{projectName}/connections/{connectionName}/schemas/{schemaName}/tables`
1480
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1481
+ .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)))
1482
+ .replace(`{${"schemaName"}}`, encodeURIComponent(String(schemaName)));
1483
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1484
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1485
+ let baseOptions;
1486
+ if (configuration) {
1487
+ baseOptions = configuration.baseOptions;
1488
+ }
1489
+
1490
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1491
+ const localVarHeaderParameter = {} as any;
1492
+ const localVarQueryParameter = {} as any;
1493
+
1494
+
1495
+
1496
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1497
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1498
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1499
+
1500
+ return {
1501
+ url: toPathString(localVarUrlObj),
1502
+ options: localVarRequestOptions,
1503
+ };
1037
1504
  },
1038
1505
  /**
1039
- *
1040
- * @summary Returns a query and its results.
1041
- * @param {string} projectName Name of project
1042
- * @param {string} connectionName Name of connection
1043
- * @param {string} [sqlStatement] SQL statement
1506
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1507
+ * @summary Execute SQL query
1508
+ * @param {string} projectName Name of the project
1509
+ * @param {string} connectionName Name of the connection
1510
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
1044
1511
  * @param {string} [_options] Options
1045
1512
  * @param {*} [options] Override http request option.
1046
1513
  * @throws {RequiredError}
1047
1514
  */
1048
- async getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>> {
1049
- const localVarAxiosArgs = await localVarAxiosParamCreator.getQuerydata(projectName, connectionName, sqlStatement, _options, options);
1050
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1051
- const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getQuerydata']?.[localVarOperationServerIndex]?.url;
1052
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1053
- },
1054
- /**
1055
- *
1056
- * @summary Returns a SQL source.
1057
- * @param {string} projectName Name of project
1058
- * @param {string} connectionName Name of connection
1059
- * @param {string} [sqlStatement] SQL statement
1060
- * @param {*} [options] Override http request option.
1061
- * @throws {RequiredError}
1062
- */
1063
- async getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>> {
1064
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSqlsource(projectName, connectionName, sqlStatement, options);
1065
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1066
- const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getSqlsource']?.[localVarOperationServerIndex]?.url;
1067
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1068
- },
1069
- /**
1070
- *
1071
- * @summary Returns a table source.
1072
- * @param {string} projectName Name of project
1073
- * @param {string} connectionName Name of connection
1074
- * @param {string} [tableKey] Table key
1075
- * @param {string} [tablePath] Table path
1076
- * @param {*} [options] Override http request option.
1077
- * @throws {RequiredError}
1078
- */
1079
- async getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TableSource>> {
1080
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTablesource(projectName, connectionName, tableKey, tablePath, options);
1081
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1082
- const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getTablesource']?.[localVarOperationServerIndex]?.url;
1083
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1515
+ postQuerydata: async (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1516
+ // verify required parameter 'projectName' is not null or undefined
1517
+ assertParamExists('postQuerydata', 'projectName', projectName)
1518
+ // verify required parameter 'connectionName' is not null or undefined
1519
+ assertParamExists('postQuerydata', 'connectionName', connectionName)
1520
+ // verify required parameter 'postSqlsourceRequest' is not null or undefined
1521
+ assertParamExists('postQuerydata', 'postSqlsourceRequest', postSqlsourceRequest)
1522
+ const localVarPath = `/projects/{projectName}/connections/{connectionName}/sqlQuery`
1523
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1524
+ .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)));
1525
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1526
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1527
+ let baseOptions;
1528
+ if (configuration) {
1529
+ baseOptions = configuration.baseOptions;
1530
+ }
1531
+
1532
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1533
+ const localVarHeaderParameter = {} as any;
1534
+ const localVarQueryParameter = {} as any;
1535
+
1536
+ if (_options !== undefined) {
1537
+ localVarQueryParameter['options'] = _options;
1538
+ }
1539
+
1540
+
1541
+
1542
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1543
+
1544
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1545
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1546
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1547
+ localVarRequestOptions.data = serializeDataIfNeeded(postSqlsourceRequest, localVarRequestOptions, configuration)
1548
+
1549
+ return {
1550
+ url: toPathString(localVarUrlObj),
1551
+ options: localVarRequestOptions,
1552
+ };
1084
1553
  },
1085
1554
  /**
1086
- *
1087
- * @summary Returns a temporary table.
1088
- * @param {string} projectName Name of project
1089
- * @param {string} connectionName Name of connection
1090
- * @param {string} [sqlStatement] SQL statement
1555
+ * 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.
1556
+ * @summary Create SQL source from statement
1557
+ * @param {string} projectName Name of the project
1558
+ * @param {string} connectionName Name of the connection
1559
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
1091
1560
  * @param {*} [options] Override http request option.
1092
1561
  * @throws {RequiredError}
1093
1562
  */
1094
- async getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>> {
1095
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTemporarytable(projectName, connectionName, sqlStatement, options);
1563
+ postSqlsource: async (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1564
+ // verify required parameter 'projectName' is not null or undefined
1565
+ assertParamExists('postSqlsource', 'projectName', projectName)
1566
+ // verify required parameter 'connectionName' is not null or undefined
1567
+ assertParamExists('postSqlsource', 'connectionName', connectionName)
1568
+ // verify required parameter 'postSqlsourceRequest' is not null or undefined
1569
+ assertParamExists('postSqlsource', 'postSqlsourceRequest', postSqlsourceRequest)
1570
+ const localVarPath = `/projects/{projectName}/connections/{connectionName}/sqlSource`
1571
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1572
+ .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)));
1573
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1574
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1575
+ let baseOptions;
1576
+ if (configuration) {
1577
+ baseOptions = configuration.baseOptions;
1578
+ }
1579
+
1580
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1581
+ const localVarHeaderParameter = {} as any;
1582
+ const localVarQueryParameter = {} as any;
1583
+
1584
+
1585
+
1586
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1587
+
1588
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1589
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1590
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1591
+ localVarRequestOptions.data = serializeDataIfNeeded(postSqlsourceRequest, localVarRequestOptions, configuration)
1592
+
1593
+ return {
1594
+ url: toPathString(localVarUrlObj),
1595
+ options: localVarRequestOptions,
1596
+ };
1597
+ },
1598
+ /**
1599
+ * 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.
1600
+ * @summary Create temporary table
1601
+ * @param {string} projectName Name of the project
1602
+ * @param {string} connectionName Name of the connection
1603
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
1604
+ * @param {*} [options] Override http request option.
1605
+ * @throws {RequiredError}
1606
+ */
1607
+ postTemporarytable: async (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1608
+ // verify required parameter 'projectName' is not null or undefined
1609
+ assertParamExists('postTemporarytable', 'projectName', projectName)
1610
+ // verify required parameter 'connectionName' is not null or undefined
1611
+ assertParamExists('postTemporarytable', 'connectionName', connectionName)
1612
+ // verify required parameter 'postSqlsourceRequest' is not null or undefined
1613
+ assertParamExists('postTemporarytable', 'postSqlsourceRequest', postSqlsourceRequest)
1614
+ const localVarPath = `/projects/{projectName}/connections/{connectionName}/sqlTemporaryTable`
1615
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1616
+ .replace(`{${"connectionName"}}`, encodeURIComponent(String(connectionName)));
1617
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1618
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1619
+ let baseOptions;
1620
+ if (configuration) {
1621
+ baseOptions = configuration.baseOptions;
1622
+ }
1623
+
1624
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1625
+ const localVarHeaderParameter = {} as any;
1626
+ const localVarQueryParameter = {} as any;
1627
+
1628
+
1629
+
1630
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1631
+
1632
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1633
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1634
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1635
+ localVarRequestOptions.data = serializeDataIfNeeded(postSqlsourceRequest, localVarRequestOptions, configuration)
1636
+
1637
+ return {
1638
+ url: toPathString(localVarUrlObj),
1639
+ options: localVarRequestOptions,
1640
+ };
1641
+ },
1642
+ }
1643
+ };
1644
+
1645
+ /**
1646
+ * ConnectionsApi - functional programming interface
1647
+ * @export
1648
+ */
1649
+ export const ConnectionsApiFp = function(configuration?: Configuration) {
1650
+ const localVarAxiosParamCreator = ConnectionsApiAxiosParamCreator(configuration)
1651
+ return {
1652
+ /**
1653
+ * Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
1654
+ * @summary Get connection details
1655
+ * @param {string} projectName Name of the project
1656
+ * @param {string} connectionName Name of the connection
1657
+ * @param {*} [options] Override http request option.
1658
+ * @throws {RequiredError}
1659
+ */
1660
+ async getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>> {
1661
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getConnection(projectName, connectionName, options);
1096
1662
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1097
- const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getTemporarytable']?.[localVarOperationServerIndex]?.url;
1663
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getConnection']?.[localVarOperationServerIndex]?.url;
1664
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1665
+ },
1666
+ /**
1667
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
1668
+ * @summary Execute SQL query (deprecated)
1669
+ * @param {string} projectName Name of the project
1670
+ * @param {string} connectionName Name of the connection
1671
+ * @param {string} [sqlStatement] SQL statement
1672
+ * @param {string} [_options] Options
1673
+ * @param {*} [options] Override http request option.
1674
+ * @deprecated
1675
+ * @throws {RequiredError}
1676
+ */
1677
+ async getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>> {
1678
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getQuerydata(projectName, connectionName, sqlStatement, _options, options);
1679
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1680
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getQuerydata']?.[localVarOperationServerIndex]?.url;
1681
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1682
+ },
1683
+ /**
1684
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1685
+ * @summary Get SQL source (deprecated)
1686
+ * @param {string} projectName Name of the project
1687
+ * @param {string} connectionName Name of the connection
1688
+ * @param {string} [sqlStatement] SQL statement
1689
+ * @param {*} [options] Override http request option.
1690
+ * @deprecated
1691
+ * @throws {RequiredError}
1692
+ */
1693
+ async getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>> {
1694
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSqlsource(projectName, connectionName, sqlStatement, options);
1695
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1696
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getSqlsource']?.[localVarOperationServerIndex]?.url;
1697
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1698
+ },
1699
+ /**
1700
+ * 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.
1701
+ * @summary Get table details from database
1702
+ * @param {string} projectName Name of the project
1703
+ * @param {string} connectionName Name of the connection
1704
+ * @param {string} schemaName Name of the schema
1705
+ * @param {string} tablePath Full path to the table
1706
+ * @param {*} [options] Override http request option.
1707
+ * @throws {RequiredError}
1708
+ */
1709
+ async getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>> {
1710
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTable(projectName, connectionName, schemaName, tablePath, options);
1711
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1712
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getTable']?.[localVarOperationServerIndex]?.url;
1713
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1714
+ },
1715
+ /**
1716
+ * 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.
1717
+ * @summary Get table source information
1718
+ * @param {string} projectName Name of the project
1719
+ * @param {string} connectionName Name of the connection
1720
+ * @param {string} [tableKey] Table key
1721
+ * @param {string} [tablePath] Table path
1722
+ * @param {*} [options] Override http request option.
1723
+ * @deprecated
1724
+ * @throws {RequiredError}
1725
+ */
1726
+ async getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TableSource>> {
1727
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTablesource(projectName, connectionName, tableKey, tablePath, options);
1728
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1729
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getTablesource']?.[localVarOperationServerIndex]?.url;
1098
1730
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1099
1731
  },
1100
1732
  /**
1101
- *
1102
- * @summary Returns a test.
1103
- * @param {string} projectName Name of project
1104
- * @param {string} connectionName Name of connection
1733
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
1734
+ * @summary Create temporary table (deprecated)
1735
+ * @param {string} projectName Name of the project
1736
+ * @param {string} connectionName Name of the connection
1737
+ * @param {string} [sqlStatement] SQL statement
1105
1738
  * @param {*} [options] Override http request option.
1739
+ * @deprecated
1106
1740
  * @throws {RequiredError}
1107
1741
  */
1108
- async getTest(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1109
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTest(projectName, connectionName, options);
1742
+ async getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>> {
1743
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTemporarytable(projectName, connectionName, sqlStatement, options);
1110
1744
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1111
- const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getTest']?.[localVarOperationServerIndex]?.url;
1745
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.getTemporarytable']?.[localVarOperationServerIndex]?.url;
1112
1746
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1113
1747
  },
1114
1748
  /**
1115
- *
1116
- * @summary Returns a list of the connections in the project.
1117
- * @param {string} projectName Name of project
1749
+ * Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
1750
+ * @summary List project database connections
1751
+ * @param {string} projectName Name of the project
1118
1752
  * @param {*} [options] Override http request option.
1119
1753
  * @throws {RequiredError}
1120
1754
  */
@@ -1124,6 +1758,81 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
1124
1758
  const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.listConnections']?.[localVarOperationServerIndex]?.url;
1125
1759
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1126
1760
  },
1761
+ /**
1762
+ * Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
1763
+ * @summary List database schemas
1764
+ * @param {string} projectName Name of the project
1765
+ * @param {string} connectionName Name of the connection
1766
+ * @param {*} [options] Override http request option.
1767
+ * @throws {RequiredError}
1768
+ */
1769
+ async listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>> {
1770
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSchemas(projectName, connectionName, options);
1771
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1772
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.listSchemas']?.[localVarOperationServerIndex]?.url;
1773
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1774
+ },
1775
+ /**
1776
+ * 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.
1777
+ * @summary List tables in database
1778
+ * @param {string} projectName Name of the project
1779
+ * @param {string} connectionName Name of the connection
1780
+ * @param {string} schemaName Name of the schema
1781
+ * @param {*} [options] Override http request option.
1782
+ * @throws {RequiredError}
1783
+ */
1784
+ async listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Table>>> {
1785
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTables(projectName, connectionName, schemaName, options);
1786
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1787
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.listTables']?.[localVarOperationServerIndex]?.url;
1788
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1789
+ },
1790
+ /**
1791
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1792
+ * @summary Execute SQL query
1793
+ * @param {string} projectName Name of the project
1794
+ * @param {string} connectionName Name of the connection
1795
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
1796
+ * @param {string} [_options] Options
1797
+ * @param {*} [options] Override http request option.
1798
+ * @throws {RequiredError}
1799
+ */
1800
+ async postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>> {
1801
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postQuerydata(projectName, connectionName, postSqlsourceRequest, _options, options);
1802
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1803
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.postQuerydata']?.[localVarOperationServerIndex]?.url;
1804
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1805
+ },
1806
+ /**
1807
+ * 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.
1808
+ * @summary Create SQL source from statement
1809
+ * @param {string} projectName Name of the project
1810
+ * @param {string} connectionName Name of the connection
1811
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
1812
+ * @param {*} [options] Override http request option.
1813
+ * @throws {RequiredError}
1814
+ */
1815
+ async postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>> {
1816
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postSqlsource(projectName, connectionName, postSqlsourceRequest, options);
1817
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1818
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.postSqlsource']?.[localVarOperationServerIndex]?.url;
1819
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1820
+ },
1821
+ /**
1822
+ * 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.
1823
+ * @summary Create temporary table
1824
+ * @param {string} projectName Name of the project
1825
+ * @param {string} connectionName Name of the connection
1826
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
1827
+ * @param {*} [options] Override http request option.
1828
+ * @throws {RequiredError}
1829
+ */
1830
+ async postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>> {
1831
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postTemporarytable(projectName, connectionName, postSqlsourceRequest, options);
1832
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1833
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.postTemporarytable']?.[localVarOperationServerIndex]?.url;
1834
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1835
+ },
1127
1836
  }
1128
1837
  };
1129
1838
 
@@ -1135,10 +1844,10 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
1135
1844
  const localVarFp = ConnectionsApiFp(configuration)
1136
1845
  return {
1137
1846
  /**
1138
- *
1139
- * @summary Returns a connection.
1140
- * @param {string} projectName Name of project
1141
- * @param {string} connectionName Name of connection
1847
+ * Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
1848
+ * @summary Get connection details
1849
+ * @param {string} projectName Name of the project
1850
+ * @param {string} connectionName Name of the connection
1142
1851
  * @param {*} [options] Override http request option.
1143
1852
  * @throws {RequiredError}
1144
1853
  */
@@ -1146,75 +1855,141 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
1146
1855
  return localVarFp.getConnection(projectName, connectionName, options).then((request) => request(axios, basePath));
1147
1856
  },
1148
1857
  /**
1149
- *
1150
- * @summary Returns a query and its results.
1151
- * @param {string} projectName Name of project
1152
- * @param {string} connectionName Name of connection
1858
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
1859
+ * @summary Execute SQL query (deprecated)
1860
+ * @param {string} projectName Name of the project
1861
+ * @param {string} connectionName Name of the connection
1153
1862
  * @param {string} [sqlStatement] SQL statement
1154
1863
  * @param {string} [_options] Options
1155
1864
  * @param {*} [options] Override http request option.
1865
+ * @deprecated
1156
1866
  * @throws {RequiredError}
1157
1867
  */
1158
1868
  getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData> {
1159
1869
  return localVarFp.getQuerydata(projectName, connectionName, sqlStatement, _options, options).then((request) => request(axios, basePath));
1160
1870
  },
1161
1871
  /**
1162
- *
1163
- * @summary Returns a SQL source.
1164
- * @param {string} projectName Name of project
1165
- * @param {string} connectionName Name of connection
1872
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
1873
+ * @summary Get SQL source (deprecated)
1874
+ * @param {string} projectName Name of the project
1875
+ * @param {string} connectionName Name of the connection
1166
1876
  * @param {string} [sqlStatement] SQL statement
1167
1877
  * @param {*} [options] Override http request option.
1878
+ * @deprecated
1168
1879
  * @throws {RequiredError}
1169
1880
  */
1170
1881
  getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource> {
1171
1882
  return localVarFp.getSqlsource(projectName, connectionName, sqlStatement, options).then((request) => request(axios, basePath));
1172
1883
  },
1173
1884
  /**
1174
- *
1175
- * @summary Returns a table source.
1176
- * @param {string} projectName Name of project
1177
- * @param {string} connectionName Name of connection
1885
+ * 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.
1886
+ * @summary Get table details from database
1887
+ * @param {string} projectName Name of the project
1888
+ * @param {string} connectionName Name of the connection
1889
+ * @param {string} schemaName Name of the schema
1890
+ * @param {string} tablePath Full path to the table
1891
+ * @param {*} [options] Override http request option.
1892
+ * @throws {RequiredError}
1893
+ */
1894
+ getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table> {
1895
+ return localVarFp.getTable(projectName, connectionName, schemaName, tablePath, options).then((request) => request(axios, basePath));
1896
+ },
1897
+ /**
1898
+ * 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.
1899
+ * @summary Get table source information
1900
+ * @param {string} projectName Name of the project
1901
+ * @param {string} connectionName Name of the connection
1178
1902
  * @param {string} [tableKey] Table key
1179
1903
  * @param {string} [tablePath] Table path
1180
1904
  * @param {*} [options] Override http request option.
1905
+ * @deprecated
1181
1906
  * @throws {RequiredError}
1182
1907
  */
1183
1908
  getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): AxiosPromise<TableSource> {
1184
1909
  return localVarFp.getTablesource(projectName, connectionName, tableKey, tablePath, options).then((request) => request(axios, basePath));
1185
1910
  },
1186
1911
  /**
1187
- *
1188
- * @summary Returns a temporary table.
1189
- * @param {string} projectName Name of project
1190
- * @param {string} connectionName Name of connection
1912
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
1913
+ * @summary Create temporary table (deprecated)
1914
+ * @param {string} projectName Name of the project
1915
+ * @param {string} connectionName Name of the connection
1191
1916
  * @param {string} [sqlStatement] SQL statement
1192
1917
  * @param {*} [options] Override http request option.
1918
+ * @deprecated
1193
1919
  * @throws {RequiredError}
1194
1920
  */
1195
1921
  getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable> {
1196
1922
  return localVarFp.getTemporarytable(projectName, connectionName, sqlStatement, options).then((request) => request(axios, basePath));
1197
1923
  },
1198
1924
  /**
1199
- *
1200
- * @summary Returns a test.
1201
- * @param {string} projectName Name of project
1202
- * @param {string} connectionName Name of connection
1925
+ * Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
1926
+ * @summary List project database connections
1927
+ * @param {string} projectName Name of the project
1203
1928
  * @param {*} [options] Override http request option.
1204
1929
  * @throws {RequiredError}
1205
1930
  */
1206
- getTest(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1207
- return localVarFp.getTest(projectName, connectionName, options).then((request) => request(axios, basePath));
1931
+ listConnections(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>> {
1932
+ return localVarFp.listConnections(projectName, options).then((request) => request(axios, basePath));
1208
1933
  },
1209
1934
  /**
1210
- *
1211
- * @summary Returns a list of the connections in the project.
1212
- * @param {string} projectName Name of project
1935
+ * Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
1936
+ * @summary List database schemas
1937
+ * @param {string} projectName Name of the project
1938
+ * @param {string} connectionName Name of the connection
1213
1939
  * @param {*} [options] Override http request option.
1214
1940
  * @throws {RequiredError}
1215
1941
  */
1216
- listConnections(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>> {
1217
- return localVarFp.listConnections(projectName, options).then((request) => request(axios, basePath));
1942
+ listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>> {
1943
+ return localVarFp.listSchemas(projectName, connectionName, options).then((request) => request(axios, basePath));
1944
+ },
1945
+ /**
1946
+ * 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.
1947
+ * @summary List tables in database
1948
+ * @param {string} projectName Name of the project
1949
+ * @param {string} connectionName Name of the connection
1950
+ * @param {string} schemaName Name of the schema
1951
+ * @param {*} [options] Override http request option.
1952
+ * @throws {RequiredError}
1953
+ */
1954
+ listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Table>> {
1955
+ return localVarFp.listTables(projectName, connectionName, schemaName, options).then((request) => request(axios, basePath));
1956
+ },
1957
+ /**
1958
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
1959
+ * @summary Execute SQL query
1960
+ * @param {string} projectName Name of the project
1961
+ * @param {string} connectionName Name of the connection
1962
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
1963
+ * @param {string} [_options] Options
1964
+ * @param {*} [options] Override http request option.
1965
+ * @throws {RequiredError}
1966
+ */
1967
+ postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData> {
1968
+ return localVarFp.postQuerydata(projectName, connectionName, postSqlsourceRequest, _options, options).then((request) => request(axios, basePath));
1969
+ },
1970
+ /**
1971
+ * 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.
1972
+ * @summary Create SQL source from statement
1973
+ * @param {string} projectName Name of the project
1974
+ * @param {string} connectionName Name of the connection
1975
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
1976
+ * @param {*} [options] Override http request option.
1977
+ * @throws {RequiredError}
1978
+ */
1979
+ postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource> {
1980
+ return localVarFp.postSqlsource(projectName, connectionName, postSqlsourceRequest, options).then((request) => request(axios, basePath));
1981
+ },
1982
+ /**
1983
+ * 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.
1984
+ * @summary Create temporary table
1985
+ * @param {string} projectName Name of the project
1986
+ * @param {string} connectionName Name of the connection
1987
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
1988
+ * @param {*} [options] Override http request option.
1989
+ * @throws {RequiredError}
1990
+ */
1991
+ postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable> {
1992
+ return localVarFp.postTemporarytable(projectName, connectionName, postSqlsourceRequest, options).then((request) => request(axios, basePath));
1218
1993
  },
1219
1994
  };
1220
1995
  };
@@ -1227,10 +2002,10 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
1227
2002
  */
1228
2003
  export class ConnectionsApi extends BaseAPI {
1229
2004
  /**
1230
- *
1231
- * @summary Returns a connection.
1232
- * @param {string} projectName Name of project
1233
- * @param {string} connectionName Name of connection
2005
+ * Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
2006
+ * @summary Get connection details
2007
+ * @param {string} projectName Name of the project
2008
+ * @param {string} connectionName Name of the connection
1234
2009
  * @param {*} [options] Override http request option.
1235
2010
  * @throws {RequiredError}
1236
2011
  * @memberof ConnectionsApi
@@ -1240,13 +2015,14 @@ export class ConnectionsApi extends BaseAPI {
1240
2015
  }
1241
2016
 
1242
2017
  /**
1243
- *
1244
- * @summary Returns a query and its results.
1245
- * @param {string} projectName Name of project
1246
- * @param {string} connectionName Name of connection
2018
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
2019
+ * @summary Execute SQL query (deprecated)
2020
+ * @param {string} projectName Name of the project
2021
+ * @param {string} connectionName Name of the connection
1247
2022
  * @param {string} [sqlStatement] SQL statement
1248
2023
  * @param {string} [_options] Options
1249
2024
  * @param {*} [options] Override http request option.
2025
+ * @deprecated
1250
2026
  * @throws {RequiredError}
1251
2027
  * @memberof ConnectionsApi
1252
2028
  */
@@ -1255,12 +2031,13 @@ export class ConnectionsApi extends BaseAPI {
1255
2031
  }
1256
2032
 
1257
2033
  /**
1258
- *
1259
- * @summary Returns a SQL source.
1260
- * @param {string} projectName Name of project
1261
- * @param {string} connectionName Name of connection
2034
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
2035
+ * @summary Get SQL source (deprecated)
2036
+ * @param {string} projectName Name of the project
2037
+ * @param {string} connectionName Name of the connection
1262
2038
  * @param {string} [sqlStatement] SQL statement
1263
2039
  * @param {*} [options] Override http request option.
2040
+ * @deprecated
1264
2041
  * @throws {RequiredError}
1265
2042
  * @memberof ConnectionsApi
1266
2043
  */
@@ -1269,13 +2046,29 @@ export class ConnectionsApi extends BaseAPI {
1269
2046
  }
1270
2047
 
1271
2048
  /**
1272
- *
1273
- * @summary Returns a table source.
1274
- * @param {string} projectName Name of project
1275
- * @param {string} connectionName Name of connection
2049
+ * 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.
2050
+ * @summary Get table details from database
2051
+ * @param {string} projectName Name of the project
2052
+ * @param {string} connectionName Name of the connection
2053
+ * @param {string} schemaName Name of the schema
2054
+ * @param {string} tablePath Full path to the table
2055
+ * @param {*} [options] Override http request option.
2056
+ * @throws {RequiredError}
2057
+ * @memberof ConnectionsApi
2058
+ */
2059
+ public getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) {
2060
+ return ConnectionsApiFp(this.configuration).getTable(projectName, connectionName, schemaName, tablePath, options).then((request) => request(this.axios, this.basePath));
2061
+ }
2062
+
2063
+ /**
2064
+ * 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.
2065
+ * @summary Get table source information
2066
+ * @param {string} projectName Name of the project
2067
+ * @param {string} connectionName Name of the connection
1276
2068
  * @param {string} [tableKey] Table key
1277
2069
  * @param {string} [tablePath] Table path
1278
2070
  * @param {*} [options] Override http request option.
2071
+ * @deprecated
1279
2072
  * @throws {RequiredError}
1280
2073
  * @memberof ConnectionsApi
1281
2074
  */
@@ -1284,12 +2077,13 @@ export class ConnectionsApi extends BaseAPI {
1284
2077
  }
1285
2078
 
1286
2079
  /**
1287
- *
1288
- * @summary Returns a temporary table.
1289
- * @param {string} projectName Name of project
1290
- * @param {string} connectionName Name of connection
2080
+ * **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
2081
+ * @summary Create temporary table (deprecated)
2082
+ * @param {string} projectName Name of the project
2083
+ * @param {string} connectionName Name of the connection
1291
2084
  * @param {string} [sqlStatement] SQL statement
1292
2085
  * @param {*} [options] Override http request option.
2086
+ * @deprecated
1293
2087
  * @throws {RequiredError}
1294
2088
  * @memberof ConnectionsApi
1295
2089
  */
@@ -1298,56 +2092,107 @@ export class ConnectionsApi extends BaseAPI {
1298
2092
  }
1299
2093
 
1300
2094
  /**
1301
- *
1302
- * @summary Returns a test.
1303
- * @param {string} projectName Name of project
1304
- * @param {string} connectionName Name of connection
2095
+ * Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
2096
+ * @summary List project database connections
2097
+ * @param {string} projectName Name of the project
1305
2098
  * @param {*} [options] Override http request option.
1306
2099
  * @throws {RequiredError}
1307
2100
  * @memberof ConnectionsApi
1308
2101
  */
1309
- public getTest(projectName: string, connectionName: string, options?: RawAxiosRequestConfig) {
1310
- return ConnectionsApiFp(this.configuration).getTest(projectName, connectionName, options).then((request) => request(this.axios, this.basePath));
2102
+ public listConnections(projectName: string, options?: RawAxiosRequestConfig) {
2103
+ return ConnectionsApiFp(this.configuration).listConnections(projectName, options).then((request) => request(this.axios, this.basePath));
1311
2104
  }
1312
2105
 
1313
2106
  /**
1314
- *
1315
- * @summary Returns a list of the connections in the project.
1316
- * @param {string} projectName Name of project
2107
+ * Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
2108
+ * @summary List database schemas
2109
+ * @param {string} projectName Name of the project
2110
+ * @param {string} connectionName Name of the connection
1317
2111
  * @param {*} [options] Override http request option.
1318
2112
  * @throws {RequiredError}
1319
2113
  * @memberof ConnectionsApi
1320
2114
  */
1321
- public listConnections(projectName: string, options?: RawAxiosRequestConfig) {
1322
- return ConnectionsApiFp(this.configuration).listConnections(projectName, options).then((request) => request(this.axios, this.basePath));
2115
+ public listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig) {
2116
+ return ConnectionsApiFp(this.configuration).listSchemas(projectName, connectionName, options).then((request) => request(this.axios, this.basePath));
2117
+ }
2118
+
2119
+ /**
2120
+ * 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.
2121
+ * @summary List tables in database
2122
+ * @param {string} projectName Name of the project
2123
+ * @param {string} connectionName Name of the connection
2124
+ * @param {string} schemaName Name of the schema
2125
+ * @param {*} [options] Override http request option.
2126
+ * @throws {RequiredError}
2127
+ * @memberof ConnectionsApi
2128
+ */
2129
+ public listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig) {
2130
+ return ConnectionsApiFp(this.configuration).listTables(projectName, connectionName, schemaName, options).then((request) => request(this.axios, this.basePath));
2131
+ }
2132
+
2133
+ /**
2134
+ * Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
2135
+ * @summary Execute SQL query
2136
+ * @param {string} projectName Name of the project
2137
+ * @param {string} connectionName Name of the connection
2138
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
2139
+ * @param {string} [_options] Options
2140
+ * @param {*} [options] Override http request option.
2141
+ * @throws {RequiredError}
2142
+ * @memberof ConnectionsApi
2143
+ */
2144
+ public postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig) {
2145
+ return ConnectionsApiFp(this.configuration).postQuerydata(projectName, connectionName, postSqlsourceRequest, _options, options).then((request) => request(this.axios, this.basePath));
2146
+ }
2147
+
2148
+ /**
2149
+ * 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.
2150
+ * @summary Create SQL source from statement
2151
+ * @param {string} projectName Name of the project
2152
+ * @param {string} connectionName Name of the connection
2153
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
2154
+ * @param {*} [options] Override http request option.
2155
+ * @throws {RequiredError}
2156
+ * @memberof ConnectionsApi
2157
+ */
2158
+ public postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) {
2159
+ return ConnectionsApiFp(this.configuration).postSqlsource(projectName, connectionName, postSqlsourceRequest, options).then((request) => request(this.axios, this.basePath));
2160
+ }
2161
+
2162
+ /**
2163
+ * 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.
2164
+ * @summary Create temporary table
2165
+ * @param {string} projectName Name of the project
2166
+ * @param {string} connectionName Name of the connection
2167
+ * @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
2168
+ * @param {*} [options] Override http request option.
2169
+ * @throws {RequiredError}
2170
+ * @memberof ConnectionsApi
2171
+ */
2172
+ public postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) {
2173
+ return ConnectionsApiFp(this.configuration).postTemporarytable(projectName, connectionName, postSqlsourceRequest, options).then((request) => request(this.axios, this.basePath));
1323
2174
  }
1324
2175
  }
1325
2176
 
1326
2177
 
1327
2178
 
1328
2179
  /**
1329
- * DatabasesApi - axios parameter creator
2180
+ * ConnectionsTestApi - axios parameter creator
1330
2181
  * @export
1331
2182
  */
1332
- export const DatabasesApiAxiosParamCreator = function (configuration?: Configuration) {
2183
+ export const ConnectionsTestApiAxiosParamCreator = function (configuration?: Configuration) {
1333
2184
  return {
1334
2185
  /**
1335
- *
1336
- * @summary Returns a list of relative paths to the databases embedded in the package.
1337
- * @param {string} projectName Name of project
1338
- * @param {string} packageName Name of package
1339
- * @param {string} [versionId] Version ID
2186
+ * 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.
2187
+ * @summary Test database connection configuration
2188
+ * @param {Connection} connection
1340
2189
  * @param {*} [options] Override http request option.
1341
2190
  * @throws {RequiredError}
1342
2191
  */
1343
- listDatabases: async (projectName: string, packageName: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1344
- // verify required parameter 'projectName' is not null or undefined
1345
- assertParamExists('listDatabases', 'projectName', projectName)
1346
- // verify required parameter 'packageName' is not null or undefined
1347
- assertParamExists('listDatabases', 'packageName', packageName)
1348
- const localVarPath = `/projects/{projectName}/packages/{packageName}/databases`
1349
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1350
- .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
2192
+ testConnectionConfiguration: async (connection: Connection, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2193
+ // verify required parameter 'connection' is not null or undefined
2194
+ assertParamExists('testConnectionConfiguration', 'connection', connection)
2195
+ const localVarPath = `/connections/test`;
1351
2196
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1352
2197
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1353
2198
  let baseOptions;
@@ -1355,19 +2200,18 @@ export const DatabasesApiAxiosParamCreator = function (configuration?: Configura
1355
2200
  baseOptions = configuration.baseOptions;
1356
2201
  }
1357
2202
 
1358
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2203
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1359
2204
  const localVarHeaderParameter = {} as any;
1360
2205
  const localVarQueryParameter = {} as any;
1361
2206
 
1362
- if (versionId !== undefined) {
1363
- localVarQueryParameter['versionId'] = versionId;
1364
- }
1365
-
1366
2207
 
1367
2208
 
2209
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2210
+
1368
2211
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1369
2212
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1370
2213
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2214
+ localVarRequestOptions.data = serializeDataIfNeeded(connection, localVarRequestOptions, configuration)
1371
2215
 
1372
2216
  return {
1373
2217
  url: toPathString(localVarUrlObj),
@@ -1378,94 +2222,93 @@ export const DatabasesApiAxiosParamCreator = function (configuration?: Configura
1378
2222
  };
1379
2223
 
1380
2224
  /**
1381
- * DatabasesApi - functional programming interface
2225
+ * ConnectionsTestApi - functional programming interface
1382
2226
  * @export
1383
2227
  */
1384
- export const DatabasesApiFp = function(configuration?: Configuration) {
1385
- const localVarAxiosParamCreator = DatabasesApiAxiosParamCreator(configuration)
2228
+ export const ConnectionsTestApiFp = function(configuration?: Configuration) {
2229
+ const localVarAxiosParamCreator = ConnectionsTestApiAxiosParamCreator(configuration)
1386
2230
  return {
1387
2231
  /**
1388
- *
1389
- * @summary Returns a list of relative paths to the databases embedded in the package.
1390
- * @param {string} projectName Name of project
1391
- * @param {string} packageName Name of package
1392
- * @param {string} [versionId] Version ID
2232
+ * 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.
2233
+ * @summary Test database connection configuration
2234
+ * @param {Connection} connection
1393
2235
  * @param {*} [options] Override http request option.
1394
2236
  * @throws {RequiredError}
1395
2237
  */
1396
- async listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Database>>> {
1397
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDatabases(projectName, packageName, versionId, options);
2238
+ async testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionStatus>> {
2239
+ const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectionConfiguration(connection, options);
1398
2240
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1399
- const localVarOperationServerBasePath = operationServerMap['DatabasesApi.listDatabases']?.[localVarOperationServerIndex]?.url;
2241
+ const localVarOperationServerBasePath = operationServerMap['ConnectionsTestApi.testConnectionConfiguration']?.[localVarOperationServerIndex]?.url;
1400
2242
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1401
2243
  },
1402
2244
  }
1403
2245
  };
1404
2246
 
1405
2247
  /**
1406
- * DatabasesApi - factory interface
2248
+ * ConnectionsTestApi - factory interface
1407
2249
  * @export
1408
2250
  */
1409
- export const DatabasesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1410
- const localVarFp = DatabasesApiFp(configuration)
2251
+ export const ConnectionsTestApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2252
+ const localVarFp = ConnectionsTestApiFp(configuration)
1411
2253
  return {
1412
2254
  /**
1413
- *
1414
- * @summary Returns a list of relative paths to the databases embedded in the package.
1415
- * @param {string} projectName Name of project
1416
- * @param {string} packageName Name of package
1417
- * @param {string} [versionId] Version ID
2255
+ * 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.
2256
+ * @summary Test database connection configuration
2257
+ * @param {Connection} connection
1418
2258
  * @param {*} [options] Override http request option.
1419
2259
  * @throws {RequiredError}
1420
2260
  */
1421
- listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Database>> {
1422
- return localVarFp.listDatabases(projectName, packageName, versionId, options).then((request) => request(axios, basePath));
2261
+ testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionStatus> {
2262
+ return localVarFp.testConnectionConfiguration(connection, options).then((request) => request(axios, basePath));
1423
2263
  },
1424
2264
  };
1425
2265
  };
1426
2266
 
1427
2267
  /**
1428
- * DatabasesApi - object-oriented interface
2268
+ * ConnectionsTestApi - object-oriented interface
1429
2269
  * @export
1430
- * @class DatabasesApi
2270
+ * @class ConnectionsTestApi
1431
2271
  * @extends {BaseAPI}
1432
2272
  */
1433
- export class DatabasesApi extends BaseAPI {
2273
+ export class ConnectionsTestApi extends BaseAPI {
1434
2274
  /**
1435
- *
1436
- * @summary Returns a list of relative paths to the databases embedded in the package.
1437
- * @param {string} projectName Name of project
1438
- * @param {string} packageName Name of package
1439
- * @param {string} [versionId] Version ID
2275
+ * 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.
2276
+ * @summary Test database connection configuration
2277
+ * @param {Connection} connection
1440
2278
  * @param {*} [options] Override http request option.
1441
2279
  * @throws {RequiredError}
1442
- * @memberof DatabasesApi
2280
+ * @memberof ConnectionsTestApi
1443
2281
  */
1444
- public listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) {
1445
- return DatabasesApiFp(this.configuration).listDatabases(projectName, packageName, versionId, options).then((request) => request(this.axios, this.basePath));
2282
+ public testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig) {
2283
+ return ConnectionsTestApiFp(this.configuration).testConnectionConfiguration(connection, options).then((request) => request(this.axios, this.basePath));
1446
2284
  }
1447
2285
  }
1448
2286
 
1449
2287
 
1450
2288
 
1451
2289
  /**
1452
- * DefaultApi - axios parameter creator
2290
+ * DatabasesApi - axios parameter creator
1453
2291
  * @export
1454
2292
  */
1455
- export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
2293
+ export const DatabasesApiAxiosParamCreator = function (configuration?: Configuration) {
1456
2294
  return {
1457
2295
  /**
1458
- *
1459
- * @summary Returns metadata about the publisher service.
1460
- * @param {string} projectName Name of project
2296
+ * Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
2297
+ * @summary List embedded databases
2298
+ * @param {string} projectName Name of the project
2299
+ * @param {string} packageName Name of the package
2300
+ * @param {string} [versionId] Version identifier for the package
1461
2301
  * @param {*} [options] Override http request option.
1462
2302
  * @throws {RequiredError}
1463
2303
  */
1464
- about: async (projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2304
+ listDatabases: async (projectName: string, packageName: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1465
2305
  // verify required parameter 'projectName' is not null or undefined
1466
- assertParamExists('about', 'projectName', projectName)
1467
- const localVarPath = `/projects/{projectName}/about`
1468
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
2306
+ assertParamExists('listDatabases', 'projectName', projectName)
2307
+ // verify required parameter 'packageName' is not null or undefined
2308
+ assertParamExists('listDatabases', 'packageName', packageName)
2309
+ const localVarPath = `/projects/{projectName}/packages/{packageName}/databases`
2310
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2311
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
1469
2312
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1470
2313
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1471
2314
  let baseOptions;
@@ -1477,6 +2320,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
1477
2320
  const localVarHeaderParameter = {} as any;
1478
2321
  const localVarQueryParameter = {} as any;
1479
2322
 
2323
+ if (versionId !== undefined) {
2324
+ localVarQueryParameter['versionId'] = versionId;
2325
+ }
2326
+
1480
2327
 
1481
2328
 
1482
2329
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1492,65 +2339,71 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
1492
2339
  };
1493
2340
 
1494
2341
  /**
1495
- * DefaultApi - functional programming interface
2342
+ * DatabasesApi - functional programming interface
1496
2343
  * @export
1497
2344
  */
1498
- export const DefaultApiFp = function(configuration?: Configuration) {
1499
- const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
2345
+ export const DatabasesApiFp = function(configuration?: Configuration) {
2346
+ const localVarAxiosParamCreator = DatabasesApiAxiosParamCreator(configuration)
1500
2347
  return {
1501
2348
  /**
1502
- *
1503
- * @summary Returns metadata about the publisher service.
1504
- * @param {string} projectName Name of project
2349
+ * Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
2350
+ * @summary List embedded databases
2351
+ * @param {string} projectName Name of the project
2352
+ * @param {string} packageName Name of the package
2353
+ * @param {string} [versionId] Version identifier for the package
1505
2354
  * @param {*} [options] Override http request option.
1506
2355
  * @throws {RequiredError}
1507
2356
  */
1508
- async about(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<About>> {
1509
- const localVarAxiosArgs = await localVarAxiosParamCreator.about(projectName, options);
2357
+ async listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Database>>> {
2358
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDatabases(projectName, packageName, versionId, options);
1510
2359
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1511
- const localVarOperationServerBasePath = operationServerMap['DefaultApi.about']?.[localVarOperationServerIndex]?.url;
2360
+ const localVarOperationServerBasePath = operationServerMap['DatabasesApi.listDatabases']?.[localVarOperationServerIndex]?.url;
1512
2361
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1513
2362
  },
1514
2363
  }
1515
2364
  };
1516
2365
 
1517
2366
  /**
1518
- * DefaultApi - factory interface
2367
+ * DatabasesApi - factory interface
1519
2368
  * @export
1520
2369
  */
1521
- export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1522
- const localVarFp = DefaultApiFp(configuration)
2370
+ export const DatabasesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2371
+ const localVarFp = DatabasesApiFp(configuration)
1523
2372
  return {
1524
2373
  /**
1525
- *
1526
- * @summary Returns metadata about the publisher service.
1527
- * @param {string} projectName Name of project
2374
+ * Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
2375
+ * @summary List embedded databases
2376
+ * @param {string} projectName Name of the project
2377
+ * @param {string} packageName Name of the package
2378
+ * @param {string} [versionId] Version identifier for the package
1528
2379
  * @param {*} [options] Override http request option.
1529
2380
  * @throws {RequiredError}
1530
2381
  */
1531
- about(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<About> {
1532
- return localVarFp.about(projectName, options).then((request) => request(axios, basePath));
2382
+ listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Database>> {
2383
+ return localVarFp.listDatabases(projectName, packageName, versionId, options).then((request) => request(axios, basePath));
1533
2384
  },
1534
2385
  };
1535
2386
  };
1536
2387
 
1537
2388
  /**
1538
- * DefaultApi - object-oriented interface
2389
+ * DatabasesApi - object-oriented interface
1539
2390
  * @export
1540
- * @class DefaultApi
2391
+ * @class DatabasesApi
1541
2392
  * @extends {BaseAPI}
1542
2393
  */
1543
- export class DefaultApi extends BaseAPI {
2394
+ export class DatabasesApi extends BaseAPI {
1544
2395
  /**
1545
- *
1546
- * @summary Returns metadata about the publisher service.
1547
- * @param {string} projectName Name of project
2396
+ * Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
2397
+ * @summary List embedded databases
2398
+ * @param {string} projectName Name of the project
2399
+ * @param {string} packageName Name of the package
2400
+ * @param {string} [versionId] Version identifier for the package
1548
2401
  * @param {*} [options] Override http request option.
1549
2402
  * @throws {RequiredError}
1550
- * @memberof DefaultApi
2403
+ * @memberof DatabasesApi
1551
2404
  */
1552
- public about(projectName: string, options?: RawAxiosRequestConfig) {
1553
- return DefaultApiFp(this.configuration).about(projectName, options).then((request) => request(this.axios, this.basePath));
2405
+ public listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) {
2406
+ return DatabasesApiFp(this.configuration).listDatabases(projectName, packageName, versionId, options).then((request) => request(this.axios, this.basePath));
1554
2407
  }
1555
2408
  }
1556
2409
 
@@ -1563,12 +2416,60 @@ export class DefaultApi extends BaseAPI {
1563
2416
  export const ModelsApiAxiosParamCreator = function (configuration?: Configuration) {
1564
2417
  return {
1565
2418
  /**
1566
- *
1567
- * @summary Returns a Malloy model.
1568
- * @param {string} projectName Name of project
1569
- * @param {string} packageName Name of package.
1570
- * @param {string} path Path to model wihin the package.
1571
- * @param {string} [versionId] Version ID
2419
+ * 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.
2420
+ * @summary Execute Malloy query
2421
+ * @param {string} projectName Name of the project
2422
+ * @param {string} packageName Name of the package
2423
+ * @param {string} path Path to the model within the package
2424
+ * @param {QueryRequest} queryRequest
2425
+ * @param {*} [options] Override http request option.
2426
+ * @throws {RequiredError}
2427
+ */
2428
+ executeQueryModel: async (projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2429
+ // verify required parameter 'projectName' is not null or undefined
2430
+ assertParamExists('executeQueryModel', 'projectName', projectName)
2431
+ // verify required parameter 'packageName' is not null or undefined
2432
+ assertParamExists('executeQueryModel', 'packageName', packageName)
2433
+ // verify required parameter 'path' is not null or undefined
2434
+ assertParamExists('executeQueryModel', 'path', path)
2435
+ // verify required parameter 'queryRequest' is not null or undefined
2436
+ assertParamExists('executeQueryModel', 'queryRequest', queryRequest)
2437
+ const localVarPath = `/projects/{projectName}/packages/{packageName}/models/{path}/query`
2438
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2439
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)))
2440
+ .replace(`{${"path"}}`, encodeURIComponent(String(path)));
2441
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2442
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2443
+ let baseOptions;
2444
+ if (configuration) {
2445
+ baseOptions = configuration.baseOptions;
2446
+ }
2447
+
2448
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2449
+ const localVarHeaderParameter = {} as any;
2450
+ const localVarQueryParameter = {} as any;
2451
+
2452
+
2453
+
2454
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2455
+
2456
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2457
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2458
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2459
+ localVarRequestOptions.data = serializeDataIfNeeded(queryRequest, localVarRequestOptions, configuration)
2460
+
2461
+ return {
2462
+ url: toPathString(localVarUrlObj),
2463
+ options: localVarRequestOptions,
2464
+ };
2465
+ },
2466
+ /**
2467
+ * 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.
2468
+ * @summary Get compiled Malloy model
2469
+ * @param {string} projectName Name of the project
2470
+ * @param {string} packageName Name of the package
2471
+ * @param {string} path Path to the model within the package
2472
+ * @param {string} [versionId] Version identifier for the package
1572
2473
  * @param {*} [options] Override http request option.
1573
2474
  * @throws {RequiredError}
1574
2475
  */
@@ -1610,11 +2511,11 @@ export const ModelsApiAxiosParamCreator = function (configuration?: Configuratio
1610
2511
  };
1611
2512
  },
1612
2513
  /**
1613
- *
1614
- * @summary Returns a list of relative paths to the models in the package.
1615
- * @param {string} projectName Name of project
1616
- * @param {string} packageName Name of package
1617
- * @param {string} [versionId] Version ID
2514
+ * Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
2515
+ * @summary List package models
2516
+ * @param {string} projectName Name of the project
2517
+ * @param {string} packageName Name of the package
2518
+ * @param {string} [versionId] Version identifier for the package
1618
2519
  * @param {*} [options] Override http request option.
1619
2520
  * @throws {RequiredError}
1620
2521
  */
@@ -1663,12 +2564,28 @@ export const ModelsApiFp = function(configuration?: Configuration) {
1663
2564
  const localVarAxiosParamCreator = ModelsApiAxiosParamCreator(configuration)
1664
2565
  return {
1665
2566
  /**
1666
- *
1667
- * @summary Returns a Malloy model.
1668
- * @param {string} projectName Name of project
1669
- * @param {string} packageName Name of package.
1670
- * @param {string} path Path to model wihin the package.
1671
- * @param {string} [versionId] Version ID
2567
+ * 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.
2568
+ * @summary Execute Malloy query
2569
+ * @param {string} projectName Name of the project
2570
+ * @param {string} packageName Name of the package
2571
+ * @param {string} path Path to the model within the package
2572
+ * @param {QueryRequest} queryRequest
2573
+ * @param {*} [options] Override http request option.
2574
+ * @throws {RequiredError}
2575
+ */
2576
+ async executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>> {
2577
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeQueryModel(projectName, packageName, path, queryRequest, options);
2578
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2579
+ const localVarOperationServerBasePath = operationServerMap['ModelsApi.executeQueryModel']?.[localVarOperationServerIndex]?.url;
2580
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2581
+ },
2582
+ /**
2583
+ * 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.
2584
+ * @summary Get compiled Malloy model
2585
+ * @param {string} projectName Name of the project
2586
+ * @param {string} packageName Name of the package
2587
+ * @param {string} path Path to the model within the package
2588
+ * @param {string} [versionId] Version identifier for the package
1672
2589
  * @param {*} [options] Override http request option.
1673
2590
  * @throws {RequiredError}
1674
2591
  */
@@ -1679,11 +2596,11 @@ export const ModelsApiFp = function(configuration?: Configuration) {
1679
2596
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1680
2597
  },
1681
2598
  /**
1682
- *
1683
- * @summary Returns a list of relative paths to the models in the package.
1684
- * @param {string} projectName Name of project
1685
- * @param {string} packageName Name of package
1686
- * @param {string} [versionId] Version ID
2599
+ * Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
2600
+ * @summary List package models
2601
+ * @param {string} projectName Name of the project
2602
+ * @param {string} packageName Name of the package
2603
+ * @param {string} [versionId] Version identifier for the package
1687
2604
  * @param {*} [options] Override http request option.
1688
2605
  * @throws {RequiredError}
1689
2606
  */
@@ -1704,12 +2621,25 @@ export const ModelsApiFactory = function (configuration?: Configuration, basePat
1704
2621
  const localVarFp = ModelsApiFp(configuration)
1705
2622
  return {
1706
2623
  /**
1707
- *
1708
- * @summary Returns a Malloy model.
1709
- * @param {string} projectName Name of project
1710
- * @param {string} packageName Name of package.
1711
- * @param {string} path Path to model wihin the package.
1712
- * @param {string} [versionId] Version ID
2624
+ * 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.
2625
+ * @summary Execute Malloy query
2626
+ * @param {string} projectName Name of the project
2627
+ * @param {string} packageName Name of the package
2628
+ * @param {string} path Path to the model within the package
2629
+ * @param {QueryRequest} queryRequest
2630
+ * @param {*} [options] Override http request option.
2631
+ * @throws {RequiredError}
2632
+ */
2633
+ executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult> {
2634
+ return localVarFp.executeQueryModel(projectName, packageName, path, queryRequest, options).then((request) => request(axios, basePath));
2635
+ },
2636
+ /**
2637
+ * 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.
2638
+ * @summary Get compiled Malloy model
2639
+ * @param {string} projectName Name of the project
2640
+ * @param {string} packageName Name of the package
2641
+ * @param {string} path Path to the model within the package
2642
+ * @param {string} [versionId] Version identifier for the package
1713
2643
  * @param {*} [options] Override http request option.
1714
2644
  * @throws {RequiredError}
1715
2645
  */
@@ -1717,11 +2647,11 @@ export const ModelsApiFactory = function (configuration?: Configuration, basePat
1717
2647
  return localVarFp.getModel(projectName, packageName, path, versionId, options).then((request) => request(axios, basePath));
1718
2648
  },
1719
2649
  /**
1720
- *
1721
- * @summary Returns a list of relative paths to the models in the package.
1722
- * @param {string} projectName Name of project
1723
- * @param {string} packageName Name of package
1724
- * @param {string} [versionId] Version ID
2650
+ * Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
2651
+ * @summary List package models
2652
+ * @param {string} projectName Name of the project
2653
+ * @param {string} packageName Name of the package
2654
+ * @param {string} [versionId] Version identifier for the package
1725
2655
  * @param {*} [options] Override http request option.
1726
2656
  * @throws {RequiredError}
1727
2657
  */
@@ -1739,12 +2669,27 @@ export const ModelsApiFactory = function (configuration?: Configuration, basePat
1739
2669
  */
1740
2670
  export class ModelsApi extends BaseAPI {
1741
2671
  /**
1742
- *
1743
- * @summary Returns a Malloy model.
1744
- * @param {string} projectName Name of project
1745
- * @param {string} packageName Name of package.
1746
- * @param {string} path Path to model wihin the package.
1747
- * @param {string} [versionId] Version ID
2672
+ * 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.
2673
+ * @summary Execute Malloy query
2674
+ * @param {string} projectName Name of the project
2675
+ * @param {string} packageName Name of the package
2676
+ * @param {string} path Path to the model within the package
2677
+ * @param {QueryRequest} queryRequest
2678
+ * @param {*} [options] Override http request option.
2679
+ * @throws {RequiredError}
2680
+ * @memberof ModelsApi
2681
+ */
2682
+ public executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig) {
2683
+ return ModelsApiFp(this.configuration).executeQueryModel(projectName, packageName, path, queryRequest, options).then((request) => request(this.axios, this.basePath));
2684
+ }
2685
+
2686
+ /**
2687
+ * 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.
2688
+ * @summary Get compiled Malloy model
2689
+ * @param {string} projectName Name of the project
2690
+ * @param {string} packageName Name of the package
2691
+ * @param {string} path Path to the model within the package
2692
+ * @param {string} [versionId] Version identifier for the package
1748
2693
  * @param {*} [options] Override http request option.
1749
2694
  * @throws {RequiredError}
1750
2695
  * @memberof ModelsApi
@@ -1754,11 +2699,11 @@ export class ModelsApi extends BaseAPI {
1754
2699
  }
1755
2700
 
1756
2701
  /**
1757
- *
1758
- * @summary Returns a list of relative paths to the models in the package.
1759
- * @param {string} projectName Name of project
1760
- * @param {string} packageName Name of package
1761
- * @param {string} [versionId] Version ID
2702
+ * Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
2703
+ * @summary List package models
2704
+ * @param {string} projectName Name of the project
2705
+ * @param {string} packageName Name of the package
2706
+ * @param {string} [versionId] Version identifier for the package
1762
2707
  * @param {*} [options] Override http request option.
1763
2708
  * @throws {RequiredError}
1764
2709
  * @memberof ModelsApi
@@ -1770,6 +2715,220 @@ export class ModelsApi extends BaseAPI {
1770
2715
 
1771
2716
 
1772
2717
 
2718
+ /**
2719
+ * NotebooksApi - axios parameter creator
2720
+ * @export
2721
+ */
2722
+ export const NotebooksApiAxiosParamCreator = function (configuration?: Configuration) {
2723
+ return {
2724
+ /**
2725
+ * Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
2726
+ * @summary Get compiled Malloy notebook
2727
+ * @param {string} projectName Name of the project
2728
+ * @param {string} packageName Name of the package
2729
+ * @param {string} path Path to notebook within the package.
2730
+ * @param {string} [versionId] Version identifier for the package
2731
+ * @param {*} [options] Override http request option.
2732
+ * @throws {RequiredError}
2733
+ */
2734
+ getNotebook: async (projectName: string, packageName: string, path: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2735
+ // verify required parameter 'projectName' is not null or undefined
2736
+ assertParamExists('getNotebook', 'projectName', projectName)
2737
+ // verify required parameter 'packageName' is not null or undefined
2738
+ assertParamExists('getNotebook', 'packageName', packageName)
2739
+ // verify required parameter 'path' is not null or undefined
2740
+ assertParamExists('getNotebook', 'path', path)
2741
+ const localVarPath = `/projects/{projectName}/packages/{packageName}/notebooks/{path}`
2742
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2743
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)))
2744
+ .replace(`{${"path"}}`, encodeURIComponent(String(path)));
2745
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2746
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2747
+ let baseOptions;
2748
+ if (configuration) {
2749
+ baseOptions = configuration.baseOptions;
2750
+ }
2751
+
2752
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2753
+ const localVarHeaderParameter = {} as any;
2754
+ const localVarQueryParameter = {} as any;
2755
+
2756
+ if (versionId !== undefined) {
2757
+ localVarQueryParameter['versionId'] = versionId;
2758
+ }
2759
+
2760
+
2761
+
2762
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2763
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2764
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2765
+
2766
+ return {
2767
+ url: toPathString(localVarUrlObj),
2768
+ options: localVarRequestOptions,
2769
+ };
2770
+ },
2771
+ /**
2772
+ * Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
2773
+ * @summary List package notebooks
2774
+ * @param {string} projectName Name of the project
2775
+ * @param {string} packageName Name of the package
2776
+ * @param {string} [versionId] Version identifier for the package
2777
+ * @param {*} [options] Override http request option.
2778
+ * @throws {RequiredError}
2779
+ */
2780
+ listNotebooks: async (projectName: string, packageName: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2781
+ // verify required parameter 'projectName' is not null or undefined
2782
+ assertParamExists('listNotebooks', 'projectName', projectName)
2783
+ // verify required parameter 'packageName' is not null or undefined
2784
+ assertParamExists('listNotebooks', 'packageName', packageName)
2785
+ const localVarPath = `/projects/{projectName}/packages/{packageName}/notebooks`
2786
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2787
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
2788
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2789
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2790
+ let baseOptions;
2791
+ if (configuration) {
2792
+ baseOptions = configuration.baseOptions;
2793
+ }
2794
+
2795
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2796
+ const localVarHeaderParameter = {} as any;
2797
+ const localVarQueryParameter = {} as any;
2798
+
2799
+ if (versionId !== undefined) {
2800
+ localVarQueryParameter['versionId'] = versionId;
2801
+ }
2802
+
2803
+
2804
+
2805
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2806
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2807
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2808
+
2809
+ return {
2810
+ url: toPathString(localVarUrlObj),
2811
+ options: localVarRequestOptions,
2812
+ };
2813
+ },
2814
+ }
2815
+ };
2816
+
2817
+ /**
2818
+ * NotebooksApi - functional programming interface
2819
+ * @export
2820
+ */
2821
+ export const NotebooksApiFp = function(configuration?: Configuration) {
2822
+ const localVarAxiosParamCreator = NotebooksApiAxiosParamCreator(configuration)
2823
+ return {
2824
+ /**
2825
+ * Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
2826
+ * @summary Get compiled Malloy notebook
2827
+ * @param {string} projectName Name of the project
2828
+ * @param {string} packageName Name of the package
2829
+ * @param {string} path Path to notebook within the package.
2830
+ * @param {string} [versionId] Version identifier for the package
2831
+ * @param {*} [options] Override http request option.
2832
+ * @throws {RequiredError}
2833
+ */
2834
+ async getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompiledNotebook>> {
2835
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getNotebook(projectName, packageName, path, versionId, options);
2836
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2837
+ const localVarOperationServerBasePath = operationServerMap['NotebooksApi.getNotebook']?.[localVarOperationServerIndex]?.url;
2838
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2839
+ },
2840
+ /**
2841
+ * Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
2842
+ * @summary List package notebooks
2843
+ * @param {string} projectName Name of the project
2844
+ * @param {string} packageName Name of the package
2845
+ * @param {string} [versionId] Version identifier for the package
2846
+ * @param {*} [options] Override http request option.
2847
+ * @throws {RequiredError}
2848
+ */
2849
+ async listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notebook>>> {
2850
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listNotebooks(projectName, packageName, versionId, options);
2851
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2852
+ const localVarOperationServerBasePath = operationServerMap['NotebooksApi.listNotebooks']?.[localVarOperationServerIndex]?.url;
2853
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2854
+ },
2855
+ }
2856
+ };
2857
+
2858
+ /**
2859
+ * NotebooksApi - factory interface
2860
+ * @export
2861
+ */
2862
+ export const NotebooksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2863
+ const localVarFp = NotebooksApiFp(configuration)
2864
+ return {
2865
+ /**
2866
+ * Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
2867
+ * @summary Get compiled Malloy notebook
2868
+ * @param {string} projectName Name of the project
2869
+ * @param {string} packageName Name of the package
2870
+ * @param {string} path Path to notebook within the package.
2871
+ * @param {string} [versionId] Version identifier for the package
2872
+ * @param {*} [options] Override http request option.
2873
+ * @throws {RequiredError}
2874
+ */
2875
+ getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompiledNotebook> {
2876
+ return localVarFp.getNotebook(projectName, packageName, path, versionId, options).then((request) => request(axios, basePath));
2877
+ },
2878
+ /**
2879
+ * Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
2880
+ * @summary List package notebooks
2881
+ * @param {string} projectName Name of the project
2882
+ * @param {string} packageName Name of the package
2883
+ * @param {string} [versionId] Version identifier for the package
2884
+ * @param {*} [options] Override http request option.
2885
+ * @throws {RequiredError}
2886
+ */
2887
+ listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Notebook>> {
2888
+ return localVarFp.listNotebooks(projectName, packageName, versionId, options).then((request) => request(axios, basePath));
2889
+ },
2890
+ };
2891
+ };
2892
+
2893
+ /**
2894
+ * NotebooksApi - object-oriented interface
2895
+ * @export
2896
+ * @class NotebooksApi
2897
+ * @extends {BaseAPI}
2898
+ */
2899
+ export class NotebooksApi extends BaseAPI {
2900
+ /**
2901
+ * Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
2902
+ * @summary Get compiled Malloy notebook
2903
+ * @param {string} projectName Name of the project
2904
+ * @param {string} packageName Name of the package
2905
+ * @param {string} path Path to notebook within the package.
2906
+ * @param {string} [versionId] Version identifier for the package
2907
+ * @param {*} [options] Override http request option.
2908
+ * @throws {RequiredError}
2909
+ * @memberof NotebooksApi
2910
+ */
2911
+ public getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig) {
2912
+ return NotebooksApiFp(this.configuration).getNotebook(projectName, packageName, path, versionId, options).then((request) => request(this.axios, this.basePath));
2913
+ }
2914
+
2915
+ /**
2916
+ * Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
2917
+ * @summary List package notebooks
2918
+ * @param {string} projectName Name of the project
2919
+ * @param {string} packageName Name of the package
2920
+ * @param {string} [versionId] Version identifier for the package
2921
+ * @param {*} [options] Override http request option.
2922
+ * @throws {RequiredError}
2923
+ * @memberof NotebooksApi
2924
+ */
2925
+ public listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) {
2926
+ return NotebooksApiFp(this.configuration).listNotebooks(projectName, packageName, versionId, options).then((request) => request(this.axios, this.basePath));
2927
+ }
2928
+ }
2929
+
2930
+
2931
+
1773
2932
  /**
1774
2933
  * PackagesApi - axios parameter creator
1775
2934
  * @export
@@ -1777,22 +2936,561 @@ export class ModelsApi extends BaseAPI {
1777
2936
  export const PackagesApiAxiosParamCreator = function (configuration?: Configuration) {
1778
2937
  return {
1779
2938
  /**
1780
- *
1781
- * @summary Returns the package metadata.
1782
- * @param {string} projectName Name of project
1783
- * @param {string} packageName Package name
1784
- * @param {string} [versionId] Version ID
2939
+ * Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
2940
+ * @summary Create a new package
2941
+ * @param {string} projectName Name of the project
2942
+ * @param {Package} _package
2943
+ * @param {*} [options] Override http request option.
2944
+ * @throws {RequiredError}
2945
+ */
2946
+ createPackage: async (projectName: string, _package: Package, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2947
+ // verify required parameter 'projectName' is not null or undefined
2948
+ assertParamExists('createPackage', 'projectName', projectName)
2949
+ // verify required parameter '_package' is not null or undefined
2950
+ assertParamExists('createPackage', '_package', _package)
2951
+ const localVarPath = `/projects/{projectName}/packages`
2952
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
2953
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2954
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2955
+ let baseOptions;
2956
+ if (configuration) {
2957
+ baseOptions = configuration.baseOptions;
2958
+ }
2959
+
2960
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2961
+ const localVarHeaderParameter = {} as any;
2962
+ const localVarQueryParameter = {} as any;
2963
+
2964
+
2965
+
2966
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2967
+
2968
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2969
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2970
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2971
+ localVarRequestOptions.data = serializeDataIfNeeded(_package, localVarRequestOptions, configuration)
2972
+
2973
+ return {
2974
+ url: toPathString(localVarUrlObj),
2975
+ options: localVarRequestOptions,
2976
+ };
2977
+ },
2978
+ /**
2979
+ * Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
2980
+ * @summary Delete a package
2981
+ * @param {string} projectName Name of the project
2982
+ * @param {string} packageName Name of the package
2983
+ * @param {*} [options] Override http request option.
2984
+ * @throws {RequiredError}
2985
+ */
2986
+ deletePackage: async (projectName: string, packageName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2987
+ // verify required parameter 'projectName' is not null or undefined
2988
+ assertParamExists('deletePackage', 'projectName', projectName)
2989
+ // verify required parameter 'packageName' is not null or undefined
2990
+ assertParamExists('deletePackage', 'packageName', packageName)
2991
+ const localVarPath = `/projects/{projectName}/packages/{packageName}`
2992
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2993
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
2994
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2995
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2996
+ let baseOptions;
2997
+ if (configuration) {
2998
+ baseOptions = configuration.baseOptions;
2999
+ }
3000
+
3001
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
3002
+ const localVarHeaderParameter = {} as any;
3003
+ const localVarQueryParameter = {} as any;
3004
+
3005
+
3006
+
3007
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3008
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3009
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3010
+
3011
+ return {
3012
+ url: toPathString(localVarUrlObj),
3013
+ options: localVarRequestOptions,
3014
+ };
3015
+ },
3016
+ /**
3017
+ * Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
3018
+ * @summary Get package details and metadata
3019
+ * @param {string} projectName Name of the project
3020
+ * @param {string} packageName Package name
3021
+ * @param {string} [versionId] Version identifier for the package
3022
+ * @param {boolean} [reload] Load / reload the package before returning result
3023
+ * @param {*} [options] Override http request option.
3024
+ * @throws {RequiredError}
3025
+ */
3026
+ getPackage: async (projectName: string, packageName: string, versionId?: string, reload?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3027
+ // verify required parameter 'projectName' is not null or undefined
3028
+ assertParamExists('getPackage', 'projectName', projectName)
3029
+ // verify required parameter 'packageName' is not null or undefined
3030
+ assertParamExists('getPackage', 'packageName', packageName)
3031
+ const localVarPath = `/projects/{projectName}/packages/{packageName}`
3032
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
3033
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
3034
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3035
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3036
+ let baseOptions;
3037
+ if (configuration) {
3038
+ baseOptions = configuration.baseOptions;
3039
+ }
3040
+
3041
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3042
+ const localVarHeaderParameter = {} as any;
3043
+ const localVarQueryParameter = {} as any;
3044
+
3045
+ if (versionId !== undefined) {
3046
+ localVarQueryParameter['versionId'] = versionId;
3047
+ }
3048
+
3049
+ if (reload !== undefined) {
3050
+ localVarQueryParameter['reload'] = reload;
3051
+ }
3052
+
3053
+
3054
+
3055
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3056
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3057
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3058
+
3059
+ return {
3060
+ url: toPathString(localVarUrlObj),
3061
+ options: localVarRequestOptions,
3062
+ };
3063
+ },
3064
+ /**
3065
+ * Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
3066
+ * @summary List project packages
3067
+ * @param {string} projectName Name of the project
3068
+ * @param {*} [options] Override http request option.
3069
+ * @throws {RequiredError}
3070
+ */
3071
+ listPackages: async (projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3072
+ // verify required parameter 'projectName' is not null or undefined
3073
+ assertParamExists('listPackages', 'projectName', projectName)
3074
+ const localVarPath = `/projects/{projectName}/packages`
3075
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
3076
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3077
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3078
+ let baseOptions;
3079
+ if (configuration) {
3080
+ baseOptions = configuration.baseOptions;
3081
+ }
3082
+
3083
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3084
+ const localVarHeaderParameter = {} as any;
3085
+ const localVarQueryParameter = {} as any;
3086
+
3087
+
3088
+
3089
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3090
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3091
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3092
+
3093
+ return {
3094
+ url: toPathString(localVarUrlObj),
3095
+ options: localVarRequestOptions,
3096
+ };
3097
+ },
3098
+ /**
3099
+ * Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
3100
+ * @summary Update package configuration
3101
+ * @param {string} projectName Name of the project
3102
+ * @param {string} packageName Name of the package
3103
+ * @param {Package} _package
3104
+ * @param {*} [options] Override http request option.
3105
+ * @throws {RequiredError}
3106
+ */
3107
+ updatePackage: async (projectName: string, packageName: string, _package: Package, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3108
+ // verify required parameter 'projectName' is not null or undefined
3109
+ assertParamExists('updatePackage', 'projectName', projectName)
3110
+ // verify required parameter 'packageName' is not null or undefined
3111
+ assertParamExists('updatePackage', 'packageName', packageName)
3112
+ // verify required parameter '_package' is not null or undefined
3113
+ assertParamExists('updatePackage', '_package', _package)
3114
+ const localVarPath = `/projects/{projectName}/packages/{packageName}`
3115
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
3116
+ .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
3117
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3118
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3119
+ let baseOptions;
3120
+ if (configuration) {
3121
+ baseOptions = configuration.baseOptions;
3122
+ }
3123
+
3124
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3125
+ const localVarHeaderParameter = {} as any;
3126
+ const localVarQueryParameter = {} as any;
3127
+
3128
+
3129
+
3130
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3131
+
3132
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3133
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3134
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3135
+ localVarRequestOptions.data = serializeDataIfNeeded(_package, localVarRequestOptions, configuration)
3136
+
3137
+ return {
3138
+ url: toPathString(localVarUrlObj),
3139
+ options: localVarRequestOptions,
3140
+ };
3141
+ },
3142
+ }
3143
+ };
3144
+
3145
+ /**
3146
+ * PackagesApi - functional programming interface
3147
+ * @export
3148
+ */
3149
+ export const PackagesApiFp = function(configuration?: Configuration) {
3150
+ const localVarAxiosParamCreator = PackagesApiAxiosParamCreator(configuration)
3151
+ return {
3152
+ /**
3153
+ * Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
3154
+ * @summary Create a new package
3155
+ * @param {string} projectName Name of the project
3156
+ * @param {Package} _package
3157
+ * @param {*} [options] Override http request option.
3158
+ * @throws {RequiredError}
3159
+ */
3160
+ async createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>> {
3161
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPackage(projectName, _package, options);
3162
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3163
+ const localVarOperationServerBasePath = operationServerMap['PackagesApi.createPackage']?.[localVarOperationServerIndex]?.url;
3164
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3165
+ },
3166
+ /**
3167
+ * Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
3168
+ * @summary Delete a package
3169
+ * @param {string} projectName Name of the project
3170
+ * @param {string} packageName Name of the package
3171
+ * @param {*} [options] Override http request option.
3172
+ * @throws {RequiredError}
3173
+ */
3174
+ async deletePackage(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>> {
3175
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deletePackage(projectName, packageName, options);
3176
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3177
+ const localVarOperationServerBasePath = operationServerMap['PackagesApi.deletePackage']?.[localVarOperationServerIndex]?.url;
3178
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3179
+ },
3180
+ /**
3181
+ * Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
3182
+ * @summary Get package details and metadata
3183
+ * @param {string} projectName Name of the project
3184
+ * @param {string} packageName Package name
3185
+ * @param {string} [versionId] Version identifier for the package
3186
+ * @param {boolean} [reload] Load / reload the package before returning result
3187
+ * @param {*} [options] Override http request option.
3188
+ * @throws {RequiredError}
3189
+ */
3190
+ async getPackage(projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>> {
3191
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPackage(projectName, packageName, versionId, reload, options);
3192
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3193
+ const localVarOperationServerBasePath = operationServerMap['PackagesApi.getPackage']?.[localVarOperationServerIndex]?.url;
3194
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3195
+ },
3196
+ /**
3197
+ * Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
3198
+ * @summary List project packages
3199
+ * @param {string} projectName Name of the project
3200
+ * @param {*} [options] Override http request option.
3201
+ * @throws {RequiredError}
3202
+ */
3203
+ async listPackages(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Package>>> {
3204
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPackages(projectName, options);
3205
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3206
+ const localVarOperationServerBasePath = operationServerMap['PackagesApi.listPackages']?.[localVarOperationServerIndex]?.url;
3207
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3208
+ },
3209
+ /**
3210
+ * Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
3211
+ * @summary Update package configuration
3212
+ * @param {string} projectName Name of the project
3213
+ * @param {string} packageName Name of the package
3214
+ * @param {Package} _package
3215
+ * @param {*} [options] Override http request option.
3216
+ * @throws {RequiredError}
3217
+ */
3218
+ async updatePackage(projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>> {
3219
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updatePackage(projectName, packageName, _package, options);
3220
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3221
+ const localVarOperationServerBasePath = operationServerMap['PackagesApi.updatePackage']?.[localVarOperationServerIndex]?.url;
3222
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3223
+ },
3224
+ }
3225
+ };
3226
+
3227
+ /**
3228
+ * PackagesApi - factory interface
3229
+ * @export
3230
+ */
3231
+ export const PackagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3232
+ const localVarFp = PackagesApiFp(configuration)
3233
+ return {
3234
+ /**
3235
+ * Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
3236
+ * @summary Create a new package
3237
+ * @param {string} projectName Name of the project
3238
+ * @param {Package} _package
3239
+ * @param {*} [options] Override http request option.
3240
+ * @throws {RequiredError}
3241
+ */
3242
+ createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package> {
3243
+ return localVarFp.createPackage(projectName, _package, options).then((request) => request(axios, basePath));
3244
+ },
3245
+ /**
3246
+ * Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
3247
+ * @summary Delete a package
3248
+ * @param {string} projectName Name of the project
3249
+ * @param {string} packageName Name of the package
3250
+ * @param {*} [options] Override http request option.
3251
+ * @throws {RequiredError}
3252
+ */
3253
+ deletePackage(projectName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<Package> {
3254
+ return localVarFp.deletePackage(projectName, packageName, options).then((request) => request(axios, basePath));
3255
+ },
3256
+ /**
3257
+ * Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
3258
+ * @summary Get package details and metadata
3259
+ * @param {string} projectName Name of the project
3260
+ * @param {string} packageName Package name
3261
+ * @param {string} [versionId] Version identifier for the package
3262
+ * @param {boolean} [reload] Load / reload the package before returning result
3263
+ * @param {*} [options] Override http request option.
3264
+ * @throws {RequiredError}
3265
+ */
3266
+ getPackage(projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Package> {
3267
+ return localVarFp.getPackage(projectName, packageName, versionId, reload, options).then((request) => request(axios, basePath));
3268
+ },
3269
+ /**
3270
+ * Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
3271
+ * @summary List project packages
3272
+ * @param {string} projectName Name of the project
3273
+ * @param {*} [options] Override http request option.
3274
+ * @throws {RequiredError}
3275
+ */
3276
+ listPackages(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Package>> {
3277
+ return localVarFp.listPackages(projectName, options).then((request) => request(axios, basePath));
3278
+ },
3279
+ /**
3280
+ * Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
3281
+ * @summary Update package configuration
3282
+ * @param {string} projectName Name of the project
3283
+ * @param {string} packageName Name of the package
3284
+ * @param {Package} _package
3285
+ * @param {*} [options] Override http request option.
3286
+ * @throws {RequiredError}
3287
+ */
3288
+ updatePackage(projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package> {
3289
+ return localVarFp.updatePackage(projectName, packageName, _package, options).then((request) => request(axios, basePath));
3290
+ },
3291
+ };
3292
+ };
3293
+
3294
+ /**
3295
+ * PackagesApi - object-oriented interface
3296
+ * @export
3297
+ * @class PackagesApi
3298
+ * @extends {BaseAPI}
3299
+ */
3300
+ export class PackagesApi extends BaseAPI {
3301
+ /**
3302
+ * Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
3303
+ * @summary Create a new package
3304
+ * @param {string} projectName Name of the project
3305
+ * @param {Package} _package
3306
+ * @param {*} [options] Override http request option.
3307
+ * @throws {RequiredError}
3308
+ * @memberof PackagesApi
3309
+ */
3310
+ public createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig) {
3311
+ return PackagesApiFp(this.configuration).createPackage(projectName, _package, options).then((request) => request(this.axios, this.basePath));
3312
+ }
3313
+
3314
+ /**
3315
+ * Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
3316
+ * @summary Delete a package
3317
+ * @param {string} projectName Name of the project
3318
+ * @param {string} packageName Name of the package
3319
+ * @param {*} [options] Override http request option.
3320
+ * @throws {RequiredError}
3321
+ * @memberof PackagesApi
3322
+ */
3323
+ public deletePackage(projectName: string, packageName: string, options?: RawAxiosRequestConfig) {
3324
+ return PackagesApiFp(this.configuration).deletePackage(projectName, packageName, options).then((request) => request(this.axios, this.basePath));
3325
+ }
3326
+
3327
+ /**
3328
+ * Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
3329
+ * @summary Get package details and metadata
3330
+ * @param {string} projectName Name of the project
3331
+ * @param {string} packageName Package name
3332
+ * @param {string} [versionId] Version identifier for the package
3333
+ * @param {boolean} [reload] Load / reload the package before returning result
3334
+ * @param {*} [options] Override http request option.
3335
+ * @throws {RequiredError}
3336
+ * @memberof PackagesApi
3337
+ */
3338
+ public getPackage(projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig) {
3339
+ return PackagesApiFp(this.configuration).getPackage(projectName, packageName, versionId, reload, options).then((request) => request(this.axios, this.basePath));
3340
+ }
3341
+
3342
+ /**
3343
+ * Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
3344
+ * @summary List project packages
3345
+ * @param {string} projectName Name of the project
3346
+ * @param {*} [options] Override http request option.
3347
+ * @throws {RequiredError}
3348
+ * @memberof PackagesApi
3349
+ */
3350
+ public listPackages(projectName: string, options?: RawAxiosRequestConfig) {
3351
+ return PackagesApiFp(this.configuration).listPackages(projectName, options).then((request) => request(this.axios, this.basePath));
3352
+ }
3353
+
3354
+ /**
3355
+ * Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
3356
+ * @summary Update package configuration
3357
+ * @param {string} projectName Name of the project
3358
+ * @param {string} packageName Name of the package
3359
+ * @param {Package} _package
3360
+ * @param {*} [options] Override http request option.
3361
+ * @throws {RequiredError}
3362
+ * @memberof PackagesApi
3363
+ */
3364
+ public updatePackage(projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig) {
3365
+ return PackagesApiFp(this.configuration).updatePackage(projectName, packageName, _package, options).then((request) => request(this.axios, this.basePath));
3366
+ }
3367
+ }
3368
+
3369
+
3370
+
3371
+ /**
3372
+ * ProjectsApi - axios parameter creator
3373
+ * @export
3374
+ */
3375
+ export const ProjectsApiAxiosParamCreator = function (configuration?: Configuration) {
3376
+ return {
3377
+ /**
3378
+ * Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
3379
+ * @summary Create a new project
3380
+ * @param {Project} project
3381
+ * @param {*} [options] Override http request option.
3382
+ * @throws {RequiredError}
3383
+ */
3384
+ createProject: async (project: Project, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3385
+ // verify required parameter 'project' is not null or undefined
3386
+ assertParamExists('createProject', 'project', project)
3387
+ const localVarPath = `/projects`;
3388
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3389
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3390
+ let baseOptions;
3391
+ if (configuration) {
3392
+ baseOptions = configuration.baseOptions;
3393
+ }
3394
+
3395
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
3396
+ const localVarHeaderParameter = {} as any;
3397
+ const localVarQueryParameter = {} as any;
3398
+
3399
+
3400
+
3401
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3402
+
3403
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3404
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3405
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3406
+ localVarRequestOptions.data = serializeDataIfNeeded(project, localVarRequestOptions, configuration)
3407
+
3408
+ return {
3409
+ url: toPathString(localVarUrlObj),
3410
+ options: localVarRequestOptions,
3411
+ };
3412
+ },
3413
+ /**
3414
+ * Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
3415
+ * @summary Delete a project
3416
+ * @param {string} projectName Name of the project
3417
+ * @param {*} [options] Override http request option.
3418
+ * @throws {RequiredError}
3419
+ */
3420
+ deleteProject: async (projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3421
+ // verify required parameter 'projectName' is not null or undefined
3422
+ assertParamExists('deleteProject', 'projectName', projectName)
3423
+ const localVarPath = `/projects/{projectName}`
3424
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
3425
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3426
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3427
+ let baseOptions;
3428
+ if (configuration) {
3429
+ baseOptions = configuration.baseOptions;
3430
+ }
3431
+
3432
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
3433
+ const localVarHeaderParameter = {} as any;
3434
+ const localVarQueryParameter = {} as any;
3435
+
3436
+
3437
+
3438
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3439
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3440
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3441
+
3442
+ return {
3443
+ url: toPathString(localVarUrlObj),
3444
+ options: localVarRequestOptions,
3445
+ };
3446
+ },
3447
+ /**
3448
+ * Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
3449
+ * @summary Get project details and metadata
3450
+ * @param {string} projectName Name of the project
3451
+ * @param {boolean} [reload] Load / reload the project before returning result
3452
+ * @param {*} [options] Override http request option.
3453
+ * @throws {RequiredError}
3454
+ */
3455
+ getProject: async (projectName: string, reload?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3456
+ // verify required parameter 'projectName' is not null or undefined
3457
+ assertParamExists('getProject', 'projectName', projectName)
3458
+ const localVarPath = `/projects/{projectName}`
3459
+ .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
3460
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3461
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3462
+ let baseOptions;
3463
+ if (configuration) {
3464
+ baseOptions = configuration.baseOptions;
3465
+ }
3466
+
3467
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3468
+ const localVarHeaderParameter = {} as any;
3469
+ const localVarQueryParameter = {} as any;
3470
+
3471
+ if (reload !== undefined) {
3472
+ localVarQueryParameter['reload'] = reload;
3473
+ }
3474
+
3475
+
3476
+
3477
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3478
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3479
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3480
+
3481
+ return {
3482
+ url: toPathString(localVarUrlObj),
3483
+ options: localVarRequestOptions,
3484
+ };
3485
+ },
3486
+ /**
3487
+ * Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
3488
+ * @summary List all available projects
1785
3489
  * @param {*} [options] Override http request option.
1786
3490
  * @throws {RequiredError}
1787
3491
  */
1788
- getPackage: async (projectName: string, packageName: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1789
- // verify required parameter 'projectName' is not null or undefined
1790
- assertParamExists('getPackage', 'projectName', projectName)
1791
- // verify required parameter 'packageName' is not null or undefined
1792
- assertParamExists('getPackage', 'packageName', packageName)
1793
- const localVarPath = `/projects/{projectName}/packages/{packageName}`
1794
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
1795
- .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
3492
+ listProjects: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3493
+ const localVarPath = `/projects`;
1796
3494
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1797
3495
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1798
3496
  let baseOptions;
@@ -1804,10 +3502,6 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
1804
3502
  const localVarHeaderParameter = {} as any;
1805
3503
  const localVarQueryParameter = {} as any;
1806
3504
 
1807
- if (versionId !== undefined) {
1808
- localVarQueryParameter['versionId'] = versionId;
1809
- }
1810
-
1811
3505
 
1812
3506
 
1813
3507
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1820,16 +3514,19 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
1820
3514
  };
1821
3515
  },
1822
3516
  /**
1823
- *
1824
- * @summary Returns a list of the Packages hosted on this server.
1825
- * @param {string} projectName Name of project
3517
+ * Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
3518
+ * @summary Update project configuration
3519
+ * @param {string} projectName Name of the project
3520
+ * @param {Project} project
1826
3521
  * @param {*} [options] Override http request option.
1827
3522
  * @throws {RequiredError}
1828
3523
  */
1829
- listPackages: async (projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3524
+ updateProject: async (projectName: string, project: Project, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1830
3525
  // verify required parameter 'projectName' is not null or undefined
1831
- assertParamExists('listPackages', 'projectName', projectName)
1832
- const localVarPath = `/projects/{projectName}/packages`
3526
+ assertParamExists('updateProject', 'projectName', projectName)
3527
+ // verify required parameter 'project' is not null or undefined
3528
+ assertParamExists('updateProject', 'project', project)
3529
+ const localVarPath = `/projects/{projectName}`
1833
3530
  .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
1834
3531
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1835
3532
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -1838,15 +3535,18 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
1838
3535
  baseOptions = configuration.baseOptions;
1839
3536
  }
1840
3537
 
1841
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3538
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
1842
3539
  const localVarHeaderParameter = {} as any;
1843
3540
  const localVarQueryParameter = {} as any;
1844
3541
 
1845
3542
 
1846
3543
 
3544
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3545
+
1847
3546
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1848
3547
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1849
3548
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3549
+ localVarRequestOptions.data = serializeDataIfNeeded(project, localVarRequestOptions, configuration)
1850
3550
 
1851
3551
  return {
1852
3552
  url: toPathString(localVarUrlObj),
@@ -1857,125 +3557,227 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
1857
3557
  };
1858
3558
 
1859
3559
  /**
1860
- * PackagesApi - functional programming interface
3560
+ * ProjectsApi - functional programming interface
1861
3561
  * @export
1862
3562
  */
1863
- export const PackagesApiFp = function(configuration?: Configuration) {
1864
- const localVarAxiosParamCreator = PackagesApiAxiosParamCreator(configuration)
3563
+ export const ProjectsApiFp = function(configuration?: Configuration) {
3564
+ const localVarAxiosParamCreator = ProjectsApiAxiosParamCreator(configuration)
1865
3565
  return {
1866
3566
  /**
1867
- *
1868
- * @summary Returns the package metadata.
1869
- * @param {string} projectName Name of project
1870
- * @param {string} packageName Package name
1871
- * @param {string} [versionId] Version ID
3567
+ * Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
3568
+ * @summary Create a new project
3569
+ * @param {Project} project
1872
3570
  * @param {*} [options] Override http request option.
1873
3571
  * @throws {RequiredError}
1874
3572
  */
1875
- async getPackage(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>> {
1876
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPackage(projectName, packageName, versionId, options);
3573
+ async createProject(project: Project, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>> {
3574
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createProject(project, options);
1877
3575
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1878
- const localVarOperationServerBasePath = operationServerMap['PackagesApi.getPackage']?.[localVarOperationServerIndex]?.url;
3576
+ const localVarOperationServerBasePath = operationServerMap['ProjectsApi.createProject']?.[localVarOperationServerIndex]?.url;
1879
3577
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1880
3578
  },
1881
3579
  /**
1882
- *
1883
- * @summary Returns a list of the Packages hosted on this server.
1884
- * @param {string} projectName Name of project
3580
+ * Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
3581
+ * @summary Delete a project
3582
+ * @param {string} projectName Name of the project
1885
3583
  * @param {*} [options] Override http request option.
1886
3584
  * @throws {RequiredError}
1887
3585
  */
1888
- async listPackages(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Package>>> {
1889
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPackages(projectName, options);
3586
+ async deleteProject(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>> {
3587
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProject(projectName, options);
1890
3588
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1891
- const localVarOperationServerBasePath = operationServerMap['PackagesApi.listPackages']?.[localVarOperationServerIndex]?.url;
3589
+ const localVarOperationServerBasePath = operationServerMap['ProjectsApi.deleteProject']?.[localVarOperationServerIndex]?.url;
3590
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3591
+ },
3592
+ /**
3593
+ * Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
3594
+ * @summary Get project details and metadata
3595
+ * @param {string} projectName Name of the project
3596
+ * @param {boolean} [reload] Load / reload the project before returning result
3597
+ * @param {*} [options] Override http request option.
3598
+ * @throws {RequiredError}
3599
+ */
3600
+ async getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>> {
3601
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProject(projectName, reload, options);
3602
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3603
+ const localVarOperationServerBasePath = operationServerMap['ProjectsApi.getProject']?.[localVarOperationServerIndex]?.url;
3604
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3605
+ },
3606
+ /**
3607
+ * Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
3608
+ * @summary List all available projects
3609
+ * @param {*} [options] Override http request option.
3610
+ * @throws {RequiredError}
3611
+ */
3612
+ async listProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>> {
3613
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProjects(options);
3614
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3615
+ const localVarOperationServerBasePath = operationServerMap['ProjectsApi.listProjects']?.[localVarOperationServerIndex]?.url;
3616
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3617
+ },
3618
+ /**
3619
+ * Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
3620
+ * @summary Update project configuration
3621
+ * @param {string} projectName Name of the project
3622
+ * @param {Project} project
3623
+ * @param {*} [options] Override http request option.
3624
+ * @throws {RequiredError}
3625
+ */
3626
+ async updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>> {
3627
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateProject(projectName, project, options);
3628
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3629
+ const localVarOperationServerBasePath = operationServerMap['ProjectsApi.updateProject']?.[localVarOperationServerIndex]?.url;
1892
3630
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1893
3631
  },
1894
3632
  }
1895
3633
  };
1896
3634
 
1897
3635
  /**
1898
- * PackagesApi - factory interface
3636
+ * ProjectsApi - factory interface
1899
3637
  * @export
1900
3638
  */
1901
- export const PackagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1902
- const localVarFp = PackagesApiFp(configuration)
3639
+ export const ProjectsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3640
+ const localVarFp = ProjectsApiFp(configuration)
1903
3641
  return {
1904
3642
  /**
1905
- *
1906
- * @summary Returns the package metadata.
1907
- * @param {string} projectName Name of project
1908
- * @param {string} packageName Package name
1909
- * @param {string} [versionId] Version ID
3643
+ * Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
3644
+ * @summary Create a new project
3645
+ * @param {Project} project
1910
3646
  * @param {*} [options] Override http request option.
1911
3647
  * @throws {RequiredError}
1912
3648
  */
1913
- getPackage(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Package> {
1914
- return localVarFp.getPackage(projectName, packageName, versionId, options).then((request) => request(axios, basePath));
3649
+ createProject(project: Project, options?: RawAxiosRequestConfig): AxiosPromise<Project> {
3650
+ return localVarFp.createProject(project, options).then((request) => request(axios, basePath));
1915
3651
  },
1916
3652
  /**
1917
- *
1918
- * @summary Returns a list of the Packages hosted on this server.
1919
- * @param {string} projectName Name of project
3653
+ * Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
3654
+ * @summary Delete a project
3655
+ * @param {string} projectName Name of the project
1920
3656
  * @param {*} [options] Override http request option.
1921
3657
  * @throws {RequiredError}
1922
3658
  */
1923
- listPackages(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Package>> {
1924
- return localVarFp.listPackages(projectName, options).then((request) => request(axios, basePath));
3659
+ deleteProject(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Project> {
3660
+ return localVarFp.deleteProject(projectName, options).then((request) => request(axios, basePath));
3661
+ },
3662
+ /**
3663
+ * Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
3664
+ * @summary Get project details and metadata
3665
+ * @param {string} projectName Name of the project
3666
+ * @param {boolean} [reload] Load / reload the project before returning result
3667
+ * @param {*} [options] Override http request option.
3668
+ * @throws {RequiredError}
3669
+ */
3670
+ getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Project> {
3671
+ return localVarFp.getProject(projectName, reload, options).then((request) => request(axios, basePath));
3672
+ },
3673
+ /**
3674
+ * Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
3675
+ * @summary List all available projects
3676
+ * @param {*} [options] Override http request option.
3677
+ * @throws {RequiredError}
3678
+ */
3679
+ listProjects(options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>> {
3680
+ return localVarFp.listProjects(options).then((request) => request(axios, basePath));
3681
+ },
3682
+ /**
3683
+ * Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
3684
+ * @summary Update project configuration
3685
+ * @param {string} projectName Name of the project
3686
+ * @param {Project} project
3687
+ * @param {*} [options] Override http request option.
3688
+ * @throws {RequiredError}
3689
+ */
3690
+ updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): AxiosPromise<Project> {
3691
+ return localVarFp.updateProject(projectName, project, options).then((request) => request(axios, basePath));
1925
3692
  },
1926
3693
  };
1927
3694
  };
1928
3695
 
1929
3696
  /**
1930
- * PackagesApi - object-oriented interface
3697
+ * ProjectsApi - object-oriented interface
1931
3698
  * @export
1932
- * @class PackagesApi
3699
+ * @class ProjectsApi
1933
3700
  * @extends {BaseAPI}
1934
3701
  */
1935
- export class PackagesApi extends BaseAPI {
3702
+ export class ProjectsApi extends BaseAPI {
1936
3703
  /**
1937
- *
1938
- * @summary Returns the package metadata.
1939
- * @param {string} projectName Name of project
1940
- * @param {string} packageName Package name
1941
- * @param {string} [versionId] Version ID
3704
+ * Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
3705
+ * @summary Create a new project
3706
+ * @param {Project} project
1942
3707
  * @param {*} [options] Override http request option.
1943
3708
  * @throws {RequiredError}
1944
- * @memberof PackagesApi
3709
+ * @memberof ProjectsApi
1945
3710
  */
1946
- public getPackage(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) {
1947
- return PackagesApiFp(this.configuration).getPackage(projectName, packageName, versionId, options).then((request) => request(this.axios, this.basePath));
3711
+ public createProject(project: Project, options?: RawAxiosRequestConfig) {
3712
+ return ProjectsApiFp(this.configuration).createProject(project, options).then((request) => request(this.axios, this.basePath));
1948
3713
  }
1949
3714
 
1950
3715
  /**
1951
- *
1952
- * @summary Returns a list of the Packages hosted on this server.
1953
- * @param {string} projectName Name of project
3716
+ * Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
3717
+ * @summary Delete a project
3718
+ * @param {string} projectName Name of the project
1954
3719
  * @param {*} [options] Override http request option.
1955
3720
  * @throws {RequiredError}
1956
- * @memberof PackagesApi
3721
+ * @memberof ProjectsApi
1957
3722
  */
1958
- public listPackages(projectName: string, options?: RawAxiosRequestConfig) {
1959
- return PackagesApiFp(this.configuration).listPackages(projectName, options).then((request) => request(this.axios, this.basePath));
3723
+ public deleteProject(projectName: string, options?: RawAxiosRequestConfig) {
3724
+ return ProjectsApiFp(this.configuration).deleteProject(projectName, options).then((request) => request(this.axios, this.basePath));
3725
+ }
3726
+
3727
+ /**
3728
+ * Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
3729
+ * @summary Get project details and metadata
3730
+ * @param {string} projectName Name of the project
3731
+ * @param {boolean} [reload] Load / reload the project before returning result
3732
+ * @param {*} [options] Override http request option.
3733
+ * @throws {RequiredError}
3734
+ * @memberof ProjectsApi
3735
+ */
3736
+ public getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig) {
3737
+ return ProjectsApiFp(this.configuration).getProject(projectName, reload, options).then((request) => request(this.axios, this.basePath));
3738
+ }
3739
+
3740
+ /**
3741
+ * Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
3742
+ * @summary List all available projects
3743
+ * @param {*} [options] Override http request option.
3744
+ * @throws {RequiredError}
3745
+ * @memberof ProjectsApi
3746
+ */
3747
+ public listProjects(options?: RawAxiosRequestConfig) {
3748
+ return ProjectsApiFp(this.configuration).listProjects(options).then((request) => request(this.axios, this.basePath));
3749
+ }
3750
+
3751
+ /**
3752
+ * Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
3753
+ * @summary Update project configuration
3754
+ * @param {string} projectName Name of the project
3755
+ * @param {Project} project
3756
+ * @param {*} [options] Override http request option.
3757
+ * @throws {RequiredError}
3758
+ * @memberof ProjectsApi
3759
+ */
3760
+ public updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig) {
3761
+ return ProjectsApiFp(this.configuration).updateProject(projectName, project, options).then((request) => request(this.axios, this.basePath));
1960
3762
  }
1961
3763
  }
1962
3764
 
1963
3765
 
1964
3766
 
1965
3767
  /**
1966
- * ProjectsApi - axios parameter creator
3768
+ * PublisherApi - axios parameter creator
1967
3769
  * @export
1968
3770
  */
1969
- export const ProjectsApiAxiosParamCreator = function (configuration?: Configuration) {
3771
+ export const PublisherApiAxiosParamCreator = function (configuration?: Configuration) {
1970
3772
  return {
1971
3773
  /**
1972
- *
1973
- * @summary Returns a list of the Projects hosted on this server.
3774
+ * Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
3775
+ * @summary Get server status and health information
1974
3776
  * @param {*} [options] Override http request option.
1975
3777
  * @throws {RequiredError}
1976
3778
  */
1977
- listProjects: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1978
- const localVarPath = `/projects`;
3779
+ getStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3780
+ const localVarPath = `/status`;
1979
3781
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1980
3782
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1981
3783
  let baseOptions;
@@ -2002,97 +3804,81 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
2002
3804
  };
2003
3805
 
2004
3806
  /**
2005
- * ProjectsApi - functional programming interface
3807
+ * PublisherApi - functional programming interface
2006
3808
  * @export
2007
3809
  */
2008
- export const ProjectsApiFp = function(configuration?: Configuration) {
2009
- const localVarAxiosParamCreator = ProjectsApiAxiosParamCreator(configuration)
3810
+ export const PublisherApiFp = function(configuration?: Configuration) {
3811
+ const localVarAxiosParamCreator = PublisherApiAxiosParamCreator(configuration)
2010
3812
  return {
2011
3813
  /**
2012
- *
2013
- * @summary Returns a list of the Projects hosted on this server.
3814
+ * Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
3815
+ * @summary Get server status and health information
2014
3816
  * @param {*} [options] Override http request option.
2015
3817
  * @throws {RequiredError}
2016
3818
  */
2017
- async listProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>> {
2018
- const localVarAxiosArgs = await localVarAxiosParamCreator.listProjects(options);
3819
+ async getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerStatus>> {
3820
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStatus(options);
2019
3821
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2020
- const localVarOperationServerBasePath = operationServerMap['ProjectsApi.listProjects']?.[localVarOperationServerIndex]?.url;
3822
+ const localVarOperationServerBasePath = operationServerMap['PublisherApi.getStatus']?.[localVarOperationServerIndex]?.url;
2021
3823
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2022
3824
  },
2023
3825
  }
2024
3826
  };
2025
3827
 
2026
3828
  /**
2027
- * ProjectsApi - factory interface
3829
+ * PublisherApi - factory interface
2028
3830
  * @export
2029
3831
  */
2030
- export const ProjectsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2031
- const localVarFp = ProjectsApiFp(configuration)
3832
+ export const PublisherApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3833
+ const localVarFp = PublisherApiFp(configuration)
2032
3834
  return {
2033
3835
  /**
2034
- *
2035
- * @summary Returns a list of the Projects hosted on this server.
3836
+ * Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
3837
+ * @summary Get server status and health information
2036
3838
  * @param {*} [options] Override http request option.
2037
3839
  * @throws {RequiredError}
2038
3840
  */
2039
- listProjects(options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>> {
2040
- return localVarFp.listProjects(options).then((request) => request(axios, basePath));
3841
+ getStatus(options?: RawAxiosRequestConfig): AxiosPromise<ServerStatus> {
3842
+ return localVarFp.getStatus(options).then((request) => request(axios, basePath));
2041
3843
  },
2042
3844
  };
2043
3845
  };
2044
3846
 
2045
3847
  /**
2046
- * ProjectsApi - object-oriented interface
3848
+ * PublisherApi - object-oriented interface
2047
3849
  * @export
2048
- * @class ProjectsApi
3850
+ * @class PublisherApi
2049
3851
  * @extends {BaseAPI}
2050
3852
  */
2051
- export class ProjectsApi extends BaseAPI {
3853
+ export class PublisherApi extends BaseAPI {
2052
3854
  /**
2053
- *
2054
- * @summary Returns a list of the Projects hosted on this server.
3855
+ * Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
3856
+ * @summary Get server status and health information
2055
3857
  * @param {*} [options] Override http request option.
2056
3858
  * @throws {RequiredError}
2057
- * @memberof ProjectsApi
3859
+ * @memberof PublisherApi
2058
3860
  */
2059
- public listProjects(options?: RawAxiosRequestConfig) {
2060
- return ProjectsApiFp(this.configuration).listProjects(options).then((request) => request(this.axios, this.basePath));
3861
+ public getStatus(options?: RawAxiosRequestConfig) {
3862
+ return PublisherApiFp(this.configuration).getStatus(options).then((request) => request(this.axios, this.basePath));
2061
3863
  }
2062
3864
  }
2063
3865
 
2064
3866
 
2065
3867
 
2066
3868
  /**
2067
- * QueryresultsApi - axios parameter creator
3869
+ * WatchModeApi - axios parameter creator
2068
3870
  * @export
2069
3871
  */
2070
- export const QueryresultsApiAxiosParamCreator = function (configuration?: Configuration) {
3872
+ export const WatchModeApiAxiosParamCreator = function (configuration?: Configuration) {
2071
3873
  return {
2072
3874
  /**
2073
- *
2074
- * @summary Returns a query and its results.
2075
- * @param {string} projectName Name of project
2076
- * @param {string} packageName Name of package
2077
- * @param {string} path Path to model within the package.
2078
- * @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
2079
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2080
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
2081
- * @param {string} [versionId] Version ID
3875
+ * Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
3876
+ * @summary Get watch mode status
2082
3877
  * @param {*} [options] Override http request option.
2083
3878
  * @throws {RequiredError}
2084
3879
  */
2085
- executeQuery: async (projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2086
- // verify required parameter 'projectName' is not null or undefined
2087
- assertParamExists('executeQuery', 'projectName', projectName)
2088
- // verify required parameter 'packageName' is not null or undefined
2089
- assertParamExists('executeQuery', 'packageName', packageName)
2090
- // verify required parameter 'path' is not null or undefined
2091
- assertParamExists('executeQuery', 'path', path)
2092
- const localVarPath = `/projects/{projectName}/packages/{packageName}/queryResults/{path}`
2093
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2094
- .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)))
2095
- .replace(`{${"path"}}`, encodeURIComponent(String(path)));
3880
+ getWatchStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3881
+ const localVarPath = `/watch-mode/status`;
2096
3882
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2097
3883
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2098
3884
  let baseOptions;
@@ -2104,22 +3890,6 @@ export const QueryresultsApiAxiosParamCreator = function (configuration?: Config
2104
3890
  const localVarHeaderParameter = {} as any;
2105
3891
  const localVarQueryParameter = {} as any;
2106
3892
 
2107
- if (query !== undefined) {
2108
- localVarQueryParameter['query'] = query;
2109
- }
2110
-
2111
- if (sourceName !== undefined) {
2112
- localVarQueryParameter['sourceName'] = sourceName;
2113
- }
2114
-
2115
- if (queryName !== undefined) {
2116
- localVarQueryParameter['queryName'] = queryName;
2117
- }
2118
-
2119
- if (versionId !== undefined) {
2120
- localVarQueryParameter['versionId'] = versionId;
2121
- }
2122
-
2123
3893
 
2124
3894
 
2125
3895
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -2131,115 +3901,50 @@ export const QueryresultsApiAxiosParamCreator = function (configuration?: Config
2131
3901
  options: localVarRequestOptions,
2132
3902
  };
2133
3903
  },
2134
- }
2135
- };
2136
-
2137
- /**
2138
- * QueryresultsApi - functional programming interface
2139
- * @export
2140
- */
2141
- export const QueryresultsApiFp = function(configuration?: Configuration) {
2142
- const localVarAxiosParamCreator = QueryresultsApiAxiosParamCreator(configuration)
2143
- return {
2144
3904
  /**
2145
- *
2146
- * @summary Returns a query and its results.
2147
- * @param {string} projectName Name of project
2148
- * @param {string} packageName Name of package
2149
- * @param {string} path Path to model within the package.
2150
- * @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
2151
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2152
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
2153
- * @param {string} [versionId] Version ID
3905
+ * Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
3906
+ * @summary Start file watching
3907
+ * @param {StartWatchRequest} startWatchRequest
2154
3908
  * @param {*} [options] Override http request option.
2155
3909
  * @throws {RequiredError}
2156
3910
  */
2157
- async executeQuery(projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>> {
2158
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeQuery(projectName, packageName, path, query, sourceName, queryName, versionId, options);
2159
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2160
- const localVarOperationServerBasePath = operationServerMap['QueryresultsApi.executeQuery']?.[localVarOperationServerIndex]?.url;
2161
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2162
- },
2163
- }
2164
- };
3911
+ startWatching: async (startWatchRequest: StartWatchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3912
+ // verify required parameter 'startWatchRequest' is not null or undefined
3913
+ assertParamExists('startWatching', 'startWatchRequest', startWatchRequest)
3914
+ const localVarPath = `/watch-mode/start`;
3915
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3916
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3917
+ let baseOptions;
3918
+ if (configuration) {
3919
+ baseOptions = configuration.baseOptions;
3920
+ }
2165
3921
 
2166
- /**
2167
- * QueryresultsApi - factory interface
2168
- * @export
2169
- */
2170
- export const QueryresultsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2171
- const localVarFp = QueryresultsApiFp(configuration)
2172
- return {
2173
- /**
2174
- *
2175
- * @summary Returns a query and its results.
2176
- * @param {string} projectName Name of project
2177
- * @param {string} packageName Name of package
2178
- * @param {string} path Path to model within the package.
2179
- * @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
2180
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2181
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
2182
- * @param {string} [versionId] Version ID
2183
- * @param {*} [options] Override http request option.
2184
- * @throws {RequiredError}
2185
- */
2186
- executeQuery(projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult> {
2187
- return localVarFp.executeQuery(projectName, packageName, path, query, sourceName, queryName, versionId, options).then((request) => request(axios, basePath));
2188
- },
2189
- };
2190
- };
3922
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
3923
+ const localVarHeaderParameter = {} as any;
3924
+ const localVarQueryParameter = {} as any;
2191
3925
 
2192
- /**
2193
- * QueryresultsApi - object-oriented interface
2194
- * @export
2195
- * @class QueryresultsApi
2196
- * @extends {BaseAPI}
2197
- */
2198
- export class QueryresultsApi extends BaseAPI {
2199
- /**
2200
- *
2201
- * @summary Returns a query and its results.
2202
- * @param {string} projectName Name of project
2203
- * @param {string} packageName Name of package
2204
- * @param {string} path Path to model within the package.
2205
- * @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
2206
- * @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
2207
- * @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
2208
- * @param {string} [versionId] Version ID
2209
- * @param {*} [options] Override http request option.
2210
- * @throws {RequiredError}
2211
- * @memberof QueryresultsApi
2212
- */
2213
- public executeQuery(projectName: string, packageName: string, path: string, query?: string, sourceName?: string, queryName?: string, versionId?: string, options?: RawAxiosRequestConfig) {
2214
- return QueryresultsApiFp(this.configuration).executeQuery(projectName, packageName, path, query, sourceName, queryName, versionId, options).then((request) => request(this.axios, this.basePath));
2215
- }
2216
- }
2217
3926
 
3927
+
3928
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2218
3929
 
3930
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3931
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3932
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3933
+ localVarRequestOptions.data = serializeDataIfNeeded(startWatchRequest, localVarRequestOptions, configuration)
2219
3934
 
2220
- /**
2221
- * SchedulesApi - axios parameter creator
2222
- * @export
2223
- */
2224
- export const SchedulesApiAxiosParamCreator = function (configuration?: Configuration) {
2225
- return {
3935
+ return {
3936
+ url: toPathString(localVarUrlObj),
3937
+ options: localVarRequestOptions,
3938
+ };
3939
+ },
2226
3940
  /**
2227
- *
2228
- * @summary Returns a list of running schedules.
2229
- * @param {string} projectName Name of project
2230
- * @param {string} packageName Name of package
2231
- * @param {string} [versionId] Version ID
3941
+ * Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
3942
+ * @summary Stop file watching
2232
3943
  * @param {*} [options] Override http request option.
2233
3944
  * @throws {RequiredError}
2234
3945
  */
2235
- listSchedules: async (projectName: string, packageName: string, versionId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2236
- // verify required parameter 'projectName' is not null or undefined
2237
- assertParamExists('listSchedules', 'projectName', projectName)
2238
- // verify required parameter 'packageName' is not null or undefined
2239
- assertParamExists('listSchedules', 'packageName', packageName)
2240
- const localVarPath = `/projects/{projectName}/packages/{packageName}/schedules`
2241
- .replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)))
2242
- .replace(`{${"packageName"}}`, encodeURIComponent(String(packageName)));
3946
+ stopWatching: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3947
+ const localVarPath = `/watch-mode/stop`;
2243
3948
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2244
3949
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2245
3950
  let baseOptions;
@@ -2247,14 +3952,10 @@ export const SchedulesApiAxiosParamCreator = function (configuration?: Configura
2247
3952
  baseOptions = configuration.baseOptions;
2248
3953
  }
2249
3954
 
2250
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3955
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2251
3956
  const localVarHeaderParameter = {} as any;
2252
3957
  const localVarQueryParameter = {} as any;
2253
3958
 
2254
- if (versionId !== undefined) {
2255
- localVarQueryParameter['versionId'] = versionId;
2256
- }
2257
-
2258
3959
 
2259
3960
 
2260
3961
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -2270,71 +3971,129 @@ export const SchedulesApiAxiosParamCreator = function (configuration?: Configura
2270
3971
  };
2271
3972
 
2272
3973
  /**
2273
- * SchedulesApi - functional programming interface
3974
+ * WatchModeApi - functional programming interface
2274
3975
  * @export
2275
3976
  */
2276
- export const SchedulesApiFp = function(configuration?: Configuration) {
2277
- const localVarAxiosParamCreator = SchedulesApiAxiosParamCreator(configuration)
3977
+ export const WatchModeApiFp = function(configuration?: Configuration) {
3978
+ const localVarAxiosParamCreator = WatchModeApiAxiosParamCreator(configuration)
2278
3979
  return {
2279
3980
  /**
2280
- *
2281
- * @summary Returns a list of running schedules.
2282
- * @param {string} projectName Name of project
2283
- * @param {string} packageName Name of package
2284
- * @param {string} [versionId] Version ID
3981
+ * Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
3982
+ * @summary Get watch mode status
3983
+ * @param {*} [options] Override http request option.
3984
+ * @throws {RequiredError}
3985
+ */
3986
+ async getWatchStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchStatus>> {
3987
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getWatchStatus(options);
3988
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3989
+ const localVarOperationServerBasePath = operationServerMap['WatchModeApi.getWatchStatus']?.[localVarOperationServerIndex]?.url;
3990
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3991
+ },
3992
+ /**
3993
+ * Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
3994
+ * @summary Start file watching
3995
+ * @param {StartWatchRequest} startWatchRequest
3996
+ * @param {*} [options] Override http request option.
3997
+ * @throws {RequiredError}
3998
+ */
3999
+ async startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
4000
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startWatching(startWatchRequest, options);
4001
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4002
+ const localVarOperationServerBasePath = operationServerMap['WatchModeApi.startWatching']?.[localVarOperationServerIndex]?.url;
4003
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4004
+ },
4005
+ /**
4006
+ * Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
4007
+ * @summary Stop file watching
2285
4008
  * @param {*} [options] Override http request option.
2286
4009
  * @throws {RequiredError}
2287
4010
  */
2288
- async listSchedules(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schedule>>> {
2289
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSchedules(projectName, packageName, versionId, options);
4011
+ async stopWatching(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
4012
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopWatching(options);
2290
4013
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2291
- const localVarOperationServerBasePath = operationServerMap['SchedulesApi.listSchedules']?.[localVarOperationServerIndex]?.url;
4014
+ const localVarOperationServerBasePath = operationServerMap['WatchModeApi.stopWatching']?.[localVarOperationServerIndex]?.url;
2292
4015
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2293
4016
  },
2294
4017
  }
2295
4018
  };
2296
4019
 
2297
4020
  /**
2298
- * SchedulesApi - factory interface
4021
+ * WatchModeApi - factory interface
2299
4022
  * @export
2300
4023
  */
2301
- export const SchedulesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2302
- const localVarFp = SchedulesApiFp(configuration)
4024
+ export const WatchModeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
4025
+ const localVarFp = WatchModeApiFp(configuration)
2303
4026
  return {
2304
4027
  /**
2305
- *
2306
- * @summary Returns a list of running schedules.
2307
- * @param {string} projectName Name of project
2308
- * @param {string} packageName Name of package
2309
- * @param {string} [versionId] Version ID
4028
+ * Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
4029
+ * @summary Get watch mode status
4030
+ * @param {*} [options] Override http request option.
4031
+ * @throws {RequiredError}
4032
+ */
4033
+ getWatchStatus(options?: RawAxiosRequestConfig): AxiosPromise<WatchStatus> {
4034
+ return localVarFp.getWatchStatus(options).then((request) => request(axios, basePath));
4035
+ },
4036
+ /**
4037
+ * Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
4038
+ * @summary Start file watching
4039
+ * @param {StartWatchRequest} startWatchRequest
4040
+ * @param {*} [options] Override http request option.
4041
+ * @throws {RequiredError}
4042
+ */
4043
+ startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
4044
+ return localVarFp.startWatching(startWatchRequest, options).then((request) => request(axios, basePath));
4045
+ },
4046
+ /**
4047
+ * Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
4048
+ * @summary Stop file watching
2310
4049
  * @param {*} [options] Override http request option.
2311
4050
  * @throws {RequiredError}
2312
4051
  */
2313
- listSchedules(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schedule>> {
2314
- return localVarFp.listSchedules(projectName, packageName, versionId, options).then((request) => request(axios, basePath));
4052
+ stopWatching(options?: RawAxiosRequestConfig): AxiosPromise<void> {
4053
+ return localVarFp.stopWatching(options).then((request) => request(axios, basePath));
2315
4054
  },
2316
4055
  };
2317
4056
  };
2318
4057
 
2319
4058
  /**
2320
- * SchedulesApi - object-oriented interface
4059
+ * WatchModeApi - object-oriented interface
2321
4060
  * @export
2322
- * @class SchedulesApi
4061
+ * @class WatchModeApi
2323
4062
  * @extends {BaseAPI}
2324
4063
  */
2325
- export class SchedulesApi extends BaseAPI {
4064
+ export class WatchModeApi extends BaseAPI {
2326
4065
  /**
2327
- *
2328
- * @summary Returns a list of running schedules.
2329
- * @param {string} projectName Name of project
2330
- * @param {string} packageName Name of package
2331
- * @param {string} [versionId] Version ID
4066
+ * Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
4067
+ * @summary Get watch mode status
4068
+ * @param {*} [options] Override http request option.
4069
+ * @throws {RequiredError}
4070
+ * @memberof WatchModeApi
4071
+ */
4072
+ public getWatchStatus(options?: RawAxiosRequestConfig) {
4073
+ return WatchModeApiFp(this.configuration).getWatchStatus(options).then((request) => request(this.axios, this.basePath));
4074
+ }
4075
+
4076
+ /**
4077
+ * Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
4078
+ * @summary Start file watching
4079
+ * @param {StartWatchRequest} startWatchRequest
4080
+ * @param {*} [options] Override http request option.
4081
+ * @throws {RequiredError}
4082
+ * @memberof WatchModeApi
4083
+ */
4084
+ public startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig) {
4085
+ return WatchModeApiFp(this.configuration).startWatching(startWatchRequest, options).then((request) => request(this.axios, this.basePath));
4086
+ }
4087
+
4088
+ /**
4089
+ * Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
4090
+ * @summary Stop file watching
2332
4091
  * @param {*} [options] Override http request option.
2333
4092
  * @throws {RequiredError}
2334
- * @memberof SchedulesApi
4093
+ * @memberof WatchModeApi
2335
4094
  */
2336
- public listSchedules(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) {
2337
- return SchedulesApiFp(this.configuration).listSchedules(projectName, packageName, versionId, options).then((request) => request(this.axios, this.basePath));
4095
+ public stopWatching(options?: RawAxiosRequestConfig) {
4096
+ return WatchModeApiFp(this.configuration).stopWatching(options).then((request) => request(this.axios, this.basePath));
2338
4097
  }
2339
4098
  }
2340
4099