@squonk/data-manager-client 1.0.0-rc.4 → 1.0.2-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/accounting/accounting.d.ts +1 -1
  2. package/admin/admin.cjs +19 -1
  3. package/admin/admin.cjs.map +1 -1
  4. package/admin/admin.d.ts +23 -6
  5. package/admin/admin.js +18 -0
  6. package/admin/admin.js.map +1 -1
  7. package/application/application.cjs.map +1 -1
  8. package/application/application.d.ts +3 -3
  9. package/application/application.js.map +1 -1
  10. package/{custom-instance-f73fb7dc.d.ts → custom-instance-3a73945d.d.ts} +49 -12
  11. package/dataset/dataset.cjs.map +1 -1
  12. package/dataset/dataset.d.ts +5 -5
  13. package/dataset/dataset.js.map +1 -1
  14. package/exchange-rate/exchange-rate.d.ts +1 -1
  15. package/file/file.d.ts +1 -1
  16. package/index.cjs.map +1 -1
  17. package/index.d.ts +1 -1
  18. package/index.js.map +1 -1
  19. package/instance/instance.cjs.map +1 -1
  20. package/instance/instance.d.ts +5 -5
  21. package/instance/instance.js.map +1 -1
  22. package/job/job.cjs.map +1 -1
  23. package/job/job.d.ts +3 -3
  24. package/job/job.js.map +1 -1
  25. package/metadata/metadata.cjs.map +1 -1
  26. package/metadata/metadata.d.ts +3 -3
  27. package/metadata/metadata.js.map +1 -1
  28. package/package.json +1 -1
  29. package/project/project.cjs.map +1 -1
  30. package/project/project.d.ts +13 -13
  31. package/project/project.js.map +1 -1
  32. package/src/admin/admin.ts +61 -4
  33. package/src/application/application.ts +2 -2
  34. package/src/data-manager-api.schemas.ts +52 -13
  35. package/src/dataset/dataset.ts +4 -4
  36. package/src/instance/instance.ts +4 -4
  37. package/src/job/job.ts +2 -2
  38. package/src/metadata/metadata.ts +2 -2
  39. package/src/project/project.ts +12 -12
  40. package/src/task/task.ts +2 -2
  41. package/task/task.cjs.map +1 -1
  42. package/task/task.d.ts +3 -3
  43. package/task/task.js.map +1 -1
  44. package/type/type.d.ts +1 -1
  45. package/user/user.d.ts +1 -1
@@ -1,5 +1,5 @@
1
1
  import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
2
- import { bz as customInstance, bt as AccountServerGetNamespaceResponse, bA as ErrorType, bv as DmError, bu as AccountServerGetRegistrationResponse, aP as VersionGetResponse } from '../custom-instance-f73fb7dc.js';
2
+ import { bB as customInstance, bv as AccountServerGetNamespaceResponse, bC as ErrorType, bx as DmError, bw as AccountServerGetRegistrationResponse, aQ as VersionGetResponse } from '../custom-instance-3a73945d.js';
3
3
  import 'axios';
4
4
 
5
5
  declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
package/admin/admin.cjs CHANGED
@@ -98,6 +98,21 @@ var useAdminPatchUser = (options) => {
98
98
  };
99
99
  return _reactquery.useMutation.call(void 0, mutationFn, mutationOptions);
100
100
  };
101
+ var adminGetJobManifests = (options, signal) => {
102
+ return _chunkIUEU2LYCcjs.customInstance.call(void 0,
103
+ { url: `/admin/job-manifest`, method: "get", signal },
104
+ options
105
+ );
106
+ };
107
+ var getAdminGetJobManifestsQueryKey = () => [`/admin/job-manifest`];
108
+ var useAdminGetJobManifests = (options) => {
109
+ const { query: queryOptions, request: requestOptions } = _nullishCoalesce(options, () => ( {}));
110
+ const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getAdminGetJobManifestsQueryKey()));
111
+ const queryFn = ({ signal }) => adminGetJobManifests(requestOptions, signal);
112
+ const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, queryOptions);
113
+ query.queryKey = queryKey;
114
+ return query;
115
+ };
101
116
  var adminJobManifestPut = (jobManifestPutBodyBody, options) => {
102
117
  const formData = new FormData();
103
118
  formData.append("url", jobManifestPutBodyBody.url);
@@ -164,5 +179,8 @@ var useAdminJobManifestLoad = (options) => {
164
179
 
165
180
 
166
181
 
167
- exports.adminDeleteServiceError = adminDeleteServiceError; exports.adminDeleteUser = adminDeleteUser; exports.adminGetServiceErrors = adminGetServiceErrors; exports.adminJobManifestLoad = adminJobManifestLoad; exports.adminJobManifestPut = adminJobManifestPut; exports.adminPatchServiceError = adminPatchServiceError; exports.adminPatchUser = adminPatchUser; exports.adminPutUser = adminPutUser; exports.getAdminGetServiceErrorsQueryKey = getAdminGetServiceErrorsQueryKey; exports.useAdminDeleteServiceError = useAdminDeleteServiceError; exports.useAdminDeleteUser = useAdminDeleteUser; exports.useAdminGetServiceErrors = useAdminGetServiceErrors; exports.useAdminJobManifestLoad = useAdminJobManifestLoad; exports.useAdminJobManifestPut = useAdminJobManifestPut; exports.useAdminPatchServiceError = useAdminPatchServiceError; exports.useAdminPatchUser = useAdminPatchUser; exports.useAdminPutUser = useAdminPutUser;
182
+
183
+
184
+
185
+ exports.adminDeleteServiceError = adminDeleteServiceError; exports.adminDeleteUser = adminDeleteUser; exports.adminGetJobManifests = adminGetJobManifests; exports.adminGetServiceErrors = adminGetServiceErrors; exports.adminJobManifestLoad = adminJobManifestLoad; exports.adminJobManifestPut = adminJobManifestPut; exports.adminPatchServiceError = adminPatchServiceError; exports.adminPatchUser = adminPatchUser; exports.adminPutUser = adminPutUser; exports.getAdminGetJobManifestsQueryKey = getAdminGetJobManifestsQueryKey; exports.getAdminGetServiceErrorsQueryKey = getAdminGetServiceErrorsQueryKey; exports.useAdminDeleteServiceError = useAdminDeleteServiceError; exports.useAdminDeleteUser = useAdminDeleteUser; exports.useAdminGetJobManifests = useAdminGetJobManifests; exports.useAdminGetServiceErrors = useAdminGetServiceErrors; exports.useAdminJobManifestLoad = useAdminJobManifestLoad; exports.useAdminJobManifestPut = useAdminJobManifestPut; exports.useAdminPatchServiceError = useAdminPatchServiceError; exports.useAdminPatchUser = useAdminPatchUser; exports.useAdminPutUser = useAdminPutUser;
168
186
  //# sourceMappingURL=admin.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/admin/admin.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAqC/B,IAAM,wBAAwB,CACnC,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC7D;AAAA,EACF;AACF;AAEO,IAAM,mCAAmC,CAC9C,WACG,CAAC,wBAAwB,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAOlD,IAAM,2BAA2B,CAItC,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,iCAAiC,MAAM;AAEnE,QAAM,UAEF,CAAC,EAAE,OAAO,MAAM,sBAAsB,QAAQ,gBAAgB,MAAM;AAExE,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AASO,IAAM,yBAAyB,CACpC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,QAAQ;AAAA,IAC1D;AAAA,EACF;AACF;AAQO,IAAM,4BAA4B,CAGvC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,uBAAuB,SAAS,cAAc;AAAA,EACvD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,0BAA0B,CACrC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,SAAS;AAAA,IAC3D;AAAA,EACF;AACF;AAQO,IAAM,6BAA6B,CAGxC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,wBAAwB,SAAS,cAAc;AAAA,EACxD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,eAAe,CAC1B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,MAAM;AAAA,IAC9C;AAAA,EACF;AACF;AAQO,IAAM,kBAAkB,CAG7B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,aAAa,QAAQ,cAAc;AAAA,EAC5C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,kBAAkB,CAC7B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,SAAS;AAAA,IACjD;AAAA,EACF;AACF;AAQO,IAAM,qBAAqB,CAGhC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,gBAAgB,QAAQ,cAAc;AAAA,EAC/C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,iBAAiB,CAC5B,QACA,mBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,MAAI,kBAAkB,oBAAoB,QAAW;AACnD,aAAS,OAAO,mBAAmB,kBAAkB,eAAe;AAAA,EACtE;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK,eAAe;AAAA,MACpB,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,oBAAoB,CAG/B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,KAAK,IAAI,SAAS,CAAC;AAEnC,WAAO,eAAe,QAAQ,MAAM,cAAc;AAAA,EACpD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAUO,IAAM,sBAAsB,CACjC,wBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,OAAO,uBAAuB,GAAG;AACjD,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AACA,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,yBAAyB,CAGpC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,oBAAoB,MAAM,cAAc;AAAA,EACjD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,uBAAuB,CAClC,4BACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,SAAS,2BAA2B,MAAM,SAAS,CAAC;AAEpE,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,0BAA0B,CAGrC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,qBAAqB,MAAM,cAAc;AAAA,EAClD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B","sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ServiceErrorsGetResponse,\n DmError,\n AdminGetServiceErrorsParams,\n AdminUserPutResponse,\n UserPatchBodyBody,\n AdminJobManifestLoadPutResponse,\n JobManifestPutBodyBody,\n JobManifestLoadPutBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Displays the existing Service Errors, which can also include acknowledged errors, normally excluded from the list.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Gets Service Errors\n */\nexport const adminGetServiceErrors = (\n params?: AdminGetServiceErrorsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ServiceErrorsGetResponse>(\n { url: `/admin/service-error`, method: \"get\", params, signal },\n options\n );\n};\n\nexport const getAdminGetServiceErrorsQueryKey = (\n params?: AdminGetServiceErrorsParams\n) => [`/admin/service-error`, ...(params ? [params] : [])];\n\nexport type AdminGetServiceErrorsQueryResult = NonNullable<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n>;\nexport type AdminGetServiceErrorsQueryError = ErrorType<void | DmError>;\n\nexport const useAdminGetServiceErrors = <\n TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError = ErrorType<void | DmError>\n>(\n params?: AdminGetServiceErrorsParams,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\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 ?? getAdminGetServiceErrorsQueryKey(params);\n\n const queryFn: QueryFunction<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n > = ({ signal }) => adminGetServiceErrors(params, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Used primarily to 'Acknowledge' but not delete a Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patches a Service Error\n */\nexport const adminPatchServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"patch\" },\n options\n );\n};\n\nexport type AdminPatchServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchServiceError>>\n>;\n\nexport type AdminPatchServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminPatchServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes an existing Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a Service Error\n */\nexport const adminDeleteServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteServiceError>>\n>;\n\nexport type AdminDeleteServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminDeleteServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * This method adds a user to the Data Manager service. The user is authenticated via a keycloak server but will need an initialised account before they can create Datasets or Projects.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Prepares a user account in the Data Manager service\n */\nexport const adminPutUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<AdminUserPutResponse>(\n { url: `/admin/user/${userId}`, method: \"put\" },\n options\n );\n};\n\nexport type AdminPutUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPutUser>>\n>;\n\nexport type AdminPutUserMutationError = ErrorType<void | DmError>;\n\nexport const useAdminPutUser = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPutUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminPutUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes a user account, along with all the user's Datasets\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a user account\n */\nexport const adminDeleteUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/user/${userId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteUser>>\n>;\n\nexport type AdminDeleteUserMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminDeleteUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Patches a user record, typically to suspend or re-enable a user account\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patch a given user\n */\nexport const adminPatchUser = (\n userId: string,\n userPatchBodyBody: UserPatchBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n if (userPatchBodyBody.suspend_message !== undefined) {\n formData.append(\"suspend_message\", userPatchBodyBody.suspend_message);\n }\n\n return customInstance<void>(\n {\n url: `/admin/user/${userId}`,\n method: \"patch\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminPatchUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchUser>>\n>;\nexport type AdminPatchUserMutationBody = UserPatchBodyBody;\nexport type AdminPatchUserMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchUser>>,\n { userId: string; data: UserPatchBodyBody }\n > = (props) => {\n const { userId, data } = props ?? {};\n\n return adminPatchUser(userId, data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * This endpoint is used to add (or update an existing manifest). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.\n\nA 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/`.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Adds a manifest and triggers the download of Job Definitions\n */\nexport const adminJobManifestPut = (\n jobManifestPutBodyBody: JobManifestPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"url\", jobManifestPutBodyBody.url);\n if (jobManifestPutBodyBody.header !== undefined) {\n formData.append(\"header\", jobManifestPutBodyBody.header);\n }\n if (jobManifestPutBodyBody.params !== undefined) {\n formData.append(\"params\", jobManifestPutBodyBody.params);\n }\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestPutMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestPut>>\n>;\nexport type AdminJobManifestPutMutationBody = JobManifestPutBodyBody;\nexport type AdminJobManifestPutMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestPut = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n { data: JobManifestPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestPut(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * 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 definitions are known to have changed in the referenced repositories.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Trigger a download of known Job Definitions using the Manifest table\n */\nexport const adminJobManifestLoad = (\n jobManifestLoadPutBodyBody: JobManifestLoadPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"purge\", jobManifestLoadPutBodyBody.purge.toString());\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest/load`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestLoadMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestLoad>>\n>;\nexport type AdminJobManifestLoadMutationBody = JobManifestLoadPutBodyBody;\nexport type AdminJobManifestLoadMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestLoad = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n { data: JobManifestLoadPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestLoad(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n"]}
1
+ {"version":3,"sources":["../../src/admin/admin.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAsC/B,IAAM,wBAAwB,CACnC,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC7D;AAAA,EACF;AACF;AAEO,IAAM,mCAAmC,CAC9C,WACG,CAAC,wBAAwB,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAOlD,IAAM,2BAA2B,CAItC,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,iCAAiC,MAAM;AAEnE,QAAM,UAEF,CAAC,EAAE,OAAO,MAAM,sBAAsB,QAAQ,gBAAgB,MAAM;AAExE,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AASO,IAAM,yBAAyB,CACpC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,QAAQ;AAAA,IAC1D;AAAA,EACF;AACF;AAQO,IAAM,4BAA4B,CAGvC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,uBAAuB,SAAS,cAAc;AAAA,EACvD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,0BAA0B,CACrC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,SAAS;AAAA,IAC3D;AAAA,EACF;AACF;AAQO,IAAM,6BAA6B,CAGxC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,wBAAwB,SAAS,cAAc;AAAA,EACxD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,eAAe,CAC1B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,MAAM;AAAA,IAC9C;AAAA,EACF;AACF;AAQO,IAAM,kBAAkB,CAG7B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,aAAa,QAAQ,cAAc;AAAA,EAC5C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,kBAAkB,CAC7B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,SAAS;AAAA,IACjD;AAAA,EACF;AACF;AAQO,IAAM,qBAAqB,CAGhC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,gBAAgB,QAAQ,cAAc;AAAA,EAC/C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,iBAAiB,CAC5B,QACA,mBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,MAAI,kBAAkB,oBAAoB,QAAW;AACnD,aAAS,OAAO,mBAAmB,kBAAkB,eAAe;AAAA,EACtE;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK,eAAe;AAAA,MACpB,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,oBAAoB,CAG/B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,KAAK,IAAI,SAAS,CAAC;AAEnC,WAAO,eAAe,QAAQ,MAAM,cAAc;AAAA,EACpD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,uBAAuB,CAClC,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,uBAAuB,QAAQ,OAAO,OAAO;AAAA,IACpD;AAAA,EACF;AACF;AAEO,IAAM,kCAAkC,MAAM,CAAC,qBAAqB;AAOpE,IAAM,0BAA0B,CAGrC,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,gCAAgC;AAE3E,QAAM,UAEF,CAAC,EAAE,OAAO,MAAM,qBAAqB,gBAAgB,MAAM;AAE/D,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AAWO,IAAM,sBAAsB,CACjC,wBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,OAAO,uBAAuB,GAAG;AACjD,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AACA,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,yBAAyB,CAGpC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,oBAAoB,MAAM,cAAc;AAAA,EACjD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,uBAAuB,CAClC,4BACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,SAAS,2BAA2B,MAAM,SAAS,CAAC;AAEpE,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,0BAA0B,CAGrC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,qBAAqB,MAAM,cAAc;AAAA,EAClD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B","sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ServiceErrorsGetResponse,\n DmError,\n AdminGetServiceErrorsParams,\n AdminUserPutResponse,\n UserPatchBodyBody,\n AdminJobManifestGetResponse,\n AdminJobManifestLoadPutResponse,\n JobManifestPutBodyBody,\n JobManifestLoadPutBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Displays the existing Service Errors, which can also include acknowledged errors, normally excluded from the list.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Gets Service Errors\n */\nexport const adminGetServiceErrors = (\n params?: AdminGetServiceErrorsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ServiceErrorsGetResponse>(\n { url: `/admin/service-error`, method: \"get\", params, signal },\n options\n );\n};\n\nexport const getAdminGetServiceErrorsQueryKey = (\n params?: AdminGetServiceErrorsParams\n) => [`/admin/service-error`, ...(params ? [params] : [])];\n\nexport type AdminGetServiceErrorsQueryResult = NonNullable<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n>;\nexport type AdminGetServiceErrorsQueryError = ErrorType<void | DmError>;\n\nexport const useAdminGetServiceErrors = <\n TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError = ErrorType<void | DmError>\n>(\n params?: AdminGetServiceErrorsParams,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\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 ?? getAdminGetServiceErrorsQueryKey(params);\n\n const queryFn: QueryFunction<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n > = ({ signal }) => adminGetServiceErrors(params, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Used primarily to 'Acknowledge' but not delete a Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patches a Service Error\n */\nexport const adminPatchServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"patch\" },\n options\n );\n};\n\nexport type AdminPatchServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchServiceError>>\n>;\n\nexport type AdminPatchServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminPatchServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes an existing Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a Service Error\n */\nexport const adminDeleteServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteServiceError>>\n>;\n\nexport type AdminDeleteServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminDeleteServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * This method adds a user to the Data Manager service. The user is authenticated via a keycloak server but will need an initialised account before they can create Datasets or Projects.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Prepares a user account in the Data Manager service\n */\nexport const adminPutUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<AdminUserPutResponse>(\n { url: `/admin/user/${userId}`, method: \"put\" },\n options\n );\n};\n\nexport type AdminPutUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPutUser>>\n>;\n\nexport type AdminPutUserMutationError = ErrorType<void | DmError>;\n\nexport const useAdminPutUser = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPutUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminPutUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes a user account, along with all the user's Datasets\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a user account\n */\nexport const adminDeleteUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/user/${userId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteUser>>\n>;\n\nexport type AdminDeleteUserMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminDeleteUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Patches a user record, typically to suspend or re-enable a user account\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patch a given user\n */\nexport const adminPatchUser = (\n userId: string,\n userPatchBodyBody: UserPatchBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n if (userPatchBodyBody.suspend_message !== undefined) {\n formData.append(\"suspend_message\", userPatchBodyBody.suspend_message);\n }\n\n return customInstance<void>(\n {\n url: `/admin/user/${userId}`,\n method: \"patch\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminPatchUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchUser>>\n>;\nexport type AdminPatchUserMutationBody = UserPatchBodyBody;\nexport type AdminPatchUserMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchUser>>,\n { userId: string; data: UserPatchBodyBody }\n > = (props) => {\n const { userId, data } = props ?? {};\n\n return adminPatchUser(userId, data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Returns the list of known **Job Manifests** including the time the manifest was last loaded and its load status, a message indicating success or failure.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Get Job Manifests\n */\nexport const adminGetJobManifests = (\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<AdminJobManifestGetResponse>(\n { url: `/admin/job-manifest`, method: \"get\", signal },\n options\n );\n};\n\nexport const getAdminGetJobManifestsQueryKey = () => [`/admin/job-manifest`];\n\nexport type AdminGetJobManifestsQueryResult = NonNullable<\n Awaited<ReturnType<typeof adminGetJobManifests>>\n>;\nexport type AdminGetJobManifestsQueryError = ErrorType<void | DmError>;\n\nexport const useAdminGetJobManifests = <\n TData = Awaited<ReturnType<typeof adminGetJobManifests>>,\n TError = ErrorType<void | DmError>\n>(options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof adminGetJobManifests>>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getAdminGetJobManifestsQueryKey();\n\n const queryFn: QueryFunction<\n Awaited<ReturnType<typeof adminGetJobManifests>>\n > = ({ signal }) => adminGetJobManifests(requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof adminGetJobManifests>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * This endpoint is used to add (or update an existing **Job Manifest**). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.\n\nA 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/`.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Adds a Job Manifest and triggers the download of its Job Definitions\n */\nexport const adminJobManifestPut = (\n jobManifestPutBodyBody: JobManifestPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"url\", jobManifestPutBodyBody.url);\n if (jobManifestPutBodyBody.header !== undefined) {\n formData.append(\"header\", jobManifestPutBodyBody.header);\n }\n if (jobManifestPutBodyBody.params !== undefined) {\n formData.append(\"params\", jobManifestPutBodyBody.params);\n }\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestPutMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestPut>>\n>;\nexport type AdminJobManifestPutMutationBody = JobManifestPutBodyBody;\nexport type AdminJobManifestPutMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestPut = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n { data: JobManifestPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestPut(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * 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 definitions are known to have changed in the referenced repositories.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Trigger a download of Job Definitions using existing Job Manifests\n */\nexport const adminJobManifestLoad = (\n jobManifestLoadPutBodyBody: JobManifestLoadPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"purge\", jobManifestLoadPutBodyBody.purge.toString());\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest/load`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestLoadMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestLoad>>\n>;\nexport type AdminJobManifestLoadMutationBody = JobManifestLoadPutBodyBody;\nexport type AdminJobManifestLoadMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestLoad = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n { data: JobManifestLoadPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestLoad(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n"]}
package/admin/admin.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as AdminGetServiceErrorsParams, bz as customInstance, aX as ServiceErrorsGetResponse, bA as ErrorType, bv as DmError, aa as UserAccountDetail, W as UserPatchBodyBody, a0 as JobManifestPutBodyBody, bs as AdminJobManifestLoadPutResponse, a1 as JobManifestLoadPutBodyBody } from '../custom-instance-f73fb7dc.js';
1
+ import { A as AdminGetServiceErrorsParams, bB as customInstance, aY as ServiceErrorsGetResponse, bC as ErrorType, bx as DmError, aa as UserAccountDetail, W as UserPatchBodyBody, bu as AdminJobManifestGetResponse, a0 as JobManifestPutBodyBody, bt as AdminJobManifestLoadPutResponse, a1 as JobManifestLoadPutBodyBody } from '../custom-instance-3a73945d.js';
2
2
  import * as react_query from 'react-query';
3
3
  import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
4
4
  import 'axios';
@@ -115,13 +115,30 @@ declare const useAdminPatchUser: <TError = ErrorType<DmError>, TContext = unknow
115
115
  data: UserPatchBodyBody;
116
116
  }, TContext>;
117
117
  /**
118
- * This endpoint is used to add (or update an existing manifest). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.
118
+ * Returns the list of known **Job Manifests** including the time the manifest was last loaded and its load status, a message indicating success or failure.
119
+
120
+ You will need **admin** rights to use this endpoint
121
+
122
+ * @summary Get Job Manifests
123
+ */
124
+ declare const adminGetJobManifests: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal | undefined) => Promise<AdminJobManifestGetResponse>;
125
+ declare const getAdminGetJobManifestsQueryKey: () => string[];
126
+ declare type AdminGetJobManifestsQueryResult = NonNullable<Awaited<ReturnType<typeof adminGetJobManifests>>>;
127
+ declare type AdminGetJobManifestsQueryError = ErrorType<void | DmError>;
128
+ declare const useAdminGetJobManifests: <TData = AdminJobManifestGetResponse, TError = ErrorType<void | DmError>>(options?: {
129
+ query?: UseQueryOptions<AdminJobManifestGetResponse, TError, TData, QueryKey> | undefined;
130
+ request?: SecondParameter<typeof customInstance>;
131
+ } | undefined) => UseQueryResult<TData, TError> & {
132
+ queryKey: QueryKey;
133
+ };
134
+ /**
135
+ * This endpoint is used to add (or update an existing **Job Manifest**). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.
119
136
 
120
137
  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/`.
121
138
 
122
139
  You will need **admin** rights to use this endpoint
123
140
 
124
- * @summary Adds a manifest and triggers the download of Job Definitions
141
+ * @summary Adds a Job Manifest and triggers the download of its Job Definitions
125
142
  */
126
143
  declare const adminJobManifestPut: (jobManifestPutBodyBody: JobManifestPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<AdminJobManifestLoadPutResponse>;
127
144
  declare type AdminJobManifestPutMutationResult = NonNullable<Awaited<ReturnType<typeof adminJobManifestPut>>>;
@@ -136,11 +153,11 @@ declare const useAdminJobManifestPut: <TError = ErrorType<void | DmError>, TCont
136
153
  data: JobManifestPutBodyBody;
137
154
  }, TContext>;
138
155
  /**
139
- * 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 definitions are known to have changed in the referenced repositories.
156
+ * 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 definitions are known to have changed in the referenced repositories.
140
157
 
141
158
  You will need **admin** rights to use this endpoint
142
159
 
143
- * @summary Trigger a download of known Job Definitions using the Manifest table
160
+ * @summary Trigger a download of Job Definitions using existing Job Manifests
144
161
  */
145
162
  declare const adminJobManifestLoad: (jobManifestLoadPutBodyBody: JobManifestLoadPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<AdminJobManifestLoadPutResponse>;
146
163
  declare type AdminJobManifestLoadMutationResult = NonNullable<Awaited<ReturnType<typeof adminJobManifestLoad>>>;
@@ -155,4 +172,4 @@ declare const useAdminJobManifestLoad: <TError = ErrorType<void | DmError>, TCon
155
172
  data: JobManifestLoadPutBodyBody;
156
173
  }, TContext>;
157
174
 
158
- export { AdminDeleteServiceErrorMutationError, AdminDeleteServiceErrorMutationResult, AdminDeleteUserMutationError, AdminDeleteUserMutationResult, AdminGetServiceErrorsQueryError, AdminGetServiceErrorsQueryResult, AdminJobManifestLoadMutationBody, AdminJobManifestLoadMutationError, AdminJobManifestLoadMutationResult, AdminJobManifestPutMutationBody, AdminJobManifestPutMutationError, AdminJobManifestPutMutationResult, AdminPatchServiceErrorMutationError, AdminPatchServiceErrorMutationResult, AdminPatchUserMutationBody, AdminPatchUserMutationError, AdminPatchUserMutationResult, AdminPutUserMutationError, AdminPutUserMutationResult, adminDeleteServiceError, adminDeleteUser, adminGetServiceErrors, adminJobManifestLoad, adminJobManifestPut, adminPatchServiceError, adminPatchUser, adminPutUser, getAdminGetServiceErrorsQueryKey, useAdminDeleteServiceError, useAdminDeleteUser, useAdminGetServiceErrors, useAdminJobManifestLoad, useAdminJobManifestPut, useAdminPatchServiceError, useAdminPatchUser, useAdminPutUser };
175
+ export { AdminDeleteServiceErrorMutationError, AdminDeleteServiceErrorMutationResult, AdminDeleteUserMutationError, AdminDeleteUserMutationResult, AdminGetJobManifestsQueryError, AdminGetJobManifestsQueryResult, AdminGetServiceErrorsQueryError, AdminGetServiceErrorsQueryResult, AdminJobManifestLoadMutationBody, AdminJobManifestLoadMutationError, AdminJobManifestLoadMutationResult, AdminJobManifestPutMutationBody, AdminJobManifestPutMutationError, AdminJobManifestPutMutationResult, AdminPatchServiceErrorMutationError, AdminPatchServiceErrorMutationResult, AdminPatchUserMutationBody, AdminPatchUserMutationError, AdminPatchUserMutationResult, AdminPutUserMutationError, AdminPutUserMutationResult, adminDeleteServiceError, adminDeleteUser, adminGetJobManifests, adminGetServiceErrors, adminJobManifestLoad, adminJobManifestPut, adminPatchServiceError, adminPatchUser, adminPutUser, getAdminGetJobManifestsQueryKey, getAdminGetServiceErrorsQueryKey, useAdminDeleteServiceError, useAdminDeleteUser, useAdminGetJobManifests, useAdminGetServiceErrors, useAdminJobManifestLoad, useAdminJobManifestPut, useAdminPatchServiceError, useAdminPatchUser, useAdminPutUser };
package/admin/admin.js CHANGED
@@ -98,6 +98,21 @@ var useAdminPatchUser = (options) => {
98
98
  };
99
99
  return useMutation(mutationFn, mutationOptions);
100
100
  };
101
+ var adminGetJobManifests = (options, signal) => {
102
+ return customInstance(
103
+ { url: `/admin/job-manifest`, method: "get", signal },
104
+ options
105
+ );
106
+ };
107
+ var getAdminGetJobManifestsQueryKey = () => [`/admin/job-manifest`];
108
+ var useAdminGetJobManifests = (options) => {
109
+ const { query: queryOptions, request: requestOptions } = options ?? {};
110
+ const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getAdminGetJobManifestsQueryKey();
111
+ const queryFn = ({ signal }) => adminGetJobManifests(requestOptions, signal);
112
+ const query = useQuery(queryKey, queryFn, queryOptions);
113
+ query.queryKey = queryKey;
114
+ return query;
115
+ };
101
116
  var adminJobManifestPut = (jobManifestPutBodyBody, options) => {
102
117
  const formData = new FormData();
103
118
  formData.append("url", jobManifestPutBodyBody.url);
@@ -149,15 +164,18 @@ var useAdminJobManifestLoad = (options) => {
149
164
  export {
150
165
  adminDeleteServiceError,
151
166
  adminDeleteUser,
167
+ adminGetJobManifests,
152
168
  adminGetServiceErrors,
153
169
  adminJobManifestLoad,
154
170
  adminJobManifestPut,
155
171
  adminPatchServiceError,
156
172
  adminPatchUser,
157
173
  adminPutUser,
174
+ getAdminGetJobManifestsQueryKey,
158
175
  getAdminGetServiceErrorsQueryKey,
159
176
  useAdminDeleteServiceError,
160
177
  useAdminDeleteUser,
178
+ useAdminGetJobManifests,
161
179
  useAdminGetServiceErrors,
162
180
  useAdminJobManifestLoad,
163
181
  useAdminJobManifestPut,
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/admin/admin.ts"],"sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ServiceErrorsGetResponse,\n DmError,\n AdminGetServiceErrorsParams,\n AdminUserPutResponse,\n UserPatchBodyBody,\n AdminJobManifestLoadPutResponse,\n JobManifestPutBodyBody,\n JobManifestLoadPutBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Displays the existing Service Errors, which can also include acknowledged errors, normally excluded from the list.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Gets Service Errors\n */\nexport const adminGetServiceErrors = (\n params?: AdminGetServiceErrorsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ServiceErrorsGetResponse>(\n { url: `/admin/service-error`, method: \"get\", params, signal },\n options\n );\n};\n\nexport const getAdminGetServiceErrorsQueryKey = (\n params?: AdminGetServiceErrorsParams\n) => [`/admin/service-error`, ...(params ? [params] : [])];\n\nexport type AdminGetServiceErrorsQueryResult = NonNullable<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n>;\nexport type AdminGetServiceErrorsQueryError = ErrorType<void | DmError>;\n\nexport const useAdminGetServiceErrors = <\n TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError = ErrorType<void | DmError>\n>(\n params?: AdminGetServiceErrorsParams,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\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 ?? getAdminGetServiceErrorsQueryKey(params);\n\n const queryFn: QueryFunction<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n > = ({ signal }) => adminGetServiceErrors(params, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Used primarily to 'Acknowledge' but not delete a Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patches a Service Error\n */\nexport const adminPatchServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"patch\" },\n options\n );\n};\n\nexport type AdminPatchServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchServiceError>>\n>;\n\nexport type AdminPatchServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminPatchServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes an existing Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a Service Error\n */\nexport const adminDeleteServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteServiceError>>\n>;\n\nexport type AdminDeleteServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminDeleteServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * This method adds a user to the Data Manager service. The user is authenticated via a keycloak server but will need an initialised account before they can create Datasets or Projects.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Prepares a user account in the Data Manager service\n */\nexport const adminPutUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<AdminUserPutResponse>(\n { url: `/admin/user/${userId}`, method: \"put\" },\n options\n );\n};\n\nexport type AdminPutUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPutUser>>\n>;\n\nexport type AdminPutUserMutationError = ErrorType<void | DmError>;\n\nexport const useAdminPutUser = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPutUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminPutUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes a user account, along with all the user's Datasets\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a user account\n */\nexport const adminDeleteUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/user/${userId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteUser>>\n>;\n\nexport type AdminDeleteUserMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminDeleteUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Patches a user record, typically to suspend or re-enable a user account\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patch a given user\n */\nexport const adminPatchUser = (\n userId: string,\n userPatchBodyBody: UserPatchBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n if (userPatchBodyBody.suspend_message !== undefined) {\n formData.append(\"suspend_message\", userPatchBodyBody.suspend_message);\n }\n\n return customInstance<void>(\n {\n url: `/admin/user/${userId}`,\n method: \"patch\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminPatchUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchUser>>\n>;\nexport type AdminPatchUserMutationBody = UserPatchBodyBody;\nexport type AdminPatchUserMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchUser>>,\n { userId: string; data: UserPatchBodyBody }\n > = (props) => {\n const { userId, data } = props ?? {};\n\n return adminPatchUser(userId, data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * This endpoint is used to add (or update an existing manifest). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.\n\nA 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/`.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Adds a manifest and triggers the download of Job Definitions\n */\nexport const adminJobManifestPut = (\n jobManifestPutBodyBody: JobManifestPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"url\", jobManifestPutBodyBody.url);\n if (jobManifestPutBodyBody.header !== undefined) {\n formData.append(\"header\", jobManifestPutBodyBody.header);\n }\n if (jobManifestPutBodyBody.params !== undefined) {\n formData.append(\"params\", jobManifestPutBodyBody.params);\n }\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestPutMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestPut>>\n>;\nexport type AdminJobManifestPutMutationBody = JobManifestPutBodyBody;\nexport type AdminJobManifestPutMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestPut = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n { data: JobManifestPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestPut(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * 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 definitions are known to have changed in the referenced repositories.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Trigger a download of known Job Definitions using the Manifest table\n */\nexport const adminJobManifestLoad = (\n jobManifestLoadPutBodyBody: JobManifestLoadPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"purge\", jobManifestLoadPutBodyBody.purge.toString());\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest/load`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestLoadMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestLoad>>\n>;\nexport type AdminJobManifestLoadMutationBody = JobManifestLoadPutBodyBody;\nexport type AdminJobManifestLoadMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestLoad = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n { data: JobManifestLoadPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestLoad(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n"],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAqC/B,IAAM,wBAAwB,CACnC,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC7D;AAAA,EACF;AACF;AAEO,IAAM,mCAAmC,CAC9C,WACG,CAAC,wBAAwB,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAOlD,IAAM,2BAA2B,CAItC,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,iCAAiC,MAAM;AAEnE,QAAM,UAEF,CAAC,EAAE,OAAO,MAAM,sBAAsB,QAAQ,gBAAgB,MAAM;AAExE,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AASO,IAAM,yBAAyB,CACpC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,QAAQ;AAAA,IAC1D;AAAA,EACF;AACF;AAQO,IAAM,4BAA4B,CAGvC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,uBAAuB,SAAS,cAAc;AAAA,EACvD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,0BAA0B,CACrC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,SAAS;AAAA,IAC3D;AAAA,EACF;AACF;AAQO,IAAM,6BAA6B,CAGxC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,wBAAwB,SAAS,cAAc;AAAA,EACxD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,eAAe,CAC1B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,MAAM;AAAA,IAC9C;AAAA,EACF;AACF;AAQO,IAAM,kBAAkB,CAG7B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,aAAa,QAAQ,cAAc;AAAA,EAC5C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,kBAAkB,CAC7B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,SAAS;AAAA,IACjD;AAAA,EACF;AACF;AAQO,IAAM,qBAAqB,CAGhC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,gBAAgB,QAAQ,cAAc;AAAA,EAC/C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,iBAAiB,CAC5B,QACA,mBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,MAAI,kBAAkB,oBAAoB,QAAW;AACnD,aAAS,OAAO,mBAAmB,kBAAkB,eAAe;AAAA,EACtE;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK,eAAe;AAAA,MACpB,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,oBAAoB,CAG/B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,KAAK,IAAI,SAAS,CAAC;AAEnC,WAAO,eAAe,QAAQ,MAAM,cAAc;AAAA,EACpD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAUO,IAAM,sBAAsB,CACjC,wBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,OAAO,uBAAuB,GAAG;AACjD,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AACA,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,yBAAyB,CAGpC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,oBAAoB,MAAM,cAAc;AAAA,EACjD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,uBAAuB,CAClC,4BACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,SAAS,2BAA2B,MAAM,SAAS,CAAC;AAEpE,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,0BAA0B,CAGrC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,qBAAqB,MAAM,cAAc;AAAA,EAClD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;","names":[]}
1
+ {"version":3,"sources":["../../src/admin/admin.ts"],"sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery, useMutation } from \"react-query\";\nimport type {\n UseQueryOptions,\n UseMutationOptions,\n QueryFunction,\n MutationFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ServiceErrorsGetResponse,\n DmError,\n AdminGetServiceErrorsParams,\n AdminUserPutResponse,\n UserPatchBodyBody,\n AdminJobManifestGetResponse,\n AdminJobManifestLoadPutResponse,\n JobManifestPutBodyBody,\n JobManifestLoadPutBodyBody,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Displays the existing Service Errors, which can also include acknowledged errors, normally excluded from the list.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Gets Service Errors\n */\nexport const adminGetServiceErrors = (\n params?: AdminGetServiceErrorsParams,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ServiceErrorsGetResponse>(\n { url: `/admin/service-error`, method: \"get\", params, signal },\n options\n );\n};\n\nexport const getAdminGetServiceErrorsQueryKey = (\n params?: AdminGetServiceErrorsParams\n) => [`/admin/service-error`, ...(params ? [params] : [])];\n\nexport type AdminGetServiceErrorsQueryResult = NonNullable<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n>;\nexport type AdminGetServiceErrorsQueryError = ErrorType<void | DmError>;\n\nexport const useAdminGetServiceErrors = <\n TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError = ErrorType<void | DmError>\n>(\n params?: AdminGetServiceErrorsParams,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\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 ?? getAdminGetServiceErrorsQueryKey(params);\n\n const queryFn: QueryFunction<\n Awaited<ReturnType<typeof adminGetServiceErrors>>\n > = ({ signal }) => adminGetServiceErrors(params, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof adminGetServiceErrors>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Used primarily to 'Acknowledge' but not delete a Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patches a Service Error\n */\nexport const adminPatchServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"patch\" },\n options\n );\n};\n\nexport type AdminPatchServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchServiceError>>\n>;\n\nexport type AdminPatchServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminPatchServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes an existing Service Error.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a Service Error\n */\nexport const adminDeleteServiceError = (\n errorId: number,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/service-error/${errorId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteServiceErrorMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteServiceError>>\n>;\n\nexport type AdminDeleteServiceErrorMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteServiceError = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n { errorId: number }\n > = (props) => {\n const { errorId } = props ?? {};\n\n return adminDeleteServiceError(errorId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteServiceError>>,\n TError,\n { errorId: number },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * This method adds a user to the Data Manager service. The user is authenticated via a keycloak server but will need an initialised account before they can create Datasets or Projects.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Prepares a user account in the Data Manager service\n */\nexport const adminPutUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<AdminUserPutResponse>(\n { url: `/admin/user/${userId}`, method: \"put\" },\n options\n );\n};\n\nexport type AdminPutUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPutUser>>\n>;\n\nexport type AdminPutUserMutationError = ErrorType<void | DmError>;\n\nexport const useAdminPutUser = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPutUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminPutUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPutUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Deletes a user account, along with all the user's Datasets\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Deletes a user account\n */\nexport const adminDeleteUser = (\n userId: string,\n options?: SecondParameter<typeof customInstance>\n) => {\n return customInstance<void>(\n { url: `/admin/user/${userId}`, method: \"delete\" },\n options\n );\n};\n\nexport type AdminDeleteUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminDeleteUser>>\n>;\n\nexport type AdminDeleteUserMutationError = ErrorType<DmError>;\n\nexport const useAdminDeleteUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n { userId: string }\n > = (props) => {\n const { userId } = props ?? {};\n\n return adminDeleteUser(userId, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminDeleteUser>>,\n TError,\n { userId: string },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Patches a user record, typically to suspend or re-enable a user account\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Patch a given user\n */\nexport const adminPatchUser = (\n userId: string,\n userPatchBodyBody: UserPatchBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n if (userPatchBodyBody.suspend_message !== undefined) {\n formData.append(\"suspend_message\", userPatchBodyBody.suspend_message);\n }\n\n return customInstance<void>(\n {\n url: `/admin/user/${userId}`,\n method: \"patch\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminPatchUserMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminPatchUser>>\n>;\nexport type AdminPatchUserMutationBody = UserPatchBodyBody;\nexport type AdminPatchUserMutationError = ErrorType<DmError>;\n\nexport const useAdminPatchUser = <\n TError = ErrorType<DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminPatchUser>>,\n { userId: string; data: UserPatchBodyBody }\n > = (props) => {\n const { userId, data } = props ?? {};\n\n return adminPatchUser(userId, data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminPatchUser>>,\n TError,\n { userId: string; data: UserPatchBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * Returns the list of known **Job Manifests** including the time the manifest was last loaded and its load status, a message indicating success or failure.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Get Job Manifests\n */\nexport const adminGetJobManifests = (\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<AdminJobManifestGetResponse>(\n { url: `/admin/job-manifest`, method: \"get\", signal },\n options\n );\n};\n\nexport const getAdminGetJobManifestsQueryKey = () => [`/admin/job-manifest`];\n\nexport type AdminGetJobManifestsQueryResult = NonNullable<\n Awaited<ReturnType<typeof adminGetJobManifests>>\n>;\nexport type AdminGetJobManifestsQueryError = ErrorType<void | DmError>;\n\nexport const useAdminGetJobManifests = <\n TData = Awaited<ReturnType<typeof adminGetJobManifests>>,\n TError = ErrorType<void | DmError>\n>(options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof adminGetJobManifests>>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getAdminGetJobManifestsQueryKey();\n\n const queryFn: QueryFunction<\n Awaited<ReturnType<typeof adminGetJobManifests>>\n > = ({ signal }) => adminGetJobManifests(requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof adminGetJobManifests>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * This endpoint is used to add (or update an existing **Job Manifest**). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.\n\nA 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/`.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Adds a Job Manifest and triggers the download of its Job Definitions\n */\nexport const adminJobManifestPut = (\n jobManifestPutBodyBody: JobManifestPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"url\", jobManifestPutBodyBody.url);\n if (jobManifestPutBodyBody.header !== undefined) {\n formData.append(\"header\", jobManifestPutBodyBody.header);\n }\n if (jobManifestPutBodyBody.params !== undefined) {\n formData.append(\"params\", jobManifestPutBodyBody.params);\n }\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestPutMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestPut>>\n>;\nexport type AdminJobManifestPutMutationBody = JobManifestPutBodyBody;\nexport type AdminJobManifestPutMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestPut = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n { data: JobManifestPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestPut(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestPut>>,\n TError,\n { data: JobManifestPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n/**\n * 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 definitions are known to have changed in the referenced repositories.\n\nYou will need **admin** rights to use this endpoint\n\n * @summary Trigger a download of Job Definitions using existing Job Manifests\n */\nexport const adminJobManifestLoad = (\n jobManifestLoadPutBodyBody: JobManifestLoadPutBodyBody,\n options?: SecondParameter<typeof customInstance>\n) => {\n const formData = new FormData();\n formData.append(\"purge\", jobManifestLoadPutBodyBody.purge.toString());\n\n return customInstance<AdminJobManifestLoadPutResponse>(\n {\n url: `/admin/job-manifest/load`,\n method: \"put\",\n headers: { \"Content-Type\": \"multipart/form-data\" },\n data: formData,\n },\n options\n );\n};\n\nexport type AdminJobManifestLoadMutationResult = NonNullable<\n Awaited<ReturnType<typeof adminJobManifestLoad>>\n>;\nexport type AdminJobManifestLoadMutationBody = JobManifestLoadPutBodyBody;\nexport type AdminJobManifestLoadMutationError = ErrorType<void | DmError>;\n\nexport const useAdminJobManifestLoad = <\n TError = ErrorType<void | DmError>,\n TContext = unknown\n>(options?: {\n mutation?: UseMutationOptions<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >;\n request?: SecondParameter<typeof customInstance>;\n}) => {\n const { mutation: mutationOptions, request: requestOptions } = options ?? {};\n\n const mutationFn: MutationFunction<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n { data: JobManifestLoadPutBodyBody }\n > = (props) => {\n const { data } = props ?? {};\n\n return adminJobManifestLoad(data, requestOptions);\n };\n\n return useMutation<\n Awaited<ReturnType<typeof adminJobManifestLoad>>,\n TError,\n { data: JobManifestLoadPutBodyBody },\n TContext\n >(mutationFn, mutationOptions);\n};\n"],"mappings":";;;;;AAUA,SAAS,UAAU,mBAAmB;AAsC/B,IAAM,wBAAwB,CACnC,QACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,QAAQ,OAAO,QAAQ,OAAO;AAAA,IAC7D;AAAA,EACF;AACF;AAEO,IAAM,mCAAmC,CAC9C,WACG,CAAC,wBAAwB,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAAE;AAOlD,IAAM,2BAA2B,CAItC,QACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,iCAAiC,MAAM;AAEnE,QAAM,UAEF,CAAC,EAAE,OAAO,MAAM,sBAAsB,QAAQ,gBAAgB,MAAM;AAExE,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AASO,IAAM,yBAAyB,CACpC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,QAAQ;AAAA,IAC1D;AAAA,EACF;AACF;AAQO,IAAM,4BAA4B,CAGvC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,uBAAuB,SAAS,cAAc;AAAA,EACvD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,0BAA0B,CACrC,SACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,wBAAwB,WAAW,QAAQ,SAAS;AAAA,IAC3D;AAAA,EACF;AACF;AAQO,IAAM,6BAA6B,CAGxC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,IAAI,SAAS,CAAC;AAE9B,WAAO,wBAAwB,SAAS,cAAc;AAAA,EACxD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,eAAe,CAC1B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,MAAM;AAAA,IAC9C;AAAA,EACF;AACF;AAQO,IAAM,kBAAkB,CAG7B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,aAAa,QAAQ,cAAc;AAAA,EAC5C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,kBAAkB,CAC7B,QACA,YACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,eAAe,UAAU,QAAQ,SAAS;AAAA,IACjD;AAAA,EACF;AACF;AAQO,IAAM,qBAAqB,CAGhC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,OAAO,IAAI,SAAS,CAAC;AAE7B,WAAO,gBAAgB,QAAQ,cAAc;AAAA,EAC/C;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,iBAAiB,CAC5B,QACA,mBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,MAAI,kBAAkB,oBAAoB,QAAW;AACnD,aAAS,OAAO,mBAAmB,kBAAkB,eAAe;AAAA,EACtE;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK,eAAe;AAAA,MACpB,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,oBAAoB,CAG/B,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,QAAQ,KAAK,IAAI,SAAS,CAAC;AAEnC,WAAO,eAAe,QAAQ,MAAM,cAAc;AAAA,EACpD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,uBAAuB,CAClC,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,uBAAuB,QAAQ,OAAO,OAAO;AAAA,IACpD;AAAA,EACF;AACF;AAEO,IAAM,kCAAkC,MAAM,CAAC,qBAAqB;AAOpE,IAAM,0BAA0B,CAGrC,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,gCAAgC;AAE3E,QAAM,UAEF,CAAC,EAAE,OAAO,MAAM,qBAAqB,gBAAgB,MAAM;AAE/D,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AAWO,IAAM,sBAAsB,CACjC,wBACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,OAAO,uBAAuB,GAAG;AACjD,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AACA,MAAI,uBAAuB,WAAW,QAAW;AAC/C,aAAS,OAAO,UAAU,uBAAuB,MAAM;AAAA,EACzD;AAEA,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,yBAAyB,CAGpC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,oBAAoB,MAAM,cAAc;AAAA,EACjD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;AAQO,IAAM,uBAAuB,CAClC,4BACA,YACG;AACH,QAAM,WAAW,IAAI,SAAS;AAC9B,WAAS,OAAO,SAAS,2BAA2B,MAAM,SAAS,CAAC;AAEpE,SAAO;AAAA,IACL;AAAA,MACE,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS,EAAE,gBAAgB,sBAAsB;AAAA,MACjD,MAAM;AAAA,IACR;AAAA,IACA;AAAA,EACF;AACF;AAQO,IAAM,0BAA0B,CAGrC,YAQI;AACJ,QAAM,EAAE,UAAU,iBAAiB,SAAS,eAAe,IAAI,WAAW,CAAC;AAE3E,QAAM,aAGF,CAAC,UAAU;AACb,UAAM,EAAE,KAAK,IAAI,SAAS,CAAC;AAE3B,WAAO,qBAAqB,MAAM,cAAc;AAAA,EAClD;AAEA,SAAO,YAKL,YAAY,eAAe;AAC/B;","names":[]}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/application/application.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,gBAAgB;AA8BlB,IAAM,kBAAkB,CAC7B,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,QAAQ,OAAO,OAAO;AAAA,IAC7C;AAAA,EACF;AACF;AAEO,IAAM,6BAA6B,MAAM,CAAC,cAAc;AAOxD,IAAM,qBAAqB,CAGhC,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,2BAA2B;AAEtE,QAAM,UAAsE,CAAC;AAAA,IAC3E;AAAA,EACF,MAAM,gBAAgB,gBAAgB,MAAM;AAE5C,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AAOO,IAAM,iBAAiB,CAC5B,eACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,iBAAiB,QAAQ,OAAO,OAAO;AAAA,IAC9D;AAAA,EACF;AACF;AAEO,IAAM,4BAA4B,CAAC,kBAA0B;AAAA,EAClE,gBAAgB;AAClB;AAOO,IAAM,oBAAoB,CAI/B,eACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,0BAA0B,aAAa;AAEnE,QAAM,UAAqE,CAAC;AAAA,IAC1E;AAAA,EACF,MAAM,eAAe,eAAe,gBAAgB,MAAM;AAE1D,QAAM,QAAQ,SAIZ,UAAU,SAAS;AAAA,IACnB,SAAS,CAAC,CAAC;AAAA,IACX,GAAG;AAAA,EACL,CAAC;AAED,QAAM,WAAW;AAEjB,SAAO;AACT","sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery } from \"react-query\";\nimport type {\n UseQueryOptions,\n QueryFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ApplicationsGetResponse,\n DmError,\n ApplicationGetResponse,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Get a list of all applications available to you that can be instantiated via the `/instance` endpoint.\n\nApplication availability will vary as applications are added to the cluster.\n\n * @summary Get all Applications available to you\n */\nexport const getApplications = (\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationsGetResponse>(\n { url: `/application`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationsQueryKey = () => [`/application`];\n\nexport type GetApplicationsQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplications>>\n>;\nexport type GetApplicationsQueryError = ErrorType<DmError>;\n\nexport const useGetApplications = <\n TData = Awaited<ReturnType<typeof getApplications>>,\n TError = ErrorType<DmError>\n>(options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({\n signal,\n }) => getApplications(requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Get details of a specific application available to you that can be instantiated.\n\n * @summary Get details of a specific application\n */\nexport const getApplication = (\n applicationId: string,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationGetResponse>(\n { url: `/application/${applicationId}`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationQueryKey = (applicationId: string) => [\n `/application/${applicationId}`,\n];\n\nexport type GetApplicationQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplication>>\n>;\nexport type GetApplicationQueryError = ErrorType<void | DmError>;\n\nexport const useGetApplication = <\n TData = Awaited<ReturnType<typeof getApplication>>,\n TError = ErrorType<void | DmError>\n>(\n applicationId: string,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplication>>,\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 ?? getGetApplicationQueryKey(applicationId);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({\n signal,\n }) => getApplication(applicationId, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplication>>,\n TError,\n TData\n >(queryKey, queryFn, {\n enabled: !!applicationId,\n ...queryOptions,\n }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n query.queryKey = queryKey;\n\n return query;\n};\n"]}
1
+ {"version":3,"sources":["../../src/application/application.ts"],"names":[],"mappings":";;;;;AAUA,SAAS,gBAAgB;AA8BlB,IAAM,kBAAkB,CAC7B,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,QAAQ,OAAO,OAAO;AAAA,IAC7C;AAAA,EACF;AACF;AAEO,IAAM,6BAA6B,MAAM,CAAC,cAAc;AAOxD,IAAM,qBAAqB,CAGhC,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,2BAA2B;AAEtE,QAAM,UAAsE,CAAC;AAAA,IAC3E;AAAA,EACF,MAAM,gBAAgB,gBAAgB,MAAM;AAE5C,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AAOO,IAAM,iBAAiB,CAC5B,eACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,iBAAiB,QAAQ,OAAO,OAAO;AAAA,IAC9D;AAAA,EACF;AACF;AAEO,IAAM,4BAA4B,CAAC,kBAA0B;AAAA,EAClE,gBAAgB;AAClB;AAOO,IAAM,oBAAoB,CAI/B,eACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,0BAA0B,aAAa;AAEnE,QAAM,UAAqE,CAAC;AAAA,IAC1E;AAAA,EACF,MAAM,eAAe,eAAe,gBAAgB,MAAM;AAE1D,QAAM,QAAQ,SAIZ,UAAU,SAAS;AAAA,IACnB,SAAS,CAAC,CAAC;AAAA,IACX,GAAG;AAAA,EACL,CAAC;AAED,QAAM,WAAW;AAEjB,SAAO;AACT","sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery } from \"react-query\";\nimport type {\n UseQueryOptions,\n QueryFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ApplicationsGetResponse,\n DmError,\n ApplicationGetResponse,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Get a list of all applications available to you that can be instantiated via the `/instance` endpoint.\n\nApplication availability will vary as applications are added to the cluster.\n\n * @summary Get all Applications available to you\n */\nexport const getApplications = (\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationsGetResponse>(\n { url: `/application`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationsQueryKey = () => [`/application`];\n\nexport type GetApplicationsQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplications>>\n>;\nexport type GetApplicationsQueryError = ErrorType<DmError>;\n\nexport const useGetApplications = <\n TData = Awaited<ReturnType<typeof getApplications>>,\n TError = ErrorType<DmError>\n>(options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({\n signal,\n }) => getApplications(requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Get details of a specific Application available to you that can be instantiated.\n\n * @summary Get details of a specific Application\n */\nexport const getApplication = (\n applicationId: string,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationGetResponse>(\n { url: `/application/${applicationId}`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationQueryKey = (applicationId: string) => [\n `/application/${applicationId}`,\n];\n\nexport type GetApplicationQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplication>>\n>;\nexport type GetApplicationQueryError = ErrorType<void | DmError>;\n\nexport const useGetApplication = <\n TData = Awaited<ReturnType<typeof getApplication>>,\n TError = ErrorType<void | DmError>\n>(\n applicationId: string,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplication>>,\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 ?? getGetApplicationQueryKey(applicationId);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({\n signal,\n }) => getApplication(applicationId, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplication>>,\n TError,\n TData\n >(queryKey, queryFn, {\n enabled: !!applicationId,\n ...queryOptions,\n }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n query.queryKey = queryKey;\n\n return query;\n};\n"]}
@@ -1,5 +1,5 @@
1
1
  import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
2
- import { bz as customInstance, bp as ApplicationsGetResponse, bA as ErrorType, bv as DmError, bq as ApplicationGetResponse } from '../custom-instance-f73fb7dc.js';
2
+ import { bB as customInstance, bq as ApplicationsGetResponse, bC as ErrorType, bx as DmError, br as ApplicationGetResponse } from '../custom-instance-3a73945d.js';
3
3
  import 'axios';
4
4
 
5
5
  declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
@@ -21,9 +21,9 @@ declare const useGetApplications: <TData = ApplicationsGetResponse, TError = Err
21
21
  queryKey: QueryKey;
22
22
  };
23
23
  /**
24
- * Get details of a specific application available to you that can be instantiated.
24
+ * Get details of a specific Application available to you that can be instantiated.
25
25
 
26
- * @summary Get details of a specific application
26
+ * @summary Get details of a specific Application
27
27
  */
28
28
  declare const getApplication: (applicationId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal | undefined) => Promise<ApplicationGetResponse>;
29
29
  declare const getGetApplicationQueryKey: (applicationId: string) => string[];
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/application/application.ts"],"sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery } from \"react-query\";\nimport type {\n UseQueryOptions,\n QueryFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ApplicationsGetResponse,\n DmError,\n ApplicationGetResponse,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Get a list of all applications available to you that can be instantiated via the `/instance` endpoint.\n\nApplication availability will vary as applications are added to the cluster.\n\n * @summary Get all Applications available to you\n */\nexport const getApplications = (\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationsGetResponse>(\n { url: `/application`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationsQueryKey = () => [`/application`];\n\nexport type GetApplicationsQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplications>>\n>;\nexport type GetApplicationsQueryError = ErrorType<DmError>;\n\nexport const useGetApplications = <\n TData = Awaited<ReturnType<typeof getApplications>>,\n TError = ErrorType<DmError>\n>(options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({\n signal,\n }) => getApplications(requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Get details of a specific application available to you that can be instantiated.\n\n * @summary Get details of a specific application\n */\nexport const getApplication = (\n applicationId: string,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationGetResponse>(\n { url: `/application/${applicationId}`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationQueryKey = (applicationId: string) => [\n `/application/${applicationId}`,\n];\n\nexport type GetApplicationQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplication>>\n>;\nexport type GetApplicationQueryError = ErrorType<void | DmError>;\n\nexport const useGetApplication = <\n TData = Awaited<ReturnType<typeof getApplication>>,\n TError = ErrorType<void | DmError>\n>(\n applicationId: string,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplication>>,\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 ?? getGetApplicationQueryKey(applicationId);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({\n signal,\n }) => getApplication(applicationId, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplication>>,\n TError,\n TData\n >(queryKey, queryFn, {\n enabled: !!applicationId,\n ...queryOptions,\n }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n query.queryKey = queryKey;\n\n return query;\n};\n"],"mappings":";;;;;AAUA,SAAS,gBAAgB;AA8BlB,IAAM,kBAAkB,CAC7B,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,QAAQ,OAAO,OAAO;AAAA,IAC7C;AAAA,EACF;AACF;AAEO,IAAM,6BAA6B,MAAM,CAAC,cAAc;AAOxD,IAAM,qBAAqB,CAGhC,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,2BAA2B;AAEtE,QAAM,UAAsE,CAAC;AAAA,IAC3E;AAAA,EACF,MAAM,gBAAgB,gBAAgB,MAAM;AAE5C,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AAOO,IAAM,iBAAiB,CAC5B,eACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,iBAAiB,QAAQ,OAAO,OAAO;AAAA,IAC9D;AAAA,EACF;AACF;AAEO,IAAM,4BAA4B,CAAC,kBAA0B;AAAA,EAClE,gBAAgB;AAClB;AAOO,IAAM,oBAAoB,CAI/B,eACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,0BAA0B,aAAa;AAEnE,QAAM,UAAqE,CAAC;AAAA,IAC1E;AAAA,EACF,MAAM,eAAe,eAAe,gBAAgB,MAAM;AAE1D,QAAM,QAAQ,SAIZ,UAAU,SAAS;AAAA,IACnB,SAAS,CAAC,CAAC;AAAA,IACX,GAAG;AAAA,EACL,CAAC;AAED,QAAM,WAAW;AAEjB,SAAO;AACT;","names":[]}
1
+ {"version":3,"sources":["../../src/application/application.ts"],"sourcesContent":["/**\n * Generated by orval v6.9.1 🍺\n * Do not edit manually.\n * Dataset Manager API\n * The Dataset Manager API service.\n\nA service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.\n\n * OpenAPI spec version: 1.0\n */\nimport { useQuery } from \"react-query\";\nimport type {\n UseQueryOptions,\n QueryFunction,\n UseQueryResult,\n QueryKey,\n} from \"react-query\";\nimport type {\n ApplicationsGetResponse,\n DmError,\n ApplicationGetResponse,\n} from \"../data-manager-api.schemas\";\nimport { customInstance } from \".././custom-instance\";\nimport type { ErrorType } from \".././custom-instance\";\n\n// eslint-disable-next-line\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n config: any,\n args: infer P\n) => any\n ? P\n : never;\n\n/**\n * Get a list of all applications available to you that can be instantiated via the `/instance` endpoint.\n\nApplication availability will vary as applications are added to the cluster.\n\n * @summary Get all Applications available to you\n */\nexport const getApplications = (\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationsGetResponse>(\n { url: `/application`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationsQueryKey = () => [`/application`];\n\nexport type GetApplicationsQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplications>>\n>;\nexport type GetApplicationsQueryError = ErrorType<DmError>;\n\nexport const useGetApplications = <\n TData = Awaited<ReturnType<typeof getApplications>>,\n TError = ErrorType<DmError>\n>(options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >;\n request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n const { query: queryOptions, request: requestOptions } = options ?? {};\n\n const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({\n signal,\n }) => getApplications(requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplications>>,\n TError,\n TData\n >(queryKey, queryFn, queryOptions) as UseQueryResult<TData, TError> & {\n queryKey: QueryKey;\n };\n\n query.queryKey = queryKey;\n\n return query;\n};\n\n/**\n * Get details of a specific Application available to you that can be instantiated.\n\n * @summary Get details of a specific Application\n */\nexport const getApplication = (\n applicationId: string,\n options?: SecondParameter<typeof customInstance>,\n signal?: AbortSignal\n) => {\n return customInstance<ApplicationGetResponse>(\n { url: `/application/${applicationId}`, method: \"get\", signal },\n options\n );\n};\n\nexport const getGetApplicationQueryKey = (applicationId: string) => [\n `/application/${applicationId}`,\n];\n\nexport type GetApplicationQueryResult = NonNullable<\n Awaited<ReturnType<typeof getApplication>>\n>;\nexport type GetApplicationQueryError = ErrorType<void | DmError>;\n\nexport const useGetApplication = <\n TData = Awaited<ReturnType<typeof getApplication>>,\n TError = ErrorType<void | DmError>\n>(\n applicationId: string,\n options?: {\n query?: UseQueryOptions<\n Awaited<ReturnType<typeof getApplication>>,\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 ?? getGetApplicationQueryKey(applicationId);\n\n const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({\n signal,\n }) => getApplication(applicationId, requestOptions, signal);\n\n const query = useQuery<\n Awaited<ReturnType<typeof getApplication>>,\n TError,\n TData\n >(queryKey, queryFn, {\n enabled: !!applicationId,\n ...queryOptions,\n }) as UseQueryResult<TData, TError> & { queryKey: QueryKey };\n\n query.queryKey = queryKey;\n\n return query;\n};\n"],"mappings":";;;;;AAUA,SAAS,gBAAgB;AA8BlB,IAAM,kBAAkB,CAC7B,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,QAAQ,OAAO,OAAO;AAAA,IAC7C;AAAA,EACF;AACF;AAEO,IAAM,6BAA6B,MAAM,CAAC,cAAc;AAOxD,IAAM,qBAAqB,CAGhC,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YAAW,6CAAc,aAAY,2BAA2B;AAEtE,QAAM,UAAsE,CAAC;AAAA,IAC3E;AAAA,EACF,MAAM,gBAAgB,gBAAgB,MAAM;AAE5C,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAIjC,QAAM,WAAW;AAEjB,SAAO;AACT;AAOO,IAAM,iBAAiB,CAC5B,eACA,SACA,WACG;AACH,SAAO;AAAA,IACL,EAAE,KAAK,gBAAgB,iBAAiB,QAAQ,OAAO,OAAO;AAAA,IAC9D;AAAA,EACF;AACF;AAEO,IAAM,4BAA4B,CAAC,kBAA0B;AAAA,EAClE,gBAAgB;AAClB;AAOO,IAAM,oBAAoB,CAI/B,eACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,eAAe,IAAI,WAAW,CAAC;AAErE,QAAM,YACJ,6CAAc,aAAY,0BAA0B,aAAa;AAEnE,QAAM,UAAqE,CAAC;AAAA,IAC1E;AAAA,EACF,MAAM,eAAe,eAAe,gBAAgB,MAAM;AAE1D,QAAM,QAAQ,SAIZ,UAAU,SAAS;AAAA,IACnB,SAAS,CAAC,CAAC;AAAA,IACX,GAAG;AAAA,EACL,CAAC;AAED,QAAM,WAAW;AAEjB,SAAO;AACT;","names":[]}
@@ -53,6 +53,16 @@ declare type GetTasksParams = {
53
53
  exclude_purpose?: QExcludePurposeParameter;
54
54
  project_id?: QProjectIdParameter;
55
55
  };
56
+ /**
57
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
58
+
59
+ */
60
+ declare type QFilePathParameter = string;
61
+ /**
62
+ * A project file.
63
+
64
+ */
65
+ declare type QFileParameter = string;
56
66
  declare type DeleteUnmanagedFileParams = {
57
67
  file: QFileParameter;
58
68
  path?: QFilePathParameter;
@@ -175,16 +185,6 @@ declare type QFromParameter = string;
175
185
  * The Project identity
176
186
  */
177
187
  declare type QFileProjectIdParameter = string;
178
- /**
179
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
180
-
181
- */
182
- declare type QFilePathParameter = string;
183
- /**
184
- * A project file.
185
-
186
- */
187
- declare type QFileParameter = string;
188
188
  /**
189
189
  * Set to a dot-separated string of purpose enumerations, i.e. `INSTANCE`, `FILE` or `DATASET`. To exclude file and dataset tasks set to `FILE.DATASET`
190
190
 
@@ -292,7 +292,9 @@ declare type JobManifestLoadPutBodyBody = {
292
292
  };
293
293
  declare type InstancePostBodyBody = {
294
294
  /** A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
295
- */
295
+
296
+ Application IDs currently supported include ``datamanagerjobs.squonk.it`` and ``jupyternotebooks.squonk.it``
297
+ */
296
298
  application_id: string;
297
299
  /** A supported application version to launch.
298
300
 
@@ -332,6 +334,8 @@ declare type InstancePostBodyBody = {
332
334
  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}`.
333
335
 
334
336
  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 (`/`).
337
+
338
+ Applications also support `variables`. The Jupyter notebook application supports the definition of the notebook image (i.e. `"image:":"tensorflow"`), `"cpu"` and `"memory"`. A full Jupyter notebook specification might look like `{"variables":{"image":"tensorflow","cpu":2,"memory":"4Gi"}}`. `memory` is limited to `Gi` as a suffix.
335
339
  */
336
340
  specification?: string;
337
341
  };
@@ -728,6 +732,34 @@ interface JobSummary {
728
732
  */
729
733
  doc_url?: string;
730
734
  }
735
+ interface JobManifestDetail {
736
+ /** The Job Manifest record ID */
737
+ id: number;
738
+ url: string;
739
+ header?: string;
740
+ params?: string;
741
+ /** The Date (and time) the manifest was created
742
+ */
743
+ created: string;
744
+ /** The (admin) user who created the manifest
745
+ */
746
+ creator?: string;
747
+ /** The number of job definition files loaded during the most recent successful load
748
+ */
749
+ job_definition_files_loaded?: number;
750
+ /** The number of job definitions loaded during the most recent successful load
751
+ */
752
+ job_definitions_loaded?: number;
753
+ /** The Date (and time) the manifest was last loaded successfully
754
+ */
755
+ last_successful_load_time?: string;
756
+ /** 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
757
+ */
758
+ last_load_time?: string;
759
+ /** 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`
760
+ */
761
+ last_load_status: string;
762
+ }
731
763
  interface JobApplication {
732
764
  /** The Job's operator ID */
733
765
  id: string;
@@ -1533,6 +1565,11 @@ interface AdminJobManifestLoadPutResponse {
1533
1565
  */
1534
1566
  jobs_purged?: number;
1535
1567
  }
1568
+ interface AdminJobManifestGetResponse {
1569
+ /** The list of known Job manifests
1570
+ */
1571
+ job_manifests: JobManifestDetail[];
1572
+ }
1536
1573
  interface AccountServerGetNamespaceResponse {
1537
1574
  /** 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.
1538
1575
  */
@@ -1564,4 +1601,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
1564
1601
  declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig<any> | undefined) => Promise<TReturn>;
1565
1602
  declare type ErrorType<TError> = AxiosError<TError>;
1566
1603
 
1567
- export { ExchangeRatePutBodyBody as $, AdminGetServiceErrorsParams as A, QJobCollectionParameter as B, QInstanceArchiveParameter as C, DeleteUnmanagedFileParams as D, QIncludeHiddenParameter as E, QIncludeDeletedParameter as F, GetUserApiLogParams as G, QIncludeAcknowlegedParameter as H, QFromParameter as I, QFileProjectIdParameter as J, QFilePathParameter as K, QFileParameter as L, QExcludePurposeParameter as M, QExcludeDoneParameter as N, QEventPriorOrdinalParameter as O, PatchInstanceParams as P, QEditorsParameter as Q, QEventLimitParameter as R, QDatasetMimeTypeParameter as S, QDoNotImpersonateParameter as T, QCurrentParameter as U, QApplicationIdParameter as V, UserPatchBodyBody as W, UserAccountPatchBodyBody as X, ProjectPostBodyBody as Y, ProjectPatchBodyBody as Z, ProjectFilePutBodyBody as _, GetUserAccountParams as a, ProjectDeleteResponse as a$, JobManifestPutBodyBody as a0, JobManifestLoadPutBodyBody as a1, InstancePostBodyBody as a2, FilePostBodyBody as a3, DatasetPutBodyBody as a4, DatasetVersionMetaPostBodyBody as a5, DatasetMetaPostBodyBody as a6, DatasetPostBodyBody as a7, UserSummary as a8, UserDetail as a9, JobExchangeRateSummary as aA, ApplicationExchangeRateSummary as aB, ExchangeRateDetail as aC, DatasetVersionSummaryLabels as aD, DatasetVersionSummaryProcessingStage as aE, DatasetVersionSummary as aF, DatasetVersionProjectFile as aG, DatasetVersionDetailLabels as aH, DatasetVersionDetailProcessingStage as aI, DatasetVersionDetail as aJ, DatasetSummary as aK, DatasetDetail as aL, ApplicationSummary as aM, ApiLogDetailMethod as aN, ApiLogDetail as aO, VersionGetResponse as aP, UsersGetResponse as aQ, UserApiLogGetResponse as aR, UserAccountGetResponse as aS, TypesGetResponse as aT, TasksGetResponse as aU, TaskGetResponsePurpose as aV, TaskGetResponse as aW, ServiceErrorsGetResponse as aX, ProjectsGetResponse as aY, ProjectPostResponse as aZ, ProjectGetResponse as a_, UserAccountDetail as aa, TypeSummaryFormatterOptionsType as ab, TypeSummaryFormatterOptions as ac, TypeSummary as ad, TaskSummaryProcessingStage as ae, TaskSummary as af, TaskStateState as ag, TaskState as ah, TaskIdentity as ai, TaskEventLevel as aj, TaskEvent as ak, ServiceErrorSummarySeverity as al, ServiceErrorSummary as am, ProjectFileDetail as an, ProjectDetail as ao, JobOrderDetail as ap, JobVariables as aq, JobSummaryImageType as ar, JobSummary as as, JobApplication as at, InstanceSummaryJobImageType as au, InstanceSummaryPhase as av, InstanceSummaryApplicationType as aw, InstanceSummary as ax, FileStat as ay, FilePathFile as az, GetInstancesParams as b, JobsGetResponse as b0, JobGetResponseImageType as b1, JobGetResponse as b2, InstanceTaskPurpose as b3, InstanceTask as b4, InstancesGetResponse as b5, InstanceGetResponsePhase as b6, InstanceGetResponseApplicationType as b7, InstanceGetResponse as b8, GetExchangeRatesResponseId as b9, ErrorType as bA, GetExchangeRatesResponse as ba, GetAllExchangeRatesResponseExchangeRatesItem as bb, GetAllExchangeRatesResponse as bc, FilesGetResponse as bd, FilePostResponse as be, InstancePostResponse as bf, InstanceDeleteResponse as bg, DatasetsGetResponse as bh, DatasetVersionsGetResponse as bi, DatasetVersionDeleteResponse as bj, DatasetSchemaGetResponseType as bk, DatasetSchemaGetResponse as bl, DatasetMetaGetResponse as bm, DatasetDigestGetResponse as bn, DatasetPutPostResponse as bo, ApplicationsGetResponse as bp, ApplicationGetResponse as bq, AdminUserPutResponse as br, AdminJobManifestLoadPutResponse as bs, AccountServerGetNamespaceResponse as bt, AccountServerGetRegistrationResponse as bu, DmError as bv, AXIOS_INSTANCE as bw, setAuthToken as bx, setBaseUrl as by, customInstance as bz, GetJobExchangeRatesParams as c, GetAllJobExchangeRatesParams as d, GetJobByVersionParams as e, GetApplicationExchangeRatesParams as f, GetAllApplicationExchangeRatesParams as g, GetTaskParams as h, GetTasksParams as i, GetFilesParams as j, DeleteDatasetParams as k, GetVersionsParams as l, GetDatasetsParams as m, GetProjectFileWithTokenParams as n, GetProjectFileParams as o, QOwnersParameter as p, QUsernameParameter as q, QUntilParameter as r, QTokenParameter as s, QProjectIdParameter as t, QLabelsParameter as u, QOnlyUndefinedParameter as v, QKeepProjectFilesParameter as w, QJobVersionParameter as x, QJobJobParameter as y, QJobIdParameter as z };
1604
+ export { ExchangeRatePutBodyBody as $, AdminGetServiceErrorsParams as A, QJobJobParameter as B, QJobIdParameter as C, DeleteUnmanagedFileParams as D, QJobCollectionParameter as E, QInstanceArchiveParameter as F, GetUserApiLogParams as G, QIncludeHiddenParameter as H, QIncludeDeletedParameter as I, QIncludeAcknowlegedParameter as J, QFromParameter as K, QFileProjectIdParameter as L, QExcludePurposeParameter as M, QExcludeDoneParameter as N, QEventPriorOrdinalParameter as O, PatchInstanceParams as P, QFilePathParameter as Q, QEventLimitParameter as R, QDatasetMimeTypeParameter as S, QDoNotImpersonateParameter as T, QCurrentParameter as U, QApplicationIdParameter as V, UserPatchBodyBody as W, UserAccountPatchBodyBody as X, ProjectPostBodyBody as Y, ProjectPatchBodyBody as Z, ProjectFilePutBodyBody as _, GetUserAccountParams as a, ProjectGetResponse as a$, JobManifestPutBodyBody as a0, JobManifestLoadPutBodyBody as a1, InstancePostBodyBody as a2, FilePostBodyBody as a3, DatasetPutBodyBody as a4, DatasetVersionMetaPostBodyBody as a5, DatasetMetaPostBodyBody as a6, DatasetPostBodyBody as a7, UserSummary as a8, UserDetail as a9, FilePathFile as aA, JobExchangeRateSummary as aB, ApplicationExchangeRateSummary as aC, ExchangeRateDetail as aD, DatasetVersionSummaryLabels as aE, DatasetVersionSummaryProcessingStage as aF, DatasetVersionSummary as aG, DatasetVersionProjectFile as aH, DatasetVersionDetailLabels as aI, DatasetVersionDetailProcessingStage as aJ, DatasetVersionDetail as aK, DatasetSummary as aL, DatasetDetail as aM, ApplicationSummary as aN, ApiLogDetailMethod as aO, ApiLogDetail as aP, VersionGetResponse as aQ, UsersGetResponse as aR, UserApiLogGetResponse as aS, UserAccountGetResponse as aT, TypesGetResponse as aU, TasksGetResponse as aV, TaskGetResponsePurpose as aW, TaskGetResponse as aX, ServiceErrorsGetResponse as aY, ProjectsGetResponse as aZ, ProjectPostResponse as a_, UserAccountDetail as aa, TypeSummaryFormatterOptionsType as ab, TypeSummaryFormatterOptions as ac, TypeSummary as ad, TaskSummaryProcessingStage as ae, TaskSummary as af, TaskStateState as ag, TaskState as ah, TaskIdentity as ai, TaskEventLevel as aj, TaskEvent as ak, ServiceErrorSummarySeverity as al, ServiceErrorSummary as am, ProjectFileDetail as an, ProjectDetail as ao, JobOrderDetail as ap, JobVariables as aq, JobSummaryImageType as ar, JobSummary as as, JobManifestDetail as at, JobApplication as au, InstanceSummaryJobImageType as av, InstanceSummaryPhase as aw, InstanceSummaryApplicationType as ax, InstanceSummary as ay, FileStat as az, GetInstancesParams as b, ProjectDeleteResponse as b0, JobsGetResponse as b1, JobGetResponseImageType as b2, JobGetResponse as b3, InstanceTaskPurpose as b4, InstanceTask as b5, InstancesGetResponse as b6, InstanceGetResponsePhase as b7, InstanceGetResponseApplicationType as b8, InstanceGetResponse as b9, setBaseUrl as bA, customInstance as bB, ErrorType as bC, GetExchangeRatesResponseId as ba, GetExchangeRatesResponse as bb, GetAllExchangeRatesResponseExchangeRatesItem as bc, GetAllExchangeRatesResponse as bd, FilesGetResponse as be, FilePostResponse as bf, InstancePostResponse as bg, InstanceDeleteResponse as bh, DatasetsGetResponse as bi, DatasetVersionsGetResponse as bj, DatasetVersionDeleteResponse as bk, DatasetSchemaGetResponseType as bl, DatasetSchemaGetResponse as bm, DatasetMetaGetResponse as bn, DatasetDigestGetResponse as bo, DatasetPutPostResponse as bp, ApplicationsGetResponse as bq, ApplicationGetResponse as br, AdminUserPutResponse as bs, AdminJobManifestLoadPutResponse as bt, AdminJobManifestGetResponse as bu, AccountServerGetNamespaceResponse as bv, AccountServerGetRegistrationResponse as bw, DmError as bx, AXIOS_INSTANCE as by, setAuthToken as bz, GetJobExchangeRatesParams as c, GetAllJobExchangeRatesParams as d, GetJobByVersionParams as e, GetApplicationExchangeRatesParams as f, GetAllApplicationExchangeRatesParams as g, GetTaskParams as h, GetTasksParams as i, QFileParameter as j, GetFilesParams as k, DeleteDatasetParams as l, GetVersionsParams as m, GetDatasetsParams as n, GetProjectFileWithTokenParams as o, GetProjectFileParams as p, QEditorsParameter as q, QOwnersParameter as r, QUsernameParameter as s, QUntilParameter as t, QTokenParameter as u, QProjectIdParameter as v, QLabelsParameter as w, QOnlyUndefinedParameter as x, QKeepProjectFilesParameter as y, QJobVersionParameter as z };