@vizzly/api-client 0.0.73 → 0.0.75
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.
|
@@ -141,6 +141,16 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
141
141
|
}>>>;
|
|
142
142
|
private buildCreateCompanyInfrastructureRequest;
|
|
143
143
|
/** Send request to ingest data */
|
|
144
|
+
ingestTreePartDatasource(params: RequestParams<DataOptimiser.BuildIngestTreePartDatasourceParams>): Promise<import("../types").Response<DataOptimiser.IngestTreePartExecuteResponse>>;
|
|
145
|
+
/** Get the status of a call to ingest data for a data source. */
|
|
146
|
+
getIngestTreePartDatasourceStatus(params: RequestParams<DataOptimiser.BuildIngestTreePartDatasourceParams>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
147
|
+
build_tree_part_ingest_table: DataOptimiser.ActionStatus<{
|
|
148
|
+
destinationAddress: string[];
|
|
149
|
+
destinationFields: DataOptimiser.DataSourceFields;
|
|
150
|
+
}>;
|
|
151
|
+
}>>>;
|
|
152
|
+
private buildIngestTreePartDatasourceRequest;
|
|
153
|
+
/** Send request to ingest data */
|
|
144
154
|
ingestDatasource(params: RequestParams<{
|
|
145
155
|
companyId: string;
|
|
146
156
|
dataSourceId: string;
|
|
@@ -232,6 +242,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
232
242
|
}>>>;
|
|
233
243
|
private buildCreateSubsnapRequest;
|
|
234
244
|
ingestFromUpload(params: RequestParams<{
|
|
245
|
+
companyId: string;
|
|
235
246
|
dataSourceId: string;
|
|
236
247
|
ingestFields: DataOptimiser.EphemeralDataSourceFields;
|
|
237
248
|
transformations: Array<{
|
|
@@ -241,6 +252,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
241
252
|
previousWorkflowResults: Partial<DataOptimiser.IngestFromUploadExecuteResponse['workflowResults']>;
|
|
242
253
|
}>): Promise<import("../types").Response<DataOptimiser.IngestFromUploadExecuteResponse>>;
|
|
243
254
|
getIngestFromUploadStatus(params: RequestParams<{
|
|
255
|
+
companyId: string;
|
|
244
256
|
dataSourceId: string;
|
|
245
257
|
ingestFields: DataOptimiser.EphemeralDataSourceFields;
|
|
246
258
|
transformations: Array<{
|
|
@@ -257,6 +269,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
257
269
|
private buildIngestFromUploadRequest;
|
|
258
270
|
/** Send request to create upload table */
|
|
259
271
|
createUploadTable(params: RequestParams<{
|
|
272
|
+
companyId: string;
|
|
260
273
|
dataSourceId: string;
|
|
261
274
|
locationName: string;
|
|
262
275
|
folderPath: string;
|
|
@@ -265,6 +278,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
265
278
|
}>): Promise<import("../types").Response<DataOptimiser.CreateUploadTableExecuteResponse>>;
|
|
266
279
|
/** Get the status of a create upload table call */
|
|
267
280
|
getCreateUploadTableStatus(params: RequestParams<{
|
|
281
|
+
companyId: string;
|
|
268
282
|
dataSourceId: string;
|
|
269
283
|
locationName: string;
|
|
270
284
|
folderPath: string;
|
|
@@ -500,6 +500,35 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
500
500
|
};
|
|
501
501
|
}
|
|
502
502
|
/** Send request to ingest data */
|
|
503
|
+
ingestTreePartDatasource(params) {
|
|
504
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
505
|
+
return yield this.execute(this.buildIngestTreePartDatasourceRequest(params, { statusOnly: false }));
|
|
506
|
+
});
|
|
507
|
+
}
|
|
508
|
+
/** Get the status of a call to ingest data for a data source. */
|
|
509
|
+
getIngestTreePartDatasourceStatus(params) {
|
|
510
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
511
|
+
return yield this.execute(this.buildIngestTreePartDatasourceRequest(params, { statusOnly: true }));
|
|
512
|
+
});
|
|
513
|
+
}
|
|
514
|
+
buildIngestTreePartDatasourceRequest(params, options) {
|
|
515
|
+
const maybeStatusRoutePath = (options === null || options === void 0 ? void 0 : options.statusOnly) ? '/status' : '';
|
|
516
|
+
return {
|
|
517
|
+
path: Path_1.Path.buildPath(`/api/v1/data-optimiser/ingest-tree-part`, maybeStatusRoutePath),
|
|
518
|
+
method: 'post',
|
|
519
|
+
abortSignal: params.abortSignal,
|
|
520
|
+
body: {
|
|
521
|
+
company: { id: params.companyId },
|
|
522
|
+
dataSourceId: params.dataSourceId,
|
|
523
|
+
filter: params.filter,
|
|
524
|
+
previousWorkflowResults: params.previousWorkflowResults,
|
|
525
|
+
instructions: params.instructions,
|
|
526
|
+
fullTreeFields: params.fullTreeFields
|
|
527
|
+
},
|
|
528
|
+
acceptedAuthParams: ['queryEngineApiKey'],
|
|
529
|
+
};
|
|
530
|
+
}
|
|
531
|
+
/** Send request to ingest data */
|
|
503
532
|
ingestDatasource(params) {
|
|
504
533
|
return __awaiter(this, void 0, void 0, function* () {
|
|
505
534
|
return yield this.execute(this.buildIngestDatasourceRequest(params, { statusOnly: false }));
|
|
@@ -604,6 +633,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
604
633
|
method: 'post',
|
|
605
634
|
abortSignal: params.abortSignal,
|
|
606
635
|
body: {
|
|
636
|
+
company: { id: params.companyId },
|
|
607
637
|
dataSourceId: params.dataSourceId,
|
|
608
638
|
ingestFields: params.ingestFields,
|
|
609
639
|
transformations: params.transformations,
|
|
@@ -631,6 +661,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
631
661
|
method: 'post',
|
|
632
662
|
abortSignal: params.abortSignal,
|
|
633
663
|
body: {
|
|
664
|
+
company: { id: params.companyId },
|
|
634
665
|
dataSourceId: params.dataSourceId,
|
|
635
666
|
locationName: params.locationName,
|
|
636
667
|
folderPath: params.folderPath,
|
package/dist/types.d.ts
CHANGED
|
@@ -574,6 +574,19 @@ export declare namespace DataOptimiser {
|
|
|
574
574
|
encryptedCredentials: string;
|
|
575
575
|
unencryptedCredentials?: Partial<SnowflakeConnection>;
|
|
576
576
|
};
|
|
577
|
+
export type BuildIngestTreePartDatasourceParams = {
|
|
578
|
+
companyId: string;
|
|
579
|
+
dataSourceId: string;
|
|
580
|
+
fullTreeFields: DataOptimiser.DataSourceFields;
|
|
581
|
+
filter: DataOptimiser.TreePartInstruction['filter'];
|
|
582
|
+
instructions: DataOptimiser.TreePartInstruction['columnInstructions'];
|
|
583
|
+
previousWorkflowResults: Partial<DataOptimiser.IngestTreePartExecuteResponse['workflowResults']>;
|
|
584
|
+
};
|
|
585
|
+
export type IngestTreePartExecuteResponse = ExecuteResponse<{
|
|
586
|
+
build_tree_part_ingest_table: DataOptimiser.ActionResult<{
|
|
587
|
+
executedInSnowflakeSessionId: string;
|
|
588
|
+
}>;
|
|
589
|
+
}>;
|
|
577
590
|
export type IngestExecuteResponse = ExecuteResponse<{
|
|
578
591
|
setup_export_data_integration: DataOptimiser.ActionResult<{}>;
|
|
579
592
|
ingest_to_storage: DataOptimiser.ActionResult<{
|