@vizzly/api-client 0.0.88 → 0.0.90
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,7 @@ 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;
|
|
255
262
|
}>): Promise<import("../types").Response<DataOptimiser.CreateSubsnapExecuteResponse>>;
|
|
256
263
|
getCreateSubsnapStatus(params: RequestParams<{
|
|
257
264
|
companyId: string;
|
|
@@ -261,6 +268,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
261
268
|
snapshotFields: DataOptimiser.DataSourceFields;
|
|
262
269
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
263
270
|
previousWorkflowResults: Partial<DataOptimiser.CreateSubsnapExecuteResponse['workflowResults']>;
|
|
271
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
264
272
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
265
273
|
create_subsnap: DataOptimiser.ActionStatus<{
|
|
266
274
|
subsnapDataSourceFields: DataOptimiser.DataSourceFields;
|
|
@@ -276,6 +284,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
276
284
|
function: string;
|
|
277
285
|
}>;
|
|
278
286
|
previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
|
|
287
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
279
288
|
}>): Promise<import("../types").Response<DataOptimiser.IngestFromUploadExecuteResponse>>;
|
|
280
289
|
getIngestFromUploadStatus(params: RequestParams<{
|
|
281
290
|
companyId: string;
|
|
@@ -286,6 +295,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
286
295
|
function: string;
|
|
287
296
|
}>;
|
|
288
297
|
previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
|
|
298
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
289
299
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
290
300
|
move_table_from_upload_to_ingest: DataOptimiser.ActionStatus<{
|
|
291
301
|
destinationAddress: string[];
|
|
@@ -340,4 +350,12 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
340
350
|
companyId: string;
|
|
341
351
|
}>): Promise<import("../types").Response<{}>>;
|
|
342
352
|
private buildEnableBucketCorsRequest;
|
|
353
|
+
/** Create a new warehouse of a given size */
|
|
354
|
+
createWarehouse(params: RequestParams<{
|
|
355
|
+
companyId: string;
|
|
356
|
+
warehouseSize: string;
|
|
357
|
+
}>): Promise<import("../types").Response<{
|
|
358
|
+
warehouseName: string;
|
|
359
|
+
}>>;
|
|
360
|
+
private buildCreateWarehouseRequest;
|
|
343
361
|
}
|
|
@@ -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,8 @@ 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 || {}
|
|
645
650
|
},
|
|
646
651
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
647
652
|
};
|
|
@@ -668,6 +673,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
668
673
|
ingestFields: params.ingestFields,
|
|
669
674
|
transformations: params.transformations,
|
|
670
675
|
previousWorkflowResults: params.previousWorkflowResults,
|
|
676
|
+
warehouseOverrideMapping: params.warehouseOverrideMapping || {}
|
|
671
677
|
},
|
|
672
678
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
673
679
|
};
|
|
@@ -789,5 +795,23 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
789
795
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
790
796
|
};
|
|
791
797
|
}
|
|
798
|
+
/** Create a new warehouse of a given size */
|
|
799
|
+
createWarehouse(params) {
|
|
800
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
801
|
+
return yield this.execute(this.buildCreateWarehouseRequest(params));
|
|
802
|
+
});
|
|
803
|
+
}
|
|
804
|
+
buildCreateWarehouseRequest(params) {
|
|
805
|
+
return {
|
|
806
|
+
path: Path_1.Path.buildPath(`/api/v1/data-optimiser/warehouse`, ''),
|
|
807
|
+
method: 'post',
|
|
808
|
+
abortSignal: params.abortSignal,
|
|
809
|
+
body: {
|
|
810
|
+
company: { id: params.companyId },
|
|
811
|
+
warehouseSize: params.warehouseSize
|
|
812
|
+
},
|
|
813
|
+
acceptedAuthParams: ['queryEngineApiKey'],
|
|
814
|
+
};
|
|
815
|
+
}
|
|
792
816
|
}
|
|
793
817
|
exports.VizzlyQueryEngineApi = VizzlyQueryEngineApi;
|
package/dist/types.d.ts
CHANGED
|
@@ -478,6 +478,11 @@ 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
|
+
};
|
|
481
486
|
type RenameColumnInstruction = {
|
|
482
487
|
type: 'rename_column';
|
|
483
488
|
columnToRename: DatabaseColumn;
|
|
@@ -583,6 +588,7 @@ export declare namespace DataOptimiser {
|
|
|
583
588
|
externalSnowflakeConnection: DataOptimiser.QueryEngineConnection;
|
|
584
589
|
instructions: DataOptimiser.TreePartInstruction['columnInstructions'];
|
|
585
590
|
previousWorkflowResults: Partial<DataOptimiser.IngestTreePartExecuteResponse['workflowResults']>;
|
|
591
|
+
warehouseOverrideMapping?: DataOptimiser.WarehouseOverrideMapping;
|
|
586
592
|
};
|
|
587
593
|
export type IngestTreePartExecuteResponse = ExecuteResponse<{
|
|
588
594
|
build_tree_part_ingest_table: DataOptimiser.ActionResult<{
|