@squonk/data-manager-client 0.6.28-rc.5 → 0.7.0

package/{custom-instance-3c2397cc.d.ts → custom-instance-9873bed3.d.ts}

@@ -9,7 +9,7 @@ import { AxiosRequestConfig, AxiosError } from 'axios';
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
 
- * OpenAPI spec version: 0.6
+ * OpenAPI spec version: 0.7
  */
 declare type AdminGetServiceErrorsParams = {
     include_acknowleged?: QIncludeAcknowlegedParameter;
@@ -41,6 +41,11 @@ declare type DeleteUnmanagedFileParams = {
     path?: QFilePathParameter;
     project_id: QFileProjectIdParameter;
 };
+declare type GetFilesParams = {
+    project_id: QFileProjectIdParameter;
+    path?: QFilePathParameter;
+    include_hidden?: QIncludeHiddenParameter;
+};
 declare type DeleteDatasetParams = {
     keep_project_files?: QKeepProjectFilesParameter;
 };
@@ -66,14 +71,6 @@ declare type QOwnersParameter = string;
 
  */
 declare type QUsernameParameter = string;
-declare type GetDatasetsParams = {
-    include_deleted?: QIncludeDeletedParameter;
-    username?: QUsernameParameter;
-    dataset_mime_type?: QDatasetMimeTypeParameter;
-    owners?: QOwnersParameter;
-    editors?: QEditorsParameter;
-    labels?: QLabelsParameter;
-};
 /**
  * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
 
@@ -88,6 +85,14 @@ declare type QProjectIdParameter = string;
 
  */
 declare type QLabelsParameter = string;
+declare type GetDatasetsParams = {
+    include_deleted?: QIncludeDeletedParameter;
+    username?: QUsernameParameter;
+    dataset_mime_type?: QDatasetMimeTypeParameter;
+    owners?: QOwnersParameter;
+    editors?: QEditorsParameter;
+    labels?: QLabelsParameter;
+};
 /**
  * Whether to convert Project managed file instances to unmanged files
 
@@ -124,11 +129,6 @@ declare type QFileProjectIdParameter = string;
 
  */
 declare type QFilePathParameter = string;
-declare type GetFilesParams = {
-    project_id: QFileProjectIdParameter;
-    path?: QFilePathParameter;
-    include_hidden?: QIncludeHiddenParameter;
-};
 /**
  * A project file.
 
@@ -154,10 +154,6 @@ declare type QEventPriorOrdinalParameter = number;
 
  */
 declare type QEventLimitParameter = number;
-declare type GetInstanceParams = {
-    event_limit?: QEventLimitParameter;
-    event_prior_ordinal?: QEventPriorOrdinalParameter;
-};
 /**
  * Filter the datasets by the supplied mime_type.
 
@@ -289,12 +285,9 @@ declare type DatasetPutBodyBody = {
     /** The file name of the file in the Project path to load as a new Dataset.
      */
     file_name: string;
-    /** The Dataset ID this version is derived from. If set the user must also provide the **parent_version**, which must be a valid number for a pre-existing version of the given Dataset, and must be '1' or higher.
+    /** If provided the File becomes a new version of the Dataset named. If not provided this File becomes the first version of a new Dataset, whose ID is returned to you on success.
      */
-    parent_id?: string;
-    /** Used along with the **parent_id** to provide a reference to the Dataset parent. It can only be used when a **parent_id** is specified and must be specified if a **parent_id** is provided. If used it must be '1' or higher and must represent a valid version of the given Dataset.
-     */
-    parent_version?: number;
+    dataset_id?: string;
     /** The Organisation you want the Dataset to belong to. If not supplied the Project Organisation is used
      */
     organisation_id?: string;
@@ -318,15 +311,12 @@ declare type DatasetPostBodyBody = {
     /** If set the post-format database load action is skipped. This means the dataset is uploaded but its molecules are not entered into the Data Manager database. This can save significant time if you're just experimenting with the dataset and do not need the molecules in the database
      */
     skip_molecule_load?: boolean;
-    /** The filename to use for the uploaded Dataset. The Dataset will be stored using this name.
+    /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
      */
-    as_filename: string;
-    /** The Dataset this version is derived from. If set the user must also provide the **parent_version**.
-     */
-    parent_id?: string;
-    /** Used along with the **parent_id** to provide a reference to the Dataset parent. It can only be used when a **parent_id** is specified.
+    as_filename?: string;
+    /** If provided the Dataset becomes a new version of the Dataset named. If not provided this Dataset becomes the first version of a new Dataset, whose ID is returned to you on success.
      */
-    parent_version?: number;
+    dataset_id?: string;
     /** The Organisation you want the Dataset to belong to
      */
     organisation_id: string;
@@ -652,18 +642,6 @@ declare const InstanceSummaryJobImageType: {
     SIMPLE: InstanceSummaryJobImageType;
     NEXTFLOW: InstanceSummaryJobImageType;
 };
-/**
- * The state of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager. Key states are `PENDING` for an instance that is starting (but has not started), `STARTED` for an instance that has started, `SUCCESS` for an instance that has finished (and started and finished successfully) and `FAILURE` for an instance that has finished but failed in some way
-
- */
-declare type InstanceSummaryState = "FAILURE" | "PENDING" | "STARTED" | "SUCCESS" | "UNKNOWN";
-declare const InstanceSummaryState: {
-    FAILURE: InstanceSummaryState;
-    PENDING: InstanceSummaryState;
-    STARTED: InstanceSummaryState;
-    SUCCESS: InstanceSummaryState;
-    UNKNOWN: InstanceSummaryState;
-};
 /**
  * The type of Application, which can be a `job` or an `application`
 
@@ -692,9 +670,9 @@ interface InstanceSummary {
     /** The code obtained from the Account Server
      */
     authorisation_code?: number;
-    /** The state of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager. Key states are `PENDING` for an instance that is starting (but has not started), `STARTED` for an instance that has started, `SUCCESS` for an instance that has finished (and started and finished successfully) and `FAILURE` for an instance that has finished but failed in some way
+    /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
      */
-    state: InstanceSummaryState;
+    phase: string;
     /** The data and time (UTC) the instance was laucnhed
      */
     launched: string;
@@ -786,6 +764,9 @@ declare const DatasetVersionSummaryProcessingStage: {
     DONE: DatasetVersionSummaryProcessingStage;
 };
 interface DatasetVersionSummary {
+    /** The owner of the Dataset version
+     */
+    owner?: string;
     /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
      */
     source_ref: string;
@@ -810,9 +791,6 @@ interface DatasetVersionSummary {
     /** The processign stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
      */
     processing_stage: DatasetVersionSummaryProcessingStage;
-    /** For a Dataset that has a parent, or is related to or derived from a pre-existing Dataset version this will be the parent version (of a dataset that shares the same ID)
-     */
-    parent_version?: number;
     /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
      */
     deleted?: string;
@@ -853,6 +831,9 @@ declare const DatasetVersionDetailProcessingStage: {
     DONE: DatasetVersionDetailProcessingStage;
 };
 interface DatasetVersionDetail {
+    /** The owner of the Dataset version
+     */
+    owner: string;
     /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
      */
     source_ref: string;
@@ -880,9 +861,6 @@ interface DatasetVersionDetail {
     /** The processign stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
      */
     processing_stage: DatasetVersionDetailProcessingStage;
-    /** For a Dataset that has a parent, or is related to or derived from a pre-existing Dataset version this will be the parent version (of a dataset that shares the same ID)
-     */
-    parent_version?: number;
     /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
      */
     deleted?: string;
@@ -906,9 +884,6 @@ interface DatasetSummary {
     /** The list of editors
      */
     editors: string[];
-    /** The owner of the Dataset
-     */
-    owner: string;
     /** The set of separate versions of the Dataset
      */
     versions: DatasetVersionSummary[];
@@ -1121,6 +1096,15 @@ interface JobGetResponse {
     keywords?: string[];
     variables?: JobVariables;
 }
+declare type InstanceTaskPurpose = "CREATE" | "DELETE";
+declare const InstanceTaskPurpose: {
+    CREATE: InstanceTaskPurpose;
+    DELETE: InstanceTaskPurpose;
+};
+interface InstanceTask {
+    id: string;
+    purpose: InstanceTaskPurpose;
+}
 interface InstancesGetResponse {
     instances: InstanceSummary[];
 }
@@ -1161,18 +1145,18 @@ interface InstanceGetResponse {
     /** The application unique reference
      */
     launched: string;
+    /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
+     */
+    phase: string;
     /** The application endpoint
      */
     url?: string;
     /** The JSON string representation of the JobDefintion's outputs
      */
     outputs?: string;
-    /** A (possibly empty) list of application states, the oldest state occupies the first position in the list.
-     */
-    states: TaskState[];
-    /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
+    /** A list of Tasks related to the application. Tasks are responsible for creating and deleteing the instance. You should fins at least one, assuming the corresponding task has not been deleted.
      */
-    events: TaskEvent[];
+    tasks: InstanceTask[];
 }
 interface FilesGetResponse {
     /** The project
@@ -1329,6 +1313,14 @@ interface AdminJobManifestLoadPutResponse {
      */
     jobs_inspected: number;
 }
+interface AccountServerGetHostanmeResponse {
+    /** The configured Account Server hostname, which will be an empty string if one is not configured
+     */
+    hostname: string;
+    /** The name of this Data Manager instance, used to distinguish itself on calls to the Account Server. Every Data Manager is deployed with a unique name, regardless of the Account Server that's being used.
+     */
+    data_manager_name: string;
+}
 interface DmError {
     /** Brief error text that can be presented to the user
      */
@@ -1350,4 +1342,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
 declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig<any> | undefined) => Promise<TReturn>;
 declare type ErrorType<TError> = AxiosError<TError>;
 
-export { TaskStateState as $, AdminGetServiceErrorsParams as A, QEventLimitParameter as B, GetInstanceParams as C, DeleteUnmanagedFileParams as D, QDatasetMimeTypeParameter as E, QDoNotImpersonateParameter as F, GetUserApiLogParams as G, UserAccountPatchBodyBody as H, ProjectPostBodyBody as I, ProjectPatchBodyBody as J, ProjectFilePutBodyBody as K, InstancePostBodyBody as L, FilePostBodyBody as M, DatasetPutBodyBody as N, DatasetAnnotationsPostBodyBody as O, PatchInstanceParams as P, QEditorsParameter as Q, DatasetPostBodyBody as R, UserSummary as S, UserDetail as T, UserPatchBodyBody as U, UserAccountDetail as V, TypeSummaryFormatterOptionsType as W, TypeSummaryFormatterOptions as X, TypeSummary as Y, TaskSummaryProcessingStage as Z, TaskSummary as _, GetUserAccountParams as a, ApplicationGetResponse as a$, TaskState as a0, TaskIdentity as a1, TaskEventLevel as a2, TaskEvent as a3, ServiceErrorSummarySeverity as a4, ServiceErrorSummary as a5, ProjectFileDetail as a6, ProjectDetail as a7, JobOrderDetail as a8, JobVariables as a9, TaskGetResponsePurpose as aA, TaskGetResponse as aB, ServiceErrorsGetResponse as aC, ProjectsGetResponse as aD, ProjectPostResponse as aE, ProjectGetResponse as aF, ProjectDeleteResponse as aG, JobsGetResponse as aH, JobGetResponseImageType as aI, JobGetResponse as aJ, InstancesGetResponse as aK, InstanceGetResponseApplicationType as aL, InstanceGetResponse as aM, FilesGetResponse as aN, FilePostResponse as aO, InstancePostResponse as aP, InstanceDeleteResponse as aQ, DatasetsGetResponse as aR, DatasetVersionsGetResponse as aS, DatasetVersionDeleteResponse as aT, DatasetSchemaGetResponseType as aU, DatasetSchemaGetResponse as aV, DatasetMetaGetResponse as aW, DatasetDigestGetResponse as aX, DatasetPutPostResponse as aY, DatasetAnnotationsPostResponse as aZ, ApplicationsGetResponse as a_, JobSummaryImageType as aa, JobSummary as ab, JobApplication as ac, InstanceSummaryJobImageType as ad, InstanceSummaryState as ae, InstanceSummaryApplicationType as af, InstanceSummary as ag, FileStat as ah, FilePathFile as ai, DatasetVersionSummaryLabels as aj, DatasetVersionSummaryProcessingStage as ak, DatasetVersionSummary as al, DatasetVersionProjectFile as am, DatasetVersionDetailLabels as an, DatasetVersionDetailProcessingStage as ao, DatasetVersionDetail as ap, DatasetSummary as aq, DatasetDetail as ar, ApplicationSummary as as, ApiLogDetailMethod as at, ApiLogDetail as au, UsersGetResponse as av, UserApiLogGetResponse as aw, UserAccountGetResponse as ax, TypesGetResponse as ay, TasksGetResponse as az, GetInstancesParams as b, AdminUserPutResponse as b0, AdminJobManifestLoadPutResponse as b1, DmError as b2, AXIOS_INSTANCE as b3, setAuthToken as b4, setBaseUrl as b5, customInstance as b6, ErrorType as b7, GetTaskParams as c, GetTasksParams as d, DeleteDatasetParams as e, GetVersionsParams as f, GetProjectFileParams as g, QOwnersParameter as h, QUsernameParameter as i, GetDatasetsParams as j, QUntilParameter as k, QProjectIdParameter as l, QLabelsParameter as m, QKeepProjectFilesParameter as n, QInstanceArchiveParameter as o, QIncludeHiddenParameter as p, QIncludeDeletedParameter as q, QIncludeAcknowlegedParameter as r, QFromParameter as s, QFileProjectIdParameter as t, QFilePathParameter as u, GetFilesParams as v, QFileParameter as w, QExcludePurposeParameter as x, QExcludeDoneParameter as y, QEventPriorOrdinalParameter as z };
+export { TaskState as $, AdminGetServiceErrorsParams as A, QEventLimitParameter as B, QDatasetMimeTypeParameter as C, DeleteUnmanagedFileParams as D, QDoNotImpersonateParameter as E, UserAccountPatchBodyBody as F, GetUserApiLogParams as G, ProjectPostBodyBody as H, ProjectPatchBodyBody as I, ProjectFilePutBodyBody as J, InstancePostBodyBody as K, FilePostBodyBody as L, DatasetPutBodyBody as M, DatasetAnnotationsPostBodyBody as N, DatasetPostBodyBody as O, PatchInstanceParams as P, QEditorsParameter as Q, UserSummary as R, UserDetail as S, UserAccountDetail as T, UserPatchBodyBody as U, TypeSummaryFormatterOptionsType as V, TypeSummaryFormatterOptions as W, TypeSummary as X, TaskSummaryProcessingStage as Y, TaskSummary as Z, TaskStateState as _, GetUserAccountParams as a, ApplicationGetResponse as a$, TaskIdentity as a0, TaskEventLevel as a1, TaskEvent as a2, ServiceErrorSummarySeverity as a3, ServiceErrorSummary as a4, ProjectFileDetail as a5, ProjectDetail as a6, JobOrderDetail as a7, JobVariables as a8, JobSummaryImageType as a9, ServiceErrorsGetResponse as aA, ProjectsGetResponse as aB, ProjectPostResponse as aC, ProjectGetResponse as aD, ProjectDeleteResponse as aE, JobsGetResponse as aF, JobGetResponseImageType as aG, JobGetResponse as aH, InstanceTaskPurpose as aI, InstanceTask as aJ, InstancesGetResponse as aK, InstanceGetResponseApplicationType as aL, InstanceGetResponse as aM, FilesGetResponse as aN, FilePostResponse as aO, InstancePostResponse as aP, InstanceDeleteResponse as aQ, DatasetsGetResponse as aR, DatasetVersionsGetResponse as aS, DatasetVersionDeleteResponse as aT, DatasetSchemaGetResponseType as aU, DatasetSchemaGetResponse as aV, DatasetMetaGetResponse as aW, DatasetDigestGetResponse as aX, DatasetPutPostResponse as aY, DatasetAnnotationsPostResponse as aZ, ApplicationsGetResponse as a_, JobSummary as aa, JobApplication as ab, InstanceSummaryJobImageType as ac, InstanceSummaryApplicationType as ad, InstanceSummary as ae, FileStat as af, FilePathFile as ag, DatasetVersionSummaryLabels as ah, DatasetVersionSummaryProcessingStage as ai, DatasetVersionSummary as aj, DatasetVersionProjectFile as ak, DatasetVersionDetailLabels as al, DatasetVersionDetailProcessingStage as am, DatasetVersionDetail as an, DatasetSummary as ao, DatasetDetail as ap, ApplicationSummary as aq, ApiLogDetailMethod as ar, ApiLogDetail as as, UsersGetResponse as at, UserApiLogGetResponse as au, UserAccountGetResponse as av, TypesGetResponse as aw, TasksGetResponse as ax, TaskGetResponsePurpose as ay, TaskGetResponse as az, GetInstancesParams as b, AdminUserPutResponse as b0, AdminJobManifestLoadPutResponse as b1, AccountServerGetHostanmeResponse as b2, DmError as b3, AXIOS_INSTANCE as b4, setAuthToken as b5, setBaseUrl as b6, customInstance as b7, ErrorType as b8, GetTaskParams as c, GetTasksParams as d, GetFilesParams as e, DeleteDatasetParams as f, GetVersionsParams as g, GetProjectFileParams as h, QOwnersParameter as i, QUsernameParameter as j, QUntilParameter as k, QProjectIdParameter as l, QLabelsParameter as m, GetDatasetsParams as n, QKeepProjectFilesParameter as o, QInstanceArchiveParameter as p, QIncludeHiddenParameter as q, QIncludeDeletedParameter as r, QIncludeAcknowlegedParameter as s, QFromParameter as t, QFileProjectIdParameter as u, QFilePathParameter as v, QFileParameter as w, QExcludePurposeParameter as x, QExcludeDoneParameter as y, QEventPriorOrdinalParameter as z };