@vizzly/api-client 0.0.89 → 0.0.91
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.
|
@@ -162,6 +162,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
162
162
|
function: string;
|
|
163
163
|
}>;
|
|
164
164
|
previousWorkflowResults: Partial<DataOptimiser.IngestExecuteResponse['workflowResults']>;
|
|
165
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
165
166
|
}>): Promise<import("../types").Response<DataOptimiser.IngestExecuteResponse>>;
|
|
166
167
|
/** Get the status of a call to ingest data for a data source. */
|
|
167
168
|
getIngestDatasourceStatus(params: RequestParams<{
|
|
@@ -175,6 +176,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
175
176
|
function: string;
|
|
176
177
|
}>;
|
|
177
178
|
previousWorkflowResults: Partial<DataOptimiser.IngestExecuteResponse['workflowResults']>;
|
|
179
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
178
180
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
179
181
|
setup_export_data_integration: DataOptimiser.ActionStatus<{}>;
|
|
180
182
|
ingest_to_storage: DataOptimiser.ActionStatus<{
|
|
@@ -199,6 +201,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
199
201
|
function: string;
|
|
200
202
|
}>;
|
|
201
203
|
previousWorkflowResults: Partial<DataOptimiser.InternalIngestExecuteResponse['workflowResults']>;
|
|
204
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
202
205
|
}>): Promise<import("../types").Response<DataOptimiser.InternalIngestExecuteResponse>>;
|
|
203
206
|
getInternalIngestDatasourceStatus(params: RequestParams<{
|
|
204
207
|
companyId: string;
|
|
@@ -210,6 +213,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
210
213
|
function: string;
|
|
211
214
|
}>;
|
|
212
215
|
previousWorkflowResults: Partial<DataOptimiser.InternalIngestExecuteResponse['workflowResults']>;
|
|
216
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
213
217
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
214
218
|
ingest_storage_to_snowflake: DataOptimiser.ActionStatus<{
|
|
215
219
|
destinationAddress: string[];
|
|
@@ -227,6 +231,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
227
231
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
228
232
|
primaryDateFieldId?: string | undefined;
|
|
229
233
|
previousWorkflowResults: Partial<DataOptimiser.CreateSnapshotExecuteResponse['workflowResults']>;
|
|
234
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
230
235
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
231
236
|
create_snapshot: DataOptimiser.ActionStatus<{
|
|
232
237
|
snapshotDataSourceFields: DataOptimiser.DataSourceFields;
|
|
@@ -242,6 +247,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
242
247
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
243
248
|
primaryDateFieldId?: string | undefined;
|
|
244
249
|
previousWorkflowResults: Partial<DataOptimiser.CreateSnapshotExecuteResponse['workflowResults']>;
|
|
250
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
245
251
|
}>): Promise<import("../types").Response<DataOptimiser.CreateSnapshotExecuteResponse>>;
|
|
246
252
|
private buildCreateSnapshotRequest;
|
|
247
253
|
createSubsnap(params: RequestParams<{
|
|
@@ -252,6 +258,8 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
252
258
|
snapshotFields: DataOptimiser.DataSourceFields;
|
|
253
259
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
254
260
|
previousWorkflowResults: Partial<DataOptimiser.CreateSubsnapExecuteResponse['workflowResults']>;
|
|
261
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
262
|
+
requiredMinimumFields: DataOptimiser.RequiredMinimumFields;
|
|
255
263
|
}>): Promise<import("../types").Response<DataOptimiser.CreateSubsnapExecuteResponse>>;
|
|
256
264
|
getCreateSubsnapStatus(params: RequestParams<{
|
|
257
265
|
companyId: string;
|
|
@@ -261,6 +269,8 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
261
269
|
snapshotFields: DataOptimiser.DataSourceFields;
|
|
262
270
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
263
271
|
previousWorkflowResults: Partial<DataOptimiser.CreateSubsnapExecuteResponse['workflowResults']>;
|
|
272
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
273
|
+
requiredMinimumFields: DataOptimiser.RequiredMinimumFields;
|
|
264
274
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
265
275
|
create_subsnap: DataOptimiser.ActionStatus<{
|
|
266
276
|
subsnapDataSourceFields: DataOptimiser.DataSourceFields;
|
|
@@ -276,6 +286,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
276
286
|
function: string;
|
|
277
287
|
}>;
|
|
278
288
|
previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
|
|
289
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
279
290
|
}>): Promise<import("../types").Response<DataOptimiser.IngestFromUploadExecuteResponse>>;
|
|
280
291
|
getIngestFromUploadStatus(params: RequestParams<{
|
|
281
292
|
companyId: string;
|
|
@@ -286,6 +297,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
286
297
|
function: string;
|
|
287
298
|
}>;
|
|
288
299
|
previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
|
|
300
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
289
301
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
290
302
|
move_table_from_upload_to_ingest: DataOptimiser.ActionStatus<{
|
|
291
303
|
destinationAddress: string[];
|
|
@@ -526,6 +526,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
526
526
|
externalSnowflakeConnection: params.externalSnowflakeConnection,
|
|
527
527
|
instructions: params.instructions,
|
|
528
528
|
fullTreeFields: params.fullTreeFields,
|
|
529
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {}
|
|
529
530
|
},
|
|
530
531
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
531
532
|
};
|
|
@@ -556,6 +557,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
556
557
|
externalSnowflakeConnection: params.externalSnowflakeConnection,
|
|
557
558
|
transformations: params.transformations,
|
|
558
559
|
previousWorkflowResults: params.previousWorkflowResults,
|
|
560
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {}
|
|
559
561
|
},
|
|
560
562
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
561
563
|
};
|
|
@@ -583,6 +585,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
583
585
|
ingestFields: params.ingestFields,
|
|
584
586
|
transformations: params.transformations,
|
|
585
587
|
previousWorkflowResults: params.previousWorkflowResults,
|
|
588
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {}
|
|
586
589
|
},
|
|
587
590
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
588
591
|
};
|
|
@@ -614,6 +617,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
614
617
|
primaryDateFieldId: params.primaryDateFieldId,
|
|
615
618
|
internalCompanyConnection: params.internalCompanyConnection,
|
|
616
619
|
previousWorkflowResults: params.previousWorkflowResults,
|
|
620
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {}
|
|
617
621
|
},
|
|
618
622
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
619
623
|
};
|
|
@@ -641,7 +645,9 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
641
645
|
subsnapDataSourceId: params.subsnapDataSourceId,
|
|
642
646
|
snapshotFields: params.snapshotFields,
|
|
643
647
|
internalCompanyConnection: params.internalCompanyConnection,
|
|
644
|
-
previousWorkflowResults: params.previousWorkflowResults
|
|
648
|
+
previousWorkflowResults: params.previousWorkflowResults,
|
|
649
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {},
|
|
650
|
+
requiredMinimumFields: params.requiredMinimumFields
|
|
645
651
|
},
|
|
646
652
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
647
653
|
};
|
|
@@ -668,6 +674,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
668
674
|
ingestFields: params.ingestFields,
|
|
669
675
|
transformations: params.transformations,
|
|
670
676
|
previousWorkflowResults: params.previousWorkflowResults,
|
|
677
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {}
|
|
671
678
|
},
|
|
672
679
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
673
680
|
};
|
package/dist/types.d.ts
CHANGED
|
@@ -478,6 +478,16 @@ export type GlobalLibraryPermissionFromAPI = {
|
|
|
478
478
|
scope: 'read' | 'read_write';
|
|
479
479
|
};
|
|
480
480
|
export declare namespace DataOptimiser {
|
|
481
|
+
export type WarehouseOverrideMapping = {
|
|
482
|
+
dataTeamSnowflake?: string;
|
|
483
|
+
gtiCommonSnowflake?: string;
|
|
484
|
+
gtiAdminSnowflake?: string;
|
|
485
|
+
};
|
|
486
|
+
export type RequiredMinimumField = Array<{
|
|
487
|
+
fieldId: string;
|
|
488
|
+
vizzlyDataSetId: string;
|
|
489
|
+
}>;
|
|
490
|
+
export type RequiredMinimumFields = Array<RequiredMinimumField>;
|
|
481
491
|
type RenameColumnInstruction = {
|
|
482
492
|
type: 'rename_column';
|
|
483
493
|
columnToRename: DatabaseColumn;
|
|
@@ -583,6 +593,7 @@ export declare namespace DataOptimiser {
|
|
|
583
593
|
externalSnowflakeConnection: DataOptimiser.QueryEngineConnection;
|
|
584
594
|
instructions: DataOptimiser.TreePartInstruction['columnInstructions'];
|
|
585
595
|
previousWorkflowResults: Partial<DataOptimiser.IngestTreePartExecuteResponse['workflowResults']>;
|
|
596
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
586
597
|
};
|
|
587
598
|
export type IngestTreePartExecuteResponse = ExecuteResponse<{
|
|
588
599
|
build_tree_part_ingest_table: DataOptimiser.ActionResult<{
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vizzly/api-client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.91",
|
|
4
4
|
"private": false,
|
|
5
5
|
"license": "NONE",
|
|
6
6
|
"source": "src/index.ts",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"uuid": "^9.0.1"
|
|
26
26
|
},
|
|
27
27
|
"scripts": {
|
|
28
|
-
"test": ". ./secrets.env && jest",
|
|
28
|
+
"test": ". ./secrets.env && jest --runInBand",
|
|
29
29
|
"test:ci": "jest",
|
|
30
30
|
"build": "rm -rf ./dist && tsc",
|
|
31
31
|
"dev": "tsc -w",
|