@squonk/data-manager-client 1.1.7-rc.2 → 1.1.7

package/src/data-manager-api.schemas.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 export type AdminGetServiceErrorsParams = {
   /**
@@ -469,13 +469,13 @@ export type UserAccountPatchBodyBody = {
   /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
    */
   private?: boolean;
-  /** For **admin** accounts, if set the user account is able to read anything, i.e. `GET` API calls (i.e. endpoints that do not change the Data Manager state) behave as though the caller is acting as *everyone*. An **admin** user would set ths parameter in order to browse the system, and then switch to `impersonate` mode in order to change things as the chosen user
+  /** For `admin` accounts, if set the user account is able to read anything, i.e. `GET` API calls (i.e. endpoints that do not change the Data Manager state) behave as though the caller is acting as *everyone*. An `admin` user would set ths parameter in order to browse the system, and then switch to `impersonate` mode in order to change things as the chosen user
    */
   become_admin?: boolean;
-  /** For **admin** accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
+  /** For `admin` accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
    */
   impersonate?: string;
-  /** For **admin** accounts, if this is set the account for the user being impersonated is patched, rather then the user's own account. To use this you must have a value for `impersonate`
+  /** For `admin` accounts, if this is set the account for the user being impersonated is patched, rather then the user's own account. To use this you must have a value for `impersonate`
    */
   use_impersonation?: boolean;
 };
@@ -1210,7 +1210,7 @@ The initial phase, indicating that the Instance is preparing to run, is `PENDING
   /** The data and time (UTC) the instance stopped running
    */
   stopped?: string;
-  /** The time the instance has spent running in the cluster. It's a string representation of a Python timedelta object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
+  /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta`` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
    */
   run_time: string;
   /** The application instance owner, the person who launched the application and is the only user than can stop it.
@@ -1222,7 +1222,7 @@ The initial phase, indicating that the Instance is preparing to run, is `PENDING
   /** The Instance name
    */
   name: string;
-  /** For applications (not Jobs) this is the URL the application has exposed. It will ponly be available when the application has started.
+  /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
    */
   url?: string;
   /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.

package/src/dataset/dataset.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -43,9 +43,9 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Using an unmanaged file in a Project as a source a Dataset (or new Dataset version) is created.
+ * 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.
+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.
 
@@ -146,13 +146,13 @@ export const useCreateDatasetFromFile = <
 /**
  * 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.
+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.
+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.
+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
  */
@@ -252,7 +252,7 @@ export const useUploadDataset = <
 
 You will not see Datasets while their upload is still in progress.
 
-Datasets can be filtered by: 1. `owner username`, 2. `mime_type`, 3. a list of `owners` (a subset of the above) 4. a list of `editors` (a subset of the above) 5. `Labels` or `Label/Value` pairs (a subset of the above)
+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.
 
@@ -330,11 +330,11 @@ export const useGetDatasets = <
 };
 
 /**
- * Returns a list of Dataset versions.
+ * 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
+ * @summary Gets all the Versions of a specific Dataset
  */
 export const getVersions = (
   datasetId: string,
@@ -661,7 +661,7 @@ export const useRemoveEditorFromDataset = <
   return useMutation(mutationOptions);
 };
 /**
- * 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.
 

package/src/exchange-rate/exchange-rate.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -126,11 +126,11 @@ export const useGetAllApplicationExchangeRates = <
 };
 
 /**
- * Sets the Exchange Rate for a specific Application. The rate replaces any exising rate for the application and applies to all future executions of the Application.
+ * Sets the Exchange Rate for a specific Application. The rate replaces any existing rate for the Application and applies to all future executions of the Application.
 
 If an Application has no specific rate it adopts the current value of the default Application Exchange Rate.
 
-You need admin privilege to use this method.
+You need `admin` privilege to use this method.
 
  * @summary Sets the Exchange Rate for a specific Application
  */
@@ -390,11 +390,11 @@ export const useGetAllJobExchangeRates = <
 };
 
 /**
- * Sets the Exchange Rate for a specific job. The rate replaces any existing rate for the Job and applies immediately and future job executions for this jon will inherit this rate.
+ * Sets the Exchange Rate for a specific job. The rate replaces any existing rate for the Job and applies immediately and future job executions for this Job will inherit this rate.
 
 If a Job has no specific rate it adopts the current value of the default Job Exchange Rate.
 
-You need admin privilege to use this method.
+You need `admin` privilege to use this method.
 
  * @summary Sets the Exchange Rate for a specific Job
  */

package/src/file/file.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -113,13 +113,13 @@ export const useGetFiles = <
 };
 
 /**
- * Given a Project and a Dataset the Dataset will be attached (added) to the project as a File using the format provided. When attached the Dataset is referred to as a Project **file**. As format conversion may take some time the file may not be immediately available. You should use the `task_id` you're presented with on the **\/task** endpoint to determine when the file is available to the project.
+ * Given a Project and a Dataset the Dataset will be attached (added) to the project as a File using the format provided. When attached the Dataset is referred to as a Project **File**. As format conversion may take some time the file may not be immediately available. You should use the `task_id` you're presented with on the `/task` endpoint to determine when the file is available to the project.
 
-Only datasets attached to projects are available through the Project API. A dataset that you upload to the **Data Manager** is only available to others (who are not already `editors` of the data) when the dataset is attached to a project.
+Only Datasets attached to projects are available through the Project API. A Dataset that you upload is only available to others (who are not already `editors` of the data) when the Dataset is attached to a project.
 
 An `editor` of a **dataset** is not automatically and `editor` of the **project** it's attached to.
 
-You must be an `editor` or the `owner` of the project to attach a dataset to a project. Being an `editor` of the dataset you are attaching does not give you the ability to detach it from the project.
+You must be an `editor` or the `owner` of the project to attach a Dataset to a project. Being an `editor` of the Dataset you are attaching does not give you the ability to detach it from the Project.
 
 You cannot add a Dataset to a Project until its upload is complete.
 
@@ -282,13 +282,13 @@ export const useDeleteUnmanagedFile = <
   return useMutation(mutationOptions);
 };
 /**
- * Given a `file_id` the file will be removed from the project it's attached to.
+ * Given a `file_id` the file will be removed from the Project it's attached to.
 
-You must be an `editor` or the `owner` of the project to delete a file from a project. Being an `editor` of the original dataset does not give you the ability to detach it from the project.
+You must be an `editor` or the `owner` of the project to delete a file from a Project. Being an `editor` of the original Dataset does not give you the ability to detach it from the Project.
 
 You cannot delete a Project File until the attach is complete.
 
- * @summary Delete/detach a File (from a project)
+ * @summary Delete/detach a File (from a Project)
  */
 export const deleteFile = (
   fileId: string,

package/src/instance/instance.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -44,9 +44,9 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
 
 Instance behaviour is controlled using the `specification`. You will need to consult individual applications to determine what can be placed in the specification. Applications typically provide a `template` describing its **options**.
 
-An Application instance is not Ready for use until the corresponding **TaskState** is `STARTED`.
+An Application instance is not Ready for use until the corresponding **TaskState** is _STARTED_.
 
-A Job instance typically runs to completion, reaching the **TaskState** `SUCCESS` when successful and `FAILURE` is unsuccessful.
+A Job instance typically runs to completion, reaching the **TaskState** _SUCCESS_ when successful and _FAILURE_ is unsuccessful.
 
  * @summary Creates a new Job or Application instance
  */
@@ -231,7 +231,7 @@ export const useGetInstances = <
 
 The test result is only valid at the time of the call, whether an actual instance would start or not will require an identical call to `/instance POST`.
 
- * @summary Used to attempt the execution of new Job or Application instance
+ * @summary Used to check the execution of new Job or Application instance
  */
 export const dryRunInstance = (
   instancePostBodyBody: InstancePostBodyBody,
@@ -334,9 +334,7 @@ export const useDryRunInstance = <
   return useMutation(mutationOptions);
 };
 /**
- * The instance information will be returned if available.
-
- * @summary Get detailed information about a specific instance
+ * @summary Get detailed information about an Instance
  */
 export const getInstance = (
   instanceId: string,
@@ -410,11 +408,11 @@ export const useGetInstance = <
 };
 
 /**
- * The Application or Job instance is terminated.
+ * The Application or Job Instance is terminated.
 
-You must be the `owner` or an `editor` of the instance to delete it
+You must be the `owner` or an `editor` of the Instance to delete it
 
- * @summary Delete a Job or Application instance
+ * @summary Delete a Job or Application Instance
  */
 export const terminateInstance = (
   instanceId: string,
@@ -480,11 +478,11 @@ export const useTerminateInstance = <
   return useMutation(mutationOptions);
 };
 /**
- * The Application or Job instance is updated according to the patch parameters.
+ * The Application or Job Instance is updated according to the patch parameters.
 
-You must be the `owner` or an `editor` of the instance to patch it
+You must be the `owner` or an `editor` of the Instance to patch it
 
- * @summary Update a Job or Application instance
+ * @summary Update a Job or Application Instance
  */
 export const patchInstance = (
   instanceId: string,
@@ -557,7 +555,7 @@ Tokens automatically expire after a period of time but can be revoked instantly
 
 The remote system will revoke the token when it's finished with it
 
- * @summary Delete (revoke) the instance token
+ * @summary Delete (revoke) the Instance Token
  */
 export const deleteInstanceToken = (
   instanceId: string,

package/src/job/job.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery } from "@tanstack/react-query";
 import type {
@@ -35,9 +35,9 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Get a list of all jobs available to you  that can be instantiated via the `/instance` endpoint.
+ * Get a list of all Jobs available to you that can be instantiated via the `/instance` endpoint.
 
-Job availability will vary as Jobs are added to the cluster.
+Job availability will vary as Jobs are added to the service.
 
  * @summary Get all Jobs available to you
  */
@@ -107,7 +107,7 @@ export const useGetJobs = <
 /**
  * Gets a Job based on its **collection**, **job** and **version**.
 
-Job availability will vary as Jobs are added to the cluster. Jobs that have been added are unlikely to be removed.
+Job availability will vary as Jobs are added to the service. Jobs that have been added are unlikely to be removed.
 
  * @summary Get a Job by its version
  */
@@ -185,7 +185,7 @@ export const useGetJobByVersion = <
 };
 
 /**
- * Get details of a specific job available to you that can be instantiated.
+ * Get details of a specific Job available to you that can be instantiated.
 
 To run a job you need to use the `/instance` endpoint. The Job is controlled through the `specification` field, a JSON string. You will need to identify the Job using its `collection`, `job` and `version` as well as providing any variables in the specification required by the Job's command.
 

package/src/metadata/metadata.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -35,7 +35,7 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Update parameters or add new annotations of the specified type(s) and to the metadata for the version of the dataset.
+ * Update parameters or add new annotations of the specified type(s) and to the Metadata for a **Dataset Version**.
 
 The parameters are provided in a list in keyword/arguments
 
@@ -141,9 +141,9 @@ export const useAddMetadataVersion = <
   return useMutation(mutationOptions);
 };
 /**
- * Returns the metadata for a Dataset version in JSON format.
+ * Returns the Metadata for a **Dataset Version** in JSON format.
 
- * @summary Gets the Metadata for a specific Dataset version
+ * @summary Gets the Metadata for a specific Dataset Version
  */
 export const getMetadataVersion = (
   datasetId: string,
@@ -240,8 +240,10 @@ export const useGetMetadataVersion = <
 };
 
 /**
- * Update default parameters or add new labels to the metadata for the dataset.
+ * Update default parameters or add new labels to the Metadata for the Dataset.
+
 The parameters are provided in a list in keyword/arguments
+
 The labels are provided in a list in JSON format. For details of the label format, see the data-manager-metadata library,
 
  * @summary Update Metadata for the Dataset
@@ -324,7 +326,7 @@ export const useAddMetadata = <
   return useMutation(mutationOptions);
 };
 /**
- * Returns the metadata for a Dataset in JSON format.
+ * Returns the Metadata for a Dataset in JSON format.
 
  * @summary Gets the Metadata for a specific Dataset
  */

package/src/project/project.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -42,9 +42,7 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Get a list of all Projects available to you.
-
- * @summary Get all Pojects available to you
+ * @summary Get all Projects available to you
  */
 export const getProjects = (
   params?: GetProjectsParams,
@@ -120,11 +118,11 @@ export const useGetProjects = <
 /**
  * Creates a new Project, assigning and returning a unique **ID**. A persistent volume is created in the cluster and assigned to your Project. It's here you can add **Datasets** as **Files** and run **Applications** and **Jobs**.
 
-To create a Project you will need an uncommitted Project product.
+To create a Project when an **Account Server** is configured you will need a **Product**.
 
-As the project `owner` (creator) you are also automatically an `editor` of the project and can add other users as editors so that they can also manipulate the project. An `editor` of a project can also delete it.
+As the Project `owner` (creator) you are also automatically an `editor` of the Project and can add other users as **Editors** so that they can also manipulate the project. An **Editor** of a project can also delete it.
 
-The name you give the project is free-form text (can contain spaces etc.). The name you use must be unique amongst all the projects you create.
+The name you give the Project is free-form text (can contain spaces etc.) but the name you use must be unique amongst all the Projects you create.
 
  * @summary Create a new Project
  */
@@ -204,7 +202,7 @@ export const useCreateProject = <
   return useMutation(mutationOptions);
 };
 /**
- * Gets the details of a project that is available to you.
+ * Gets the details of a Project that is available to you.
 
  * @summary Get a Project
  */
@@ -280,7 +278,7 @@ export const useGetProject = <
 };
 
 /**
- * Used to update some adjustable parameters of a Project, i.e. to make it Private or make it Public. What can be adjusted will depend on the purchased product
+ * Used to update some adjustable parameters of a Project, i.e. to make it `private` or make it `public``. What can be adjusted will depend on the purchased **Product**
 
  * @summary Adjust an existing Project
  */
@@ -362,11 +360,11 @@ export const usePatchProject = <
   return useMutation(mutationOptions);
 };
 /**
- * Deletes an existing project.
+ * Deletes an existing Project.
 
 You must be an `editor` or the `owner` of the project.
 
-Once deleted all **Files**, working directories and material in the project will also be removed
+Once deleted all **Files**, working directories and material in the Project will also be removed
 
  * @summary Delete a Project
  */
@@ -434,7 +432,7 @@ export const useDeleteProject = <
   return useMutation(mutationOptions);
 };
 /**
- * Adds a user to a project as an `editor`. Editors can add and remove datasets in a project and delete the project.
+ * Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
 
 An `editor` of a project is not automatically an `editor` of any datasets the project contains.
 
@@ -507,7 +505,7 @@ export const useAddEditorToProject = <
   return useMutation(mutationOptions);
 };
 /**
- * Deletes a project `editor`. The editor can be you but you cannot delete the last `editor`
+ * Deletes a project `editor`. The editor can be you.
 
 A project must always have one `editor` so you will not be able to delete the last editor of a project.
 
@@ -580,7 +578,7 @@ export const useRemoveEditorFromProject = <
   return useMutation(mutationOptions);
 };
 /**
- * Adds a user to a project as an `observer`. Observers can view Projects and download files but they cannot modify Project data or run Applications or Jobs.
+ * Adds a user to a project as an `observer`. Observers can view Projects and download files but they cannot modify Project data or run **Applications** or **Jobs**.
 
 You must be an `editor` or the `owner` of the Project to add Observers
 
@@ -726,7 +724,7 @@ export const useRemoveObserverFromProject = <
 
 For **managed** files you should consider using the `/file/{file_id}` endpoint.
 
-You must be an `editor` or the `owner` of the project if the project is private
+You must be an `editor` or the `owner` of the Project if the Project is `private`
 
  * @summary Download a Project file
  */
@@ -903,7 +901,7 @@ export const useAddFileToProject = <
 
 For **managed** files you should consider using the `/file/{file_id}` endpoint.
 
-As there is no security You must provide a valid token. The token must be a token valid for the project, usually generated when an Instance has been launched in the Project. If the token is not valid ou will receive a `403` error
+As there is no authentication for this endpoint you must provide a valid token. The token must be a token valid for the project, usually generated when an **Instance** has been launched in the Project.
 
  * @summary Download a Project file using a Token
  */

package/src/task/task.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -36,7 +36,7 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Returns a list of tasks that you have access to.
+ * Returns a list of Tasks that you have access to.
 
  * @summary Returns a list of Tasks
  */
@@ -116,19 +116,19 @@ export const useGetTasks = <
 
 You can only retrieve a Task if you have access to it. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.
 
-Tasks are created in response to creating datasets and launching applications.
+Tasks are created in response to creating Datasets and launching **Applications** and **Jobs**.
 
-Tasks contain of a list of `states` and `events`. A task will always have states but may not have events.
+Tasks contain of a list of `states` and `events`. A Task will always have `states` but may not have `events`.
 
-States and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 100 events are returned.
+States and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 500 events are returned.
 
 You can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.
 
-**Dataset** tasks must be allowed to complete successfully before you can expect a it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.
+**Dataset** tasks must be allowed to complete successfully before you can expect it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.
 
-For **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The dataset is available when the task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the task is `done` but you have a non-zero `exit_code`, the dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.
+For **Dataset** Tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The Dataset is available when the Task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the Task is `done` but you have a non-zero `exit_code`, the Dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.
 
-For Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.
+For Application **Instance** Tasks, where the Task `purpose` is `INSTANCE`, you must wait until you find the _STARTED_ state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.
 
  * @summary Returns Task information
  */
@@ -203,7 +203,7 @@ export const useGetTask = <
 
 You cannot delete a Task until it is `done`.
 
-You must be an **owner** of the Task action to delete it. For example you must be the owner of the Dataset to delete **DATASET** tasks and an owner of the ProjectFile to delete **FILE** tasks.
+You must be an `owner` of the Task to delete it. For example you must be the `owner` of the Dataset to delete **DATASET** Tasks and an `owner` of the ProjectFile to delete **FILE** Tasks.
 
  * @summary Delete a Task entry
  */

package/src/type/type.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery } from "@tanstack/react-query";
 import type {

package/src/user/user.ts

@@ -6,7 +6,7 @@
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 1.0
+ * OpenAPI spec version: 1.1
  */
 import { useQuery, useMutation } from "@tanstack/react-query";
 import type {
@@ -38,9 +38,9 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * Returns a summary of all users that have accessed the Data Manager API and where the account is not **private**. Users can set their accounts to be private and therefor do not show up in methods like this
+ * Returns a summary of all users that have accessed the Data Manager API and where the account is not `private`. Users can set their accounts to be private and therefore will not show up in methods like this
 
- * @summary Get information about all known users
+ * @summary Get information about all known Users
  */
 export const getUsers = (
   options?: SecondParameter<typeof customInstance>,
@@ -98,8 +98,6 @@ export const useGetUsers = <
 };
 
 /**
- * Returns a summary of your account
-
  * @summary Get information about your account
  */
 export const getUserAccount = (
@@ -176,8 +174,6 @@ export const useGetUserAccount = <
 };
 
 /**
- * Make changes to your user account
-
  * @summary Patch your account
  */
 export const patchUserAccount = (

package/task/task.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/task/task.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAgC/B,IAAM,WAAW,CACtB,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,WAClC,CAAC,oBAAoB,SAAS,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAEpD,IAAM,0BAA0B,CAIrC,QACA,YAUG;AACH,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,oBAAoB,MAAM;AAErE,QAAM,UAA+D,CAAC;AAAA,IACpE;AAAA,EACF,MAAM,SAAS,QAAQ,gBAAgB,MAAM;AAE7C,SAAO,EAAE,UAAU,SAAS,GAAG,aAAa;AAC9C;AAOO,IAAM,cAAc,CAIzB,QACA,YAQ2D;AAC3D,QAAM,eAAe,wBAAwB,QAAQ,OAAO;AAE5D,QAAM,QAAQ,SAAS,YAAY;AAInC,QAAM,WAAW,aAAa;AAE9B,SAAO;AACT;AAuBO,IAAM,UAAU,CACrB,QACA,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,OAAO,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AACF;AAEO,IAAM,qBAAqB,CAAC,QAAgB,WACjD,CAAC,oBAAoB,SAAS,UAAU,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAE9D,IAAM,yBAAyB,CAIpC,QACA,QACA,YAMG;AACH,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,mBAAmB,QAAQ,MAAM;AAE5E,QAAM,UAA8D,CAAC;AAAA,IACnE;AAAA,EACF,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,MAAM;AAEpD,SAAO,EAAE,UAAU,SAAS,SAAS,CAAC,CAAC,QAAQ,GAAG,aAAa;AACjE;AAOO,IAAM,aAAa,CAIxB,QACA,QACA,YAI2D;AAC3D,QAAM,eAAe,uBAAuB,QAAQ,QAAQ,OAAO;AAEnE,QAAM,QAAQ,SAAS,YAAY;AAInC,QAAM,WAAW,aAAa;AAE9B,SAAO;AACT;AAWO,IAAM,aAAa,CACxB,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,SAAS;AAAA,IAC3C;AAAA,EACF;AACF;AAEO,IAAM,+BAA+B,CAG1C,YAaG;AACH,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,WAAW,QAAQ,cAAc;AAAA,EAC1C;AAEA,SAAO,EAAE,YAAY,GAAG,gBAAgB;AAC1C;AAQO,IAAM,gBAAgB,CAG3B,YAQI;AACJ,QAAM,kBAAkB,6BAA6B,OAAO;AAE5D,SAAO,YAAY,eAAe;AACpC","sourcesContent":["/**\n * Generated by orval v6.15.0 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"@tanstack/react-query\";\nimport type {\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"@tanstack/react-query\";\nimport type {\n  TasksGetResponse,\n  DmError,\n  GetTasksParams,\n  TaskGetResponse,\n  GetTaskParams,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Returns a list of tasks that you have access to.\n\n * @summary Returns a list of Tasks\n */\nexport const getTasks = (\n  params?: GetTasksParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TasksGetResponse>(\n    { url: `/task`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTasksQueryKey = (params?: GetTasksParams) =>\n  [\"data-manager-api\", `/task`, ...(params ? [params] : [])] as const;\n\nexport const getGetTasksQueryOptions = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryOptions<Awaited<ReturnType<typeof getTasks>>, TError, TData> & {\n  queryKey: QueryKey;\n} => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTasksQueryKey(params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTasks>>> = ({\n    signal,\n  }) => getTasks(params, requestOptions, signal);\n\n  return { queryKey, queryFn, ...queryOptions };\n};\n\nexport type GetTasksQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTasks>>\n>;\nexport type GetTasksQueryError = ErrorType<void | DmError>;\n\nexport const useGetTasks = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const queryOptions = getGetTasksQueryOptions(params, options);\n\n  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {\n    queryKey: QueryKey;\n  };\n\n  query.queryKey = queryOptions.queryKey;\n\n  return query;\n};\n\n/**\n * Returns Task information including its states and events.\n\nYou can only retrieve a Task if you have access to it. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.\n\nTasks are created in response to creating datasets and launching applications.\n\nTasks contain of a list of `states` and `events`. A task will always have states but may not have events.\n\nStates and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 100 events are returned.\n\nYou can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.\n\n**Dataset** tasks must be allowed to complete successfully before you can expect a it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.\n\nFor **Dataset** tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The dataset is available when the task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the task is `done` but you have a non-zero `exit_code`, the dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.\n\nFor Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you must wait until you find the `STARTED` state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.\n\n * @summary Returns Task information\n */\nexport const getTask = (\n  taskId: string,\n  params?: GetTaskParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TaskGetResponse>(\n    { url: `/task/${taskId}`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) =>\n  [\"data-manager-api\", `/task/${taskId}`, ...(params ? [params] : [])] as const;\n\nexport const getGetTaskQueryOptions = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData> & {\n  queryKey: QueryKey;\n} => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTask>>> = ({\n    signal,\n  }) => getTask(taskId, params, requestOptions, signal);\n\n  return { queryKey, queryFn, enabled: !!taskId, ...queryOptions };\n};\n\nexport type GetTaskQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTask>>\n>;\nexport type GetTaskQueryError = ErrorType<void | DmError>;\n\nexport const useGetTask = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const queryOptions = getGetTaskQueryOptions(taskId, params, options);\n\n  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {\n    queryKey: QueryKey;\n  };\n\n  query.queryKey = queryOptions.queryKey;\n\n  return query;\n};\n\n/**\n * Given a `task_id` the Task will be removed.\n\nYou cannot delete a Task until it is `done`.\n\nYou must be an **owner** of the Task action to delete it. For example you must be the owner of the Dataset to delete **DATASET** tasks and an owner of the ProjectFile to delete **FILE** tasks.\n\n * @summary Delete a Task entry\n */\nexport const deleteTask = (\n  taskId: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<void>(\n    { url: `/task/${taskId}`, method: \"delete\" },\n    options\n  );\n};\n\nexport const getDeleteTaskMutationOptions = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}): UseMutationOptions<\n  Awaited<ReturnType<typeof deleteTask>>,\n  TError,\n  { taskId: string },\n  TContext\n> => {\n  const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n  const mutationFn: MutationFunction<\n    Awaited<ReturnType<typeof deleteTask>>,\n    { taskId: string }\n  > = (props) => {\n    const { taskId } = props ?? {};\n\n    return deleteTask(taskId, requestOptions);\n  };\n\n  return { mutationFn, ...mutationOptions };\n};\n\nexport type DeleteTaskMutationResult = NonNullable<\n  Awaited<ReturnType<typeof deleteTask>>\n>;\n\nexport type DeleteTaskMutationError = ErrorType<DmError>;\n\nexport const useDeleteTask = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const mutationOptions = getDeleteTaskMutationOptions(options);\n\n  return useMutation(mutationOptions);\n};\n"]}
+{"version":3,"sources":["../../src/task/task.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAgC/B,IAAM,WAAW,CACtB,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC9C;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,WAClC,CAAC,oBAAoB,SAAS,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAEpD,IAAM,0BAA0B,CAIrC,QACA,YAUG;AACH,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,oBAAoB,MAAM;AAErE,QAAM,UAA+D,CAAC;AAAA,IACpE;AAAA,EACF,MAAM,SAAS,QAAQ,gBAAgB,MAAM;AAE7C,SAAO,EAAE,UAAU,SAAS,GAAG,aAAa;AAC9C;AAOO,IAAM,cAAc,CAIzB,QACA,YAQ2D;AAC3D,QAAM,eAAe,wBAAwB,QAAQ,OAAO;AAE5D,QAAM,QAAQ,SAAS,YAAY;AAInC,QAAM,WAAW,aAAa;AAE9B,SAAO;AACT;AAuBO,IAAM,UAAU,CACrB,QACA,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,OAAO,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AACF;AAEO,IAAM,qBAAqB,CAAC,QAAgB,WACjD,CAAC,oBAAoB,SAAS,UAAU,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAE9D,IAAM,yBAAyB,CAIpC,QACA,QACA,YAMG;AACH,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,mBAAmB,QAAQ,MAAM;AAE5E,QAAM,UAA8D,CAAC;AAAA,IACnE;AAAA,EACF,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,MAAM;AAEpD,SAAO,EAAE,UAAU,SAAS,SAAS,CAAC,CAAC,QAAQ,GAAG,aAAa;AACjE;AAOO,IAAM,aAAa,CAIxB,QACA,QACA,YAI2D;AAC3D,QAAM,eAAe,uBAAuB,QAAQ,QAAQ,OAAO;AAEnE,QAAM,QAAQ,SAAS,YAAY;AAInC,QAAM,WAAW,aAAa;AAE9B,SAAO;AACT;AAWO,IAAM,aAAa,CACxB,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,SAAS,UAAU,QAAQ,SAAS;AAAA,IAC3C;AAAA,EACF;AACF;AAEO,IAAM,+BAA+B,CAG1C,YAaG;AACH,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,WAAW,QAAQ,cAAc;AAAA,EAC1C;AAEA,SAAO,EAAE,YAAY,GAAG,gBAAgB;AAC1C;AAQO,IAAM,gBAAgB,CAG3B,YAQI;AACJ,QAAM,kBAAkB,6BAA6B,OAAO;AAE5D,SAAO,YAAY,eAAe;AACpC","sourcesContent":["/**\n * Generated by orval v6.15.0 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.1\n */\nimport { useQuery, useMutation } from \"@tanstack/react-query\";\nimport type {\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"@tanstack/react-query\";\nimport type {\n  TasksGetResponse,\n  DmError,\n  GetTasksParams,\n  TaskGetResponse,\n  GetTaskParams,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Returns a list of Tasks that you have access to.\n\n * @summary Returns a list of Tasks\n */\nexport const getTasks = (\n  params?: GetTasksParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TasksGetResponse>(\n    { url: `/task`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTasksQueryKey = (params?: GetTasksParams) =>\n  [\"data-manager-api\", `/task`, ...(params ? [params] : [])] as const;\n\nexport const getGetTasksQueryOptions = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryOptions<Awaited<ReturnType<typeof getTasks>>, TError, TData> & {\n  queryKey: QueryKey;\n} => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTasksQueryKey(params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTasks>>> = ({\n    signal,\n  }) => getTasks(params, requestOptions, signal);\n\n  return { queryKey, queryFn, ...queryOptions };\n};\n\nexport type GetTasksQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTasks>>\n>;\nexport type GetTasksQueryError = ErrorType<void | DmError>;\n\nexport const useGetTasks = <\n  TData = Awaited<ReturnType<typeof getTasks>>,\n  TError = ErrorType<void | DmError>\n>(\n  params?: GetTasksParams,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getTasks>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const queryOptions = getGetTasksQueryOptions(params, options);\n\n  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {\n    queryKey: QueryKey;\n  };\n\n  query.queryKey = queryOptions.queryKey;\n\n  return query;\n};\n\n/**\n * Returns Task information including its states and events.\n\nYou can only retrieve a Task if you have access to it. For example, you can get a Task relating to an Application **Instance** if you created the **Instance**.\n\nTasks are created in response to creating Datasets and launching **Applications** and **Jobs**.\n\nTasks contain of a list of `states` and `events`. A Task will always have `states` but may not have `events`.\n\nStates and events are listed with the oldest occupying the first entry in the list. As the number of events a task accumulates is uncontrolled, by default, only the first 500 events are returned.\n\nYou can control the number of events returned by using the `event_limit` query parameter. You can also retrieve the next set of events by combining it with the `event_prior_ordinal`, setting it to the ordinal of the oldest event you've already received.\n\n**Dataset** tasks must be allowed to complete successfully before you can expect it to be available through the dataset API endpoints. Application **Instances** are not available until their task state is _STARTED_.\n\nFor **Dataset** Tasks, where the task `purpose` is `DATASET`, you must wait until `done` is **true**. The Dataset is available when the Task object's `done` field is **true** and the `exit_code` field is zero (**0**). If you discover the Task is `done` but you have a non-zero `exit_code`, the Dataset upload will have failed, and you may need need to inspect the final `state` and any related `events` to understand why.\n\nFor Application **Instance** Tasks, where the Task `purpose` is `INSTANCE`, you must wait until you find the _STARTED_ state in the `states` list. An Application Instance is only `done` when the Application Instance has been deleted.\n\n * @summary Returns Task information\n */\nexport const getTask = (\n  taskId: string,\n  params?: GetTaskParams,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<TaskGetResponse>(\n    { url: `/task/${taskId}`, method: \"get\", params, signal },\n    options\n  );\n};\n\nexport const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) =>\n  [\"data-manager-api\", `/task/${taskId}`, ...(params ? [params] : [])] as const;\n\nexport const getGetTaskQueryOptions = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData> & {\n  queryKey: QueryKey;\n} => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getTask>>> = ({\n    signal,\n  }) => getTask(taskId, params, requestOptions, signal);\n\n  return { queryKey, queryFn, enabled: !!taskId, ...queryOptions };\n};\n\nexport type GetTaskQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getTask>>\n>;\nexport type GetTaskQueryError = ErrorType<void | DmError>;\n\nexport const useGetTask = <\n  TData = Awaited<ReturnType<typeof getTask>>,\n  TError = ErrorType<void | DmError>\n>(\n  taskId: string,\n  params?: GetTaskParams,\n  options?: {\n    query?: UseQueryOptions<Awaited<ReturnType<typeof getTask>>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const queryOptions = getGetTaskQueryOptions(taskId, params, options);\n\n  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {\n    queryKey: QueryKey;\n  };\n\n  query.queryKey = queryOptions.queryKey;\n\n  return query;\n};\n\n/**\n * Given a `task_id` the Task will be removed.\n\nYou cannot delete a Task until it is `done`.\n\nYou must be an `owner` of the Task to delete it. For example you must be the `owner` of the Dataset to delete **DATASET** Tasks and an `owner` of the ProjectFile to delete **FILE** Tasks.\n\n * @summary Delete a Task entry\n */\nexport const deleteTask = (\n  taskId: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<void>(\n    { url: `/task/${taskId}`, method: \"delete\" },\n    options\n  );\n};\n\nexport const getDeleteTaskMutationOptions = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}): UseMutationOptions<\n  Awaited<ReturnType<typeof deleteTask>>,\n  TError,\n  { taskId: string },\n  TContext\n> => {\n  const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n  const mutationFn: MutationFunction<\n    Awaited<ReturnType<typeof deleteTask>>,\n    { taskId: string }\n  > = (props) => {\n    const { taskId } = props ?? {};\n\n    return deleteTask(taskId, requestOptions);\n  };\n\n  return { mutationFn, ...mutationOptions };\n};\n\nexport type DeleteTaskMutationResult = NonNullable<\n  Awaited<ReturnType<typeof deleteTask>>\n>;\n\nexport type DeleteTaskMutationError = ErrorType<DmError>;\n\nexport const useDeleteTask = <\n  TError = ErrorType<DmError>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    Awaited<ReturnType<typeof deleteTask>>,\n    TError,\n    { taskId: string },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const mutationOptions = getDeleteTaskMutationOptions(options);\n\n  return useMutation(mutationOptions);\n};\n"]}