@squonk/data-manager-client 1.2.3-rc.2 → 1.2.4-rc.1

package/dataset/dataset.d.cts

@@ -0,0 +1,315 @@
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult } from '@tanstack/react-query';
+import { ae as DatasetPutBodyBody, bX as customInstance, bK as DatasetPutPostResponse, bY as ErrorType, bT as DmError, ah as DatasetPostBodyBody, q as GetDatasetsParams, bD as DatasetsGetResponse, p as GetVersionsParams, b0 as DatasetDetail, o as DeleteDatasetParams, at as TaskIdentity, bJ as DatasetDigestGetResponse, bH as DatasetSchemaGetResponse } from '../custom-instance-a2110e78.js';
+import 'axios';
+
+type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
+/**
+ * Using an unmanaged file in a Project as a source a Dataset (or new Dataset Version) is created.
+
+The Dataset is assigned a unique identity if it has no **Parent**. If a Parent Dataset is named during the upload the uploaded file inherits the Parent's identity and is issued with a new unique Version number within the Dataset.
+
+Behaves like the corresponding **POST** method except the file is expected to exist on a Project path.
+
+ * @summary Create a Dataset from a file in a Project
+ */
+declare const createDatasetFromFile: (datasetPutBodyBody: DatasetPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
+declare const getCreateDatasetFromFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+        data: DatasetPutBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<DatasetPutPostResponse, TError, {
+    data: DatasetPutBodyBody;
+}, TContext>;
+type CreateDatasetFromFileMutationResult = NonNullable<Awaited<ReturnType<typeof createDatasetFromFile>>>;
+type CreateDatasetFromFileMutationBody = DatasetPutBodyBody;
+type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
+/**
+* @summary Create a Dataset from a file in a Project
+*/
+declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+        data: DatasetPutBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<DatasetPutPostResponse, TError, {
+    data: DatasetPutBodyBody;
+}, TContext>;
+/**
+* Uploads a dataset.
+
+Dataset file-naming is strictly limited to a fixed set of extensions based on the Dataset **Type**. You can obtain the supported types (and their extensions) via the `/type` endpoint. Filenames that do not comply with the supported filename extensions will be rejected.
+
+Datasets can be uploaded in an uncompressed form, or uploaded pre-compressed using the `.gz` extension.
+
+The Dataset is assigned a unique identity if it has no **Parent**. If a Parent dataset is named during the upload the uploaded file inherits the Parent's identity and is issued with a new unique version number within the Dataset.
+
+Datasets undergo some processing in an asynchronous **Task** after control returns to you. The unique identity of the assigned task (the `task id`) is presented to you in this endpoint's response. Before you can use an uploaded dataset, and before the dataset can be added to any pre-assigned projects, you must wait until the task is complete by making regular calls to the `/task/{task-id}` endpoint. A Dataset upload is complete when the corresponding `task.done` is **true** along with a `task.exit_code` of **0**. If the Dataset upload fails `task.done` will be **true** but the `task.exit_code` will be non-zero.
+
+* @summary Upload an external file as a Dataset
+*/
+declare const uploadDataset: (datasetPostBodyBody: DatasetPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
+declare const getUploadDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+        data: DatasetPostBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<DatasetPutPostResponse, TError, {
+    data: DatasetPostBodyBody;
+}, TContext>;
+type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>;
+type UploadDatasetMutationBody = DatasetPostBodyBody;
+type UploadDatasetMutationError = ErrorType<void | DmError>;
+/**
+* @summary Upload an external file as a Dataset
+*/
+declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
+        data: DatasetPostBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<DatasetPutPostResponse, TError, {
+    data: DatasetPostBodyBody;
+}, TContext>;
+/**
+* Returns datasets that you have access to, whether attached to a project or not.
+
+You will not see Datasets while their upload is still in progress.
+
+Datasets can be filtered by the `owner username`, `mime_type`, a list of `owners`, a list of `editors`, `Labels` or `Label/Value` pairs.
+
+Note that if `editors` are combined with `owner username`, then the datasets will be filtered by owner username first followed by editors (so it's an AND). If `editors` are combined with `owners`, then the result will be datasets filtered by a combination of owners OR editors.
+
+* @summary Get Datasets that are available to you
+*/
+declare const getDatasets: (params?: GetDatasetsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetsGetResponse>;
+declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["data-manager-api", "/dataset", ...GetDatasetsParams[]];
+declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
+    query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
+type GetDatasetsQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Get Datasets that are available to you
+ */
+declare const useGetDatasets: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
+    query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Returns a list of Dataset Versions.
+
+You will not see Datasets while their upload is still in progress.
+
+ * @summary Gets all the Versions of a specific Dataset
+ */
+declare const getVersions: (datasetId: string, params?: GetVersionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDetail>;
+declare const getGetVersionsQueryKey: (datasetId: string, params?: GetVersionsParams) => readonly ["data-manager-api", `/dataset/${string}/versions`, ...GetVersionsParams[]];
+declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
+    query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
+type GetVersionsQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Gets all the Versions of a specific Dataset
+ */
+declare const useGetVersions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
+    query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Given the Dataset `id` and `version` the Dataset will be removed. The API does not prevent you removing a Dataset that's been used in a **Project**. When removed using this endpoint the Dataset is automatically detached from any and all Projects that it was attached to and any corresponding Project Files relating to the Dataset are also removed.
+
+You must be an `editor` or `owner` of the Dataset.
+
+You cannot delete a Dataset until its upload is complete.
+
+ * @summary Delete a Dataset
+ */
+declare const deleteDataset: (datasetId: string, datasetVersion: number, params?: DeleteDatasetParams, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
+declare const getDeleteDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TaskIdentity, TError, {
+        datasetId: string;
+        datasetVersion: number;
+        params?: DeleteDatasetParams | undefined;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<TaskIdentity, TError, {
+    datasetId: string;
+    datasetVersion: number;
+    params?: DeleteDatasetParams | undefined;
+}, TContext>;
+type DeleteDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataset>>>;
+type DeleteDatasetMutationError = ErrorType<void | DmError>;
+/**
+* @summary Delete a Dataset
+*/
+declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TaskIdentity, TError, {
+        datasetId: string;
+        datasetVersion: number;
+        params?: DeleteDatasetParams | undefined;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<TaskIdentity, TError, {
+    datasetId: string;
+    datasetVersion: number;
+    params?: DeleteDatasetParams | undefined;
+}, TContext>;
+/**
+* Given a `dataset_id` the dataset will be returned if available.
+
+You cannot get a Dataset until its upload is complete.
+
+* @summary Download a Dataset
+*/
+declare const downloadDataset: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
+declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/${number}`];
+declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
+type DownloadDatasetQueryError = ErrorType<DmError>;
+/**
+ * @summary Download a Dataset
+ */
+declare const useDownloadDataset: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * The user is removed from the Dataset's `editor` list. The user is removed from all versions of a dataset. You can remove yourself but an `owner` (creator) will always have access to the dataset.
+
+You must be an `editor` or `owner` of the dataset.
+
+You cannot modify Dataset editors until its upload is complete.
+
+ * @summary Remove a user's edit permission for a Dataset
+ */
+declare const removeEditorFromDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getRemoveEditorFromDatasetMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        datasetId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    datasetId: string;
+    userId: string;
+}, TContext>;
+type RemoveEditorFromDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromDataset>>>;
+type RemoveEditorFromDatasetMutationError = ErrorType<DmError>;
+/**
+* @summary Remove a user's edit permission for a Dataset
+*/
+declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        datasetId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    datasetId: string;
+    userId: string;
+}, TContext>;
+/**
+* The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
+
+You must be an `editor` or `owner` of the dataset.
+
+You cannot modify Dataset editors until its upload is complete.
+
+* @summary Give a user edit permission for a Dataset
+*/
+declare const addEditorToDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getAddEditorToDatasetMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        datasetId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    datasetId: string;
+    userId: string;
+}, TContext>;
+type AddEditorToDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToDataset>>>;
+type AddEditorToDatasetMutationError = ErrorType<DmError>;
+/**
+* @summary Give a user edit permission for a Dataset
+*/
+declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        datasetId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    datasetId: string;
+    userId: string;
+}, TContext>;
+/**
+* Returns a dataset ID and version of a dataset that matches the provided SHA256 digest, a 64-character hex string.
+
+* @summary Gets the first Dataset that matches the provided digest
+*/
+declare const getDatasetDigest: (datasetDigest: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDigestGetResponse>;
+declare const getGetDatasetDigestQueryKey: (datasetDigest: string) => readonly ["data-manager-api", `/dataset/digest/${string}`];
+declare const getGetDatasetDigestQueryOptions: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
+    query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetDatasetDigestQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasetDigest>>>;
+type GetDatasetDigestQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Gets the first Dataset that matches the provided digest
+ */
+declare const useGetDatasetDigest: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
+    query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Returns the property schema for a Dataset versions in JSON format (if available).
+
+ * @summary Gets the property schema for a specific Dataset
+ */
+declare const getSchema: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetSchemaGetResponse>;
+declare const getGetSchemaQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/schema/${number}`];
+declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
+type GetSchemaQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Gets the property schema for a specific Dataset
+ */
+declare const useGetSchema: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
+    query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+
+export { AddEditorToDatasetMutationError, AddEditorToDatasetMutationResult, CreateDatasetFromFileMutationBody, CreateDatasetFromFileMutationError, CreateDatasetFromFileMutationResult, DeleteDatasetMutationError, DeleteDatasetMutationResult, DownloadDatasetQueryError, DownloadDatasetQueryResult, GetDatasetDigestQueryError, GetDatasetDigestQueryResult, GetDatasetsQueryError, GetDatasetsQueryResult, GetSchemaQueryError, GetSchemaQueryResult, GetVersionsQueryError, GetVersionsQueryResult, RemoveEditorFromDatasetMutationError, RemoveEditorFromDatasetMutationResult, UploadDatasetMutationBody, UploadDatasetMutationError, UploadDatasetMutationResult, addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasetDigest, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getGetDatasetDigestQueryKey, getGetDatasetDigestQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useGetDatasetDigest, useGetDatasets, useGetSchema, useGetVersions, useRemoveEditorFromDataset, useUploadDataset };

package/dataset/dataset.d.ts

@@ -1,6 +1,6 @@
-import { ae as DatasetPutBodyBody, bX as customInstance, bK as DatasetPutPostResponse, bY as ErrorType, bT as DmError, ah as DatasetPostBodyBody, q as GetDatasetsParams, bD as DatasetsGetResponse, p as GetVersionsParams, b0 as DatasetDetail, o as DeleteDatasetParams, at as TaskIdentity, bJ as DatasetDigestGetResponse, bH as DatasetSchemaGetResponse } from '../custom-instance-50c9dd5d.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult } from '@tanstack/react-query';
+import { ae as DatasetPutBodyBody, bX as customInstance, bK as DatasetPutPostResponse, bY as ErrorType, bT as DmError, ah as DatasetPostBodyBody, q as GetDatasetsParams, bD as DatasetsGetResponse, p as GetVersionsParams, b0 as DatasetDetail, o as DeleteDatasetParams, at as TaskIdentity, bJ as DatasetDigestGetResponse, bH as DatasetSchemaGetResponse } from '../custom-instance-a2110e78.js';
 import 'axios';
 
 type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
@@ -25,6 +25,9 @@ declare const getCreateDatasetFromFileMutationOptions: <TError = ErrorType<void
 type CreateDatasetFromFileMutationResult = NonNullable<Awaited<ReturnType<typeof createDatasetFromFile>>>;
 type CreateDatasetFromFileMutationBody = DatasetPutBodyBody;
 type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
+/**
+* @summary Create a Dataset from a file in a Project
+*/
 declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
         data: DatasetPutBodyBody;
@@ -34,7 +37,7 @@ declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TCo
     data: DatasetPutBodyBody;
 }, TContext>;
 /**
- * Uploads a dataset.
+* Uploads a dataset.
 
 Dataset file-naming is strictly limited to a fixed set of extensions based on the Dataset **Type**. You can obtain the supported types (and their extensions) via the `/type` endpoint. Filenames that do not comply with the supported filename extensions will be rejected.
 
@@ -44,8 +47,8 @@ The Dataset is assigned a unique identity if it has no **Parent**. If a Parent d
 
 Datasets undergo some processing in an asynchronous **Task** after control returns to you. The unique identity of the assigned task (the `task id`) is presented to you in this endpoint's response. Before you can use an uploaded dataset, and before the dataset can be added to any pre-assigned projects, you must wait until the task is complete by making regular calls to the `/task/{task-id}` endpoint. A Dataset upload is complete when the corresponding `task.done` is **true** along with a `task.exit_code` of **0**. If the Dataset upload fails `task.done` will be **true** but the `task.exit_code` will be non-zero.
 
- * @summary Upload an external file as a Dataset
- */
+* @summary Upload an external file as a Dataset
+*/
 declare const uploadDataset: (datasetPostBodyBody: DatasetPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
 declare const getUploadDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
@@ -58,6 +61,9 @@ declare const getUploadDatasetMutationOptions: <TError = ErrorType<void | DmErro
 type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>;
 type UploadDatasetMutationBody = DatasetPostBodyBody;
 type UploadDatasetMutationError = ErrorType<void | DmError>;
+/**
+* @summary Upload an external file as a Dataset
+*/
 declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<DatasetPutPostResponse, TError, {
         data: DatasetPostBodyBody;
@@ -67,7 +73,7 @@ declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext =
     data: DatasetPostBodyBody;
 }, TContext>;
 /**
- * Returns datasets that you have access to, whether attached to a project or not.
+* Returns datasets that you have access to, whether attached to a project or not.
 
 You will not see Datasets while their upload is still in progress.
 
@@ -75,8 +81,8 @@ Datasets can be filtered by the `owner username`, `mime_type`, a list of `owners
 
 Note that if `editors` are combined with `owner username`, then the datasets will be filtered by owner username first followed by editors (so it's an AND). If `editors` are combined with `owners`, then the result will be datasets filtered by a combination of owners OR editors.
 
- * @summary Get Datasets that are available to you
- */
+* @summary Get Datasets that are available to you
+*/
 declare const getDatasets: (params?: GetDatasetsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetsGetResponse>;
 declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["data-manager-api", "/dataset", ...GetDatasetsParams[]];
 declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
@@ -87,6 +93,9 @@ declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError =
 };
 type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
 type GetDatasetsQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Get Datasets that are available to you
+ */
 declare const useGetDatasets: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
     query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -110,6 +119,9 @@ declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = Error
 };
 type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
 type GetVersionsQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Gets all the Versions of a specific Dataset
+ */
 declare const useGetVersions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
     query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -140,6 +152,9 @@ declare const getDeleteDatasetMutationOptions: <TError = ErrorType<void | DmErro
 }, TContext>;
 type DeleteDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataset>>>;
 type DeleteDatasetMutationError = ErrorType<void | DmError>;
+/**
+* @summary Delete a Dataset
+*/
 declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<TaskIdentity, TError, {
         datasetId: string;
@@ -153,12 +168,12 @@ declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext =
     params?: DeleteDatasetParams | undefined;
 }, TContext>;
 /**
- * Given a `dataset_id` the dataset will be returned if available.
+* Given a `dataset_id` the dataset will be returned if available.
 
 You cannot get a Dataset until its upload is complete.
 
- * @summary Download a Dataset
- */
+* @summary Download a Dataset
+*/
 declare const downloadDataset: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
 declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/${number}`];
 declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
@@ -169,6 +184,9 @@ declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<
 };
 type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
 type DownloadDatasetQueryError = ErrorType<DmError>;
+/**
+ * @summary Download a Dataset
+ */
 declare const useDownloadDataset: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
     query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -197,6 +215,9 @@ declare const getRemoveEditorFromDatasetMutationOptions: <TError = ErrorType<DmE
 }, TContext>;
 type RemoveEditorFromDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromDataset>>>;
 type RemoveEditorFromDatasetMutationError = ErrorType<DmError>;
+/**
+* @summary Remove a user's edit permission for a Dataset
+*/
 declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         datasetId: string;
@@ -208,14 +229,14 @@ declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError>, TContext
     userId: string;
 }, TContext>;
 /**
- * The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
+* The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
 
 You must be an `editor` or `owner` of the dataset.
 
 You cannot modify Dataset editors until its upload is complete.
 
- * @summary Give a user edit permission for a Dataset
- */
+* @summary Give a user edit permission for a Dataset
+*/
 declare const addEditorToDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
 declare const getAddEditorToDatasetMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
@@ -229,6 +250,9 @@ declare const getAddEditorToDatasetMutationOptions: <TError = ErrorType<DmError>
 }, TContext>;
 type AddEditorToDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToDataset>>>;
 type AddEditorToDatasetMutationError = ErrorType<DmError>;
+/**
+* @summary Give a user edit permission for a Dataset
+*/
 declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         datasetId: string;
@@ -240,10 +264,10 @@ declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = un
     userId: string;
 }, TContext>;
 /**
- * Returns a dataset ID and version of a dataset that matches the provided SHA256 digest, a 64-character hex string.
+* Returns a dataset ID and version of a dataset that matches the provided SHA256 digest, a 64-character hex string.
 
- * @summary Gets the first Dataset that matches the provided digest
- */
+* @summary Gets the first Dataset that matches the provided digest
+*/
 declare const getDatasetDigest: (datasetDigest: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDigestGetResponse>;
 declare const getGetDatasetDigestQueryKey: (datasetDigest: string) => readonly ["data-manager-api", `/dataset/digest/${string}`];
 declare const getGetDatasetDigestQueryOptions: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
@@ -254,6 +278,9 @@ declare const getGetDatasetDigestQueryOptions: <TData = DatasetDigestGetResponse
 };
 type GetDatasetDigestQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasetDigest>>>;
 type GetDatasetDigestQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Gets the first Dataset that matches the provided digest
+ */
 declare const useGetDatasetDigest: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
     query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -275,6 +302,9 @@ declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TErro
 };
 type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
 type GetSchemaQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Gets the property schema for a specific Dataset
+ */
 declare const useGetSchema: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
     query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;