@squonk/data-manager-client 0.7.0 → 0.7.1

package/metadata/metadata.d.ts

@@ -0,0 +1,72 @@
+import * as react_query from 'react-query';
+import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
+import { O as DatasetVersionMetaPostBodyBody, bb as customInstance, a$ as DatasetMetaGetResponse, bc as ErrorType, b7 as DmError, R as DatasetMetaPostBodyBody } from '../custom-instance-eb1ebf45';
+import 'axios';
+
+declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
+/**
+ * Update parameters or add new annotations of the specified type(s) and to the metadata for the version of the dataset.
+The parameters are provided in a list in keyword/arguments
+The annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,
+
+ * @summary Update Metadata for the Dataset version
+ */
+declare const addMetadataVersion: (datasetid: string, datasetversion: number, datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetMetaGetResponse>;
+declare const useAddMetadataVersion: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<DatasetMetaGetResponse, TError, {
+        datasetid: string;
+        datasetversion: number;
+        data: DatasetVersionMetaPostBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => react_query.UseMutationResult<DatasetMetaGetResponse, TError, {
+    datasetid: string;
+    datasetversion: number;
+    data: DatasetVersionMetaPostBodyBody;
+}, TContext>;
+/**
+ * Returns the metadata for a Dataset version in JSON format.
+
+ * @summary Gets the metadata for a specific Dataset version
+ */
+declare const getMetadataVersion: (datasetid: string, datasetversion: number, options?: SecondParameter<typeof customInstance>) => Promise<DatasetMetaGetResponse>;
+declare const getGetMetadataVersionQueryKey: (datasetid: string, datasetversion: number) => string[];
+declare const useGetMetadataVersion: <TData = DatasetMetaGetResponse, TError = ErrorType<void | DmError>>(datasetid: string, datasetversion: number, options?: {
+    query?: UseQueryOptions<DatasetMetaGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Update default parameters or add new labels to the metadata for the dataset.
+The parameters are provided in a list in keyword/arguments
+The labels are provided in a list in JSON format. For details of the label format, see the data-manager-metadata library,
+
+ * @summary Update Metadata for the Dataset
+ */
+declare const addMetadata: (datasetid: string, datasetMetaPostBodyBody: DatasetMetaPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetMetaGetResponse>;
+declare const useAddMetadata: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<DatasetMetaGetResponse, TError, {
+        datasetid: string;
+        data: DatasetMetaPostBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => react_query.UseMutationResult<DatasetMetaGetResponse, TError, {
+    datasetid: string;
+    data: DatasetMetaPostBodyBody;
+}, TContext>;
+/**
+ * Returns the metadata for a Dataset in JSON format.
+
+ * @summary Gets the metadata for a specific Dataset
+ */
+declare const getMetadata: (datasetid: string, options?: SecondParameter<typeof customInstance>) => Promise<DatasetMetaGetResponse>;
+declare const getGetMetadataQueryKey: (datasetid: string) => string[];
+declare const useGetMetadata: <TData = DatasetMetaGetResponse, TError = ErrorType<void | DmError>>(datasetid: string, options?: {
+    query?: UseQueryOptions<DatasetMetaGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+
+export { addMetadata, addMetadataVersion, getGetMetadataQueryKey, getGetMetadataVersionQueryKey, getMetadata, getMetadataVersion, useAddMetadata, useAddMetadataVersion, useGetMetadata, useGetMetadataVersion };

package/metadata/metadata.js

@@ -0,0 +1,93 @@
+import {
+  __spreadValues,
+  customInstance
+} from "../chunk-JR7F532L.js";
+
+// src/metadata/metadata.ts
+import {
+  useQuery,
+  useMutation
+} from "react-query";
+var addMetadataVersion = (datasetid, datasetversion, datasetVersionMetaPostBodyBody, options) => {
+  const formData = new FormData();
+  if (datasetVersionMetaPostBodyBody.meta_properties !== void 0) {
+    formData.append("meta_properties", datasetVersionMetaPostBodyBody.meta_properties);
+  }
+  if (datasetVersionMetaPostBodyBody.annotations !== void 0) {
+    formData.append("annotations", datasetVersionMetaPostBodyBody.annotations);
+  }
+  return customInstance({
+    url: `/dataset/${datasetid}/meta/${datasetversion}`,
+    method: "post",
+    data: formData
+  }, options);
+};
+var useAddMetadataVersion = (options) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const mutationFn = (props) => {
+    const { datasetid, datasetversion, data } = props || {};
+    return addMetadataVersion(datasetid, datasetversion, data, requestOptions);
+  };
+  return useMutation(mutationFn, mutationOptions);
+};
+var getMetadataVersion = (datasetid, datasetversion, options) => {
+  return customInstance({ url: `/dataset/${datasetid}/meta/${datasetversion}`, method: "get" }, options);
+};
+var getGetMetadataVersionQueryKey = (datasetid, datasetversion) => [`/dataset/${datasetid}/meta/${datasetversion}`];
+var useGetMetadataVersion = (datasetid, datasetversion, options) => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetMetadataVersionQueryKey(datasetid, datasetversion);
+  const queryFn = () => getMetadataVersion(datasetid, datasetversion, requestOptions);
+  const query = useQuery(queryKey, queryFn, __spreadValues({
+    enabled: !!(datasetid && datasetversion)
+  }, queryOptions));
+  return __spreadValues({
+    queryKey
+  }, query);
+};
+var addMetadata = (datasetid, datasetMetaPostBodyBody, options) => {
+  const formData = new FormData();
+  if (datasetMetaPostBodyBody.meta_properties !== void 0) {
+    formData.append("meta_properties", datasetMetaPostBodyBody.meta_properties);
+  }
+  if (datasetMetaPostBodyBody.labels !== void 0) {
+    formData.append("labels", datasetMetaPostBodyBody.labels);
+  }
+  return customInstance({ url: `/dataset/${datasetid}/meta`, method: "post", data: formData }, options);
+};
+var useAddMetadata = (options) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+  const mutationFn = (props) => {
+    const { datasetid, data } = props || {};
+    return addMetadata(datasetid, data, requestOptions);
+  };
+  return useMutation(mutationFn, mutationOptions);
+};
+var getMetadata = (datasetid, options) => {
+  return customInstance({ url: `/dataset/${datasetid}/meta`, method: "get" }, options);
+};
+var getGetMetadataQueryKey = (datasetid) => [
+  `/dataset/${datasetid}/meta`
+];
+var useGetMetadata = (datasetid, options) => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetMetadataQueryKey(datasetid);
+  const queryFn = () => getMetadata(datasetid, requestOptions);
+  const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!datasetid }, queryOptions));
+  return __spreadValues({
+    queryKey
+  }, query);
+};
+export {
+  addMetadata,
+  addMetadataVersion,
+  getGetMetadataQueryKey,
+  getGetMetadataVersionQueryKey,
+  getMetadata,
+  getMetadataVersion,
+  useAddMetadata,
+  useAddMetadataVersion,
+  useGetMetadata,
+  useGetMetadataVersion
+};
+//# sourceMappingURL=metadata.js.map

package/metadata/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/metadata/metadata.ts"],"sourcesContent":["/**\n * Generated by orval v6.6.0 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 0.7\n */\nimport {\n  useQuery,\n  useMutation,\n  UseQueryOptions,\n  UseMutationOptions,\n  QueryFunction,\n  MutationFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"react-query\";\nimport type {\n  DatasetMetaGetResponse,\n  DmError,\n  DatasetVersionMetaPostBodyBody,\n  DatasetMetaPostBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n  ...args: any\n) => Promise<infer R>\n  ? R\n  : any;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Update parameters or add new annotations of the specified type(s) and to the metadata for the version of the dataset.\nThe parameters are provided in a list in keyword/arguments\nThe annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,\n\n * @summary Update Metadata for the Dataset version\n */\nexport const addMetadataVersion = (\n  datasetid: string,\n  datasetversion: number,\n  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  const formData = new FormData();\n  if (datasetVersionMetaPostBodyBody.meta_properties !== undefined) {\n    formData.append(\n      \"meta_properties\",\n      datasetVersionMetaPostBodyBody.meta_properties\n    );\n  }\n  if (datasetVersionMetaPostBodyBody.annotations !== undefined) {\n    formData.append(\"annotations\", datasetVersionMetaPostBodyBody.annotations);\n  }\n\n  return customInstance<DatasetMetaGetResponse>(\n    {\n      url: `/dataset/${datasetid}/meta/${datasetversion}`,\n      method: \"post\",\n      data: formData,\n    },\n    options\n  );\n};\n\nexport const useAddMetadataVersion = <\n  TError = ErrorType<DmError | void>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    AsyncReturnType<typeof addMetadataVersion>,\n    TError,\n    {\n      datasetid: string;\n      datasetversion: number;\n      data: DatasetVersionMetaPostBodyBody;\n    },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n  const mutationFn: MutationFunction<\n    AsyncReturnType<typeof addMetadataVersion>,\n    {\n      datasetid: string;\n      datasetversion: number;\n      data: DatasetVersionMetaPostBodyBody;\n    }\n  > = (props) => {\n    const { datasetid, datasetversion, data } = props || {};\n\n    return addMetadataVersion(datasetid, datasetversion, data, requestOptions);\n  };\n\n  return useMutation<\n    AsyncReturnType<typeof addMetadataVersion>,\n    TError,\n    {\n      datasetid: string;\n      datasetversion: number;\n      data: DatasetVersionMetaPostBodyBody;\n    },\n    TContext\n  >(mutationFn, mutationOptions);\n};\n/**\n * Returns the metadata for a Dataset version in JSON format.\n\n * @summary Gets the metadata for a specific Dataset version\n */\nexport const getMetadataVersion = (\n  datasetid: string,\n  datasetversion: number,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<DatasetMetaGetResponse>(\n    { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: \"get\" },\n    options\n  );\n};\n\nexport const getGetMetadataVersionQueryKey = (\n  datasetid: string,\n  datasetversion: number\n) => [`/dataset/${datasetid}/meta/${datasetversion}`];\n\nexport const useGetMetadataVersion = <\n  TData = AsyncReturnType<typeof getMetadataVersion>,\n  TError = ErrorType<void | DmError>\n>(\n  datasetid: string,\n  datasetversion: number,\n  options?: {\n    query?: UseQueryOptions<\n      AsyncReturnType<typeof getMetadataVersion>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options || {};\n\n  const queryKey =\n    queryOptions?.queryKey ??\n    getGetMetadataVersionQueryKey(datasetid, datasetversion);\n\n  const queryFn: QueryFunction<\n    AsyncReturnType<typeof getMetadataVersion>\n  > = () => getMetadataVersion(datasetid, datasetversion, requestOptions);\n\n  const query = useQuery<\n    AsyncReturnType<typeof getMetadataVersion>,\n    TError,\n    TData\n  >(queryKey, queryFn, {\n    enabled: !!(datasetid && datasetversion),\n    ...queryOptions,\n  });\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n\n/**\n * Update default parameters or add new labels to the metadata for the dataset.\nThe parameters are provided in a list in keyword/arguments\nThe labels are provided in a list in JSON format. For details of the label format, see the data-manager-metadata library,\n\n * @summary Update Metadata for the Dataset\n */\nexport const addMetadata = (\n  datasetid: string,\n  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  const formData = new FormData();\n  if (datasetMetaPostBodyBody.meta_properties !== undefined) {\n    formData.append(\"meta_properties\", datasetMetaPostBodyBody.meta_properties);\n  }\n  if (datasetMetaPostBodyBody.labels !== undefined) {\n    formData.append(\"labels\", datasetMetaPostBodyBody.labels);\n  }\n\n  return customInstance<DatasetMetaGetResponse>(\n    { url: `/dataset/${datasetid}/meta`, method: \"post\", data: formData },\n    options\n  );\n};\n\nexport const useAddMetadata = <\n  TError = ErrorType<DmError | void>,\n  TContext = unknown\n>(options?: {\n  mutation?: UseMutationOptions<\n    AsyncReturnType<typeof addMetadata>,\n    TError,\n    { datasetid: string; data: DatasetMetaPostBodyBody },\n    TContext\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}) => {\n  const { mutation: mutationOptions, request: requestOptions } = options || {};\n\n  const mutationFn: MutationFunction<\n    AsyncReturnType<typeof addMetadata>,\n    { datasetid: string; data: DatasetMetaPostBodyBody }\n  > = (props) => {\n    const { datasetid, data } = props || {};\n\n    return addMetadata(datasetid, data, requestOptions);\n  };\n\n  return useMutation<\n    AsyncReturnType<typeof addMetadata>,\n    TError,\n    { datasetid: string; data: DatasetMetaPostBodyBody },\n    TContext\n  >(mutationFn, mutationOptions);\n};\n/**\n * Returns the metadata for a Dataset in JSON format.\n\n * @summary Gets the metadata for a specific Dataset\n */\nexport const getMetadata = (\n  datasetid: string,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<DatasetMetaGetResponse>(\n    { url: `/dataset/${datasetid}/meta`, method: \"get\" },\n    options\n  );\n};\n\nexport const getGetMetadataQueryKey = (datasetid: string) => [\n  `/dataset/${datasetid}/meta`,\n];\n\nexport const useGetMetadata = <\n  TData = AsyncReturnType<typeof getMetadata>,\n  TError = ErrorType<void | DmError>\n>(\n  datasetid: string,\n  options?: {\n    query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, TError, TData>;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options || {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid);\n\n  const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>\n    getMetadata(datasetid, requestOptions);\n\n  const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!datasetid, ...queryOptions }\n  );\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n"],"mappings":";;;;;;AAUA;AAAA;AAAA;AAAA;AAwCO,IAAM,qBAAqB,CAChC,WACA,gBACA,gCACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,MAAI,+BAA+B,oBAAoB,QAAW;AAChE,aAAS,OACP,mBACA,+BAA+B;AAAA;AAGnC,MAAI,+BAA+B,gBAAgB,QAAW;AAC5D,aAAS,OAAO,eAAe,+BAA+B;AAAA;AAGhE,SAAO,eACL;AAAA,IACE,KAAK,YAAY,kBAAkB;AAAA,IACnC,QAAQ;AAAA,IACR,MAAM;AAAA,KAER;AAAA;AAIG,IAAM,wBAAwB,CAGnC,YAYI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAOF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,gBAAgB,SAAS,SAAS;AAErD,WAAO,mBAAmB,WAAW,gBAAgB,MAAM;AAAA;AAG7D,SAAO,YASL,YAAY;AAAA;AAOT,IAAM,qBAAqB,CAChC,WACA,gBACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,kBAAkB,QAAQ,SAC/D;AAAA;AAIG,IAAM,gCAAgC,CAC3C,WACA,mBACG,CAAC,YAAY,kBAAkB;AAE7B,IAAM,wBAAwB,CAInC,WACA,gBACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WACJ,8CAAc,aACd,8BAA8B,WAAW;AAE3C,QAAM,UAEF,MAAM,mBAAmB,WAAW,gBAAgB;AAExD,QAAM,QAAQ,SAIZ,UAAU,SAAS;AAAA,IACnB,SAAS,CAAC,CAAE,cAAa;AAAA,KACtB;AAGL,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AAWA,IAAM,cAAc,CACzB,WACA,yBACA,YACG;AACH,QAAM,WAAW,IAAI;AACrB,MAAI,wBAAwB,oBAAoB,QAAW;AACzD,aAAS,OAAO,mBAAmB,wBAAwB;AAAA;AAE7D,MAAI,wBAAwB,WAAW,QAAW;AAChD,aAAS,OAAO,UAAU,wBAAwB;AAAA;AAGpD,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,QAAQ,QAAQ,MAAM,YAC3D;AAAA;AAIG,IAAM,iBAAiB,CAG5B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,mBAAmB,WAAW;AAE1E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,WAAW,SAAS,SAAS;AAErC,WAAO,YAAY,WAAW,MAAM;AAAA;AAGtC,SAAO,YAKL,YAAY;AAAA;AAOT,IAAM,cAAc,CACzB,WACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,kBAAkB,QAAQ,SAC7C;AAAA;AAIG,IAAM,yBAAyB,CAAC,cAAsB;AAAA,EAC3D,YAAY;AAAA;AAGP,IAAM,iBAAiB,CAI5B,WACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY,uBAAuB;AAElE,QAAM,UAA8D,MAClE,YAAY,WAAW;AAEzB,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,aAAc;AAG7B,SAAO;AAAA,IACL;AAAA,KACG;AAAA;","names":[]}

package/metadata/package.json

@@ -0,0 +1,7 @@
+{
+  "module": "./metadata.js",
+  "main": "./metadata.cjs",
+  "types": "./metadata.d.ts",
+  "sideEffects": false,
+  "type": "module"
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.7.0",
+  "version": "0.7.1",
   "author": "Oliver Dudgeon",
   "name": "@squonk/data-manager-client",
   "private": false,

package/project/project.d.ts

@@ -1,4 +1,4 @@
-import { b7 as customInstance, aB as ProjectsGetResponse, b8 as ErrorType, b3 as DmError, H as ProjectPostBodyBody, aC as ProjectPostResponse, a6 as ProjectDetail, I as ProjectPatchBodyBody, a0 as TaskIdentity, h as GetProjectFileParams, J as ProjectFilePutBodyBody } from '../custom-instance-9873bed3';
+import { bb as customInstance, aF as ProjectsGetResponse, bc as ErrorType, b7 as DmError, H as ProjectPostBodyBody, aG as ProjectPostResponse, a8 as ProjectDetail, I as ProjectPatchBodyBody, a2 as TaskIdentity, g as GetProjectFileParams, J as ProjectFilePutBodyBody } from '../custom-instance-eb1ebf45';
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
 import 'axios';

package/src/accounting/accounting.ts

@@ -16,8 +16,9 @@ import {
   QueryKey,
 } from "react-query";
 import type {
-  AccountServerGetHostanmeResponse,
+  AccountServerGetNamespaceResponse,
   DmError,
+  VersionGetResponse,
 } from "../data-manager-api.schemas";
 import { customInstance, ErrorType } from ".././custom-instance";
 
@@ -37,29 +38,29 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
   : never;
 
 /**
- * If an Account Server is configured its hostanme, e.g. `example.com`, is returned, otherwise an empty string is returned
+ * If an Account Server is configured its namespace, e.g. `account-server`, is returned, otherwise an empty string is returned
 
- * @summary Gets the Account Server hostname
+ * @summary Gets the Account Server cluster namespace
  */
-export const getAccountServerHostname = (
+export const getAccountServerNamespace = (
   options?: SecondParameter<typeof customInstance>
 ) => {
-  return customInstance<AccountServerGetHostanmeResponse>(
-    { url: `/account-server/hostname`, method: "get" },
+  return customInstance<AccountServerGetNamespaceResponse>(
+    { url: `/account-server/namespace`, method: "get" },
     options
   );
 };
 
-export const getGetAccountServerHostnameQueryKey = () => [
-  `/account-server/hostname`,
+export const getGetAccountServerNamespaceQueryKey = () => [
+  `/account-server/namespace`,
 ];
 
-export const useGetAccountServerHostname = <
-  TData = AsyncReturnType<typeof getAccountServerHostname>,
+export const useGetAccountServerNamespace = <
+  TData = AsyncReturnType<typeof getAccountServerNamespace>,
   TError = ErrorType<void | DmError>
 >(options?: {
   query?: UseQueryOptions<
-    AsyncReturnType<typeof getAccountServerHostname>,
+    AsyncReturnType<typeof getAccountServerNamespace>,
     TError,
     TData
   >;
@@ -68,14 +69,14 @@ export const useGetAccountServerHostname = <
   const { query: queryOptions, request: requestOptions } = options || {};
 
   const queryKey =
-    queryOptions?.queryKey ?? getGetAccountServerHostnameQueryKey();
+    queryOptions?.queryKey ?? getGetAccountServerNamespaceQueryKey();
 
   const queryFn: QueryFunction<
-    AsyncReturnType<typeof getAccountServerHostname>
-  > = () => getAccountServerHostname(requestOptions);
+    AsyncReturnType<typeof getAccountServerNamespace>
+  > = () => getAccountServerNamespace(requestOptions);
 
   const query = useQuery<
-    AsyncReturnType<typeof getAccountServerHostname>,
+    AsyncReturnType<typeof getAccountServerNamespace>,
     TError,
     TData
   >(queryKey, queryFn, queryOptions);
@@ -85,3 +86,43 @@ export const useGetAccountServerHostname = <
     ...query,
   };
 };
+
+/**
+ * @summary Gets the Data Manager version that's running behind the API
+ */
+export const getVersion = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<VersionGetResponse>(
+    { url: `/version`, method: "get" },
+    options
+  );
+};
+
+export const getGetVersionQueryKey = () => [`/version`];
+
+export const useGetVersion = <
+  TData = AsyncReturnType<typeof getVersion>,
+  TError = ErrorType<void | DmError>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getVersion>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetVersionQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getVersion>> = () =>
+    getVersion(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getVersion>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};

package/src/admin/admin.ts

@@ -25,6 +25,7 @@ import type {
   AdminUserPutResponse,
   UserPatchBodyBody,
   AdminJobManifestLoadPutResponse,
+  JobManifestPutBodyBody,
 } from "../data-manager-api.schemas";
 import { customInstance, ErrorType } from ".././custom-instance";
 
@@ -340,6 +341,64 @@ export const useAdminPatchUser = <
     TContext
   >(mutationFn, mutationOptions);
 };
+/**
+ * This endpoint is used to add (or update an existing manifest). Manifests are the soirce of Job defintions. Once added the manifest is inspected and any Jobs it refers to are loaded.
+
+A limited number of manifest origins (URLs) are supported. At the moment we support basic GitHib and GitLab URLs, i.e. those that begin `https://raw.githubusercontent.com/` and `https://gitlab.com/api/v4/projects/`.
+
+You will need **admin** rights to use this endpoint
+
+ * @summary Adds a manifest and triggers the download of Job Definitions
+ */
+export const adminJobManifestPut = (
+  jobManifestPutBodyBody: JobManifestPutBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  const formData = new FormData();
+  formData.append("url", jobManifestPutBodyBody.url);
+  if (jobManifestPutBodyBody.header !== undefined) {
+    formData.append("header", jobManifestPutBodyBody.header);
+  }
+  if (jobManifestPutBodyBody.params !== undefined) {
+    formData.append("params", jobManifestPutBodyBody.params);
+  }
+
+  return customInstance<AdminJobManifestLoadPutResponse>(
+    { url: `/admin/job-manifest`, method: "put", data: formData },
+    options
+  );
+};
+
+export const useAdminJobManifestPut = <
+  TError = ErrorType<void | DmError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof adminJobManifestPut>,
+    TError,
+    { data: JobManifestPutBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof adminJobManifestPut>,
+    { data: JobManifestPutBodyBody }
+  > = (props) => {
+    const { data } = props || {};
+
+    return adminJobManifestPut(data, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof adminJobManifestPut>,
+    TError,
+    { data: JobManifestPutBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};
 /**
  * This endpoint is used to trigger the Data Manager to re-inspect the internal Job **Manifest** table and download the manifests and reprocess the related job definitions. This is normally done by an administrator when the Manifest table has been modified or if external job defitnions are known to have changed in the referenced repositories.
 

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

@@ -17,10 +17,6 @@ export type GetUserApiLogParams = {
   until?: QUntilParameter;
 };
 
-export type GetUserAccountParams = {
-  do_not_impersonate?: QDoNotImpersonateParameter;
-};
-
 export type PatchInstanceParams = { archive?: QInstanceArchiveParameter };
 
 export type GetInstancesParams = { project_id?: QProjectIdParameter };
@@ -189,6 +185,10 @@ export type QDatasetMimeTypeParameter = string;
  */
 export type QDoNotImpersonateParameter = boolean;
 
+export type GetUserAccountParams = {
+  do_not_impersonate?: QDoNotImpersonateParameter;
+};
+
 export 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 accont can be restored by setting the message to `/restore`
    */
@@ -243,6 +243,15 @@ export type ProjectFilePutBodyBody = {
   path?: string;
 };
 
+export type JobManifestPutBodyBody = {
+  /** The URL of the Job Manifest */
+  url: string;
+  /** Optional URL header values (a JSON string) */
+  header?: string;
+  /** Optional URL parameter values (a JSON string) */
+  params?: string;
+};
+
 export 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_.
    */
@@ -256,6 +265,12 @@ export type InstancePostBodyBody = {
   /** The name to use for the instance
    */
   as_name: 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;
+  /** 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;
   /** 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.
@@ -265,11 +280,11 @@ The behaviour of **Application** instances using this property is undefined. It
   debug?: string;
   /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
 
-When laucnhing a Data Manager **Job** Application you must identify the Job using the properties `collection`, `job` and `version`, e.g. `{"collection":"blob","job":"filter","version":"1.0.0"}`
+When laucnhing 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`. For example, if you want the Job to start in the path `foo/bar` (inside the Job's built-in working directory) you can provide `"sub_path":"foo/bar"` in the specification. In this instance the Job will start in the directory `/data/foo/bar` with the Data Manager creating the directory if it does not exist. You can only use a sub-path for a Job if the Job defines a working directory.
+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 (`/`).
  */
   specification?: string;
 };
@@ -328,10 +343,22 @@ export type DatasetPutBodyBody = {
   unit_id?: string;
 };
 
-export type DatasetAnnotationsPostBodyBody = {
-  /** JSON string containing a list of annotations. The format of these annotations is expected to have been created using the data-manager-metadata library. The same library will be used to created the annotation object(s) that is added to the metadata for the dataset, so the formats should match.
+export type DatasetVersionMetaPostBodyBody = {
+  /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
    */
-  annotations: string;
+  meta_properties?: string;
+  /** 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;
+};
+
+export type DatasetMetaPostBodyBody = {
+  /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
+   */
+  meta_properties?: string;
+  /** 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;
 };
 
 export type DatasetPostBodyBody = {
@@ -730,6 +757,33 @@ export const InstanceSummaryJobImageType = {
   NEXTFLOW: "NEXTFLOW" as InstanceSummaryJobImageType,
 };
 
+/**
+ * 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 preparring 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 unsuccesfully.
+
+ */
+export type InstanceSummaryPhase =
+  | "COMPLETED"
+  | "CRASH_LOOP_BACKOFF"
+  | "FAILED"
+  | "IMAGE_PULL_BACKOFF"
+  | "PENDING"
+  | "RUNNING"
+  | "SUCCEEDED"
+  | "UNKNOWN";
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const InstanceSummaryPhase = {
+  COMPLETED: "COMPLETED" as InstanceSummaryPhase,
+  CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF" as InstanceSummaryPhase,
+  FAILED: "FAILED" as InstanceSummaryPhase,
+  IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF" as InstanceSummaryPhase,
+  PENDING: "PENDING" as InstanceSummaryPhase,
+  RUNNING: "RUNNING" as InstanceSummaryPhase,
+  SUCCEEDED: "SUCCEEDED" as InstanceSummaryPhase,
+  UNKNOWN: "UNKNOWN" as InstanceSummaryPhase,
+};
+
 /**
  * The type of Application, which can be a `job` or an `application`
 
@@ -762,8 +816,9 @@ export interface InstanceSummary {
    */
   authorisation_code?: number;
   /** 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 initial phase, indicating that the Instance is preparring 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 unsuccesfully.
+ */
+  phase: InstanceSummaryPhase;
   /** The data and time (UTC) the instance was laucnhed
    */
   launched: string;
@@ -1074,6 +1129,12 @@ export interface ApiLogDetail {
   impersonator?: string;
 }
 
+export 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;
+}
+
 export interface UsersGetResponse {
   /** A list of Users that have used the Data Manager
    */
@@ -1260,6 +1321,33 @@ export 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 preparring 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 unsuccesfully.
+
+ */
+export type InstanceGetResponsePhase =
+  | "COMPLETED"
+  | "CRASH_LOOP_BACKOFF"
+  | "FAILED"
+  | "IMAGE_PULL_BACKOFF"
+  | "PENDING"
+  | "RUNNING"
+  | "SUCCEEDED"
+  | "UNKNOWN";
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const InstanceGetResponsePhase = {
+  COMPLETED: "COMPLETED" as InstanceGetResponsePhase,
+  CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF" as InstanceGetResponsePhase,
+  FAILED: "FAILED" as InstanceGetResponsePhase,
+  IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF" as InstanceGetResponsePhase,
+  PENDING: "PENDING" as InstanceGetResponsePhase,
+  RUNNING: "RUNNING" as InstanceGetResponsePhase,
+  SUCCEEDED: "SUCCEEDED" as InstanceGetResponsePhase,
+  UNKNOWN: "UNKNOWN" as InstanceGetResponsePhase,
+};
+
 /**
  * The type of Application, which can be a `job` or an `application`
 
@@ -1301,8 +1389,9 @@ export interface InstanceGetResponse {
    */
   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 initial phase, indicating that the Instance is preparring 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 unsuccesfully.
+ */
+  phase: InstanceGetResponsePhase;
   /** The application endpoint
    */
   url?: string;
@@ -1417,6 +1506,9 @@ export interface DatasetMetaGetResponse {
   /** The Metadata's annotations
    */
   annotations: unknown[];
+  /** The Metadata's labels
+   */
+  labels: unknown[];
 }
 
 export interface DatasetDigestGetResponse {
@@ -1440,10 +1532,6 @@ export interface DatasetPutPostResponse {
   task_id: string;
 }
 
-export interface DatasetAnnotationsPostResponse {
-  annotations: unknown[];
-}
-
 export interface ApplicationsGetResponse {
   /** A list of installed appications, which are application-compliant Kubernetes "operators"
    */
@@ -1488,10 +1576,10 @@ export interface AdminJobManifestLoadPutResponse {
   jobs_inspected: number;
 }
 
-export interface AccountServerGetHostanmeResponse {
-  /** The configured Account Server hostname, which will be an empty string if one is not configured
+export 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.
    */
-  hostname: string;
+  namespace: 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;

package/src/instance/instance.ts

@@ -68,6 +68,12 @@ export const createInstance = (
   );
   formData.append("project_id", instancePostBodyBody.project_id);
   formData.append("as_name", instancePostBodyBody.as_name);
+  if (instancePostBodyBody.callback_url !== undefined) {
+    formData.append("callback_url", instancePostBodyBody.callback_url);
+  }
+  if (instancePostBodyBody.callback_context !== undefined) {
+    formData.append("callback_context", instancePostBodyBody.callback_context);
+  }
   if (instancePostBodyBody.debug !== undefined) {
     formData.append("debug", instancePostBodyBody.debug);
   }