@explo-tech/fido-api 2.7.12 → 2.8.0

package/index.ts

@@ -14,12 +14,16 @@ export type { And1 } from './models/And1';
 export type { BigQuery } from './models/BigQuery';
 export type { BigQueryAuthentication } from './models/BigQueryAuthentication';
 export type { BooleanPropertyValue } from './models/BooleanPropertyValue';
+export type { Branch } from './models/Branch';
+export type { BranchResponse } from './models/BranchResponse';
+export type { BranchResponseMetadata } from './models/BranchResponseMetadata';
 export type { CacheTelemetry } from './models/CacheTelemetry';
 export { CalendarInterval } from './models/CalendarInterval';
 export type { CalendarIntervalGrouping } from './models/CalendarIntervalGrouping';
 export type { ClientError } from './models/ClientError';
 export type { Computation } from './models/Computation';
 export type { ComputedView } from './models/ComputedView';
+export type { CreateViewChange } from './models/CreateViewChange';
 export type { DataPage } from './models/DataPage';
 export type { DataRecord } from './models/DataRecord';
 export type { DataRequestParameters } from './models/DataRequestParameters';
@@ -36,6 +40,7 @@ export type { DatePropertyValue } from './models/DatePropertyValue';
 export type { DateTimePropertyValue } from './models/DateTimePropertyValue';
 export type { DecimalIntervalGrouping } from './models/DecimalIntervalGrouping';
 export type { DecimalPropertyValue } from './models/DecimalPropertyValue';
+export type { DeleteViewChange } from './models/DeleteViewChange';
 export type { DoublePropertyValue } from './models/DoublePropertyValue';
 export type { EmailConfiguration } from './models/EmailConfiguration';
 export type { Equal } from './models/Equal';
@@ -75,9 +80,12 @@ export type { LessThan } from './models/LessThan';
 export type { LessThan1 } from './models/LessThan1';
 export type { LessThanOrEqual } from './models/LessThanOrEqual';
 export type { LessThanOrEqual1 } from './models/LessThanOrEqual1';
+export type { ListBranchResponse } from './models/ListBranchResponse';
 export type { ListNamespacesResponse } from './models/ListNamespacesResponse';
+export type { ListVersionedViewsRequest } from './models/ListVersionedViewsRequest';
 export type { ListViewsRequest } from './models/ListViewsRequest';
 export type { ListViewsResponse } from './models/ListViewsResponse';
+export type { MergeBranchRequest } from './models/MergeBranchRequest';
 export type { MSS } from './models/MSS';
 export type { MySql } from './models/MySql';
 export type { Namespace } from './models/Namespace';
@@ -132,15 +140,19 @@ export type { TestConnectionRequest } from './models/TestConnectionRequest';
 export type { TestConnectionResponse } from './models/TestConnectionResponse';
 export type { TtlEviction } from './models/TtlEviction';
 export type { Tunnel } from './models/Tunnel';
+export type { UpdateViewChange } from './models/UpdateViewChange';
 export type { UUID } from './models/UUID';
 export type { ValueGrouping } from './models/ValueGrouping';
 export type { VendorPrivateKeyAuthentication } from './models/VendorPrivateKeyAuthentication';
 export type { View } from './models/View';
+export type { ViewChange } from './models/ViewChange';
 export type { ViewExportRequest } from './models/ViewExportRequest';
 export type { ViewRequest } from './models/ViewRequest';
 export type { ViewResponse } from './models/ViewResponse';
 export type { ViewRunRequest } from './models/ViewRunRequest';
 
+export { BranchResourceService } from './services/BranchResourceService';
+export { CommitResourceService } from './services/CommitResourceService';
 export { DataSourceResourceService } from './services/DataSourceResourceService';
 export { HealthResourceService } from './services/HealthResourceService';
 export { ListViewsResourceService } from './services/ListViewsResourceService';

package/models/Branch.ts

@@ -0,0 +1,9 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type Branch = {
+    name: string;
+    headId: string;
+};
+

package/models/BranchResponse.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Branch } from './Branch';
+import type { BranchResponseMetadata } from './BranchResponseMetadata';
+
+export type BranchResponse = {
+    branch: Branch;
+    meta: BranchResponseMetadata | null;
+};
+

package/models/BranchResponseMetadata.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { ViewChange } from './ViewChange';
+
+export type BranchResponseMetadata = {
+    changes: Array<ViewChange>;
+    originCommitId: string;
+};
+

package/models/ComputedView.ts

@@ -10,6 +10,7 @@ export type ComputedView = {
     description: string | null;
     columnDefinitions: Array<PropertySchema>;
     readonly id?: string | null;
+    readonly versionId?: string | null;
     readonly namespaceId?: string | null;
     '@type': 'computed-view';
     query: string;

package/models/CreateViewChange.ts

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

package/models/DeleteViewChange.ts

@@ -0,0 +1,9 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type DeleteViewChange = {
+    '@type': 'delete';
+    id: string;
+};
+

package/models/ListBranchResponse.ts

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

package/models/ListVersionedViewsRequest.ts

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

package/models/MergeBranchRequest.ts

@@ -0,0 +1,9 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type MergeBranchRequest = {
+    commitMessage: string;
+    sourceBranch: string;
+};
+

package/models/TableView.ts

@@ -9,6 +9,7 @@ export type TableView = {
     description: string | null;
     columnDefinitions: Array<PropertySchema>;
     readonly id?: string | null;
+    readonly versionId?: string | null;
     readonly namespaceId?: string | null;
     '@type': 'table-view';
     tableName: string;

package/models/UpdateViewChange.ts

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

package/models/View.ts

@@ -11,6 +11,7 @@ export type View = (ComputedView | TableView | {
     description: string | null;
     columnDefinitions: Array<PropertySchema>;
     readonly id?: string | null;
+    readonly versionId?: string | null;
     readonly namespaceId?: string | null;
 });
 

package/models/ViewChange.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CreateViewChange } from './CreateViewChange';
+import type { DeleteViewChange } from './DeleteViewChange';
+import type { UpdateViewChange } from './UpdateViewChange';
+
+export type ViewChange = (CreateViewChange | UpdateViewChange | DeleteViewChange);
+

package/models/ViewRequest.ts

@@ -12,6 +12,7 @@ export type ViewRequest = {
         description: string | null;
         columnDefinitions: Array<PropertySchema>;
         readonly id?: string | null;
+        readonly versionId?: string | null;
         readonly namespaceId?: string | null;
     });
 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@explo-tech/fido-api",
   "description": "Fido api",
   "homepage": "https://github.com/trust-kaz/fido",
-  "version": "2.7.12",
+  "version": "2.8.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/trust-kaz/fido"

package/services/BranchResourceService.ts

@@ -0,0 +1,90 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { BranchResponse } from '../models/BranchResponse';
+import type { ListBranchResponse } from '../models/ListBranchResponse';
+import type { MergeBranchRequest } from '../models/MergeBranchRequest';
+import type { UUID } from '../models/UUID';
+import type { ViewRequest } from '../models/ViewRequest';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class BranchResourceService {
+
+    /**
+     * Lists all branches
+     * @returns ListBranchResponse The branches
+     * @throws ApiError
+     */
+    public static listBranches(): CancelablePromise<ListBranchResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/branches',
+        });
+    }
+
+    /**
+     * Creates a new branch
+     * @param requestBody Branch to create
+     * @returns BranchResponse The created branch
+     * @throws ApiError
+     */
+    public static createBranch(
+        requestBody: ViewRequest,
+    ): CancelablePromise<BranchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/branches',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+    /**
+     * Gets the branch with the requested id
+     * @param id
+     * @param includeMeta
+     * @returns BranchResponse The requested branch
+     * @throws ApiError
+     */
+    public static getBranch(
+        id: UUID,
+        includeMeta: boolean = false,
+    ): CancelablePromise<BranchResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/branches/{id}',
+            path: {
+                'id': id,
+            },
+            query: {
+                'includeMeta': includeMeta,
+            },
+        });
+    }
+
+    /**
+     * Merge the provided source branch into the provided target branch
+     * @param targetBranchId
+     * @param requestBody Options for merge
+     * @returns BranchResponse The target branch with the new head
+     * @throws ApiError
+     */
+    public static mergeBranch(
+        targetBranchId: string,
+        requestBody: MergeBranchRequest,
+    ): CancelablePromise<BranchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/branches/{targetBranchId}/merge',
+            path: {
+                'targetBranchId': targetBranchId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+}

package/services/CommitResourceService.ts

@@ -0,0 +1,35 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { BranchResponse } from '../models/BranchResponse';
+import type { ViewRequest } from '../models/ViewRequest';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+
+export class CommitResourceService {
+
+    /**
+     * Creates a new commit on the provided branch
+     * @param branchId
+     * @param requestBody Branch to create
+     * @returns BranchResponse The created commit
+     * @throws ApiError
+     */
+    public static createCommit(
+        branchId: string,
+        requestBody: ViewRequest,
+    ): CancelablePromise<BranchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/branches/{branchId}/commits',
+            path: {
+                'branchId': branchId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
+}

package/services/ListViewsResourceService.ts

@@ -1,6 +1,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { ListVersionedViewsRequest } from '../models/ListVersionedViewsRequest';
 import type { ListViewsRequest } from '../models/ListViewsRequest';
 import type { ViewResponse } from '../models/ViewResponse';
 
@@ -11,6 +12,7 @@ import { request as __request } from '../core/request';
 export class ListViewsResourceService {
 
     /**
+     * @deprecated
      * Clones the request set of views
      * @param requestBody View ids to clone
      * @returns any The cloned views
@@ -30,6 +32,7 @@ export class ListViewsResourceService {
     }
 
     /**
+     * @deprecated
      * Gets the requested set of views
      * @param requestBody View ids to get
      * @returns any The requested views
@@ -48,4 +51,23 @@ export class ListViewsResourceService {
         });
     }
 
+    /**
+     * Gets the requested set of views
+     * @param requestBody View ids to get
+     * @returns any The requested views
+     * @throws ApiError
+     */
+    public static listViews(
+        requestBody: ListVersionedViewsRequest,
+    ): CancelablePromise<{
+        views: Array<ViewResponse>;
+    }> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/views/list',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+
 }

package/services/QueryResourceService.ts

@@ -72,6 +72,75 @@ export class QueryResourceService {
         });
     }
 
+    /**
+     * Runs the requested versioned view against the provided data source
+     * @param commit
+     * @param dataSourceId
+     * @param namespaceId
+     * @param viewId
+     * @param requestBody Request options for the export
+     * @returns QueryExportResponse A DataPage of the provided query
+     * @throws ApiError
+     */
+    public static exportVersionedView(
+        commit: string,
+        dataSourceId: UUID,
+        namespaceId: UUID,
+        viewId: UUID,
+        requestBody: ViewExportRequest,
+    ): CancelablePromise<QueryExportResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{dataSourceId}/views/{viewId}/commit/{commit}/export',
+            path: {
+                'commit': commit,
+                'dataSourceId': dataSourceId,
+                'namespaceId': namespaceId,
+                'viewId': viewId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `An error related to the user request`,
+            },
+        });
+    }
+
+    /**
+     * Runs the requested versioned view against the provided data source
+     * @param commit
+     * @param dataSourceId
+     * @param namespaceId
+     * @param viewId
+     * @param requestBody Request options for the query
+     * @returns QueryExecutionResponse A DataPage of the provided query
+     * @throws ApiError
+     */
+    public static runVersionedView(
+        commit: string,
+        dataSourceId: UUID,
+        namespaceId: UUID,
+        viewId: UUID,
+        requestBody: ViewRunRequest,
+    ): CancelablePromise<QueryExecutionResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/v1/namespaces/{namespaceId}/data-sources/{dataSourceId}/views/{viewId}/commit/{commit}/run',
+            path: {
+                'commit': commit,
+                'dataSourceId': dataSourceId,
+                'namespaceId': namespaceId,
+                'viewId': viewId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `An error related to the user request`,
+                503: `An error related to the execution of the request`,
+            },
+        });
+    }
+
     /**
      * Runs the requested view against the provided data source
      * @param dataSourceId

package/services/ViewResourceService.ts

@@ -12,6 +12,7 @@ import { request as __request } from '../core/request';
 export class ViewResourceService {
 
     /**
+     * @deprecated
      * Creates a view
      * @param namespaceId
      * @param requestBody View object to create
@@ -55,6 +56,7 @@ export class ViewResourceService {
     }
 
     /**
+     * @deprecated
      * Updates a view's metadata
      * @param id
      * @param namespaceId
@@ -80,6 +82,7 @@ export class ViewResourceService {
     }
 
     /**
+     * @deprecated
      * Deletes a view
      * @param id
      * @param namespaceId
@@ -100,4 +103,28 @@ export class ViewResourceService {
         });
     }
 
+    /**
+     * Gets a view with the specified version
+     * @param id
+     * @param namespaceId
+     * @param versionId
+     * @returns ViewResponse The requested view
+     * @throws ApiError
+     */
+    public static getVersionedView(
+        id: UUID,
+        namespaceId: UUID,
+        versionId: UUID,
+    ): CancelablePromise<ViewResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/namespaces/{namespaceId}/views/{id}/commit/{versionId}',
+            path: {
+                'id': id,
+                'namespaceId': namespaceId,
+                'versionId': versionId,
+            },
+        });
+    }
+
 }