@squonk/data-manager-client 3.1.0-beta.2 → 3.1.0

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 (119) hide show
  1. package/accounting/accounting.cjs +12 -12
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +103 -49
  4. package/accounting/accounting.d.ts +103 -49
  5. package/accounting/accounting.js +12 -12
  6. package/accounting/accounting.js.map +1 -1
  7. package/admin/admin.cjs +12 -12
  8. package/admin/admin.cjs.map +1 -1
  9. package/admin/admin.d.cts +168 -115
  10. package/admin/admin.d.ts +168 -115
  11. package/admin/admin.js +12 -12
  12. package/admin/admin.js.map +1 -1
  13. package/application/application.cjs +8 -8
  14. package/application/application.cjs.map +1 -1
  15. package/application/application.d.cts +69 -33
  16. package/application/application.d.ts +69 -33
  17. package/application/application.js +8 -8
  18. package/application/application.js.map +1 -1
  19. package/chunk-TKLTUR4R.cjs.map +1 -1
  20. package/configuration/configuration.cjs +4 -4
  21. package/configuration/configuration.cjs.map +1 -1
  22. package/configuration/configuration.d.cts +35 -17
  23. package/configuration/configuration.d.ts +35 -17
  24. package/configuration/configuration.js +4 -4
  25. package/configuration/configuration.js.map +1 -1
  26. package/dataset/dataset.cjs +16 -16
  27. package/dataset/dataset.cjs.map +1 -1
  28. package/dataset/dataset.d.cts +181 -110
  29. package/dataset/dataset.d.ts +181 -110
  30. package/dataset/dataset.js +16 -16
  31. package/dataset/dataset.js.map +1 -1
  32. package/digest/digest.cjs +4 -4
  33. package/digest/digest.cjs.map +1 -1
  34. package/digest/digest.d.cts +35 -17
  35. package/digest/digest.d.ts +35 -17
  36. package/digest/digest.js +4 -4
  37. package/digest/digest.js.map +1 -1
  38. package/exchange-rate/exchange-rate.cjs +16 -16
  39. package/exchange-rate/exchange-rate.cjs.map +1 -1
  40. package/exchange-rate/exchange-rate.d.cts +155 -84
  41. package/exchange-rate/exchange-rate.d.ts +155 -84
  42. package/exchange-rate/exchange-rate.js +16 -16
  43. package/exchange-rate/exchange-rate.js.map +1 -1
  44. package/file-and-path/file-and-path.cjs +8 -8
  45. package/file-and-path/file-and-path.cjs.map +1 -1
  46. package/file-and-path/file-and-path.d.cts +133 -98
  47. package/file-and-path/file-and-path.d.ts +133 -98
  48. package/file-and-path/file-and-path.js +8 -8
  49. package/file-and-path/file-and-path.js.map +1 -1
  50. package/index.cjs.map +1 -1
  51. package/index.d.cts +156 -68
  52. package/index.d.ts +156 -68
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +8 -8
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +106 -71
  57. package/instance/instance.d.ts +106 -71
  58. package/instance/instance.js +8 -8
  59. package/instance/instance.js.map +1 -1
  60. package/inventory/inventory.cjs +4 -4
  61. package/inventory/inventory.cjs.map +1 -1
  62. package/inventory/inventory.d.cts +35 -17
  63. package/inventory/inventory.d.ts +35 -17
  64. package/inventory/inventory.js +4 -4
  65. package/inventory/inventory.js.map +1 -1
  66. package/job/job.cjs +12 -12
  67. package/job/job.cjs.map +1 -1
  68. package/job/job.d.cts +103 -49
  69. package/job/job.d.ts +103 -49
  70. package/job/job.js +12 -12
  71. package/job/job.js.map +1 -1
  72. package/metadata/metadata.cjs +8 -8
  73. package/metadata/metadata.cjs.map +1 -1
  74. package/metadata/metadata.d.cts +81 -46
  75. package/metadata/metadata.d.ts +81 -46
  76. package/metadata/metadata.js +8 -8
  77. package/metadata/metadata.js.map +1 -1
  78. package/package.json +7 -7
  79. package/project/project.cjs +16 -16
  80. package/project/project.cjs.map +1 -1
  81. package/project/project.d.cts +225 -154
  82. package/project/project.d.ts +225 -154
  83. package/project/project.js +16 -16
  84. package/project/project.js.map +1 -1
  85. package/src/accounting/accounting.ts +137 -13
  86. package/src/admin/admin.ts +217 -52
  87. package/src/application/application.ts +93 -9
  88. package/src/configuration/configuration.ts +49 -5
  89. package/src/data-manager-api.schemas.ts +156 -70
  90. package/src/dataset/dataset.ts +250 -42
  91. package/src/digest/digest.ts +49 -5
  92. package/src/exchange-rate/exchange-rate.ts +216 -29
  93. package/src/file-and-path/file-and-path.ts +172 -52
  94. package/src/instance/instance.ts +137 -27
  95. package/src/inventory/inventory.ts +49 -5
  96. package/src/job/job.ts +143 -13
  97. package/src/metadata/metadata.ts +116 -15
  98. package/src/project/project.ts +302 -75
  99. package/src/task/task.ts +111 -15
  100. package/src/type/type.ts +49 -5
  101. package/src/user/user.ts +149 -19
  102. package/task/task.cjs +8 -8
  103. package/task/task.cjs.map +1 -1
  104. package/task/task.d.cts +78 -43
  105. package/task/task.d.ts +78 -43
  106. package/task/task.js +8 -8
  107. package/task/task.js.map +1 -1
  108. package/type/type.cjs +4 -4
  109. package/type/type.cjs.map +1 -1
  110. package/type/type.d.cts +35 -17
  111. package/type/type.d.ts +35 -17
  112. package/type/type.js +4 -4
  113. package/type/type.js.map +1 -1
  114. package/user/user.cjs +12 -12
  115. package/user/user.cjs.map +1 -1
  116. package/user/user.d.cts +112 -59
  117. package/user/user.d.ts +112 -59
  118. package/user/user.js +12 -12
  119. package/user/user.js.map +1 -1
@@ -1,5 +1,6 @@
1
+ // @ts-nocheck
1
2
  /**
2
- * Generated by orval v6.25.0 🍺
3
+ * Generated by orval v7.2.0 🍺
3
4
  * Do not edit manually.
4
5
  * Dataset Manager API
5
6
  * The Dataset Manager API service.
@@ -13,8 +14,11 @@ import {
13
14
  useSuspenseQuery
14
15
  } from '@tanstack/react-query'
15
16
  import type {
17
+ DefinedInitialDataOptions,
18
+ DefinedUseQueryResult,
16
19
  QueryFunction,
17
20
  QueryKey,
21
+ UndefinedInitialDataOptions,
18
22
  UseQueryOptions,
19
23
  UseQueryResult,
20
24
  UseSuspenseQueryOptions,
@@ -78,13 +82,39 @@ const {query: queryOptions, request: requestOptions} = options ?? {};
78
82
  export type GetApplicationsQueryResult = NonNullable<Awaited<ReturnType<typeof getApplications>>>
79
83
  export type GetApplicationsQueryError = ErrorType<DmError>
80
84
 
85
+
86
+ export function useGetApplications<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
87
+ options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>> & Pick<
88
+ DefinedInitialDataOptions<
89
+ Awaited<ReturnType<typeof getApplications>>,
90
+ TError,
91
+ TData
92
+ > , 'initialData'
93
+ >, request?: SecondParameter<typeof customInstance>}
94
+
95
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
96
+ export function useGetApplications<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
97
+ options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>> & Pick<
98
+ UndefinedInitialDataOptions<
99
+ Awaited<ReturnType<typeof getApplications>>,
100
+ TError,
101
+ TData
102
+ > , 'initialData'
103
+ >, request?: SecondParameter<typeof customInstance>}
104
+
105
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
106
+ export function useGetApplications<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
107
+ options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
108
+
109
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
81
110
  /**
82
111
  * @summary Get all Applications available to you
83
112
  */
84
- export const useGetApplications = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
113
+
114
+ export function useGetApplications<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
85
115
  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
86
116
 
87
- ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
117
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
88
118
 
89
119
  const queryOptions = getGetApplicationsQueryOptions(options)
90
120
 
@@ -118,13 +148,27 @@ const {query: queryOptions, request: requestOptions} = options ?? {};
118
148
  export type GetApplicationsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getApplications>>>
119
149
  export type GetApplicationsSuspenseQueryError = ErrorType<DmError>
120
150
 
151
+
152
+ export function useGetApplicationsSuspense<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
153
+ options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
154
+
155
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
156
+ export function useGetApplicationsSuspense<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
157
+ options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
158
+
159
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
160
+ export function useGetApplicationsSuspense<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
161
+ options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
162
+
163
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
121
164
  /**
122
165
  * @summary Get all Applications available to you
123
166
  */
124
- export const useGetApplicationsSuspense = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
167
+
168
+ export function useGetApplicationsSuspense<TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
125
169
  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
126
170
 
127
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
171
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
128
172
 
129
173
  const queryOptions = getGetApplicationsSuspenseQueryOptions(options)
130
174
 
@@ -181,13 +225,39 @@ const {query: queryOptions, request: requestOptions} = options ?? {};
181
225
  export type GetApplicationQueryResult = NonNullable<Awaited<ReturnType<typeof getApplication>>>
182
226
  export type GetApplicationQueryError = ErrorType<void | DmError>
183
227
 
228
+
229
+ export function useGetApplication<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
230
+ applicationId: string, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>> & Pick<
231
+ DefinedInitialDataOptions<
232
+ Awaited<ReturnType<typeof getApplication>>,
233
+ TError,
234
+ TData
235
+ > , 'initialData'
236
+ >, request?: SecondParameter<typeof customInstance>}
237
+
238
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
239
+ export function useGetApplication<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
240
+ applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>> & Pick<
241
+ UndefinedInitialDataOptions<
242
+ Awaited<ReturnType<typeof getApplication>>,
243
+ TError,
244
+ TData
245
+ > , 'initialData'
246
+ >, request?: SecondParameter<typeof customInstance>}
247
+
248
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
249
+ export function useGetApplication<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
250
+ applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
251
+
252
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
184
253
  /**
185
254
  * @summary Get details of a specific Application
186
255
  */
187
- export const useGetApplication = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
256
+
257
+ export function useGetApplication<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
188
258
  applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
189
259
 
190
- ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
260
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
191
261
 
192
262
  const queryOptions = getGetApplicationQueryOptions(applicationId,options)
193
263
 
@@ -221,13 +291,27 @@ const {query: queryOptions, request: requestOptions} = options ?? {};
221
291
  export type GetApplicationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getApplication>>>
222
292
  export type GetApplicationSuspenseQueryError = ErrorType<void | DmError>
223
293
 
294
+
295
+ export function useGetApplicationSuspense<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
296
+ applicationId: string, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
297
+
298
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
299
+ export function useGetApplicationSuspense<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
300
+ applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
301
+
302
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
303
+ export function useGetApplicationSuspense<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
304
+ applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
305
+
306
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
224
307
  /**
225
308
  * @summary Get details of a specific Application
226
309
  */
227
- export const useGetApplicationSuspense = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
310
+
311
+ export function useGetApplicationSuspense<TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
228
312
  applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
229
313
 
230
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
314
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
231
315
 
232
316
  const queryOptions = getGetApplicationSuspenseQueryOptions(applicationId,options)
233
317
 
@@ -1,5 +1,6 @@
1
+ // @ts-nocheck
1
2
  /**
2
- * Generated by orval v6.25.0 🍺
3
+ * Generated by orval v7.2.0 🍺
3
4
  * Do not edit manually.
4
5
  * Dataset Manager API
5
6
  * The Dataset Manager API service.
@@ -13,8 +14,11 @@ import {
13
14
  useSuspenseQuery
14
15
  } from '@tanstack/react-query'
15
16
  import type {
17
+ DefinedInitialDataOptions,
18
+ DefinedUseQueryResult,
16
19
  QueryFunction,
17
20
  QueryKey,
21
+ UndefinedInitialDataOptions,
18
22
  UseQueryOptions,
19
23
  UseQueryResult,
20
24
  UseSuspenseQueryOptions,
@@ -73,13 +77,39 @@ const {query: queryOptions, request: requestOptions} = options ?? {};
73
77
  export type GetModeQueryResult = NonNullable<Awaited<ReturnType<typeof getMode>>>
74
78
  export type GetModeQueryError = ErrorType<void | DmError>
75
79
 
80
+
81
+ export function useGetMode<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
82
+ options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>> & Pick<
83
+ DefinedInitialDataOptions<
84
+ Awaited<ReturnType<typeof getMode>>,
85
+ TError,
86
+ TData
87
+ > , 'initialData'
88
+ >, request?: SecondParameter<typeof customInstance>}
89
+
90
+ ): DefinedUseQueryResult<TData, TError> & { queryKey: QueryKey }
91
+ export function useGetMode<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
92
+ options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>> & Pick<
93
+ UndefinedInitialDataOptions<
94
+ Awaited<ReturnType<typeof getMode>>,
95
+ TError,
96
+ TData
97
+ > , 'initialData'
98
+ >, request?: SecondParameter<typeof customInstance>}
99
+
100
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
101
+ export function useGetMode<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
102
+ options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
103
+
104
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey }
76
105
  /**
77
106
  * @summary Gets the Data Manager mode that's running behind the API
78
107
  */
79
- export const useGetMode = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
108
+
109
+ export function useGetMode<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
80
110
  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
81
111
 
82
- ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
112
+ ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
83
113
 
84
114
  const queryOptions = getGetModeQueryOptions(options)
85
115
 
@@ -113,13 +143,27 @@ const {query: queryOptions, request: requestOptions} = options ?? {};
113
143
  export type GetModeSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getMode>>>
114
144
  export type GetModeSuspenseQueryError = ErrorType<void | DmError>
115
145
 
146
+
147
+ export function useGetModeSuspense<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
148
+ options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
149
+
150
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
151
+ export function useGetModeSuspense<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
152
+ options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
153
+
154
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
155
+ export function useGetModeSuspense<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
156
+ options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
157
+
158
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey }
116
159
  /**
117
160
  * @summary Gets the Data Manager mode that's running behind the API
118
161
  */
119
- export const useGetModeSuspense = <TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
162
+
163
+ export function useGetModeSuspense<TData = Awaited<ReturnType<typeof getMode>>, TError = ErrorType<void | DmError>>(
120
164
  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMode>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
121
165
 
122
- ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
166
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
123
167
 
124
168
  const queryOptions = getGetModeSuspenseQueryOptions(options)
125
169
 
@@ -1,5 +1,6 @@
1
+ // @ts-nocheck
1
2
  /**
2
- * Generated by orval v6.25.0 🍺
3
+ * Generated by orval v7.2.0 🍺
3
4
  * Do not edit manually.
4
5
  * Dataset Manager API
5
6
  * The Dataset Manager API service.
@@ -640,8 +641,12 @@ export type UserAccountPatchBodyBody = {
640
641
  /** For `admin` accounts, if set the user account is able to read anything, i.e. `GET` API calls (i.e. endpoints that do not change the Data Manager state) behave as though the caller is acting as *everyone*. An `admin` user would set ths parameter in order to browse the system, and then switch to `impersonate` mode in order to change things as the chosen user
641
642
  */
642
643
  become_admin?: boolean;
643
- /** For `admin` accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
644
- */
644
+ /**
645
+ * For `admin` accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
646
+
647
+ * @maxLength 80
648
+ * @pattern ^(\w(?:\w*(?:[@.-]\w+)?)*|)$
649
+ */
645
650
  impersonate?: string;
646
651
  /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
647
652
  */
@@ -652,12 +657,19 @@ export type UserAccountPatchBodyBody = {
652
657
  };
653
658
 
654
659
  export type ProjectPostBodyBody = {
660
+ /**
661
+ * @minLength 2
662
+ * @maxLength 80
663
+ */
655
664
  name: string;
656
665
  /** Whether the project is private. You may not be permitted to make the project private, that will depend on the project product you're using to create the project
657
666
  */
658
667
  private?: boolean;
659
- /** The Data Manager *Tier Product ID* you're using to create the Project
660
- */
668
+ /**
669
+ * The Data Manager *Tier Product ID* you're using to create the Project
670
+
671
+ * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
672
+ */
661
673
  tier_product_id: string;
662
674
  };
663
675
 
@@ -669,18 +681,30 @@ export type ProjectPatchBodyBody = {
669
681
  };
670
682
 
671
683
  export type ProjectFilePutBodyBody = {
672
- /** An alternative filename to use for the uploaded File
673
- */
684
+ /**
685
+ * An alternative filename to use for the uploaded File
686
+
687
+ * @minLength 1
688
+ * @maxLength 128
689
+ */
674
690
  as_filename?: string;
675
691
  file: Blob;
676
- /** The Project path of the file.
677
- */
692
+ /**
693
+ * The Project path of the file.
694
+
695
+ * @minLength 1
696
+ * @maxLength 260
697
+ * @pattern ^/.+$|^/$
698
+ */
678
699
  path?: string;
679
700
  };
680
701
 
681
702
  export type ExchangeRatePutBodyBody = {
682
- /** A brief comment relating to the new rate
683
- */
703
+ /**
704
+ * A brief comment relating to the new rate
705
+
706
+ * @maxLength 80
707
+ */
684
708
  comment?: string;
685
709
  /** A decimal value used as the new Exchange Rate. Application _raw_ **costs** are multiplied by this value to covert costs to **coins**. A string is used to avoid rounding errors. Internally the value is treated as a Python Decimal.
686
710
  */
@@ -688,30 +712,54 @@ export type ExchangeRatePutBodyBody = {
688
712
  };
689
713
 
690
714
  export type JobManifestPutBodyBody = {
691
- /** Optional URL header values (a JSON string) */
715
+ /**
716
+ * Optional URL header values (a JSON string)
717
+ * @pattern ^|{.*}$
718
+ */
692
719
  header?: string;
693
- /** Optional URL parameter values (a JSON string) */
720
+ /**
721
+ * Optional URL parameter values (a JSON string)
722
+ * @pattern ^|{.*}$
723
+ */
694
724
  params?: string;
695
725
  /** The URL of the Job Manifest */
696
726
  url: string;
697
727
  };
698
728
 
699
729
  export type InstancePostBodyBody = {
700
- /** A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
730
+ /**
731
+ * A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
701
732
 
702
733
  Application IDs currently supported include `datamanagerjobs.squonk.it` and `jupyternotebooks.squonk.it`
703
- */
734
+
735
+ * @minLength 1
736
+ * @maxLength 80
737
+ */
704
738
  application_id: string;
705
- /** The name to use for the instance
706
- */
739
+ /**
740
+ * The name to use for the instance
741
+
742
+ * @minLength 2
743
+ * @maxLength 80
744
+ * @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_. ]*[A-Za-z0-9]+$
745
+ */
707
746
  as_name: string;
708
- /** Used in conjunction with the `callback_url` any value provided here will be passed back in the message payload that's delivered to the callback URL. It can be used by the recipient to provide a context that's meaningful
709
- */
747
+ /**
748
+ * Used in conjunction with the `callback_url` any value provided here will be passed back in the message payload that's delivered to the callback URL. It can be used by the recipient to provide a context that's meaningful
749
+
750
+ * @minLength 1
751
+ * @maxLength 256
752
+ */
710
753
  callback_context?: string;
711
- /** An optional 22-character **sortuuid** callback token that is supplied by the remote service. If not provided the user can use `generate_callback_token` to have one generated and returned in the response.
754
+ /**
755
+ * An optional 22-character **sortuuid** callback token that is supplied by the remote service. If not provided the user can use `generate_callback_token` to have one generated and returned in the response.
712
756
 
713
757
  See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
714
- */
758
+
759
+ * @minLength 22
760
+ * @maxLength 22
761
+ * @pattern ^[2-9A-HJ-NP-Za-km-z]{22}$
762
+ */
715
763
  callback_token?: string;
716
764
  /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
717
765
  */
@@ -730,8 +778,11 @@ Caution should be taken using this feature. A 3rd party can access the Project's
730
778
  Tokens should therefore be revoked when they're no longer required
731
779
  */
732
780
  generate_callback_token?: boolean;
733
- /** The project to attach
734
- */
781
+ /**
782
+ * The project to attach
783
+
784
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
785
+ */
735
786
  project_id: string;
736
787
  /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
737
788
 
@@ -753,47 +804,78 @@ export type FilePostBodyBody = {
753
804
  /** Whether to compress the Dataset File as it's attached. Compression is achieved using gzip, resulting in a File ending `.gz`. By default the file will be compressed
754
805
  */
755
806
  compress?: boolean;
756
- /** The Dataset UUID for the File that you intend to attach
757
- */
807
+ /**
808
+ * The Dataset UUID for the File that you intend to attach
809
+
810
+ * @pattern ^dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
811
+ */
758
812
  dataset_id: string;
759
- /** The Dataset version to attach
760
- */
813
+ /**
814
+ * The Dataset version to attach
815
+
816
+ * @minimum 1
817
+ */
761
818
  dataset_version: number;
762
819
  /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
763
820
  */
764
821
  immutable?: boolean;
765
- /** A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
766
- */
822
+ /**
823
+ * A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
824
+
825
+ * @maxLength 260
826
+ * @pattern ^/.+$|^/$
827
+ */
767
828
  path?: string;
768
- /** The Project UUID you're attaching to
769
- */
829
+ /**
830
+ * The Project UUID you're attaching to
831
+
832
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
833
+ */
770
834
  project_id: string;
771
835
  };
772
836
 
773
837
  export type DatasetPutBodyBody = {
774
- /** If provided the File becomes a new version of the Dataset named. If not provided this File becomes the first version of a new Dataset, whose ID is returned to you on success.
775
- */
838
+ /**
839
+ * If provided the File becomes a new version of the Dataset named. If not provided this File becomes the first version of a new Dataset, whose ID is returned to you on success.
840
+
841
+ * @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
842
+ */
776
843
  dataset_id?: string;
777
844
  /** The MIME type of the Dataset
778
845
  */
779
846
  dataset_type: string;
780
- /** The file name of the file in the Project path to load as a new Dataset.
781
- */
847
+ /**
848
+ * The file name of the file in the Project path to load as a new Dataset.
849
+
850
+ * @minLength 1
851
+ * @maxLength 128
852
+ */
782
853
  file_name: string;
783
854
  /** Extra variables (text) presented to the Dataset format-support container, which occurs during the upload and database processing stage. The content of the text is Dataset type specific.
784
855
  */
785
856
  format_extra_variables?: string;
786
- /** The Project path of the file.
787
- */
857
+ /**
858
+ * The Project path of the file.
859
+
860
+ * @minLength 1
861
+ * @maxLength 260
862
+ * @pattern ^/.+$|^/$
863
+ */
788
864
  path: string;
789
- /** The Project the file belongs to
790
- */
865
+ /**
866
+ * The Project the file belongs to
867
+
868
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
869
+ */
791
870
  project_id: string;
792
871
  /** If set the post-format database load action is skipped. This means the dataset is uploaded but its molecules are not entered into the Data Manager database. This can save significant time if you're just experimenting with the dataset and do not need the molecules in the database
793
872
  */
794
873
  skip_molecule_load?: boolean;
795
- /** The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
796
- */
874
+ /**
875
+ * The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
876
+
877
+ * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
878
+ */
797
879
  unit_id?: string;
798
880
  };
799
881
 
@@ -816,12 +898,19 @@ export type DatasetMetaPostBodyBody = {
816
898
  };
817
899
 
818
900
  export type DatasetPostBodyBody = {
819
- /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
820
- */
901
+ /**
902
+ * An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
903
+
904
+ * @minLength 1
905
+ * @maxLength 128
906
+ */
821
907
  as_filename?: string;
822
908
  dataset_file: Blob;
823
- /** If provided the Dataset becomes a new version of the Dataset named. If not provided this Dataset becomes the first version of a new Dataset, whose ID is returned to you on success.
824
- */
909
+ /**
910
+ * If provided the Dataset becomes a new version of the Dataset named. If not provided this Dataset becomes the first version of a new Dataset, whose ID is returned to you on success.
911
+
912
+ * @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
913
+ */
825
914
  dataset_id?: string;
826
915
  /** The MIME type of the Dataset. Values like `chemical/x-mdl-sdfile`, `chemical/x-mdl-molfile`, and `chemical/x-pdb` are permitted. See the **\/type** endpoint for a full list of types.
827
916
  */
@@ -832,8 +921,11 @@ export type DatasetPostBodyBody = {
832
921
  /** If set the post-format database load action is skipped. This means the dataset is uploaded but its molecules are not entered into the Data Manager database. This can save significant time if you're just experimenting with the dataset and do not need the molecules in the database
833
922
  */
834
923
  skip_molecule_load?: boolean;
835
- /** The Organisational Unit you want the Dataset to belong to
836
- */
924
+ /**
925
+ * The Organisational Unit you want the Dataset to belong to
926
+
927
+ * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
928
+ */
837
929
  unit_id: string;
838
930
  };
839
931
 
@@ -924,7 +1016,7 @@ export type TypeSummaryFormatterOptions = {
924
1016
  /** The Schema type (an object)
925
1017
  */
926
1018
  type: TypeSummaryFormatterOptionsType;
927
- [key: string]: any;
1019
+ [key: string]: unknown;
928
1020
  };
929
1021
 
930
1022
  export interface TypeSummary {
@@ -1169,19 +1261,19 @@ export interface JobOrderDetail {
1169
1261
  * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1170
1262
 
1171
1263
  */
1172
- export type JobVariablesOutputs = { [key: string]: any };
1264
+ export type JobVariablesOutputs = { [key: string]: unknown };
1173
1265
 
1174
1266
  /**
1175
1267
  * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1176
1268
 
1177
1269
  */
1178
- export type JobVariablesOptions = { [key: string]: any };
1270
+ export type JobVariablesOptions = { [key: string]: unknown };
1179
1271
 
1180
1272
  /**
1181
1273
  * The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
1182
1274
 
1183
1275
  */
1184
- export type JobVariablesInputs = { [key: string]: any };
1276
+ export type JobVariablesInputs = { [key: string]: unknown };
1185
1277
 
1186
1278
  export interface JobVariables {
1187
1279
  /** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
@@ -1504,7 +1596,7 @@ export const DatasetVersionSummaryProcessingStage = {
1504
1596
  * The dictionary of label/value pairs
1505
1597
 
1506
1598
  */
1507
- export type DatasetVersionSummaryLabels = { [key: string]: any };
1599
+ export type DatasetVersionSummaryLabels = { [key: string]: unknown };
1508
1600
 
1509
1601
  export interface DatasetVersionSummary {
1510
1602
  /** The code obtained from the Account Server
@@ -1581,7 +1673,7 @@ export const DatasetVersionDetailProcessingStage = {
1581
1673
  * The dictionary of label/value pairs
1582
1674
 
1583
1675
  */
1584
- export type DatasetVersionDetailLabels = { [key: string]: any };
1676
+ export type DatasetVersionDetailLabels = { [key: string]: unknown };
1585
1677
 
1586
1678
  export interface DatasetVersionDetail {
1587
1679
  /** The code obtained from the Account Server
@@ -1887,12 +1979,6 @@ export interface JobsGetResponse {
1887
1979
  jobs: JobSummary[];
1888
1980
  }
1889
1981
 
1890
- /**
1891
- * The directory used as the container image working directory (if defined)
1892
-
1893
- */
1894
- export type JobGetResponseImageWorkingDirectory = {};
1895
-
1896
1982
  /**
1897
1983
  * The optional container image type. Typically a single-container `SIMPLE` (where only one container runs) or a workflow where multiple container images can be spawned (like `NEXTFLOW`)
1898
1984
 
@@ -1955,7 +2041,7 @@ Where there is no remedy for a given reason the remedy will be "There is no reme
1955
2041
  image_type?: JobGetResponseImageType;
1956
2042
  /** The directory used as the container image working directory (if defined)
1957
2043
  */
1958
- image_working_directory?: JobGetResponseImageWorkingDirectory;
2044
+ image_working_directory?: unknown;
1959
2045
  /** The Job name, unique within a given collection
1960
2046
  */
1961
2047
  job: string;
@@ -2284,17 +2370,13 @@ export interface DatasetSchemaGetResponse {
2284
2370
  /** The Metadata type (an object)
2285
2371
  */
2286
2372
  type: DatasetSchemaGetResponseType;
2287
- [key: string]: any;
2373
+ [key: string]: unknown;
2288
2374
  }
2289
2375
 
2290
- export type DatasetMetaGetResponseLabelsItem = {};
2291
-
2292
- export type DatasetMetaGetResponseAnnotationsItem = {};
2293
-
2294
2376
  export interface DatasetMetaGetResponse {
2295
2377
  /** The Metadata's annotations
2296
2378
  */
2297
- annotations: DatasetMetaGetResponseAnnotationsItem[];
2379
+ annotations: unknown[];
2298
2380
  /** The date and time of creation
2299
2381
  */
2300
2382
  created: string;
@@ -2312,22 +2394,25 @@ export interface DatasetMetaGetResponse {
2312
2394
  description: string;
2313
2395
  /** The Metadata's labels
2314
2396
  */
2315
- labels: DatasetMetaGetResponseLabelsItem[];
2397
+ labels: unknown[];
2316
2398
  /** The date and time it was last updated
2317
2399
  */
2318
2400
  last_updated: string;
2319
2401
  /** The Metadata version
2320
2402
  */
2321
2403
  metadata_version: string;
2322
- [key: string]: any;
2404
+ [key: string]: unknown;
2323
2405
  }
2324
2406
 
2325
2407
  export interface DatasetDigestGetResponse {
2326
2408
  /** The Dataset matching the digest
2327
2409
  */
2328
2410
  dataset_id: string;
2329
- /** The Dataset version
2330
- */
2411
+ /**
2412
+ * The Dataset version
2413
+
2414
+ * @minimum 1
2415
+ */
2331
2416
  dataset_version: number;
2332
2417
  }
2333
2418
 
@@ -2441,6 +2526,7 @@ export interface AccountServerGetNamespaceResponse {
2441
2526
  }
2442
2527
 
2443
2528
  export interface AccountServerGetRegistrationResponse {
2529
+ /** @minimum 1 */
2444
2530
  merchant_id: number;
2445
2531
  name: string;
2446
2532
  registered: string;