@explo-tech/fido-api 0.0.8 → 0.0.9

package/index.ts

@@ -7,9 +7,11 @@ export { OpenAPI } from './core/OpenAPI';
 export type { OpenAPIConfig } from './core/OpenAPI';
 
 export type { BooleanPropertyValue } from './models/BooleanPropertyValue';
+export type { BulkViewsRequest } from './models/BulkViewsRequest';
+export type { BulkViewsResponse } from './models/BulkViewsResponse';
 export type { ClientError } from './models/ClientError';
 export type { Computation } from './models/Computation';
-export type { ComputedViewRunRequest } from './models/ComputedViewRunRequest';
+export type { ComputedView } from './models/ComputedView';
 export type { DataPage } from './models/DataPage';
 export type { DataRecord } from './models/DataRecord';
 export type { DataRequestParameters } from './models/DataRequestParameters';
@@ -19,7 +21,6 @@ export type { DataSource } from './models/DataSource';
 export type { DataSourceConfiguration } from './models/DataSourceConfiguration';
 export type { DataSourceRequest } from './models/DataSourceRequest';
 export type { DataSourceResponse } from './models/DataSourceResponse';
-export type { DataSourceTablePreviewRequest } from './models/DataSourceTablePreviewRequest';
 export type { DatePropertyValue } from './models/DatePropertyValue';
 export type { DateTimePropertyValue } from './models/DateTimePropertyValue';
 export type { DecimalPropertyValue } from './models/DecimalPropertyValue';
@@ -28,6 +29,8 @@ export type { Duration } from './models/Duration';
 export type { Filter } from './models/Filter';
 export type { IntegerPropertyValue } from './models/IntegerPropertyValue';
 export type { LocalDate } from './models/LocalDate';
+export type { MySql } from './models/MySql';
+export type { MySqlAuthentication } from './models/MySqlAuthentication';
 export type { Namespace } from './models/Namespace';
 export type { NamespaceRequest } from './models/NamespaceRequest';
 export type { NamespaceResponse } from './models/NamespaceResponse';
@@ -43,18 +46,26 @@ export { PropertyType } from './models/PropertyType';
 export type { PropertyValue } from './models/PropertyValue';
 export type { PublicTunnel } from './models/PublicTunnel';
 export type { QueryExecutionResponse } from './models/QueryExecutionResponse';
+export type { QueryPreviewRequest } from './models/QueryPreviewRequest';
 export type { RequestTelemetry } from './models/RequestTelemetry';
 export type { Sort } from './models/Sort';
 export { SortDirection } from './models/SortDirection';
 export type { SSHAuthentication } from './models/SSHAuthentication';
 export type { SSHTunnel } from './models/SSHTunnel';
 export type { StringPropertyValue } from './models/StringPropertyValue';
+export type { TablePreviewRequest } from './models/TablePreviewRequest';
+export type { TableView } from './models/TableView';
 export type { TenantPrivateKeyAuthentication } from './models/TenantPrivateKeyAuthentication';
 export type { Tunnel } from './models/Tunnel';
 export type { UUID } from './models/UUID';
 export type { VendorPrivateKeyAuthentication } from './models/VendorPrivateKeyAuthentication';
+export type { View } from './models/View';
+export type { ViewRequest } from './models/ViewRequest';
+export type { ViewResponse } from './models/ViewResponse';
+export type { ViewRunRequest } from './models/ViewRunRequest';
 
 export { DatasourceResourceService } from './services/DatasourceResourceService';
 export { HealthResourceService } from './services/HealthResourceService';
 export { NamespaceResourceService } from './services/NamespaceResourceService';
 export { QueryResourceService } from './services/QueryResourceService';
+export { ViewResourceService } from './services/ViewResourceService';

package/models/BulkViewsRequest.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type BulkViewsRequest = {
+    viewIds: Array<string>;
+};
+

package/models/BulkViewsResponse.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { View } from './View';
+
+export type BulkViewsResponse = {
+    views: Array<View>;
+};
+

package/models/ComputedView.ts

@@ -0,0 +1,16 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PropertySchema } from './PropertySchema';
+import type { UUID } from './UUID';
+
+export type ComputedView = {
+    name: string;
+    description: string;
+    columnDefinitions: Array<PropertySchema>;
+    id: UUID | null;
+    namespaceId: UUID | null;
+    query: string;
+};
+

package/models/DataSourceConfiguration.ts

@@ -2,10 +2,11 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { MySql } from './MySql';
 import type { Postgres } from './Postgres';
 import type { Tunnel } from './Tunnel';
 
-export type DataSourceConfiguration = (Postgres | {
+export type DataSourceConfiguration = (Postgres | MySql | {
     tunnel: Tunnel;
 });
 

package/models/MySql.ts

@@ -0,0 +1,15 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { MySqlAuthentication } from './MySqlAuthentication';
+import type { Tunnel } from './Tunnel';
+
+export type MySql = {
+    tunnel: Tunnel;
+    authentication: MySqlAuthentication;
+    database: string;
+    host: string;
+    port?: number;
+};
+

package/models/MySqlAuthentication.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PasswordAuthentication } from './PasswordAuthentication';
+
+export type MySqlAuthentication = PasswordAuthentication;
+

package/models/{ComputedViewRunRequest.ts → QueryPreviewRequest.ts}

@@ -5,7 +5,7 @@
 import type { Computation } from './Computation';
 import type { DataRequestParameters } from './DataRequestParameters';
 
-export type ComputedViewRunRequest = {
+export type QueryPreviewRequest = {
     query: string;
     tableIdentifier: string;
     dataRequestParameters: DataRequestParameters;

package/models/{DataSourceTablePreviewRequest.ts → TablePreviewRequest.ts}

@@ -4,7 +4,7 @@
 
 import type { DataRequestParameters } from './DataRequestParameters';
 
-export type DataSourceTablePreviewRequest = {
+export type TablePreviewRequest = {
     tableIdentifier: string;
     dataRequestParameters: DataRequestParameters;
 };

package/models/TableView.ts

@@ -0,0 +1,16 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PropertySchema } from './PropertySchema';
+import type { UUID } from './UUID';
+
+export type TableView = {
+    name: string;
+    description: string;
+    columnDefinitions: Array<PropertySchema>;
+    id: UUID | null;
+    namespaceId: UUID | null;
+    tableName: string;
+};
+

package/models/View.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { ComputedView } from './ComputedView';
+import type { PropertySchema } from './PropertySchema';
+import type { TableView } from './TableView';
+import type { UUID } from './UUID';
+
+export type View = (TableView | ComputedView | {
+    name: string;
+    description: string;
+    columnDefinitions: Array<PropertySchema>;
+    id: UUID | null;
+    namespaceId: UUID | null;
+});
+

package/models/ViewRequest.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { View } from './View';
+
+export type ViewRequest = {
+    view: View;
+};
+

package/models/ViewResponse.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { View } from './View';
+
+export type ViewResponse = {
+    view: View;
+};
+

package/models/ViewRunRequest.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Computation } from './Computation';
+import type { DataRequestParameters } from './DataRequestParameters';
+
+export type ViewRunRequest = {
+    dataRequestParameters: DataRequestParameters;
+    queryContext: Record<string, any>;
+    computation: Computation | null;
+};
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@explo-tech/fido-api",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Fido api",
   "homepage": "https://github.com/trust-kaz/fido",
   "license": "MIT",

package/services/QueryResourceService.ts

@@ -1,10 +1,11 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { ComputedViewRunRequest } from '../models/ComputedViewRunRequest';
-import type { DataSourceTablePreviewRequest } from '../models/DataSourceTablePreviewRequest';
 import type { QueryExecutionResponse } from '../models/QueryExecutionResponse';
+import type { QueryPreviewRequest } from '../models/QueryPreviewRequest';
+import type { TablePreviewRequest } from '../models/TablePreviewRequest';
 import type { UUID } from '../models/UUID';
+import type { ViewRunRequest } from '../models/ViewRunRequest';
 
 import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
@@ -20,10 +21,10 @@ export class QueryResourceService {
      * @returns QueryExecutionResponse A DataPage of the provided query
      * @throws ApiError
      */
-    public static runComputedView(
+    public static getQueryPreview(
         dataSourceId: UUID,
         namespaceId: UUID,
-        requestBody?: ComputedViewRunRequest,
+        requestBody?: QueryPreviewRequest,
     ): CancelablePromise<QueryExecutionResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -45,10 +46,10 @@ export class QueryResourceService {
      * @returns QueryExecutionResponse A DataPage of the resulting Data Source's data
      * @throws ApiError
      */
-    public static getDatasourceTablePreview(
+    public static getTablePreview(
         dataSourceId: UUID,
         namespaceId: UUID,
-        requestBody?: DataSourceTablePreviewRequest,
+        requestBody?: TablePreviewRequest,
     ): CancelablePromise<QueryExecutionResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -62,4 +63,32 @@ export class QueryResourceService {
         });
     }
 
+    /**
+     * Runs the requested view against the provided data source
+     * @param dataSourceId
+     * @param namespaceId
+     * @param viewId
+     * @param requestBody
+     * @returns QueryExecutionResponse A DataPage of the provided query
+     * @throws ApiError
+     */
+    public static runView(
+        dataSourceId: UUID,
+        namespaceId: UUID,
+        viewId: UUID,
+        requestBody?: ViewRunRequest,
+    ): CancelablePromise<QueryExecutionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{dataSourceId}/views/{viewId}/run',
+            path: {
+                'dataSourceId': dataSourceId,
+                'namespaceId': namespaceId,
+                'viewId': viewId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
 }

package/services/ViewResourceService.ts

@@ -0,0 +1,156 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { BulkViewsRequest } from '../models/BulkViewsRequest';
+import type { UUID } from '../models/UUID';
+import type { View } from '../models/View';
+import type { ViewRequest } from '../models/ViewRequest';
+import type { ViewResponse } from '../models/ViewResponse';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class ViewResourceService {
+
+    /**
+     * Deletes a view
+     * @param namespaceId
+     * @param requestBody
+     * @returns any The requested views
+     * @throws ApiError
+     */
+    public static getViews(
+        namespaceId: UUID,
+        requestBody?: BulkViewsRequest,
+    ): CancelablePromise<{
+        views: Array<View>;
+    }> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/views/bulk-get',
+            path: {
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Clones the request set of views
+     * @param namespaceId
+     * @param requestBody
+     * @returns any The cloned views
+     * @throws ApiError
+     */
+    public static cloneViews(
+        namespaceId: UUID,
+        requestBody?: BulkViewsRequest,
+    ): CancelablePromise<{
+        views: Array<View>;
+    }> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/views/clone',
+            path: {
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Gets a view
+     * @param id
+     * @param namespaceId
+     * @returns ViewResponse The requested view
+     * @throws ApiError
+     */
+    public static getView(
+        id: UUID,
+        namespaceId: UUID,
+    ): CancelablePromise<ViewResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/namespaces/{namespaceId}/views/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+        });
+    }
+
+    /**
+     * Updates a view's metadata
+     * @param id
+     * @param namespaceId
+     * @param requestBody
+     * @returns ViewResponse The updated view
+     * @throws ApiError
+     */
+    public static updateView(
+        id: UUID,
+        namespaceId: UUID,
+        requestBody?: ViewRequest,
+    ): CancelablePromise<ViewResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/v1/namespaces/{namespaceId}/views/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Creates a view
+     * @param id
+     * @param namespaceId
+     * @param requestBody
+     * @returns ViewResponse The requested view
+     * @throws ApiError
+     */
+    public static createView(
+        id: UUID,
+        namespaceId: UUID,
+        requestBody?: ViewRequest,
+    ): CancelablePromise<ViewResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/views/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Deletes a view
+     * @param id
+     * @param namespaceId
+     * @returns any 200 if the view was deleted properly
+     * @throws ApiError
+     */
+    public static deleteView(
+        id: UUID,
+        namespaceId: UUID,
+    ): CancelablePromise<Record<string, any>> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/v1/namespaces/{namespaceId}/views/{id}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+            },
+        });
+    }
+
+}