@squonk/data-manager-client 1.2.8 → 1.2.9

package/index.d.cts

@@ -1,2 +1,2033 @@
-export { bW as AXIOS_INSTANCE, bT as AccountServerGetNamespaceResponse, bU as AccountServerGetRegistrationResponse, A as AdminDeleteJobManifestParams, b as AdminGetServiceErrorsParams, a as AdminGetUsersParams, bS as AdminJobManifestGetResponse, bR as AdminJobManifestLoadPutResponse, bQ as AdminUserPutResponse, bP as AdminUsersGetResponse, b7 as ApiLogDetail, b6 as ApiLogDetailMethod, aU as ApplicationExchangeRateSummary, bO as ApplicationGetResponse, b4 as ApplicationImageVariant, b5 as ApplicationImageVariants, b3 as ApplicationSummary, bN as ApplicationsGetResponse, ak as AsAdditionalDataProcessingCharge, C as CreatePathParams, b2 as DatasetDetail, bL as DatasetDigestGetResponse, bK as DatasetMetaGetResponse, ai as DatasetMetaPostBodyBody, aj as DatasetPostBodyBody, ag as DatasetPutBodyBody, bM as DatasetPutPostResponse, bJ as DatasetSchemaGetResponse, bI as DatasetSchemaGetResponseType, b1 as DatasetSummary, bH as DatasetVersionDeleteResponse, b0 as DatasetVersionDetail, a$ as DatasetVersionDetailLabels, a_ as DatasetVersionDetailProcessingStage, ah as DatasetVersionMetaPostBodyBody, aZ as DatasetVersionProjectFile, aY as DatasetVersionSummary, aX as DatasetVersionSummaryLabels, aW as DatasetVersionSummaryProcessingStage, bG as DatasetVersionsGetResponse, bF as DatasetsGetResponse, o as DeleteDatasetParams, u as DeletePathParams, D as DeleteUnmanagedFileParams, bV as DmError, b_ as ErrorType, aV as ExchangeRateDetail, ac as ExchangeRatePutBodyBody, aS as FilePathFile, af as FilePostBodyBody, bB as FilePostResponse, aR as FileStat, bA as FilesGetResponse, k as GetAllApplicationExchangeRatesParams, bz as GetAllExchangeRatesResponse, by as GetAllExchangeRatesResponseExchangeRatesItem, f as GetAllJobExchangeRatesParams, j as GetApplicationExchangeRatesParams, q as GetDatasetsParams, bx as GetExchangeRatesResponse, bw as GetExchangeRatesResponseId, n as GetFilesParams, d as GetInstancesParams, h as GetJobByVersionParams, e as GetJobExchangeRatesParams, g as GetJobParams, i as GetJobsParams, s as GetProjectFileParams, r as GetProjectFileWithTokenParams, t as GetProjectsParams, l as GetTaskParams, m as GetTasksParams, c as GetUserAccountParams, G as GetUserApiLogParams, p as GetVersionsParams, bE as InstanceDeleteResponse, bD as InstanceDryRunPostResponse, bv as InstanceGetResponse, bu as InstanceGetResponseApplicationType, bt as InstanceGetResponseJobImageType, bs as InstanceGetResponsePhase, ae as InstancePostBodyBody, bC as InstancePostResponse, aQ as InstanceSummary, aP as InstanceSummaryApplicationType, aO as InstanceSummaryJobImageType, aN as InstanceSummaryPhase, bq as InstanceTask, bp as InstanceTaskPurpose, br as InstancesGetResponse, aM as JobApplication, aT as JobExchangeRateSummary, bo as JobGetResponse, bn as JobGetResponseImageType, aL as JobManifestDetail, ad as JobManifestPutBodyBody, aE as JobOrderDetail, aC as JobReplacement, aD as JobReplacements, aK as JobSummary, aJ as JobSummaryImageType, aI as JobVariables, aH as JobVariablesInputs, aG as JobVariablesOptions, aF as JobVariablesOutputs, bm as JobsGetResponse, b8 as ModeGetResponse, P as PatchInstanceParams, bl as ProjectDeleteResponse, aB as ProjectDetail, aA as ProjectFileDetail, ab as ProjectFilePutBodyBody, bk as ProjectGetResponse, aa as ProjectPatchBodyBody, a9 as ProjectPostBodyBody, bj as ProjectPostResponse, bi as ProjectsGetResponse, Y as QActiveDaysParameter, a6 as QApplicationIdParameter, a5 as QCurrentParameter, a3 as QDatasetMimeTypeParameter, a4 as QDoNotImpersonateParameter, Q as QEditorsParameter, a2 as QEventLimitParameter, a1 as QEventPriorOrdinalParameter, a0 as QExcludeDoneParameter, _ as QExcludePurposeParameter, $ as QExcludeRemovalParameter, X as QFileParameter, W as QFilePathParameter, V as QFileProjectIdParameter, U as QFromParameter, Z as QIdleDaysParameter, T as QIncludeAcknowlegedParameter, S as QIncludeDeletedParameter, R as QIncludeHiddenParameter, O as QInstanceArchiveParameter, B as QInstanceCallbackContextParameter, N as QJobCollectionParameter, M as QJobIdParameter, L as QJobJobParameter, K as QJobVersionParameter, J as QKeepProjectFilesParameter, H as QLabelsParameter, I as QOnlyUndefinedParameter, w as QOwnersParameter, F as QProjectIdParameter, E as QProjectNameParameter, v as QPurgeParameter, z as QTokenParameter, y as QUntilParameter, x as QUsernameParameter, az as ServiceErrorSummary, ay as ServiceErrorSummarySeverity, bh as ServiceErrorsGetResponse, ax as TaskEvent, aw as TaskEventLevel, bg as TaskGetResponse, bf as TaskGetResponsePurpose, av as TaskIdentity, au as TaskState, at as TaskStateState, as as TaskSummary, ar as TaskSummaryProcessingStage, be as TasksGetResponse, aq as TypeSummary, ap as TypeSummaryFormatterOptions, ao as TypeSummaryFormatterOptionsType, bd as TypesGetResponse, an as UserAccountDetail, bc as UserAccountGetResponse, a8 as UserAccountPatchBodyBody, bb as UserApiLogGetResponse, am as UserDetail, a7 as UserPatchBodyBody, al as UserSummary, ba as UsersGetResponse, b9 as VersionGetResponse, bZ as customInstance, bX as setAuthToken, bY as setBaseUrl } from './custom-instance-37ed2460.js';
-import 'axios';
+import * as axios from 'axios';
+import { AxiosRequestConfig, AxiosError } from 'axios';
+
+/**
+ * Generated by orval v6.25.0 🍺
+ * Do not edit manually.
+ * Dataset Manager API
+ * The Dataset Manager API service.
+
+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.2
+ */
+type AdminDeleteJobManifestParams = {
+    /**
+     * Purge unreferenced Jobs
+     */
+    purge?: QPurgeParameter;
+};
+type AdminGetUsersParams = {
+    /**
+     * Maximum days a user has been idle (has not used the API). If you specify `2` and it's Monday then users who have not used the API since Saturday will be returned.
+    
+     */
+    idle_days?: QIdleDaysParameter;
+    /**
+     * Minimum days a user has been active (has used the API). If you specify `2` and it's Monday then users who have used the API on Saturday or later will be returned.
+    
+     */
+    active_days?: QActiveDaysParameter;
+};
+/**
+ * Set to include acknowledged items
+
+ */
+type QIncludeAcknowlegedParameter = boolean;
+type AdminGetServiceErrorsParams = {
+    /**
+     * Set to include acknowledged items
+    
+     */
+    include_acknowleged?: QIncludeAcknowlegedParameter;
+};
+/**
+ * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
+
+ */
+type QFromParameter = string;
+type GetUserApiLogParams = {
+    /**
+     * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
+    
+     */
+    from?: QFromParameter;
+    /**
+     * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
+    
+     */
+    until?: QUntilParameter;
+};
+type GetUserAccountParams = {
+    /**
+     * Set, if you're an admin, to call the endpoint without impersonation
+    
+     */
+    do_not_impersonate?: QDoNotImpersonateParameter;
+};
+type PatchInstanceParams = {
+    /**
+     * True to archive the instance
+     */
+    archive?: QInstanceArchiveParameter;
+};
+type GetInstancesParams = {
+    /**
+     * A Project identity
+     */
+    project_id?: QProjectIdParameter;
+};
+type GetJobExchangeRatesParams = {
+    /**
+     * Set to get current
+    
+     */
+    current?: QCurrentParameter;
+};
+type GetAllJobExchangeRatesParams = {
+    /**
+     * Only return records where the exchange rate is undefined
+    
+     */
+    only_undefined?: QOnlyUndefinedParameter;
+};
+type GetJobParams = {
+    /**
+     * A Project identity
+     */
+    project_id?: QProjectIdParameter;
+};
+type GetJobByVersionParams = {
+    /**
+     * The Collection for a Job, i.e. "im-test"
+    
+     */
+    collection: QJobCollectionParameter;
+    /**
+     * The Job, i.e. "nop"
+    
+     */
+    job: QJobJobParameter;
+    /**
+     * The version of a Job, i.e. "1.0.0"
+    
+     */
+    version: QJobVersionParameter;
+    /**
+     * A Project identity
+     */
+    project_id?: QProjectIdParameter;
+};
+type GetJobsParams = {
+    /**
+     * A Project identity
+     */
+    project_id?: QProjectIdParameter;
+};
+type GetApplicationExchangeRatesParams = {
+    /**
+     * Set to get current
+    
+     */
+    current?: QCurrentParameter;
+};
+type GetAllApplicationExchangeRatesParams = {
+    /**
+     * Only return records where the exchange rate is undefined
+    
+     */
+    only_undefined?: QOnlyUndefinedParameter;
+};
+type GetTaskParams = {
+    /**
+     * Maximum number of events to return. If provided, can be 1 or more.
+    
+     */
+    event_limit?: QEventLimitParameter;
+    /**
+     * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
+    
+     */
+    event_prior_ordinal?: QEventPriorOrdinalParameter;
+};
+type GetTasksParams = {
+    /**
+     * Set to limit the response to objects relating to the named purpose.
+    
+     */
+    purpose?: QPurposeParameter;
+    /**
+     * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
+    
+     */
+    exclude_done?: QExcludeDoneParameter;
+    /**
+     * Set true if you want to exclude Tasks related to object removal.
+    
+     */
+    exclude_removal?: QExcludeRemovalParameter;
+    /**
+     * Set to a dot-separated string of purpose enumerations, i.e. `DATASET`, `FILE`, `INSTANCE`, or `PROJECT`. To exclude file and dataset tasks set this field to `FILE.DATASET`
+    
+     */
+    exclude_purpose?: QExcludePurposeParameter;
+    /**
+     * A Project identity
+     */
+    project_id?: QProjectIdParameter;
+    /**
+     * An instance callback context string
+     */
+    instance_callback_context?: QInstanceCallbackContextParameter;
+};
+/**
+ * The Project identity
+ */
+type QFileProjectIdParameter = string;
+/**
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+
+ */
+type QFilePathParameter = string;
+/**
+ * A project file.
+
+ */
+type QFileParameter = string;
+type DeleteUnmanagedFileParams = {
+    /**
+     * A project file.
+    
+     */
+    file: QFileParameter;
+    /**
+     * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+    
+     */
+    path?: QFilePathParameter;
+    /**
+     * The Project identity
+     */
+    project_id: QFileProjectIdParameter;
+};
+type GetFilesParams = {
+    /**
+     * The Project identity
+     */
+    project_id: QFileProjectIdParameter;
+    /**
+     * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+    
+     */
+    path?: QFilePathParameter;
+    /**
+     * Whether to include hidden files and directories
+     */
+    include_hidden?: QIncludeHiddenParameter;
+};
+type DeleteDatasetParams = {
+    /**
+     * Whether to convert Project managed file instances to unmanaged files
+    
+     */
+    keep_project_files?: QKeepProjectFilesParameter;
+};
+type GetVersionsParams = {
+    /**
+     * Whether to include records that are deleted
+     */
+    include_deleted?: QIncludeDeletedParameter;
+};
+type GetDatasetsParams = {
+    /**
+     * Whether to include records that are deleted
+     */
+    include_deleted?: QIncludeDeletedParameter;
+    /**
+     * Filter the datasets by username
+    
+     */
+    username?: QUsernameParameter;
+    /**
+     * Filter the datasets by the supplied mime_type.
+    
+     */
+    dataset_mime_type?: QDatasetMimeTypeParameter;
+    /**
+     * Filter the datasets by a comma separated list of owners
+    
+     */
+    owners?: QOwnersParameter;
+    /**
+     * Filter the datasets by a comma separated list of editors
+    
+     */
+    editors?: QEditorsParameter;
+    /**
+     * JSON string containing a list of label/value pairs for the datasets to be filtered by. If the value is set to null, then only the label is matched. If both the label and value are set, then both are matched. e.g. '{"label1": null, "label2": "value2"}'
+    
+     */
+    labels?: QLabelsParameter;
+};
+type GetProjectFileWithTokenParams = {
+    /**
+     * A token
+     */
+    token?: QTokenParameter;
+    /**
+     * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+    
+     */
+    path?: QFilePathParameter;
+    /**
+     * A project file.
+    
+     */
+    file: QFileParameter;
+};
+type GetProjectFileParams = {
+    /**
+     * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+    
+     */
+    path?: QFilePathParameter;
+    /**
+     * A project file.
+    
+     */
+    file: QFileParameter;
+};
+type GetProjectsParams = {
+    /**
+     * A Project name
+     */
+    project_name?: QProjectNameParameter;
+};
+type DeletePathParams = {
+    /**
+     * The Project identity
+     */
+    project_id: QFileProjectIdParameter;
+    /**
+     * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+    
+     */
+    path?: QFilePathParameter;
+};
+type CreatePathParams = {
+    /**
+     * The Project identity
+     */
+    project_id: QFileProjectIdParameter;
+    /**
+     * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
+    
+     */
+    path?: QFilePathParameter;
+};
+/**
+ * Filter the datasets by a comma separated list of editors
+
+ */
+type QEditorsParameter = string;
+/**
+ * Purge unreferenced Jobs
+ */
+type QPurgeParameter = boolean;
+/**
+ * Filter the datasets by a comma separated list of owners
+
+ */
+type QOwnersParameter = string;
+/**
+ * Filter the datasets by username
+
+ */
+type QUsernameParameter = string;
+/**
+ * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
+
+ */
+type QUntilParameter = string;
+/**
+ * A token
+ */
+type QTokenParameter = string;
+/**
+ * An instance callback context string
+ */
+type QInstanceCallbackContextParameter = string;
+/**
+ * A Project name
+ */
+type QProjectNameParameter = string;
+/**
+ * A Project identity
+ */
+type QProjectIdParameter = string;
+/**
+ * JSON string containing a list of label/value pairs for the datasets to be filtered by. If the value is set to null, then only the label is matched. If both the label and value are set, then both are matched. e.g. '{"label1": null, "label2": "value2"}'
+
+ */
+type QLabelsParameter = string;
+/**
+ * Only return records where the exchange rate is undefined
+
+ */
+type QOnlyUndefinedParameter = boolean;
+/**
+ * Whether to convert Project managed file instances to unmanaged files
+
+ */
+type QKeepProjectFilesParameter = boolean;
+/**
+ * The version of a Job, i.e. "1.0.0"
+
+ */
+type QJobVersionParameter = string;
+/**
+ * The Job, i.e. "nop"
+
+ */
+type QJobJobParameter = string;
+/**
+ * A Job identity
+
+ */
+type QJobIdParameter = number;
+/**
+ * The Collection for a Job, i.e. "im-test"
+
+ */
+type QJobCollectionParameter = string;
+/**
+ * True to archive the instance
+ */
+type QInstanceArchiveParameter = boolean;
+/**
+ * Whether to include hidden files and directories
+ */
+type QIncludeHiddenParameter = boolean;
+/**
+ * Whether to include records that are deleted
+ */
+type QIncludeDeletedParameter = boolean;
+/**
+ * Minimum days a user has been active (has used the API). If you specify `2` and it's Monday then users who have used the API on Saturday or later will be returned.
+
+ */
+type QActiveDaysParameter = number;
+/**
+ * Maximum days a user has been idle (has not used the API). If you specify `2` and it's Monday then users who have not used the API since Saturday will be returned.
+
+ */
+type QIdleDaysParameter = number;
+type QPurposeParameter = typeof QPurposeParameter[keyof typeof QPurposeParameter];
+declare const QPurposeParameter: {
+    readonly DATASET: "DATASET";
+    readonly FILE: "FILE";
+    readonly INSTANCE: "INSTANCE";
+    readonly PROJECT: "PROJECT";
+};
+/**
+ * Set to a dot-separated string of purpose enumerations, i.e. `DATASET`, `FILE`, `INSTANCE`, or `PROJECT`. To exclude file and dataset tasks set this field to `FILE.DATASET`
+
+ */
+type QExcludePurposeParameter = string;
+/**
+ * Set true if you want to exclude Tasks related to object removal.
+
+ */
+type QExcludeRemovalParameter = boolean;
+/**
+ * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
+
+ */
+type QExcludeDoneParameter = boolean;
+/**
+ * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
+
+ */
+type QEventPriorOrdinalParameter = number;
+/**
+ * Maximum number of events to return. If provided, can be 1 or more.
+
+ */
+type QEventLimitParameter = number;
+/**
+ * Filter the datasets by the supplied mime_type.
+
+ */
+type QDatasetMimeTypeParameter = string;
+/**
+ * Set, if you're an admin, to call the endpoint without impersonation
+
+ */
+type QDoNotImpersonateParameter = boolean;
+/**
+ * Set to get current
+
+ */
+type QCurrentParameter = boolean;
+/**
+ * An Application identity
+
+ */
+type QApplicationIdParameter = string;
+type UserPatchBodyBody = {
+    /** If set to a message the user account is suspended, with the user receiving this message when they try and use the API. A suspended user account can be restored by setting the message to `/restore`
+   */
+    suspend_message?: string;
+};
+type UserAccountPatchBodyBody = {
+    /** 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`
+   */
+    impersonate?: string;
+    /** 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 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;
+};
+type ProjectPostBodyBody = {
+    name: string;
+    /** Whether the project is private. You may not be permitted to make the project private, that will depend on the project product you're using to create the project
+   */
+    private?: boolean;
+    /** The Data Manager *Tier Product ID* you're using to create the Project
+   */
+    tier_product_id: string;
+};
+type ProjectPatchBodyBody = {
+    /** The new name of the ptojct
+   */
+    name?: string;
+    private?: boolean;
+};
+type ProjectFilePutBodyBody = {
+    /** An alternative filename to use for the uploaded File
+   */
+    as_filename?: string;
+    file: Blob;
+    /** The Project path of the file.
+   */
+    path?: string;
+};
+type ExchangeRatePutBodyBody = {
+    /** A brief comment relating to the new rate
+   */
+    comment?: string;
+    /** A decimal value used as the new Exchange Rate. Application _raw_ **costs** are multiplied by this value to covert costs to **coins**. A string is used to avoid rounding errors. Internally the value is treated as a Python Decimal.
+   */
+    rate: string;
+};
+type JobManifestPutBodyBody = {
+    /** Optional URL header values (a JSON string) */
+    header?: string;
+    /** Optional URL parameter values (a JSON string) */
+    params?: string;
+    /** The URL of the Job Manifest */
+    url: string;
+};
+type InstancePostBodyBody = {
+    /** A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
+  
+  Application IDs currently supported include `datamanagerjobs.squonk.it` and `jupyternotebooks.squonk.it`
+   */
+    application_id: string;
+    /** A supported application version to launch.
+  
+  This property is **Deprecated**. It is currently ignored will be removed in a future release
+   */
+    application_version?: string;
+    /** The name to use for the instance
+   */
+    as_name: string;
+    /** Used in conjunction with the `callback_url` any value provided here will be passed back in the message payload that's delivered to the callback URL. It can be used by the recipient to provide a context that's meaningful
+   */
+    callback_context?: string;
+    /** An optional 22-character **sortuuid** callback token that is supplied by the remote service. If not provided the user can use `generate_callback_token` to have one generated and returned in the response.
+  
+  See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
+   */
+    callback_token?: string;
+    /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
+   */
+    callback_url?: string;
+    /** A debug value that may be used by the instance.
+  
+  For Data Manager **Job** applications setting this to anything other zero ('0') prevents the Job's Pod from being deleted automatically, allowing a developer to inspect the Pod's log for example.
+  
+  The behaviour of **Application** instances using this property is undefined. It will depend on whether the application **CRD** handles the Data Manager debug field.
+   */
+    debug?: string;
+    /** If set a callback token will be provided in the response. The token allows files to be downloaded from the instance project and expires after a pre-configured amount of time after the instance is complete or if the user revokes the token.
+  
+  Caution should be taken using this feature. A 3rd party can access the Project's files without authentication, they just need the token and the project identity.
+  
+  Tokens should therefore be revoked when they're no longer required
+   */
+    generate_callback_token?: boolean;
+    /** The project to attach
+   */
+    project_id: string;
+    /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
+  
+  When launching a Data Manager **Job** Application you must identify the Job using the properties `collection`, `job` and `version`, e.g. `{"collection":"im-test","job":"nop","version":"1.0.0"}`
+  
+  Jobs that offer commands will often advertise a series of **inputs** and **options** where the values can be provided using a **variables** map in the specification. Something like `"variables":{"x":7}`.
+  
+  Jobs start in a Job-specific **working directory** but the starting directory for any Job can be adjusted by defining a `sub_path` to the root specification. For example, if you want the Job to start in the path `foo/bar` (inside the Job's built-in working directory) you can add `"sub_path":"foo/bar"` to the specification. You can only use a sub-path for a Job if the Job defines a working directory and `sub-path` cannot begin or end with a path separator (`/`).
+  
+  Applications also support `variables`. The Jupyter notebook application supports the definition of the notebook `"image"`, `"cpu"` and `"memory"`. A full Jupyter notebook specification might be `{"variables":{"image":"Tensorflow 2.9","cpu":2,"memory":"4Gi"}}`, where `memory` is limited to `Gi` as a suffix.
+   */
+    specification?: string;
+};
+type FilePostBodyBody = {
+    /** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
+   */
+    as_type: string;
+    /** Whether to compress the Dataset File as it's attached. Compression is achieved using gzip, resulting in a File ending `.gz`. By default the file will be compressed
+   */
+    compress?: boolean;
+    /** The Dataset UUID for the File that you intend to attach
+   */
+    dataset_id: string;
+    /** The Dataset version to attach
+   */
+    dataset_version: number;
+    /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
+   */
+    immutable?: boolean;
+    /** A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
+   */
+    path?: string;
+    /** The Project UUID you're attaching to
+   */
+    project_id: string;
+};
+type DatasetPutBodyBody = {
+    /** 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.
+   */
+    dataset_id?: string;
+    /** The MIME type of the Dataset
+   */
+    dataset_type: string;
+    /** The file name of the file in the Project path to load as a new Dataset.
+   */
+    file_name: string;
+    /** Extra variables (text) presented to the Dataset format-support container, which occurs during the upload and database processing stage. The content of the text is Dataset type specific.
+   */
+    format_extra_variables?: string;
+    /** The Project path of the file.
+   */
+    path: string;
+    /** The Project the file belongs to
+   */
+    project_id: string;
+    /** 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 Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
+   */
+    unit_id?: string;
+};
+type DatasetVersionMetaPostBodyBody = {
+    /** JSON string containing a list of annotations. The format of the labels should match either the Fields Descriptor or Service Execution annotation formats described in the data-manager-metadata library.
+   */
+    annotations?: string;
+    /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
+   */
+    meta_properties?: string;
+};
+type DatasetMetaPostBodyBody = {
+    /** JSON string containing a list of labels. The format of the labels should match the label annotation format described in the data-manager-metadata library.
+   */
+    labels?: string;
+    /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
+   */
+    meta_properties?: string;
+};
+type DatasetPostBodyBody = {
+    /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
+   */
+    as_filename?: string;
+    dataset_file: Blob;
+    /** 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.
+   */
+    dataset_id?: string;
+    /** The MIME type of the Dataset. Values like `chemical/x-mdl-sdfile`, `chemical/x-mdl-molfile`, and `chemical/x-pdb` are permitted. See the **\/type** endpoint for a full list of types.
+   */
+    dataset_type: string;
+    /** Extra variables (text) presented to the Dataset format-support container, which occurs during the upload and database processing stage. The content of the text is Dataset type specific.
+   */
+    format_extra_variables?: string;
+    /** 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 Organisational Unit you want the Dataset to belong to
+   */
+    unit_id: string;
+};
+interface AsAdditionalDataProcessingCharge {
+    collateral_cpu_hours?: string;
+    collateral_pod_count?: number;
+    cost: string;
+    cost_scale_factor: string;
+    cost_to_coins_er: string;
+    error_message?: string;
+    instance_id: string;
+    instance_name: string;
+    job_collection?: string;
+    job_job?: string;
+    job_version?: string;
+    run_time?: string;
+    started: string;
+    stopped?: string;
+}
+interface UserSummary {
+    /** The user's preferred username
+   */
+    username: string;
+}
+interface UserDetail {
+    /** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
+   */
+    become_admin?: boolean;
+    /** The user's filesystem user uid
+   */
+    f_uid?: number;
+    /** The date and time the user was first seen (an ISO-8601 formatted string in UTC)
+   */
+    first_seen?: string;
+    /** For admin accounts, whether the user is impersonating another user
+   */
+    impersonate?: string;
+    /** The date the user was last seen
+   */
+    last_seen_date?: string;
+    /** Set if the user's account is marked as private. Private accounts do not show up against general queries.
+   */
+    private: boolean;
+    /** True if the account is suspended
+   */
+    suspended?: boolean;
+    /** If the account is suspended this typically displays a reason for suspension
+   */
+    suspension_message?: string;
+    /** The user's preferred username
+   */
+    username: string;
+}
+interface UserAccountDetail {
+    /** Whether the caller has admin privilege */
+    caller_has_admin_privilege: boolean;
+    /** The Data Manager roles the user has */
+    data_manager_roles: string[];
+    user: UserDetail;
+}
+/**
+ * The Schema type (an object)
+
+ */
+type TypeSummaryFormatterOptionsType = typeof TypeSummaryFormatterOptionsType[keyof typeof TypeSummaryFormatterOptionsType];
+declare const TypeSummaryFormatterOptionsType: {
+    readonly object: "object";
+};
+/**
+ * If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
+
+ */
+type TypeSummaryFormatterOptions = {
+    /** Required properties
+   */
+    required: string[];
+    /** The title of the Formatter object
+   */
+    title: string;
+    /** The Schema type (an object)
+   */
+    type: TypeSummaryFormatterOptionsType;
+    [key: string]: any;
+};
+interface TypeSummary {
+    /** The file's supported file extensions. Each type is limited to a limited number of extensions. For example, SDF files must have the extension `.sdf` (or `.sdf.gz`).
+   */
+    file_extensions: string[];
+    /** The file's type's format-support container image (if set). Types without a format support image cannot be uploaded, but they might be available for use as destination type when a Dataset is added to a Project.
+   */
+    formatter_image?: string;
+    /** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
+   */
+    formatter_options?: TypeSummaryFormatterOptions;
+    /** True if Datasets uploaded using this type's support loading of data into the Data Manager data-base.
+   */
+    formatter_supports_db_load?: boolean;
+    /** The File Type MIME
+   */
+    mime: string;
+}
+/**
+ * The processing 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
+
+ */
+type TaskSummaryProcessingStage = typeof TaskSummaryProcessingStage[keyof typeof TaskSummaryProcessingStage];
+declare const TaskSummaryProcessingStage: {
+    readonly COPYING: "COPYING";
+    readonly FAILED: "FAILED";
+    readonly FORMATTING: "FORMATTING";
+    readonly LOADING: "LOADING";
+    readonly DELETING: "DELETING";
+    readonly DONE: "DONE";
+};
+interface TaskSummary {
+    /** The date and time the task was created
+   */
+    created: string;
+    /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
+   */
+    done: boolean;
+    /** Present when `done` and zero if the task finished successfully.
+   */
+    exit_code?: number;
+    /** The Task UUID
+   */
+    id: string;
+    /** If a container image is launched by the task the image name is available here
+   */
+    image?: string;
+    /** The processing 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?: TaskSummaryProcessingStage;
+    /** The purpose for the Task. Tasks are responsible for _uploading_ a Dataset, _attaching_ a Dataset as a File to a project or launching an Applications _instance_.
+   */
+    purpose: string;
+    /** The related object ID for the Task purpose. If the purpose relates to a **Dataset** upload the ID will be a Dataset ID.
+   */
+    purpose_id: string;
+    /** The related object version for the Task purpose. This field will only be set if the **purpose** is `DATASET`.
+   */
+    purpose_version?: number;
+    /** True if the Task relates to an object removal, i.e. a DELETE
+   */
+    removal?: boolean;
+}
+/**
+ * The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
+
+ */
+type TaskStateState = typeof TaskStateState[keyof typeof TaskStateState];
+declare const TaskStateState: {
+    readonly PENDING: "PENDING";
+    readonly STARTED: "STARTED";
+    readonly RETRY: "RETRY";
+    readonly SUCCESS: "SUCCESS";
+    readonly FAILURE: "FAILURE";
+};
+interface TaskState {
+    /** A short message accompanying the state, generally only found when the state is `FAILURE`
+   */
+    message?: string;
+    /** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
+   */
+    state: TaskStateState;
+    /** The date and time of the state change
+   */
+    time: string;
+}
+interface TaskIdentity {
+    task_id: string;
+}
+/**
+ * The level of the message, a typical logging framework value
+
+ */
+type TaskEventLevel = typeof TaskEventLevel[keyof typeof TaskEventLevel];
+declare const TaskEventLevel: {
+    readonly CRITICAL: "CRITICAL";
+    readonly ERROR: "ERROR";
+    readonly WARNING: "WARNING";
+    readonly INFO: "INFO";
+    readonly DEBUG: "DEBUG";
+};
+interface TaskEvent {
+    /** The level of the message, a typical logging framework value
+   */
+    level: TaskEventLevel;
+    /** A short message.
+   */
+    message: string;
+    /** The event sequence number. The first event is always '1'.
+   */
+    ordinal: number;
+    /** The date and time the event was generated
+   */
+    time: string;
+}
+type ServiceErrorSummarySeverity = typeof ServiceErrorSummarySeverity[keyof typeof ServiceErrorSummarySeverity];
+declare const ServiceErrorSummarySeverity: {
+    readonly CRITICAL: "CRITICAL";
+    readonly ERROR: "ERROR";
+    readonly WARNING: "WARNING";
+};
+interface ServiceErrorSummary {
+    acknowledged: boolean;
+    acknowledged_at?: string;
+    acknowledging_user?: string;
+    created: string;
+    error_code?: number;
+    hostname: string;
+    id: number;
+    severity: ServiceErrorSummarySeverity;
+    stack_trace: string;
+    summary: string;
+}
+interface ProjectFileDetail {
+    /** The code obtained from the Account Server
+   */
+    authorisation_code?: number;
+    /** The ProjectFile's Dataset origin
+   */
+    dataset_id?: string;
+    /** The ProjectFile's Dataset origin version
+   */
+    dataset_version?: number;
+    /** The ProjectFile's unique ID
+   */
+    file_id: string;
+    /** The ProjectFile's filename within the Project
+   */
+    file_name: string;
+    /** The ProjectFile's path within the Project volume
+   */
+    file_path: string;
+    /** True if the ProjectFile cannot be modified while in the Project
+   */
+    immutable: boolean;
+    /** The ProjectFile MIME type
+   */
+    mime_type: string;
+    /** The owner of the ProjectFile. This is the user that added the Dataset (as this file) to the Project
+   */
+    owner: string;
+    /** The Project the ProjectFile belongs to
+   */
+    project_id?: string;
+}
+interface ProjectDetail {
+    created: string;
+    /** An editor (user_id) of the project */
+    editors: string[];
+    /** A list of managed files in the Project
+   */
+    files?: ProjectFileDetail[];
+    /** The project name
+   */
+    name: string;
+    /** An observer (user_id) of the project */
+    observers: string[];
+    /** The Account Server Organisation the Project Product Unit belongs to
+   */
+    organisation_id?: string;
+    /** The project (owner) creator
+   */
+    owner: string;
+    /** True if the project is private. Private projects are only visible to the owner and its editors.
+   */
+    private: boolean;
+    /** The Account Server Product the Project belongs to
+   */
+    product_id?: string;
+    /** The project unique reference
+   */
+    project_id: string;
+    /** The approximate size of all the files in the Project volume. This is updated regularly throughout the day and its current size may differ from what is reported here. The smallest billable unit is 1GiB (1,073,741,824 bytes). Therefore a project that contains 32KiB of files is recorded as 1GiB in size */
+    size: number;
+    /** The Account Server Unit the Project Product belongs to
+   */
+    unit_id?: string;
+}
+interface JobReplacement {
+    collection: string;
+    job: string;
+}
+/**
+ * A list of Jobs, collection and job that are either replacing or being replaced
+
+ */
+type JobReplacements = JobReplacement[];
+interface JobOrderDetail {
+    options: string[];
+}
+/**
+ * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
+
+ */
+type JobVariablesOutputs = {
+    [key: string]: any;
+};
+/**
+ * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
+
+ */
+type JobVariablesOptions = {
+    [key: string]: any;
+};
+/**
+ * The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
+
+ */
+type JobVariablesInputs = {
+    [key: string]: any;
+};
+interface JobVariables {
+    /** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
+   */
+    inputs?: JobVariablesInputs;
+    /** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
+   */
+    options?: JobVariablesOptions;
+    /** The Job command's variable ordering declaration. Contains a list of `options` in an ordered list, the order defines the order of presentation of the Job's variables.
+   */
+    order?: JobOrderDetail;
+    /** The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
+   */
+    outputs?: JobVariablesOutputs;
+}
+/**
+ * The optional container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
+
+ */
+type JobSummaryImageType = typeof JobSummaryImageType[keyof typeof JobSummaryImageType];
+declare const JobSummaryImageType: {
+    readonly SIMPLE: "SIMPLE";
+    readonly NEXTFLOW: "NEXTFLOW";
+};
+interface JobSummary {
+    /** The Job's category
+   */
+    category?: string;
+    /** The Job namespace
+   */
+    collection: string;
+    /** The description of the job in English
+   */
+    description?: string;
+    /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
+   */
+    disabled: boolean;
+    /** A reason why the Job has been disabled.
+   */
+    disabled_reason?: string;
+    /** A suggested remedy that accompanies the "disabled_reason". This provides the client with advice on how to avoid the reason that the Job's been disabled, for reasons that can be avoided (not all are).
+  
+  Where there is no remedy for a given reason the remedy will be "There is no remedy".
+   */
+    disabled_remedy?: string;
+    /** A URL linking to the Job documentation
+   */
+    doc_url?: string;
+    /** The Job's unique ID
+   */
+    id: number;
+    /** The optional container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
+   */
+    image_type: JobSummaryImageType;
+    /** The Job name, unique within a given namespace
+   */
+    job: string;
+    /** The list of keywords assigned to the Job
+   */
+    keywords?: string[];
+    /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
+   */
+    missing_assets?: string[];
+    /** The name of the job in English
+   */
+    name: string;
+    replaced_by?: JobReplacements;
+    replaces?: JobReplacements;
+    /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
+   */
+    required_assets: string[];
+    /** The Job version
+   */
+    version: string;
+}
+interface JobManifestDetail {
+    /** The Date (and time) the manifest was created
+   */
+    created: string;
+    /** The (admin) user who created the manifest
+   */
+    creator?: string;
+    header?: string;
+    /** The Job Manifest record ID */
+    id: number;
+    /** The number of job definition files loaded during the most recent successful load
+   */
+    job_definition_files_loaded?: number;
+    /** The number of job definitions loaded during the most recent successful load
+   */
+    job_definitions_loaded?: number;
+    /** The status of the time the manifest was last loaded. If the load was successful this will be `SUCCESS` and `last_successful_load` will be the same as `last_load`
+   */
+    last_load_status: string;
+    /** The Date (and time) the manifest was last loaded, successfully or otherwise. If the manifest (or any of the Job definition files it refers to) fails to load the `load_status` should provide some diagnostic feedback
+   */
+    last_load_time?: string;
+    /** The Date (and time) the manifest was last loaded successfully
+   */
+    last_successful_load_time?: string;
+    params?: string;
+    url: string;
+}
+interface JobApplication {
+    /** The Job's operator ID */
+    id: string;
+    /** The Job's operator version */
+    version: 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.
+The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
+
+ */
+type InstanceSummaryPhase = typeof InstanceSummaryPhase[keyof typeof InstanceSummaryPhase];
+declare const InstanceSummaryPhase: {
+    readonly COMPLETED: "COMPLETED";
+    readonly CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF";
+    readonly FAILED: "FAILED";
+    readonly IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF";
+    readonly PENDING: "PENDING";
+    readonly RUNNING: "RUNNING";
+    readonly SUCCEEDED: "SUCCEEDED";
+    readonly UNKNOWN: "UNKNOWN";
+};
+/**
+ * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
+
+ */
+type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
+declare const InstanceSummaryJobImageType: {
+    readonly SIMPLE: "SIMPLE";
+    readonly NEXTFLOW: "NEXTFLOW";
+};
+/**
+ * The type of Application, which can be a `job` or an `application`
+
+ */
+type InstanceSummaryApplicationType = typeof InstanceSummaryApplicationType[keyof typeof InstanceSummaryApplicationType];
+declare const InstanceSummaryApplicationType: {
+    readonly APPLICATION: "APPLICATION";
+    readonly JOB: "JOB";
+};
+interface InstanceSummary {
+    /** The application ID
+   */
+    application_id: string;
+    /** The User's specification, provided when the application was launched
+   */
+    application_specification?: string;
+    /** The type of Application, which can be a `job` or an `application`
+   */
+    application_type: InstanceSummaryApplicationType;
+    /** The application version
+   */
+    application_version: string;
+    /** True if the instance is archived (protected from automatic deletion)
+   */
+    archived: boolean;
+    /** The code obtained from the Account Server
+   */
+    authorisation_code?: number;
+    /** The current running coin cost of the instance.
+   */
+    coins?: string;
+    /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
+   */
+    fix_permissions?: boolean;
+    /** The application instance ID
+   */
+    id: string;
+    /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
+   */
+    job_collection?: string;
+    /** The Job definition's unique ID
+   */
+    job_id?: number;
+    /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
+   */
+    job_image_type?: InstanceSummaryJobImageType;
+    /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
+   */
+    job_job?: string;
+    /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
+   */
+    job_name?: string;
+    /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
+   */
+    job_version?: string;
+    /** The data and time (UTC) the instance was launched
+   */
+    launched: string;
+    /** The Instance name
+   */
+    name: string;
+    /** The instance's known outputs, a JSON string defining a map of all the outputs. Typically applied only to JOB application types
+   */
+    outputs?: string;
+    /** The application instance owner, the person who launched the application and is the only user than can stop it.
+   */
+    owner: 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.
+  The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
+   */
+    phase: InstanceSummaryPhase;
+    /** The Project the instances is running in.
+   */
+    project_id: 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.
+   */
+    run_time: string;
+    /** The data and time (UTC) the instance started running
+   */
+    started?: string;
+    /** The data and time (UTC) the instance stopped running
+   */
+    stopped?: string;
+    /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
+   */
+    url?: string;
+}
+interface FileStat {
+    /** The date and time (UTC) of the last modification
+   */
+    modified: string;
+    /** The size of the file in bytes
+   */
+    size: number;
+}
+interface FilePathFile {
+    /** The code obtained from the Account Server
+   */
+    authorisation_code?: number;
+    /** The file's Dataset ID (if the file belongs to a Dataset)
+   */
+    dataset_id?: string;
+    /** The file's Dataset version (if the file belongs to a Dataset)
+   */
+    dataset_version?: number;
+    /** The ID of the file (if the file belongs to a Dataset)
+   */
+    file_id?: string;
+    /** The file name
+   */
+    file_name: string;
+    /** Whether the file is immutable (read-only)
+   */
+    immutable?: boolean;
+    /** The file's MIME type
+   */
+    mime_type?: string;
+    /** The file's owner
+   */
+    owner: string;
+    stat: FileStat;
+}
+interface JobExchangeRateSummary {
+    collection: string;
+    id: number;
+    job: string;
+    rate?: string;
+    version: string;
+}
+interface ApplicationExchangeRateSummary {
+    id: string;
+    rate?: string;
+}
+interface ExchangeRateDetail {
+    comment?: string;
+    created: string;
+    id: number;
+    rate: string;
+    user_id: string;
+}
+/**
+ * The processing 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
+
+ */
+type DatasetVersionSummaryProcessingStage = typeof DatasetVersionSummaryProcessingStage[keyof typeof DatasetVersionSummaryProcessingStage];
+declare const DatasetVersionSummaryProcessingStage: {
+    readonly COPYING: "COPYING";
+    readonly FAILED: "FAILED";
+    readonly FORMATTING: "FORMATTING";
+    readonly LOADING: "LOADING";
+    readonly DELETING: "DELETING";
+    readonly DONE: "DONE";
+};
+/**
+ * The dictionary of label/value pairs
+
+ */
+type DatasetVersionSummaryLabels = {
+    [key: string]: any;
+};
+interface DatasetVersionSummary {
+    /** The code obtained from the Account Server
+   */
+    authorisation_code?: number;
+    /** The name of the Pod handling the creation of the Dataset
+   */
+    creator_pod_name?: string;
+    /** 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;
+    /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
+   */
+    deleting_user?: string;
+    /** The filename of the Dataset
+   */
+    file_name: string;
+    /** Any extra variables passed in during the upload and handed to the format-support container.
+   */
+    format_extra_variables?: string;
+    /** The dictionary of label/value pairs
+   */
+    labels?: DatasetVersionSummaryLabels;
+    /** The owner of the Dataset version
+   */
+    owner?: string;
+    /** The processing 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;
+    /** The list of Project's the Dataset is attached to
+   */
+    projects: string[];
+    /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
+   */
+    published: string;
+    /** The size, in bytes, of the formatted Dataset
+   */
+    size?: number;
+    /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
+   */
+    source_ref: string;
+    /** The Dataset MIME type
+   */
+    type: string;
+    /** The version of the dataset
+   */
+    version: number;
+}
+interface DatasetVersionProjectFile {
+    files: string[];
+    project: string;
+    project_name: string;
+}
+/**
+ * The processing 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
+
+ */
+type DatasetVersionDetailProcessingStage = typeof DatasetVersionDetailProcessingStage[keyof typeof DatasetVersionDetailProcessingStage];
+declare const DatasetVersionDetailProcessingStage: {
+    readonly COPYING: "COPYING";
+    readonly FAILED: "FAILED";
+    readonly FORMATTING: "FORMATTING";
+    readonly LOADING: "LOADING";
+    readonly DELETING: "DELETING";
+    readonly DONE: "DONE";
+};
+/**
+ * The dictionary of label/value pairs
+
+ */
+type DatasetVersionDetailLabels = {
+    [key: string]: any;
+};
+interface DatasetVersionDetail {
+    /** The code obtained from the Account Server
+   */
+    authorisation_code?: number;
+    /** The name of the Pod handling the creation of the Dataset
+   */
+    creator_pod_name?: string;
+    /** 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;
+    /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
+   */
+    deleting_user?: string;
+    /** The filename of the Dataset
+   */
+    file_name: string;
+    /** Any extra variables passed in during the upload and handed to the format-support container.
+   */
+    format_extra_variables?: string;
+    /** The dictionary of label/value pairs
+   */
+    labels?: DatasetVersionDetailLabels;
+    /** The owner of the Dataset version
+   */
+    owner: string;
+    /** The processing 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;
+    /** The list of
+   */
+    project_files: DatasetVersionProjectFile[];
+    /** The list of Project's the Dataset is attached to
+   */
+    projects: string[];
+    /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
+   */
+    published: string;
+    /** The size, in bytes, of the formatted Dataset
+   */
+    size?: number;
+    /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
+   */
+    source_ref: string;
+    /** The Dataset MIME type
+   */
+    type: string;
+    /** The version of the dataset
+   */
+    version: number;
+}
+interface DatasetSummary {
+    /** The Dataset ID
+   */
+    dataset_id: string;
+    /** The list of editors
+   */
+    editors: string[];
+    /** The set of separate versions of the Dataset
+   */
+    versions: DatasetVersionSummary[];
+}
+interface DatasetDetail {
+    /** The Dataset ID
+   */
+    dataset_id: string;
+    /** The list of editors
+   */
+    editors: string[];
+    /** The owner of the Dataset
+   */
+    owner: string;
+    /** The set of separate versions of the Dataset
+   */
+    versions: DatasetVersionDetail[];
+}
+interface ApplicationSummary {
+    /** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
+   */
+    application_id: string;
+    /** The application group
+   */
+    group?: string;
+    /** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
+   */
+    kind: string;
+    /** The application's latest version as declared in The **Custom Resource Definition**
+   */
+    latest_version: string;
+}
+interface ApplicationImageVariant {
+    image: string;
+    name: string;
+}
+interface ApplicationImageVariants {
+    public?: ApplicationImageVariant[];
+}
+/**
+ * The REST method used. GET methods are not logged
+
+ */
+type ApiLogDetailMethod = typeof ApiLogDetailMethod[keyof typeof ApiLogDetailMethod];
+declare const ApiLogDetailMethod: {
+    readonly DELETE: "DELETE";
+    readonly PATCH: "PATCH";
+    readonly POST: "POST";
+    readonly PUT: "PUT";
+};
+interface ApiLogDetail {
+    /** The date/time the API call began
+   */
+    began: string;
+    /** A JSON string representing the in-body properties used in the call
+   */
+    body?: string;
+    /** The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400
+   */
+    duration_ns?: string;
+    /** Not all API calls using your user ID may have been executed by you, In cases where an administrator has executed a REST API call on your behalf, their user ID will be revealed using this property
+   */
+    impersonator?: string;
+    /** The REST method used. GET methods are not logged
+   */
+    method: ApiLogDetailMethod;
+    /** A JSON string representing the in-query properties used in the call
+   */
+    params?: string;
+    /** The API path used, e.g. `/dataset`
+   */
+    path: string;
+    /** The HTTP response status code
+   */
+    status_code?: number;
+}
+interface ModeGetResponse {
+    /** The Data Manager mode. The mode determines what features are available through the API. There are two modes, DEVELOPMENT, and PRODUCTION. In DEVELOPMENT mode some destructive operation are permitted (for example the removal of Job Definitions)
+   */
+    mode: string;
+}
+interface VersionGetResponse {
+    /** The Data Manager version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
+   */
+    version: string;
+}
+interface UsersGetResponse {
+    /** A list of Users that have used the Data Manager
+   */
+    users: UserSummary[];
+}
+interface UserApiLogGetResponse {
+    /** A list of API loc call records, with the oldest record first in the list
+   */
+    api_log: ApiLogDetail[];
+}
+type UserAccountGetResponse = UserAccountDetail;
+interface TypesGetResponse {
+    /** A list of available MIME types
+   */
+    types: TypeSummary[];
+}
+interface TasksGetResponse {
+    /** A list of Tasks
+   */
+    tasks: TaskSummary[];
+}
+/**
+ * The purpose of the task. Tasks are typically executed for the purpose of Dataset processing, attaching as Project Files or Application Instance execution. Other fields in this object are only valid if the purpose is known (i.e. is not `UNKNOWN`)
+
+ */
+type TaskGetResponsePurpose = typeof TaskGetResponsePurpose[keyof typeof TaskGetResponsePurpose];
+declare const TaskGetResponsePurpose: {
+    readonly DATASET: "DATASET";
+    readonly FILE: "FILE";
+    readonly INSTANCE: "INSTANCE";
+    readonly PROJECT: "PROJECT";
+};
+interface TaskGetResponse {
+    /** The date and time the task was created
+   */
+    created: string;
+    /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
+   */
+    done: boolean;
+    /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
+   */
+    events?: TaskEvent[];
+    /** Present when `done` and zero if the task finished successfully.
+   */
+    exit_code?: number;
+    /** If a container image is launched by the task the image name is available here
+   */
+    image?: string;
+    /** Is the Task Purpose is `INSTANCE`, and the instance was given a `specification` the specification can be found here. For **Applications** the specification is returned verbatim.
+   */
+    instance_specification?: string;
+    /** The purpose of the task. Tasks are typically executed for the purpose of Dataset processing, attaching as Project Files or Application Instance execution. Other fields in this object are only valid if the purpose is known (i.e. is not `UNKNOWN`)
+   */
+    purpose: TaskGetResponsePurpose;
+    /** The identity of the purpose, where available. This will be the Dataset UUID if the purpose of the task is/was for Dataset processing.
+   */
+    purpose_id: string;
+    /** The version number, relating to the object under control. For Datasets this will be the Dataset version.
+   */
+    purpose_version?: number;
+    /** True if the Task relates to an object removal, i.e. a DELETE
+   */
+    removal?: boolean;
+    /** A (possibly empty) list of application states, the oldest state occupies the first position in the list.
+   */
+    states?: TaskState[];
+}
+interface ServiceErrorsGetResponse {
+    /** A list of service errors
+   */
+    service_errors: ServiceErrorSummary[];
+}
+interface ProjectsGetResponse {
+    projects: ProjectDetail[];
+}
+interface ProjectPostResponse {
+    /** The project identity
+   */
+    project_id: string;
+}
+type ProjectGetResponse = ProjectDetail;
+type ProjectDeleteResponse = TaskIdentity;
+interface JobsGetResponse {
+    jobs: JobSummary[];
+}
+/**
+ * The directory used as the container image working directory (if defined)
+
+ */
+type JobGetResponseImageWorkingDirectory = {};
+/**
+ * The optional container image type. Typically a single-container `SIMPLE` (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
+
+ */
+type JobGetResponseImageType = typeof JobGetResponseImageType[keyof typeof JobGetResponseImageType];
+declare const JobGetResponseImageType: {
+    readonly SIMPLE: "SIMPLE";
+    readonly NEXTFLOW: "NEXTFLOW";
+};
+interface JobGetResponse {
+    application: ApplicationSummary;
+    /** The Job's category
+   */
+    category?: string;
+    /** The Job collection
+   */
+    collection: string;
+    /** The Job command (usually encoded)
+   */
+    command: string;
+    /** The Job command encoding
+   */
+    command_encoding: string;
+    /** English description of the job
+   */
+    description?: string;
+    /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
+   */
+    disabled: boolean;
+    /** A reason why the Job has been disabled.
+   */
+    disabled_reason?: string;
+    /** A suggested remedy that accompanies the "disabled_reason". This provides the client with advice on how to avoid the reason that the Job's been disabled, for reasons that can be avoided (not all are).
+  
+  Where there is no remedy for a given reason the remedy will be "There is no remedy".
+   */
+    disabled_remedy?: string;
+    /** A URL linking to the Job documentation
+   */
+    doc_url?: string;
+    exchange_rate: string;
+    /** The Job's unique ID
+   */
+    id: number;
+    /** The name of the container image that houses the job
+   */
+    image_name: string;
+    /** The directory where the project volume will be mounted. The root path to the project files
+   */
+    image_project_directory: string;
+    /** The container image tag
+   */
+    image_tag: string;
+    /** The optional container image type. Typically a single-container `SIMPLE` (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
+   */
+    image_type?: JobGetResponseImageType;
+    /** The directory used as the container image working directory (if defined)
+   */
+    image_working_directory?: JobGetResponseImageWorkingDirectory;
+    /** The Job name, unique within a given collection
+   */
+    job: string;
+    /** The list of keywords assigned to the Job
+   */
+    keywords?: string[];
+    /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
+   */
+    missing_assets?: string[];
+    /** The Job's descriptive name
+   */
+    name: string;
+    replaced_by?: JobReplacements;
+    replaces?: JobReplacements;
+    /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
+   */
+    required_assets: string[];
+    variables?: JobVariables;
+    /** The Job version
+   */
+    version: string;
+}
+type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
+declare const InstanceTaskPurpose: {
+    readonly CREATE: "CREATE";
+    readonly DELETE: "DELETE";
+};
+interface InstanceTask {
+    id: string;
+    purpose: InstanceTaskPurpose;
+}
+interface InstancesGetResponse {
+    instances: InstanceSummary[];
+}
+/**
+ * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
+The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
+
+ */
+type InstanceGetResponsePhase = typeof InstanceGetResponsePhase[keyof typeof InstanceGetResponsePhase];
+declare const InstanceGetResponsePhase: {
+    readonly COMPLETED: "COMPLETED";
+    readonly CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF";
+    readonly FAILED: "FAILED";
+    readonly IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF";
+    readonly PENDING: "PENDING";
+    readonly RUNNING: "RUNNING";
+    readonly SUCCEEDED: "SUCCEEDED";
+    readonly UNKNOWN: "UNKNOWN";
+};
+/**
+ * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
+
+ */
+type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
+declare const InstanceGetResponseJobImageType: {
+    readonly SIMPLE: "SIMPLE";
+    readonly NEXTFLOW: "NEXTFLOW";
+};
+/**
+ * The type of Application, which can be a `job` or an `application`
+
+ */
+type InstanceGetResponseApplicationType = typeof InstanceGetResponseApplicationType[keyof typeof InstanceGetResponseApplicationType];
+declare const InstanceGetResponseApplicationType: {
+    readonly APPLICATION: "APPLICATION";
+    readonly JOB: "JOB";
+};
+interface InstanceGetResponse {
+    /** The application ID
+   */
+    application_id: string;
+    /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
+   */
+    application_specification?: string;
+    /** The type of Application, which can be a `job` or an `application`
+   */
+    application_type: InstanceGetResponseApplicationType;
+    /** The application version
+   */
+    application_version: string;
+    /** True if the instance is archived (protected from automatic deletion)
+   */
+    archived: boolean;
+    /** The code obtained from the Account Server
+   */
+    authorisation_code?: number;
+    /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'`
+   */
+    coins?: string;
+    /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds).
+   */
+    collateral_cpu_hours?: string;
+    /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned.
+   */
+    collateral_pod_count?: number;
+    /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'`
+   */
+    cost?: string;
+    /** An optional error message, used to report underlying problems.
+   */
+    error_message?: string;
+    /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
+   */
+    fix_permissions?: boolean;
+    /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
+   */
+    has_valid_callback_token: boolean;
+    /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
+   */
+    job_collection?: string;
+    /** The Job definition's unique ID
+   */
+    job_id?: number;
+    /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
+   */
+    job_image_type?: InstanceGetResponseJobImageType;
+    /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
+   */
+    job_job?: string;
+    /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
+   */
+    job_name?: string;
+    /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
+   */
+    job_version?: string;
+    /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'`
+   */
+    launch_exchange_rate?: string;
+    /** The date and time the instance was started, an ISO-8601 format string.
+   */
+    launched: string;
+    /** The application name
+   */
+    name: string;
+    /** The JSON string representation of the JobDefinition's outputs
+   */
+    outputs?: string;
+    /** The application owner, the person who launched the application and is the only user than can stop it.
+   */
+    owner: 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.
+  The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
+   */
+    phase: InstanceGetResponsePhase;
+    /** The Project the Instance is running in
+   */
+    project_id: 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.
+   */
+    run_time: string;
+    /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available.
+   */
+    started?: string;
+    /** The date and time the instance stopped, an ISO-8601 format string.
+   */
+    stopped?: string;
+    /** A list of Tasks related to the application. Tasks are responsible for creating and deleting the instance. You should fins at least one, assuming the corresponding task has not been deleted.
+   */
+    tasks: InstanceTask[];
+    /** The application endpoint
+   */
+    url?: string;
+}
+type GetExchangeRatesResponseId = number | string;
+interface GetExchangeRatesResponse {
+    exchange_rates: ExchangeRateDetail[];
+    id: GetExchangeRatesResponseId;
+}
+type GetAllExchangeRatesResponseExchangeRatesItem = ApplicationExchangeRateSummary | JobExchangeRateSummary;
+interface GetAllExchangeRatesResponse {
+    exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
+    only_undefined: boolean;
+}
+interface FilesGetResponse {
+    /** The dataset identity (not its name). A unique reference assigned automatically when uploaded
+   */
+    files: FilePathFile[];
+    /** The project path
+   */
+    path: string;
+    /** Sub-directories in the current path
+   */
+    paths: string[];
+    /** The project
+   */
+    project_id: string;
+}
+interface FilePostResponse {
+    /** The Project File identity, assigned automatically when a Dataset is added to a Project
+   */
+    file_id: string;
+    /** The name of the File that will appear in the Project
+   */
+    file_name: string;
+    /** The path to the file in the Project, relative to the volume root (mount point). Files in the root of the project will have a path value of '/'
+   */
+    file_path: string;
+    /** The File task identity. The task assigned to convert and attach the Dataset File to the Project
+   */
+    task_id: string;
+}
+interface InstancePostResponse {
+    /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it. The token is only provided if asked for when the instance is launched.
+   */
+    callback_token?: string;
+    /** The instance expanded command. Applies only to Job instances.
+   */
+    command?: string;
+    /** The application instance identity (not its name). Assigned automatically when created
+   */
+    instance_id: string;
+    /** The instance task identity. The task assigned to process the instance
+   */
+    task_id: string;
+}
+interface InstanceDryRunPostResponse {
+    /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it.
+   */
+    callback_token?: string;
+    /** The instance expanded command. Applies only to Job instances.
+   */
+    command?: string;
+}
+type InstanceDeleteResponse = TaskIdentity;
+interface DatasetsGetResponse {
+    datasets: DatasetSummary[];
+}
+type DatasetVersionsGetResponse = DatasetDetail;
+type DatasetVersionDeleteResponse = TaskIdentity;
+/**
+ * The Metadata type (an object)
+
+ */
+type DatasetSchemaGetResponseType = typeof DatasetSchemaGetResponseType[keyof typeof DatasetSchemaGetResponseType];
+declare const DatasetSchemaGetResponseType: {
+    readonly object: "object";
+};
+interface DatasetSchemaGetResponse {
+    /** The Metadata description
+   */
+    description: string;
+    /** Required properties
+   */
+    required: string[];
+    /** The Metadata title
+   */
+    title: string;
+    /** The Metadata type (an object)
+   */
+    type: DatasetSchemaGetResponseType;
+    [key: string]: any;
+}
+type DatasetMetaGetResponseLabelsItem = {};
+type DatasetMetaGetResponseAnnotationsItem = {};
+interface DatasetMetaGetResponse {
+    /** The Metadata's annotations
+   */
+    annotations: DatasetMetaGetResponseAnnotationsItem[];
+    /** The date and time of creation
+   */
+    created: string;
+    /** The user who created the Metadata
+   */
+    created_by: string;
+    /** The Metadata description
+   */
+    dataset_id: string;
+    /** The Metadata title
+   */
+    dataset_name: string;
+    /** The Metadata type (an object)
+   */
+    description: string;
+    /** The Metadata's labels
+   */
+    labels: DatasetMetaGetResponseLabelsItem[];
+    /** The date and time it was last updated
+   */
+    last_updated: string;
+    /** The Metadata version
+   */
+    metadata_version: string;
+    [key: string]: any;
+}
+interface DatasetDigestGetResponse {
+    /** The Dataset matching the digest
+   */
+    dataset_id: string;
+    /** The Dataset version
+   */
+    dataset_version: number;
+}
+interface DatasetPutPostResponse {
+    /** The dataset identity (not its name). Assigned automatically when uploaded
+   */
+    dataset_id: string;
+    /** The dataset identity version. Assigned automatically when uploaded
+   */
+    dataset_version: number;
+    /** The dataset task identity. The task assigned to process the dataset
+   */
+    task_id: string;
+}
+interface ApplicationsGetResponse {
+    /** A list of installed applications, which are application-compliant Kubernetes "operators"
+   */
+    applications: ApplicationSummary[];
+}
+interface ApplicationGetResponse {
+    /** The Application COST exchange rate
+   */
+    exchange_rate: string;
+    /** The application group
+   */
+    group: string;
+    /** The Application's unique ID
+   */
+    id: string;
+    image_variants?: ApplicationImageVariants;
+    /** A list of instances of the application
+   */
+    instances: string[];
+    /** The name (kind) of the application
+   */
+    kind: string;
+    /** The application specification template. Used when creating application instances
+   */
+    template: string;
+    /** The list of available versions
+   */
+    versions: string[];
+}
+interface AdminUsersGetResponse {
+    /** A list of Users that have used the Data Manager
+   */
+    users: UserDetail[];
+}
+type AdminUserPutResponse = UserAccountDetail;
+interface AdminJobManifestLoadPutResponse {
+    /** The number of Job Definitions inspected
+   */
+    job_definitions_inspected: number;
+    /** The number of Jobs inspected
+   */
+    jobs_inspected: number;
+    /** The number of Job Manifests inspected
+   */
+    manifests_inspected: number;
+    /** True if successful, false otherwise
+   */
+    status: boolean;
+}
+interface AdminJobManifestGetResponse {
+    /** The list of known Job manifests
+   */
+    job_manifests: JobManifestDetail[];
+}
+interface AccountServerGetNamespaceResponse {
+    /** The configured Account Server namespace, which will be an empty string if one is not configured. The AS API is expected as the service `as-api` in this namespace.
+   */
+    namespace: string;
+}
+interface AccountServerGetRegistrationResponse {
+    merchant_id: number;
+    name: string;
+    registered: string;
+}
+interface DmError {
+    /** Brief error text that can be presented to the user
+   */
+    error: string;
+}
+
+declare const AXIOS_INSTANCE: axios.AxiosInstance;
+/**
+ * Set the access token to be added as the `Authorization: Bearer 'token'` header
+ * Useful for client only apps where a proxy API route isn't involved to securely add the access token
+ * @param token access token
+ */
+declare const setAuthToken: (token: string) => void;
+/**
+ * Set the url to which request paths are added to.
+ * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'
+ */
+declare const setBaseUrl: (baseUrl: string) => void;
+declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
+type ErrorType<TError> = AxiosError<TError>;
+
+export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaGetResponseAnnotationsItem, type DatasetMetaGetResponseLabelsItem, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetVersionsParams, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobGetResponseImageWorkingDirectory, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type PatchInstanceParams, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowlegedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUntilParameter, type QUsernameParameter, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };