@vizzly/api-client 0.0.85 → 0.0.87
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.
|
@@ -189,6 +189,34 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
189
189
|
}>;
|
|
190
190
|
}>>>;
|
|
191
191
|
private buildIngestDatasourceRequest;
|
|
192
|
+
ingestInternalDataSource(params: RequestParams<{
|
|
193
|
+
companyId: string;
|
|
194
|
+
currentDataSourceId: string;
|
|
195
|
+
nextDataSourceId: string;
|
|
196
|
+
ingestFields: DataOptimiser.EphemeralDataSourceFields;
|
|
197
|
+
transformations: Array<{
|
|
198
|
+
columnName: string;
|
|
199
|
+
function: string;
|
|
200
|
+
}>;
|
|
201
|
+
previousWorkflowResults: Partial<DataOptimiser.InternalIngestExecuteResponse['workflowResults']>;
|
|
202
|
+
}>): Promise<import("../types").Response<DataOptimiser.InternalIngestExecuteResponse>>;
|
|
203
|
+
getInternalIngestDatasourceStatus(params: RequestParams<{
|
|
204
|
+
companyId: string;
|
|
205
|
+
currentDataSourceId: string;
|
|
206
|
+
nextDataSourceId: string;
|
|
207
|
+
ingestFields: DataOptimiser.EphemeralDataSourceFields;
|
|
208
|
+
transformations: Array<{
|
|
209
|
+
columnName: string;
|
|
210
|
+
function: string;
|
|
211
|
+
}>;
|
|
212
|
+
previousWorkflowResults: Partial<DataOptimiser.InternalIngestExecuteResponse['workflowResults']>;
|
|
213
|
+
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
214
|
+
ingest_storage_to_snowflake: DataOptimiser.ActionStatus<{
|
|
215
|
+
destinationAddress: string[];
|
|
216
|
+
destinationFields: DataOptimiser.DataSourceFields;
|
|
217
|
+
}>;
|
|
218
|
+
}>>>;
|
|
219
|
+
private buildInternalIngestDatasourceRequest;
|
|
192
220
|
/** Get the status of a call to ingest data for a data source. */
|
|
193
221
|
getCreateSnapshotStatus(params: RequestParams<{
|
|
194
222
|
companyId: string;
|
|
@@ -223,11 +251,8 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
223
251
|
subsnapDataSourceId: string;
|
|
224
252
|
snapshotFields: DataOptimiser.DataSourceFields;
|
|
225
253
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
subsnapFields: DataOptimiser.DataSourceFields;
|
|
229
|
-
}>;
|
|
230
|
-
}>>>;
|
|
254
|
+
previousWorkflowResults: Partial<DataOptimiser.CreateSubsnapExecuteResponse['workflowResults']>;
|
|
255
|
+
}>): Promise<import("../types").Response<DataOptimiser.CreateSubsnapExecuteResponse>>;
|
|
231
256
|
getCreateSubsnapStatus(params: RequestParams<{
|
|
232
257
|
companyId: string;
|
|
233
258
|
dashboardId: string;
|
|
@@ -235,6 +260,7 @@ export declare class VizzlyQueryEngineApi extends Api {
|
|
|
235
260
|
subsnapDataSourceId: string;
|
|
236
261
|
snapshotFields: DataOptimiser.DataSourceFields;
|
|
237
262
|
internalCompanyConnection: DataOptimiser.QueryEngineConnection;
|
|
263
|
+
previousWorkflowResults: Partial<DataOptimiser.CreateSubsnapExecuteResponse['workflowResults']>;
|
|
238
264
|
}>): Promise<import("../types").Response<DataOptimiser.StatusResponse<{
|
|
239
265
|
create_subsnap: DataOptimiser.ActionStatus<{
|
|
240
266
|
subsnapDataSourceFields: DataOptimiser.DataSourceFields;
|
|
@@ -560,6 +560,33 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
560
560
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
561
561
|
};
|
|
562
562
|
}
|
|
563
|
+
ingestInternalDataSource(params) {
|
|
564
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
565
|
+
return yield this.execute(this.buildInternalIngestDatasourceRequest(params, { statusOnly: false }));
|
|
566
|
+
});
|
|
567
|
+
}
|
|
568
|
+
getInternalIngestDatasourceStatus(params) {
|
|
569
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
570
|
+
return yield this.execute(this.buildInternalIngestDatasourceRequest(params, { statusOnly: true }));
|
|
571
|
+
});
|
|
572
|
+
}
|
|
573
|
+
buildInternalIngestDatasourceRequest(params, options) {
|
|
574
|
+
const maybeStatusRoutePath = (options === null || options === void 0 ? void 0 : options.statusOnly) ? '/status' : '';
|
|
575
|
+
return {
|
|
576
|
+
path: Path_1.Path.buildPath(`/api/v1/data-optimiser/internal-ingest`, maybeStatusRoutePath),
|
|
577
|
+
method: 'post',
|
|
578
|
+
abortSignal: params.abortSignal,
|
|
579
|
+
body: {
|
|
580
|
+
company: { id: params.companyId },
|
|
581
|
+
currentDataSourceId: params.currentDataSourceId,
|
|
582
|
+
nextDataSourceId: params.nextDataSourceId,
|
|
583
|
+
ingestFields: params.ingestFields,
|
|
584
|
+
transformations: params.transformations,
|
|
585
|
+
previousWorkflowResults: params.previousWorkflowResults,
|
|
586
|
+
},
|
|
587
|
+
acceptedAuthParams: ['queryEngineApiKey'],
|
|
588
|
+
};
|
|
589
|
+
}
|
|
563
590
|
/** Get the status of a call to ingest data for a data source. */
|
|
564
591
|
getCreateSnapshotStatus(params) {
|
|
565
592
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -614,6 +641,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
614
641
|
subsnapDataSourceId: params.subsnapDataSourceId,
|
|
615
642
|
snapshotFields: params.snapshotFields,
|
|
616
643
|
internalCompanyConnection: params.internalCompanyConnection,
|
|
644
|
+
previousWorkflowResults: params.previousWorkflowResults
|
|
617
645
|
},
|
|
618
646
|
acceptedAuthParams: ['queryEngineApiKey'],
|
|
619
647
|
};
|
package/dist/types.d.ts
CHANGED
|
@@ -602,6 +602,18 @@ export declare namespace DataOptimiser {
|
|
|
602
602
|
executedInSnowflakeSessionId: string;
|
|
603
603
|
}>;
|
|
604
604
|
}>;
|
|
605
|
+
export type InternalIngestExecuteResponse = ExecuteResponse<{
|
|
606
|
+
ingest_storage_to_snowflake: DataOptimiser.ActionResult<{
|
|
607
|
+
destinationAddress: string[];
|
|
608
|
+
executedInSnowflakeSessionId: string;
|
|
609
|
+
}>;
|
|
610
|
+
}>;
|
|
611
|
+
export type CreateSubsnapExecuteResponse = DataOptimiser.ExecuteResponse<{
|
|
612
|
+
create_subsnap: DataOptimiser.ActionResult<{
|
|
613
|
+
executedInSnowflakeSessionId: string;
|
|
614
|
+
subsnapFields: DataOptimiser.DataSourceFields;
|
|
615
|
+
}>;
|
|
616
|
+
}>;
|
|
605
617
|
export type CreateSnapshotExecuteResponse = DataOptimiser.ExecuteResponse<{
|
|
606
618
|
create_snapshot: DataOptimiser.ActionResult<{
|
|
607
619
|
executedInSnowflakeSessionId: string;
|