@squonk/data-manager-client 1.2.3-rc.2 → 1.2.4-rc.1

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 (112) hide show
  1. package/accounting/accounting.cjs +31 -13
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +77 -0
  4. package/accounting/accounting.d.ts +10 -1
  5. package/accounting/accounting.js +29 -11
  6. package/accounting/accounting.js.map +1 -1
  7. package/admin/admin.cjs +67 -27
  8. package/admin/admin.cjs.map +1 -1
  9. package/admin/admin.d.cts +324 -0
  10. package/admin/admin.d.ts +55 -22
  11. package/admin/admin.js +57 -17
  12. package/admin/admin.js.map +1 -1
  13. package/application/application.cjs +23 -13
  14. package/application/application.cjs.map +1 -1
  15. package/application/application.d.cts +57 -0
  16. package/application/application.d.ts +7 -1
  17. package/application/application.js +22 -12
  18. package/application/application.js.map +1 -1
  19. package/{chunk-UZTHSGDT.cjs → chunk-J22A7LHX.cjs} +1 -1
  20. package/chunk-J22A7LHX.cjs.map +1 -0
  21. package/{chunk-3RNIDX7T.js → chunk-UKA7G3OB.js} +1 -1
  22. package/{chunk-3RNIDX7T.js.map → chunk-UKA7G3OB.js.map} +1 -1
  23. package/configuration/configuration.cjs +13 -7
  24. package/configuration/configuration.cjs.map +1 -1
  25. package/configuration/configuration.d.cts +29 -0
  26. package/configuration/configuration.d.ts +4 -1
  27. package/configuration/configuration.js +13 -7
  28. package/configuration/configuration.js.map +1 -1
  29. package/{custom-instance-50c9dd5d.d.ts → custom-instance-a2110e78.d.ts} +825 -825
  30. package/dataset/dataset.cjs +71 -72
  31. package/dataset/dataset.cjs.map +1 -1
  32. package/dataset/dataset.d.cts +315 -0
  33. package/dataset/dataset.d.ts +46 -16
  34. package/dataset/dataset.js +62 -63
  35. package/dataset/dataset.js.map +1 -1
  36. package/exchange-rate/exchange-rate.cjs +43 -32
  37. package/exchange-rate/exchange-rate.cjs.map +1 -1
  38. package/exchange-rate/exchange-rate.d.cts +180 -0
  39. package/exchange-rate/exchange-rate.d.ts +25 -7
  40. package/exchange-rate/exchange-rate.js +38 -27
  41. package/exchange-rate/exchange-rate.js.map +1 -1
  42. package/file/file.cjs +38 -22
  43. package/file/file.cjs.map +1 -1
  44. package/file/file.d.cts +154 -0
  45. package/file/file.d.ts +25 -10
  46. package/file/file.js +34 -18
  47. package/file/file.js.map +1 -1
  48. package/index.cjs +10 -10
  49. package/index.cjs.map +1 -1
  50. package/index.d.cts +2 -0
  51. package/index.d.ts +1 -1
  52. package/index.js +9 -9
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +47 -37
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +215 -0
  57. package/instance/instance.d.ts +33 -12
  58. package/instance/instance.js +41 -31
  59. package/instance/instance.js.map +1 -1
  60. package/job/job.cjs +36 -19
  61. package/job/job.cjs.map +1 -1
  62. package/job/job.d.cts +85 -0
  63. package/job/job.d.ts +10 -1
  64. package/job/job.js +34 -17
  65. package/job/job.js.map +1 -1
  66. package/metadata/metadata.cjs +23 -26
  67. package/metadata/metadata.cjs.map +1 -1
  68. package/metadata/metadata.d.cts +132 -0
  69. package/metadata/metadata.d.ts +19 -7
  70. package/metadata/metadata.js +20 -23
  71. package/metadata/metadata.js.map +1 -1
  72. package/package.json +12 -12
  73. package/project/project.cjs +70 -48
  74. package/project/project.cjs.map +1 -1
  75. package/project/project.d.cts +377 -0
  76. package/project/project.d.ts +61 -25
  77. package/project/project.js +59 -37
  78. package/project/project.js.map +1 -1
  79. package/src/accounting/accounting.ts +179 -194
  80. package/src/admin/admin.ts +590 -735
  81. package/src/application/application.ts +125 -141
  82. package/src/configuration/configuration.ts +72 -60
  83. package/src/data-manager-api.schemas.ts +940 -941
  84. package/src/dataset/dataset.ts +591 -770
  85. package/src/exchange-rate/exchange-rate.ts +362 -478
  86. package/src/file/file.ts +292 -357
  87. package/src/instance/instance.ts +427 -533
  88. package/src/job/job.ts +187 -198
  89. package/src/metadata/metadata.ts +247 -339
  90. package/src/project/project.ts +669 -860
  91. package/src/task/task.ts +181 -202
  92. package/src/type/type.ts +72 -68
  93. package/src/user/user.ts +248 -286
  94. package/task/task.cjs +31 -15
  95. package/task/task.cjs.map +1 -1
  96. package/task/task.d.cts +103 -0
  97. package/task/task.d.ts +10 -1
  98. package/task/task.js +29 -13
  99. package/task/task.js.map +1 -1
  100. package/type/type.cjs +13 -7
  101. package/type/type.cjs.map +1 -1
  102. package/type/type.d.cts +31 -0
  103. package/type/type.d.ts +4 -1
  104. package/type/type.js +13 -7
  105. package/type/type.js.map +1 -1
  106. package/user/user.cjs +39 -28
  107. package/user/user.cjs.map +1 -1
  108. package/user/user.d.cts +104 -0
  109. package/user/user.d.ts +16 -4
  110. package/user/user.js +36 -25
  111. package/user/user.js.map +1 -1
  112. package/chunk-UZTHSGDT.cjs.map +0 -1
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.15.0 🍺
2
+ * Generated by orval v6.20.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -9,290 +9,290 @@ A service that allows *registered* users to make **Datasets** and associated **M
9
9
  * OpenAPI spec version: 1.2
10
10
  */
11
11
  export type AdminDeleteJobManifestParams = {
12
- /**
13
- * Purge unreferenced Jobs
14
- */
15
- purge?: QPurgeParameter;
12
+ /**
13
+ * Purge unreferenced Jobs
14
+ */
15
+ purge?: QPurgeParameter;
16
16
  };
17
17
 
18
18
  export type AdminGetUsersParams = {
19
- /**
19
+ /**
20
20
  * Maximum days a user has been idle (has not used the API). If you specify `2` and it's Monday then users who have not used the API since Saturday will be returned.
21
21
 
22
22
  */
23
- idle_days?: QIdleDaysParameter;
24
- /**
23
+ idle_days?: QIdleDaysParameter;
24
+ /**
25
25
  * Minimum days a user has been active (has used the API). If you specify `2` and it's Monday then users who have used the API on Saturday or later will be returned.
26
26
 
27
27
  */
28
- active_days?: QActiveDaysParameter;
28
+ active_days?: QActiveDaysParameter;
29
29
  };
30
30
 
31
31
  export type AdminGetServiceErrorsParams = {
32
- /**
32
+ /**
33
33
  * Set to include acknowledged items
34
34
 
35
35
  */
36
- include_acknowleged?: QIncludeAcknowlegedParameter;
36
+ include_acknowleged?: QIncludeAcknowlegedParameter;
37
37
  };
38
38
 
39
39
  export type GetUserApiLogParams = {
40
- /**
40
+ /**
41
41
  * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
42
42
 
43
43
  */
44
- from?: QFromParameter;
45
- /**
44
+ from?: QFromParameter;
45
+ /**
46
46
  * An until (exclusive) date-time. If provided only API calls made before this will be returned. UTC is assumed if no timezone is provided
47
47
 
48
48
  */
49
- until?: QUntilParameter;
49
+ until?: QUntilParameter;
50
50
  };
51
51
 
52
52
  export type GetUserAccountParams = {
53
- /**
53
+ /**
54
54
  * Set, if you're an admin, to call the endpoint without impersonation
55
55
 
56
56
  */
57
- do_not_impersonate?: QDoNotImpersonateParameter;
57
+ do_not_impersonate?: QDoNotImpersonateParameter;
58
58
  };
59
59
 
60
60
  export type PatchInstanceParams = {
61
- /**
62
- * True to archive the instance
63
- */
64
- archive?: QInstanceArchiveParameter;
61
+ /**
62
+ * True to archive the instance
63
+ */
64
+ archive?: QInstanceArchiveParameter;
65
65
  };
66
66
 
67
67
  export type GetInstancesParams = {
68
- /**
69
- * A Project identity
70
- */
71
- project_id?: QProjectIdParameter;
68
+ /**
69
+ * A Project identity
70
+ */
71
+ project_id?: QProjectIdParameter;
72
72
  };
73
73
 
74
74
  export type GetJobExchangeRatesParams = {
75
- /**
75
+ /**
76
76
  * Set to get current
77
77
 
78
78
  */
79
- current?: QCurrentParameter;
79
+ current?: QCurrentParameter;
80
80
  };
81
81
 
82
82
  export type GetAllJobExchangeRatesParams = {
83
- /**
83
+ /**
84
84
  * Only return records where the exchange rate is undefined
85
85
 
86
86
  */
87
- only_undefined?: QOnlyUndefinedParameter;
87
+ only_undefined?: QOnlyUndefinedParameter;
88
88
  };
89
89
 
90
90
  export type GetJobParams = {
91
- /**
92
- * A Project identity
93
- */
94
- project_id?: QProjectIdParameter;
91
+ /**
92
+ * A Project identity
93
+ */
94
+ project_id?: QProjectIdParameter;
95
95
  };
96
96
 
97
97
  export type GetJobByVersionParams = {
98
- /**
98
+ /**
99
99
  * The Collection for a Job, i.e. "im-test"
100
100
 
101
101
  */
102
- collection: QJobCollectionParameter;
103
- /**
102
+ collection: QJobCollectionParameter;
103
+ /**
104
104
  * The Job, i.e. "nop"
105
105
 
106
106
  */
107
- job: QJobJobParameter;
108
- /**
107
+ job: QJobJobParameter;
108
+ /**
109
109
  * The version of a Job, i.e. "1.0.0"
110
110
 
111
111
  */
112
- version: QJobVersionParameter;
113
- /**
114
- * A Project identity
115
- */
116
- project_id?: QProjectIdParameter;
112
+ version: QJobVersionParameter;
113
+ /**
114
+ * A Project identity
115
+ */
116
+ project_id?: QProjectIdParameter;
117
117
  };
118
118
 
119
119
  export type GetJobsParams = {
120
- /**
121
- * A Project identity
122
- */
123
- project_id?: QProjectIdParameter;
120
+ /**
121
+ * A Project identity
122
+ */
123
+ project_id?: QProjectIdParameter;
124
124
  };
125
125
 
126
126
  export type GetApplicationExchangeRatesParams = {
127
- /**
127
+ /**
128
128
  * Set to get current
129
129
 
130
130
  */
131
- current?: QCurrentParameter;
131
+ current?: QCurrentParameter;
132
132
  };
133
133
 
134
134
  export type GetAllApplicationExchangeRatesParams = {
135
- /**
135
+ /**
136
136
  * Only return records where the exchange rate is undefined
137
137
 
138
138
  */
139
- only_undefined?: QOnlyUndefinedParameter;
139
+ only_undefined?: QOnlyUndefinedParameter;
140
140
  };
141
141
 
142
142
  export type GetTaskParams = {
143
- /**
143
+ /**
144
144
  * Maximum number of events to return. If provided, can be 1 or more.
145
145
 
146
146
  */
147
- event_limit?: QEventLimitParameter;
148
- /**
147
+ event_limit?: QEventLimitParameter;
148
+ /**
149
149
  * The ordinal of a previously received event. If set, only events subsequent to the ordinal provided will be returned. Providing a value of 0 will result in retrieving the first and subsequent events.
150
150
 
151
151
  */
152
- event_prior_ordinal?: QEventPriorOrdinalParameter;
152
+ event_prior_ordinal?: QEventPriorOrdinalParameter;
153
153
  };
154
154
 
155
155
  export type GetTasksParams = {
156
- /**
156
+ /**
157
157
  * Set true if you want to exclude 'done' tasks, i.e. just see those that are still running.
158
158
 
159
159
  */
160
- exclude_done?: QExcludeDoneParameter;
161
- /**
160
+ exclude_done?: QExcludeDoneParameter;
161
+ /**
162
162
  * Set true if you want to exclude Tasks related to object removal.
163
163
 
164
164
  */
165
- exclude_removal?: QExcludeRemovalParameter;
166
- /**
165
+ exclude_removal?: QExcludeRemovalParameter;
166
+ /**
167
167
  * Set to a dot-separated string of purpose enumerations, i.e. `DATASET`, `FILE`, `INSTANCE`, or `PROJECT`. To exclude file and dataset tasks set this field to `FILE.DATASET`
168
168
 
169
169
  */
170
- exclude_purpose?: QExcludePurposeParameter;
171
- /**
172
- * A Project identity
173
- */
174
- project_id?: QProjectIdParameter;
175
- /**
176
- * An instance callback context string
177
- */
178
- instance_callback_context?: QInstanceCallbackContextParameter;
170
+ exclude_purpose?: QExcludePurposeParameter;
171
+ /**
172
+ * A Project identity
173
+ */
174
+ project_id?: QProjectIdParameter;
175
+ /**
176
+ * An instance callback context string
177
+ */
178
+ instance_callback_context?: QInstanceCallbackContextParameter;
179
179
  };
180
180
 
181
181
  export type DeleteUnmanagedFileParams = {
182
- /**
182
+ /**
183
183
  * A project file.
184
184
 
185
185
  */
186
- file: QFileParameter;
187
- /**
186
+ file: QFileParameter;
187
+ /**
188
188
  * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
189
189
 
190
190
  */
191
- path?: QFilePathParameter;
192
- /**
193
- * The Project identity
194
- */
195
- project_id: QFileProjectIdParameter;
191
+ path?: QFilePathParameter;
192
+ /**
193
+ * The Project identity
194
+ */
195
+ project_id: QFileProjectIdParameter;
196
196
  };
197
197
 
198
198
  export type GetFilesParams = {
199
- /**
200
- * The Project identity
201
- */
202
- project_id: QFileProjectIdParameter;
203
- /**
199
+ /**
200
+ * The Project identity
201
+ */
202
+ project_id: QFileProjectIdParameter;
203
+ /**
204
204
  * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
205
205
 
206
206
  */
207
- path?: QFilePathParameter;
208
- /**
209
- * Whether to include hidden files and directories
210
- */
211
- include_hidden?: QIncludeHiddenParameter;
207
+ path?: QFilePathParameter;
208
+ /**
209
+ * Whether to include hidden files and directories
210
+ */
211
+ include_hidden?: QIncludeHiddenParameter;
212
212
  };
213
213
 
214
214
  export type DeleteDatasetParams = {
215
- /**
215
+ /**
216
216
  * Whether to convert Project managed file instances to unmanaged files
217
217
 
218
218
  */
219
- keep_project_files?: QKeepProjectFilesParameter;
219
+ keep_project_files?: QKeepProjectFilesParameter;
220
220
  };
221
221
 
222
222
  export type GetVersionsParams = {
223
- /**
224
- * Whether to include records that are deleted
225
- */
226
- include_deleted?: QIncludeDeletedParameter;
223
+ /**
224
+ * Whether to include records that are deleted
225
+ */
226
+ include_deleted?: QIncludeDeletedParameter;
227
227
  };
228
228
 
229
229
  export type GetDatasetsParams = {
230
- /**
231
- * Whether to include records that are deleted
232
- */
233
- include_deleted?: QIncludeDeletedParameter;
234
- /**
230
+ /**
231
+ * Whether to include records that are deleted
232
+ */
233
+ include_deleted?: QIncludeDeletedParameter;
234
+ /**
235
235
  * Filter the datasets by username
236
236
 
237
237
  */
238
- username?: QUsernameParameter;
239
- /**
238
+ username?: QUsernameParameter;
239
+ /**
240
240
  * Filter the datasets by the supplied mime_type.
241
241
 
242
242
  */
243
- dataset_mime_type?: QDatasetMimeTypeParameter;
244
- /**
243
+ dataset_mime_type?: QDatasetMimeTypeParameter;
244
+ /**
245
245
  * Filter the datasets by a comma separated list of owners
246
246
 
247
247
  */
248
- owners?: QOwnersParameter;
249
- /**
248
+ owners?: QOwnersParameter;
249
+ /**
250
250
  * Filter the datasets by a comma separated list of editors
251
251
 
252
252
  */
253
- editors?: QEditorsParameter;
254
- /**
253
+ editors?: QEditorsParameter;
254
+ /**
255
255
  * JSON string containing a list of label/value pairs for the datasets to be filtered by. If the value is set to null, then only the label is matched. If both the label and value are set, then both are matched. e.g. '{"label1": null, "label2": "value2"}'
256
256
 
257
257
  */
258
- labels?: QLabelsParameter;
258
+ labels?: QLabelsParameter;
259
259
  };
260
260
 
261
261
  export type GetProjectFileWithTokenParams = {
262
- /**
263
- * A token
264
- */
265
- token?: QTokenParameter;
266
- /**
262
+ /**
263
+ * A token
264
+ */
265
+ token?: QTokenParameter;
266
+ /**
267
267
  * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
268
268
 
269
269
  */
270
- path?: QFilePathParameter;
271
- /**
270
+ path?: QFilePathParameter;
271
+ /**
272
272
  * A project file.
273
273
 
274
274
  */
275
- file: QFileParameter;
275
+ file: QFileParameter;
276
276
  };
277
277
 
278
278
  export type GetProjectFileParams = {
279
- /**
279
+ /**
280
280
  * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
281
281
 
282
282
  */
283
- path?: QFilePathParameter;
284
- /**
283
+ path?: QFilePathParameter;
284
+ /**
285
285
  * A project file.
286
286
 
287
287
  */
288
- file: QFileParameter;
288
+ file: QFileParameter;
289
289
  };
290
290
 
291
291
  export type GetProjectsParams = {
292
- /**
293
- * A Project name
294
- */
295
- project_name?: QProjectNameParameter;
292
+ /**
293
+ * A Project name
294
+ */
295
+ project_name?: QProjectNameParameter;
296
296
  };
297
297
 
298
298
  /**
@@ -498,68 +498,68 @@ export type QApplicationIdParameter = string;
498
498
 
499
499
  export type UserPatchBodyBody = {
500
500
  /** If set to a message the user account is suspended, with the user receiving this message when they try and use the API. A suspended user account can be restored by setting the message to `/restore`
501
- */
501
+ */
502
502
  suspend_message?: string;
503
503
  };
504
504
 
505
505
  export type UserAccountPatchBodyBody = {
506
- /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
507
- */
508
- private?: boolean;
509
506
  /** 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
510
- */
507
+ */
511
508
  become_admin?: boolean;
512
509
  /** 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`
513
- */
510
+ */
514
511
  impersonate?: string;
512
+ /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
513
+ */
514
+ private?: boolean;
515
515
  /** For `admin` accounts, if this is set the account for the user being impersonated is patched, rather then the user's own account. To use this you must have a value for `impersonate`
516
- */
516
+ */
517
517
  use_impersonation?: boolean;
518
518
  };
519
519
 
520
520
  export type ProjectPostBodyBody = {
521
521
  name: string;
522
522
  /** 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
523
- */
523
+ */
524
524
  private?: boolean;
525
525
  /** The Data Manager *Tier Product ID* you're using to create the Project
526
- */
526
+ */
527
527
  tier_product_id: string;
528
528
  };
529
529
 
530
530
  export type ProjectPatchBodyBody = {
531
- private?: boolean;
532
531
  /** The new name of the ptojct
533
- */
532
+ */
534
533
  name?: string;
534
+ private?: boolean;
535
535
  };
536
536
 
537
537
  export type ProjectFilePutBodyBody = {
538
- file: Blob;
539
538
  /** An alternative filename to use for the uploaded File
540
- */
539
+ */
541
540
  as_filename?: string;
541
+ file: Blob;
542
542
  /** The Project path of the file.
543
- */
543
+ */
544
544
  path?: string;
545
545
  };
546
546
 
547
547
  export type ExchangeRatePutBodyBody = {
548
- /** 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.
549
- */
550
- rate: string;
551
548
  /** A brief comment relating to the new rate
552
- */
549
+ */
553
550
  comment?: string;
551
+ /** 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.
552
+ */
553
+ rate: string;
554
554
  };
555
555
 
556
556
  export type JobManifestPutBodyBody = {
557
- /** The URL of the Job Manifest */
558
- url: string;
559
557
  /** Optional URL header values (a JSON string) */
560
558
  header?: string;
561
559
  /** Optional URL parameter values (a JSON string) */
562
560
  params?: string;
561
+ /** The URL of the Job Manifest */
562
+ url: string;
563
563
  };
564
564
 
565
565
  export type InstancePostBodyBody = {
@@ -573,30 +573,20 @@ Application IDs currently supported include `datamanagerjobs.squonk.it` and `jup
573
573
  This property is **Deprecated**. It is currently ignored will be removed in a future release
574
574
  */
575
575
  application_version?: string;
576
- /** The project to attach
577
- */
578
- project_id: string;
579
576
  /** The name to use for the instance
580
- */
577
+ */
581
578
  as_name: string;
582
- /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
583
- */
584
- callback_url?: string;
585
579
  /** 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
586
- */
587
- callback_context?: string;
588
- /** If set a callback token will be provided in the response. The token allows files to be downloaded from the instance project and expires after a pre-configured amount of time after the instance is complete or if the user revokes the token.
589
-
590
- Caution should be taken using this feature. A 3rd party can access the Project's files without authentication, they just need the token and the project identity.
591
-
592
- Tokens should therefore be revoked when they're no longer required
593
580
  */
594
- generate_callback_token?: boolean;
581
+ callback_context?: string;
595
582
  /** 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.
596
583
 
597
584
  See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
598
585
  */
599
586
  callback_token?: string;
587
+ /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
588
+ */
589
+ callback_url?: string;
600
590
  /** A debug value that may be used by the instance.
601
591
 
602
592
  For Data Manager **Job** applications setting this to anything other zero ('0') prevents the Job's Pod from being deleted automatically, allowing a developer to inspect the Pod's log for example.
@@ -604,6 +594,16 @@ For Data Manager **Job** applications setting this to anything other zero ('0')
604
594
  The behaviour of **Application** instances using this property is undefined. It will depend on whether the application **CRD** handles the Data Manager debug field.
605
595
  */
606
596
  debug?: string;
597
+ /** If set a callback token will be provided in the response. The token allows files to be downloaded from the instance project and expires after a pre-configured amount of time after the instance is complete or if the user revokes the token.
598
+
599
+ Caution should be taken using this feature. A 3rd party can access the Project's files without authentication, they just need the token and the project identity.
600
+
601
+ Tokens should therefore be revoked when they're no longer required
602
+ */
603
+ generate_callback_token?: boolean;
604
+ /** The project to attach
605
+ */
606
+ project_id: string;
607
607
  /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
608
608
 
609
609
  When launching a Data Manager **Job** Application you must identify the Job using the properties `collection`, `job` and `version`, e.g. `{"collection":"im-test","job":"nop","version":"1.0.0"}`
@@ -618,167 +618,167 @@ Applications also support `variables`. The Jupyter notebook application supports
618
618
  };
619
619
 
620
620
  export type FilePostBodyBody = {
621
- /** The Dataset UUID for the File that you intend to attach
622
- */
623
- dataset_id: string;
624
- /** The Dataset version to attach
625
- */
626
- dataset_version: number;
627
- /** The Project UUID you're attaching to
628
- */
629
- project_id: string;
630
621
  /** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
631
- */
622
+ */
632
623
  as_type: string;
633
- /** A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
634
- */
635
- path?: string;
636
624
  /** 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
637
- */
625
+ */
638
626
  compress?: boolean;
627
+ /** The Dataset UUID for the File that you intend to attach
628
+ */
629
+ dataset_id: string;
630
+ /** The Dataset version to attach
631
+ */
632
+ dataset_version: number;
639
633
  /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
640
- */
634
+ */
641
635
  immutable?: boolean;
636
+ /** A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
637
+ */
638
+ path?: string;
639
+ /** The Project UUID you're attaching to
640
+ */
641
+ project_id: string;
642
642
  };
643
643
 
644
644
  export type DatasetPutBodyBody = {
645
+ /** 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.
646
+ */
647
+ dataset_id?: string;
645
648
  /** The MIME type of the Dataset
646
- */
649
+ */
647
650
  dataset_type: string;
651
+ /** The file name of the file in the Project path to load as a new Dataset.
652
+ */
653
+ file_name: string;
648
654
  /** 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.
649
- */
655
+ */
650
656
  format_extra_variables?: string;
651
- /** 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
652
- */
653
- skip_molecule_load?: boolean;
654
- /** The Project the file belongs to
655
- */
656
- project_id: string;
657
657
  /** The Project path of the file.
658
- */
658
+ */
659
659
  path: string;
660
- /** The file name of the file in the Project path to load as a new Dataset.
661
- */
662
- file_name: string;
663
- /** 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.
664
- */
665
- dataset_id?: string;
660
+ /** The Project the file belongs to
661
+ */
662
+ project_id: string;
663
+ /** 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
664
+ */
665
+ skip_molecule_load?: boolean;
666
666
  /** The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
667
- */
667
+ */
668
668
  unit_id?: string;
669
669
  };
670
670
 
671
671
  export type DatasetVersionMetaPostBodyBody = {
672
- /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
673
- */
674
- meta_properties?: string;
675
672
  /** JSON string containing a list of annotations. The format of the labels should match either the Fields Descriptor or Service Execution annotation formats described in the data-manager-metadata library.
676
- */
673
+ */
677
674
  annotations?: string;
675
+ /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
676
+ */
677
+ meta_properties?: string;
678
678
  };
679
679
 
680
680
  export type DatasetMetaPostBodyBody = {
681
- /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
682
- */
683
- meta_properties?: string;
684
681
  /** JSON string containing a list of labels. The format of the labels should match the label annotation format described in the data-manager-metadata library.
685
- */
682
+ */
686
683
  labels?: string;
684
+ /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
685
+ */
686
+ meta_properties?: string;
687
687
  };
688
688
 
689
689
  export type DatasetPostBodyBody = {
690
+ /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
691
+ */
692
+ as_filename?: string;
690
693
  dataset_file: Blob;
694
+ /** 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.
695
+ */
696
+ dataset_id?: string;
691
697
  /** 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.
692
- */
698
+ */
693
699
  dataset_type: string;
694
700
  /** 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.
695
- */
701
+ */
696
702
  format_extra_variables?: string;
697
703
  /** 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
698
- */
704
+ */
699
705
  skip_molecule_load?: boolean;
700
- /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
701
- */
702
- as_filename?: string;
703
- /** 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.
704
- */
705
- dataset_id?: string;
706
706
  /** The Organisational Unit you want the Dataset to belong to
707
- */
707
+ */
708
708
  unit_id: string;
709
709
  };
710
710
 
711
711
  export interface AsAdditionalDataProcessingCharge {
712
+ collateral_cpu_hours?: string;
713
+ collateral_pod_count?: number;
712
714
  cost: string;
713
- cost_to_coins_er: string;
714
715
  cost_scale_factor: string;
716
+ cost_to_coins_er: string;
717
+ error_message?: string;
715
718
  instance_id: string;
716
719
  instance_name: string;
717
- started: string;
718
- stopped?: string;
719
- run_time?: string;
720
- error_message?: string;
721
720
  job_collection?: string;
722
721
  job_job?: string;
723
722
  job_version?: string;
724
- collateral_pod_count?: number;
725
- collateral_cpu_hours?: string;
723
+ run_time?: string;
724
+ started: string;
725
+ stopped?: string;
726
726
  }
727
727
 
728
728
  export interface UserSummary {
729
729
  /** The user's preferred username
730
- */
730
+ */
731
731
  username: string;
732
732
  }
733
733
 
734
734
  export interface UserDetail {
735
- /** The user's preferred username
736
- */
737
- username: string;
735
+ /** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
736
+ */
737
+ become_admin?: boolean;
738
738
  /** The user's filesystem user uid
739
- */
739
+ */
740
740
  f_uid?: number;
741
741
  /** The date and time the user was first seen (an ISO-8601 formatted string in UTC)
742
- */
742
+ */
743
743
  first_seen?: string;
744
+ /** For admin accounts, whether the user is impersonating another user
745
+ */
746
+ impersonate?: string;
744
747
  /** The date the user was last seen
745
- */
748
+ */
746
749
  last_seen_date?: string;
747
750
  /** Set if the user's account is marked as private. Private accounts do not show up against general queries.
748
- */
751
+ */
749
752
  private: boolean;
750
753
  /** True if the account is suspended
751
- */
754
+ */
752
755
  suspended?: boolean;
753
756
  /** If the account is suspended this typically displays a reason for suspension
754
- */
757
+ */
755
758
  suspension_message?: string;
756
- /** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
757
- */
758
- become_admin?: boolean;
759
- /** For admin accounts, whether the user is impersonating another user
760
- */
761
- impersonate?: string;
759
+ /** The user's preferred username
760
+ */
761
+ username: string;
762
762
  }
763
763
 
764
764
  export interface UserAccountDetail {
765
- user: UserDetail;
766
765
  /** Whether the caller has admin privilege */
767
766
  caller_has_admin_privilege: boolean;
768
767
  /** The Data Manager roles the user has */
769
768
  data_manager_roles: string[];
769
+ user: UserDetail;
770
770
  }
771
771
 
772
772
  /**
773
773
  * The Schema type (an object)
774
774
 
775
775
  */
776
- export type TypeSummaryFormatterOptionsType =
777
- (typeof TypeSummaryFormatterOptionsType)[keyof typeof TypeSummaryFormatterOptionsType];
776
+ export type TypeSummaryFormatterOptionsType = typeof TypeSummaryFormatterOptionsType[keyof typeof TypeSummaryFormatterOptionsType];
777
+
778
778
 
779
779
  // eslint-disable-next-line @typescript-eslint/no-redeclare
780
780
  export const TypeSummaryFormatterOptionsType = {
781
- object: "object",
781
+ object: 'object',
782
782
  } as const;
783
783
 
784
784
  /**
@@ -786,111 +786,111 @@ export const TypeSummaryFormatterOptionsType = {
786
786
 
787
787
  */
788
788
  export type TypeSummaryFormatterOptions = {
789
+ /** Required properties
790
+ */
791
+ required: string[];
789
792
  /** The title of the Formatter object
790
- */
793
+ */
791
794
  title: string;
792
795
  /** The Schema type (an object)
793
- */
796
+ */
794
797
  type: TypeSummaryFormatterOptionsType;
795
- /** Required properties
796
- */
797
- required: string[];
798
798
  [key: string]: any;
799
- };
799
+ };
800
800
 
801
801
  export interface TypeSummary {
802
- /** The File Type MIME
803
- */
804
- mime: string;
805
802
  /** The file's supported file extensions. Each type is limited to a limited number of extensions. For example, SDF files must have the extension `.sdf` (or `.sdf.gz`).
806
- */
803
+ */
807
804
  file_extensions: string[];
808
805
  /** The file's type's format-support container image (if set). Types without a format support image cannot be uploaded, but they might be available for use as destination type when a Dataset is added to a Project.
809
- */
806
+ */
810
807
  formatter_image?: string;
811
- /** True if Datasets uploaded using this type's support loading of data into the Data Manager data-base.
812
- */
813
- formatter_supports_db_load?: boolean;
814
808
  /** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
815
- */
809
+ */
816
810
  formatter_options?: TypeSummaryFormatterOptions;
811
+ /** True if Datasets uploaded using this type's support loading of data into the Data Manager data-base.
812
+ */
813
+ formatter_supports_db_load?: boolean;
814
+ /** The File Type MIME
815
+ */
816
+ mime: string;
817
817
  }
818
818
 
819
819
  /**
820
820
  * The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
821
821
 
822
822
  */
823
- export type TaskSummaryProcessingStage =
824
- (typeof TaskSummaryProcessingStage)[keyof typeof TaskSummaryProcessingStage];
823
+ export type TaskSummaryProcessingStage = typeof TaskSummaryProcessingStage[keyof typeof TaskSummaryProcessingStage];
824
+
825
825
 
826
826
  // eslint-disable-next-line @typescript-eslint/no-redeclare
827
827
  export const TaskSummaryProcessingStage = {
828
- COPYING: "COPYING",
829
- FAILED: "FAILED",
830
- FORMATTING: "FORMATTING",
831
- LOADING: "LOADING",
832
- DELETING: "DELETING",
833
- DONE: "DONE",
828
+ COPYING: 'COPYING',
829
+ FAILED: 'FAILED',
830
+ FORMATTING: 'FORMATTING',
831
+ LOADING: 'LOADING',
832
+ DELETING: 'DELETING',
833
+ DONE: 'DONE',
834
834
  } as const;
835
835
 
836
836
  export interface TaskSummary {
837
- /** The Task UUID
838
- */
839
- id: string;
840
- /** If a container image is launched by the task the image name is available here
841
- */
842
- image?: string;
843
837
  /** The date and time the task was created
844
- */
838
+ */
845
839
  created: string;
846
840
  /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
847
- */
841
+ */
848
842
  done: boolean;
849
- /** True if the Task relates to an object removal, i.e. a DELETE
850
- */
851
- removal?: boolean;
852
843
  /** Present when `done` and zero if the task finished successfully.
853
- */
844
+ */
854
845
  exit_code?: number;
846
+ /** The Task UUID
847
+ */
848
+ id: string;
849
+ /** If a container image is launched by the task the image name is available here
850
+ */
851
+ image?: string;
852
+ /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
853
+ */
854
+ processing_stage?: TaskSummaryProcessingStage;
855
855
  /** The purpose for the Task. Tasks are responsible for _uploading_ a Dataset, _attaching_ a Dataset as a File to a project or launching an Applications _instance_.
856
- */
856
+ */
857
857
  purpose: string;
858
858
  /** The related object ID for the Task purpose. If the purpose relates to a **Dataset** upload the ID will be a Dataset ID.
859
- */
859
+ */
860
860
  purpose_id: string;
861
861
  /** The related object version for the Task purpose. This field will only be set if the **purpose** is `DATASET`.
862
- */
862
+ */
863
863
  purpose_version?: number;
864
- /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
865
- */
866
- processing_stage?: TaskSummaryProcessingStage;
864
+ /** True if the Task relates to an object removal, i.e. a DELETE
865
+ */
866
+ removal?: boolean;
867
867
  }
868
868
 
869
869
  /**
870
870
  * The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
871
871
 
872
872
  */
873
- export type TaskStateState =
874
- (typeof TaskStateState)[keyof typeof TaskStateState];
873
+ export type TaskStateState = typeof TaskStateState[keyof typeof TaskStateState];
874
+
875
875
 
876
876
  // eslint-disable-next-line @typescript-eslint/no-redeclare
877
877
  export const TaskStateState = {
878
- PENDING: "PENDING",
879
- STARTED: "STARTED",
880
- RETRY: "RETRY",
881
- SUCCESS: "SUCCESS",
882
- FAILURE: "FAILURE",
878
+ PENDING: 'PENDING',
879
+ STARTED: 'STARTED',
880
+ RETRY: 'RETRY',
881
+ SUCCESS: 'SUCCESS',
882
+ FAILURE: 'FAILURE',
883
883
  } as const;
884
884
 
885
885
  export interface TaskState {
886
- /** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
887
- */
888
- state: TaskStateState;
889
886
  /** A short message accompanying the state, generally only found when the state is `FAILURE`
890
- */
887
+ */
891
888
  message?: string;
889
+ /** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
890
+ */
891
+ state: TaskStateState;
892
892
  /** The date and time of the state change
893
- */
893
+ */
894
894
  time: string;
895
895
  }
896
896
 
@@ -902,118 +902,118 @@ export interface TaskIdentity {
902
902
  * The level of the message, a typical logging framework value
903
903
 
904
904
  */
905
- export type TaskEventLevel =
906
- (typeof TaskEventLevel)[keyof typeof TaskEventLevel];
905
+ export type TaskEventLevel = typeof TaskEventLevel[keyof typeof TaskEventLevel];
906
+
907
907
 
908
908
  // eslint-disable-next-line @typescript-eslint/no-redeclare
909
909
  export const TaskEventLevel = {
910
- CRITICAL: "CRITICAL",
911
- ERROR: "ERROR",
912
- WARNING: "WARNING",
913
- INFO: "INFO",
914
- DEBUG: "DEBUG",
910
+ CRITICAL: 'CRITICAL',
911
+ ERROR: 'ERROR',
912
+ WARNING: 'WARNING',
913
+ INFO: 'INFO',
914
+ DEBUG: 'DEBUG',
915
915
  } as const;
916
916
 
917
917
  export interface TaskEvent {
918
- /** The event sequence number. The first event is always '1'.
919
- */
920
- ordinal: number;
921
- /** A short message.
922
- */
923
- message: string;
924
918
  /** The level of the message, a typical logging framework value
925
- */
919
+ */
926
920
  level: TaskEventLevel;
921
+ /** A short message.
922
+ */
923
+ message: string;
924
+ /** The event sequence number. The first event is always '1'.
925
+ */
926
+ ordinal: number;
927
927
  /** The date and time the event was generated
928
- */
928
+ */
929
929
  time: string;
930
930
  }
931
931
 
932
- export type ServiceErrorSummarySeverity =
933
- (typeof ServiceErrorSummarySeverity)[keyof typeof ServiceErrorSummarySeverity];
932
+ export type ServiceErrorSummarySeverity = typeof ServiceErrorSummarySeverity[keyof typeof ServiceErrorSummarySeverity];
933
+
934
934
 
935
935
  // eslint-disable-next-line @typescript-eslint/no-redeclare
936
936
  export const ServiceErrorSummarySeverity = {
937
- CRITICAL: "CRITICAL",
938
- ERROR: "ERROR",
939
- WARNING: "WARNING",
937
+ CRITICAL: 'CRITICAL',
938
+ ERROR: 'ERROR',
939
+ WARNING: 'WARNING',
940
940
  } as const;
941
941
 
942
942
  export interface ServiceErrorSummary {
943
- id: number;
944
- created: string;
945
- summary: string;
946
- severity: ServiceErrorSummarySeverity;
947
- hostname: string;
948
- error_code?: number;
949
- stack_trace: string;
950
943
  acknowledged: boolean;
951
944
  acknowledged_at?: string;
952
945
  acknowledging_user?: string;
946
+ created: string;
947
+ error_code?: number;
948
+ hostname: string;
949
+ id: number;
950
+ severity: ServiceErrorSummarySeverity;
951
+ stack_trace: string;
952
+ summary: string;
953
953
  }
954
954
 
955
955
  export interface ProjectFileDetail {
956
956
  /** The code obtained from the Account Server
957
- */
957
+ */
958
958
  authorisation_code?: number;
959
959
  /** The ProjectFile's Dataset origin
960
- */
960
+ */
961
961
  dataset_id?: string;
962
962
  /** The ProjectFile's Dataset origin version
963
- */
963
+ */
964
964
  dataset_version?: number;
965
965
  /** The ProjectFile's unique ID
966
- */
966
+ */
967
967
  file_id: string;
968
968
  /** The ProjectFile's filename within the Project
969
- */
969
+ */
970
970
  file_name: string;
971
971
  /** The ProjectFile's path within the Project volume
972
- */
972
+ */
973
973
  file_path: string;
974
974
  /** True if the ProjectFile cannot be modified while in the Project
975
- */
975
+ */
976
976
  immutable: boolean;
977
+ /** The ProjectFile MIME type
978
+ */
979
+ mime_type: string;
977
980
  /** The owner of the ProjectFile. This is the user that added the Dataset (as this file) to the Project
978
- */
981
+ */
979
982
  owner: string;
980
983
  /** The Project the ProjectFile belongs to
981
- */
984
+ */
982
985
  project_id?: string;
983
- /** The ProjectFile MIME type
984
- */
985
- mime_type: string;
986
986
  }
987
987
 
988
988
  export interface ProjectDetail {
989
+ created: string;
990
+ /** An editor (user_id) of the project */
991
+ editors: string[];
992
+ /** A list of managed files in the Project
993
+ */
994
+ files?: ProjectFileDetail[];
989
995
  /** The project name
990
- */
996
+ */
991
997
  name: string;
992
- /** The project unique reference
993
- */
994
- project_id: string;
995
- created: string;
996
- /** The Account Server Product the Project belongs to
997
- */
998
- product_id?: string;
999
- /** The Account Server Unit the Project Product belongs to
1000
- */
1001
- unit_id?: string;
998
+ /** An observer (user_id) of the project */
999
+ observers: string[];
1002
1000
  /** The project (owner) creator
1003
- */
1001
+ */
1004
1002
  owner: string;
1005
1003
  /** True if the project is private. Private projects are only visible to the owner and its editors.
1006
- */
1004
+ */
1007
1005
  private: boolean;
1008
- /** An editor (user_id) of the project */
1009
- editors: string[];
1010
- /** An observer (user_id) of the project */
1011
- observers: string[];
1006
+ /** The Account Server Product the Project belongs to
1007
+ */
1008
+ product_id?: string;
1009
+ /** The project unique reference
1010
+ */
1011
+ project_id: string;
1012
1012
  /** The approximate size of all the files in the Project volume. This is updated regularly throughout the day and its current size may differ from what is reported here. The smallest billable unit is 1GiB (1,073,741,824 bytes). Therefore a project that contains 32KiB of files is recorded as 1GiB in size */
1013
1013
  size: number;
1014
- /** A list of managed files in the Project
1015
- */
1016
- files?: ProjectFileDetail[];
1014
+ /** The Account Server Unit the Project Product belongs to
1015
+ */
1016
+ unit_id?: string;
1017
1017
  }
1018
1018
 
1019
1019
  export interface JobReplacement {
@@ -1032,16 +1032,16 @@ export interface JobOrderDetail {
1032
1032
  }
1033
1033
 
1034
1034
  /**
1035
- * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1035
+ * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1036
1036
 
1037
1037
  */
1038
- export type JobVariablesOptions = { [key: string]: any };
1038
+ export type JobVariablesOutputs = { [key: string]: any };
1039
1039
 
1040
1040
  /**
1041
- * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1041
+ * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1042
1042
 
1043
1043
  */
1044
- export type JobVariablesOutputs = { [key: string]: any };
1044
+ export type JobVariablesOptions = { [key: string]: any };
1045
1045
 
1046
1046
  /**
1047
1047
  * The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
@@ -1050,112 +1050,112 @@ export type JobVariablesOutputs = { [key: string]: any };
1050
1050
  export type JobVariablesInputs = { [key: string]: any };
1051
1051
 
1052
1052
  export interface JobVariables {
1053
- /** The Job command's variable ordering declaration. Contains a list of `options` in an ordered list, the order defines the order of presentation of the Job's variables.
1054
- */
1055
- order?: JobOrderDetail;
1056
1053
  /** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
1057
- */
1054
+ */
1058
1055
  inputs?: JobVariablesInputs;
1059
- /** The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1060
- */
1061
- outputs?: JobVariablesOutputs;
1062
1056
  /** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1063
- */
1057
+ */
1064
1058
  options?: JobVariablesOptions;
1059
+ /** The Job command's variable ordering declaration. Contains a list of `options` in an ordered list, the order defines the order of presentation of the Job's variables.
1060
+ */
1061
+ order?: JobOrderDetail;
1062
+ /** The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1063
+ */
1064
+ outputs?: JobVariablesOutputs;
1065
1065
  }
1066
1066
 
1067
1067
  /**
1068
1068
  * 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)
1069
1069
 
1070
1070
  */
1071
- export type JobSummaryImageType =
1072
- (typeof JobSummaryImageType)[keyof typeof JobSummaryImageType];
1071
+ export type JobSummaryImageType = typeof JobSummaryImageType[keyof typeof JobSummaryImageType];
1072
+
1073
1073
 
1074
1074
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1075
1075
  export const JobSummaryImageType = {
1076
- SIMPLE: "SIMPLE",
1077
- NEXTFLOW: "NEXTFLOW",
1076
+ SIMPLE: 'SIMPLE',
1077
+ NEXTFLOW: 'NEXTFLOW',
1078
1078
  } as const;
1079
1079
 
1080
1080
  export interface JobSummary {
1081
- /** The Job's unique ID
1082
- */
1083
- id: number;
1084
- /** The Job namespace
1085
- */
1086
- collection: string;
1087
- /** The Job name, unique within a given namespace
1088
- */
1089
- job: string;
1090
- /** The Job version
1091
- */
1092
- version: string;
1093
- /** 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)
1094
- */
1095
- image_type: JobSummaryImageType;
1096
1081
  /** The Job's category
1097
- */
1082
+ */
1098
1083
  category?: string;
1099
- /** The list of keywords assigned to the Job
1100
- */
1101
- keywords?: string[];
1102
- /** The name of the job in English
1103
- */
1104
- name: string;
1084
+ /** The Job namespace
1085
+ */
1086
+ collection: string;
1105
1087
  /** The description of the job in English
1106
- */
1088
+ */
1107
1089
  description?: string;
1108
- /** A URL linking to the Job documentation
1109
- */
1110
- doc_url?: string;
1111
- /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1112
- */
1113
- required_assets: string[];
1114
- /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
1115
- */
1116
- missing_assets?: string[];
1117
1090
  /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1118
- */
1091
+ */
1119
1092
  disabled: boolean;
1120
1093
  /** A reason why the Job has been disabled.
1121
- */
1094
+ */
1122
1095
  disabled_reason?: string;
1123
1096
  /** A suggested remedy that accompanies the "disabled_reason". This provides the client with advice on how to avoid the reason that the Job's been disabled, for reasons that can be avoided (not all are).
1124
1097
 
1125
1098
  Where there is no remedy for a given reason the remedy will be "There is no remedy".
1126
1099
  */
1127
1100
  disabled_remedy?: string;
1128
- replaces?: JobReplacements;
1101
+ /** A URL linking to the Job documentation
1102
+ */
1103
+ doc_url?: string;
1104
+ /** The Job's unique ID
1105
+ */
1106
+ id: number;
1107
+ /** 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)
1108
+ */
1109
+ image_type: JobSummaryImageType;
1110
+ /** The Job name, unique within a given namespace
1111
+ */
1112
+ job: string;
1113
+ /** The list of keywords assigned to the Job
1114
+ */
1115
+ keywords?: string[];
1116
+ /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
1117
+ */
1118
+ missing_assets?: string[];
1119
+ /** The name of the job in English
1120
+ */
1121
+ name: string;
1129
1122
  replaced_by?: JobReplacements;
1123
+ replaces?: JobReplacements;
1124
+ /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1125
+ */
1126
+ required_assets: string[];
1127
+ /** The Job version
1128
+ */
1129
+ version: string;
1130
1130
  }
1131
1131
 
1132
1132
  export interface JobManifestDetail {
1133
- /** The Job Manifest record ID */
1134
- id: number;
1135
- url: string;
1136
- header?: string;
1137
- params?: string;
1138
1133
  /** The Date (and time) the manifest was created
1139
- */
1134
+ */
1140
1135
  created: string;
1141
1136
  /** The (admin) user who created the manifest
1142
- */
1137
+ */
1143
1138
  creator?: string;
1139
+ header?: string;
1140
+ /** The Job Manifest record ID */
1141
+ id: number;
1144
1142
  /** The number of job definition files loaded during the most recent successful load
1145
- */
1143
+ */
1146
1144
  job_definition_files_loaded?: number;
1147
1145
  /** The number of job definitions loaded during the most recent successful load
1148
- */
1146
+ */
1149
1147
  job_definitions_loaded?: number;
1150
- /** The Date (and time) the manifest was last loaded successfully
1151
- */
1152
- last_successful_load_time?: string;
1153
- /** 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
1154
- */
1155
- last_load_time?: string;
1156
1148
  /** 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`
1157
- */
1149
+ */
1158
1150
  last_load_status: string;
1151
+ /** 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
1152
+ */
1153
+ last_load_time?: string;
1154
+ /** The Date (and time) the manifest was last loaded successfully
1155
+ */
1156
+ last_successful_load_time?: string;
1157
+ params?: string;
1158
+ url: string;
1159
1159
  }
1160
1160
 
1161
1161
  export interface JobApplication {
@@ -1166,172 +1166,172 @@ export interface JobApplication {
1166
1166
  }
1167
1167
 
1168
1168
  /**
1169
- * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1169
+ * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1170
+ The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1170
1171
 
1171
1172
  */
1172
- export type InstanceSummaryJobImageType =
1173
- (typeof InstanceSummaryJobImageType)[keyof typeof InstanceSummaryJobImageType];
1173
+ export type InstanceSummaryPhase = typeof InstanceSummaryPhase[keyof typeof InstanceSummaryPhase];
1174
+
1174
1175
 
1175
1176
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1176
- export const InstanceSummaryJobImageType = {
1177
- SIMPLE: "SIMPLE",
1178
- NEXTFLOW: "NEXTFLOW",
1177
+ export const InstanceSummaryPhase = {
1178
+ COMPLETED: 'COMPLETED',
1179
+ CRASH_LOOP_BACKOFF: 'CRASH_LOOP_BACKOFF',
1180
+ FAILED: 'FAILED',
1181
+ IMAGE_PULL_BACKOFF: 'IMAGE_PULL_BACKOFF',
1182
+ PENDING: 'PENDING',
1183
+ RUNNING: 'RUNNING',
1184
+ SUCCEEDED: 'SUCCEEDED',
1185
+ UNKNOWN: 'UNKNOWN',
1179
1186
  } as const;
1180
1187
 
1181
1188
  /**
1182
- * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1183
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1189
+ * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1184
1190
 
1185
1191
  */
1186
- export type InstanceSummaryPhase =
1187
- (typeof InstanceSummaryPhase)[keyof typeof InstanceSummaryPhase];
1192
+ export type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
1193
+
1188
1194
 
1189
1195
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1190
- export const InstanceSummaryPhase = {
1191
- COMPLETED: "COMPLETED",
1192
- CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF",
1193
- FAILED: "FAILED",
1194
- IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF",
1195
- PENDING: "PENDING",
1196
- RUNNING: "RUNNING",
1197
- SUCCEEDED: "SUCCEEDED",
1198
- UNKNOWN: "UNKNOWN",
1196
+ export const InstanceSummaryJobImageType = {
1197
+ SIMPLE: 'SIMPLE',
1198
+ NEXTFLOW: 'NEXTFLOW',
1199
1199
  } as const;
1200
1200
 
1201
1201
  /**
1202
1202
  * The type of Application, which can be a `job` or an `application`
1203
1203
 
1204
1204
  */
1205
- export type InstanceSummaryApplicationType =
1206
- (typeof InstanceSummaryApplicationType)[keyof typeof InstanceSummaryApplicationType];
1205
+ export type InstanceSummaryApplicationType = typeof InstanceSummaryApplicationType[keyof typeof InstanceSummaryApplicationType];
1206
+
1207
1207
 
1208
1208
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1209
1209
  export const InstanceSummaryApplicationType = {
1210
- APPLICATION: "APPLICATION",
1211
- JOB: "JOB",
1210
+ APPLICATION: 'APPLICATION',
1211
+ JOB: 'JOB',
1212
1212
  } as const;
1213
1213
 
1214
1214
  export interface InstanceSummary {
1215
- /** The application instance ID
1216
- */
1217
- id: string;
1218
- /** True if the instance is archived (protected from automatic deletion)
1219
- */
1220
- archived: boolean;
1221
1215
  /** The application ID
1222
- */
1216
+ */
1223
1217
  application_id: string;
1224
- /** The application version
1225
- */
1226
- application_version: string;
1227
1218
  /** The User's specification, provided when the application was launched
1228
- */
1219
+ */
1229
1220
  application_specification?: string;
1230
1221
  /** The type of Application, which can be a `job` or an `application`
1231
- */
1222
+ */
1232
1223
  application_type: InstanceSummaryApplicationType;
1224
+ /** The application version
1225
+ */
1226
+ application_version: string;
1227
+ /** True if the instance is archived (protected from automatic deletion)
1228
+ */
1229
+ archived: boolean;
1233
1230
  /** The code obtained from the Account Server
1234
- */
1231
+ */
1235
1232
  authorisation_code?: number;
1236
- /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1237
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1233
+ /** The current running coin cost of the instance.
1238
1234
  */
1239
- phase: InstanceSummaryPhase;
1240
- /** The data and time (UTC) the instance was launched
1241
- */
1242
- launched: string;
1243
- /** The data and time (UTC) the instance started running
1244
- */
1245
- started?: string;
1246
- /** The data and time (UTC) the instance stopped running
1247
- */
1248
- stopped?: string;
1249
- /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta`` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
1250
- */
1251
- run_time: string;
1252
- /** The application instance owner, the person who launched the application and is the only user than can stop it.
1253
- */
1254
- owner: string;
1255
- /** The Project the instances is running in.
1256
- */
1257
- project_id: string;
1258
- /** The Instance name
1259
- */
1260
- name: string;
1261
- /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
1262
- */
1263
- url?: string;
1235
+ coins?: string;
1236
+ /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1237
+ */
1238
+ fix_permissions?: boolean;
1239
+ /** The application instance ID
1240
+ */
1241
+ id: string;
1264
1242
  /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1265
- */
1243
+ */
1266
1244
  job_collection?: string;
1245
+ /** The Job definition's unique ID
1246
+ */
1247
+ job_id?: number;
1248
+ /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1249
+ */
1250
+ job_image_type?: InstanceSummaryJobImageType;
1267
1251
  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
1268
- */
1252
+ */
1269
1253
  job_job?: string;
1270
1254
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1271
- */
1255
+ */
1272
1256
  job_name?: string;
1273
- /** The Job definition's unique ID
1274
- */
1275
- job_id?: number;
1276
1257
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1277
- */
1258
+ */
1278
1259
  job_version?: string;
1279
- /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1280
- */
1281
- job_image_type?: InstanceSummaryJobImageType;
1260
+ /** The data and time (UTC) the instance was launched
1261
+ */
1262
+ launched: string;
1263
+ /** The Instance name
1264
+ */
1265
+ name: string;
1282
1266
  /** The instance's known outputs, a JSON string defining a map of all the outputs. Typically applied only to JOB application types
1283
- */
1267
+ */
1284
1268
  outputs?: string;
1285
- /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1286
- */
1287
- fix_permissions?: boolean;
1288
- /** The current running coin cost of the instance.
1289
- */
1290
- coins?: string;
1269
+ /** The application instance owner, the person who launched the application and is the only user than can stop it.
1270
+ */
1271
+ owner: string;
1272
+ /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1273
+ The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1274
+ */
1275
+ phase: InstanceSummaryPhase;
1276
+ /** The Project the instances is running in.
1277
+ */
1278
+ project_id: string;
1279
+ /** The time the instance has spent running in the cluster. It's a string representation of a Python `timedelta`` object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
1280
+ */
1281
+ run_time: string;
1282
+ /** The data and time (UTC) the instance started running
1283
+ */
1284
+ started?: string;
1285
+ /** The data and time (UTC) the instance stopped running
1286
+ */
1287
+ stopped?: string;
1288
+ /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
1289
+ */
1290
+ url?: string;
1291
1291
  }
1292
1292
 
1293
1293
  export interface FileStat {
1294
- /** The size of the file in bytes
1295
- */
1296
- size: number;
1297
1294
  /** The date and time (UTC) of the last modification
1298
- */
1295
+ */
1299
1296
  modified: string;
1297
+ /** The size of the file in bytes
1298
+ */
1299
+ size: number;
1300
1300
  }
1301
1301
 
1302
1302
  export interface FilePathFile {
1303
+ /** The code obtained from the Account Server
1304
+ */
1305
+ authorisation_code?: number;
1303
1306
  /** The file's Dataset ID (if the file belongs to a Dataset)
1304
- */
1307
+ */
1305
1308
  dataset_id?: string;
1306
1309
  /** The file's Dataset version (if the file belongs to a Dataset)
1307
- */
1310
+ */
1308
1311
  dataset_version?: number;
1309
- /** The file name
1310
- */
1311
- file_name: string;
1312
1312
  /** The ID of the file (if the file belongs to a Dataset)
1313
- */
1313
+ */
1314
1314
  file_id?: string;
1315
+ /** The file name
1316
+ */
1317
+ file_name: string;
1315
1318
  /** Whether the file is immutable (read-only)
1316
- */
1319
+ */
1317
1320
  immutable?: boolean;
1318
1321
  /** The file's MIME type
1319
- */
1322
+ */
1320
1323
  mime_type?: string;
1321
1324
  /** The file's owner
1322
- */
1325
+ */
1323
1326
  owner: string;
1324
- /** The code obtained from the Account Server
1325
- */
1326
- authorisation_code?: number;
1327
1327
  stat: FileStat;
1328
1328
  }
1329
1329
 
1330
1330
  export interface JobExchangeRateSummary {
1331
- id: number;
1332
- rate?: string;
1333
1331
  collection: string;
1332
+ id: number;
1334
1333
  job: string;
1334
+ rate?: string;
1335
1335
  version: string;
1336
1336
  }
1337
1337
 
@@ -1341,209 +1341,209 @@ export interface ApplicationExchangeRateSummary {
1341
1341
  }
1342
1342
 
1343
1343
  export interface ExchangeRateDetail {
1344
+ comment?: string;
1345
+ created: string;
1344
1346
  id: number;
1345
1347
  rate: string;
1346
- created: string;
1347
1348
  user_id: string;
1348
- comment?: string;
1349
1349
  }
1350
1350
 
1351
- /**
1352
- * The dictionary of label/value pairs
1353
-
1354
- */
1355
- export type DatasetVersionSummaryLabels = { [key: string]: any };
1356
-
1357
1351
  /**
1358
1352
  * The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1359
1353
 
1360
1354
  */
1361
- export type DatasetVersionSummaryProcessingStage =
1362
- (typeof DatasetVersionSummaryProcessingStage)[keyof typeof DatasetVersionSummaryProcessingStage];
1355
+ export type DatasetVersionSummaryProcessingStage = typeof DatasetVersionSummaryProcessingStage[keyof typeof DatasetVersionSummaryProcessingStage];
1356
+
1363
1357
 
1364
1358
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1365
1359
  export const DatasetVersionSummaryProcessingStage = {
1366
- COPYING: "COPYING",
1367
- FAILED: "FAILED",
1368
- FORMATTING: "FORMATTING",
1369
- LOADING: "LOADING",
1370
- DELETING: "DELETING",
1371
- DONE: "DONE",
1360
+ COPYING: 'COPYING',
1361
+ FAILED: 'FAILED',
1362
+ FORMATTING: 'FORMATTING',
1363
+ LOADING: 'LOADING',
1364
+ DELETING: 'DELETING',
1365
+ DONE: 'DONE',
1372
1366
  } as const;
1373
1367
 
1368
+ /**
1369
+ * The dictionary of label/value pairs
1370
+
1371
+ */
1372
+ export type DatasetVersionSummaryLabels = { [key: string]: any };
1373
+
1374
1374
  export interface DatasetVersionSummary {
1375
- /** The owner of the Dataset version
1376
- */
1377
- owner?: string;
1378
- /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1379
- */
1380
- source_ref: string;
1381
- /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1382
- */
1383
- published: string;
1384
- /** The Dataset MIME type
1385
- */
1386
- type: string;
1387
- /** The filename of the Dataset
1388
- */
1389
- file_name: string;
1390
- /** The list of Project's the Dataset is attached to
1391
- */
1392
- projects: string[];
1393
- /** Any extra variables passed in during the upload and handed to the format-support container.
1394
- */
1395
- format_extra_variables?: string;
1396
- /** The version of the dataset
1397
- */
1398
- version: number;
1375
+ /** The code obtained from the Account Server
1376
+ */
1377
+ authorisation_code?: number;
1399
1378
  /** The name of the Pod handling the creation of the Dataset
1400
- */
1379
+ */
1401
1380
  creator_pod_name?: string;
1402
- /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1403
- */
1404
- processing_stage: DatasetVersionSummaryProcessingStage;
1405
1381
  /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1406
- */
1382
+ */
1407
1383
  deleted?: string;
1408
1384
  /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1409
- */
1385
+ */
1410
1386
  deleting_user?: string;
1387
+ /** The filename of the Dataset
1388
+ */
1389
+ file_name: string;
1390
+ /** Any extra variables passed in during the upload and handed to the format-support container.
1391
+ */
1392
+ format_extra_variables?: string;
1411
1393
  /** The dictionary of label/value pairs
1412
- */
1394
+ */
1413
1395
  labels?: DatasetVersionSummaryLabels;
1396
+ /** The owner of the Dataset version
1397
+ */
1398
+ owner?: string;
1399
+ /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1400
+ */
1401
+ processing_stage: DatasetVersionSummaryProcessingStage;
1402
+ /** The list of Project's the Dataset is attached to
1403
+ */
1404
+ projects: string[];
1405
+ /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1406
+ */
1407
+ published: string;
1414
1408
  /** The size, in bytes, of the formatted Dataset
1415
- */
1409
+ */
1416
1410
  size?: number;
1417
- /** The code obtained from the Account Server
1418
- */
1419
- authorisation_code?: number;
1411
+ /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1412
+ */
1413
+ source_ref: string;
1414
+ /** The Dataset MIME type
1415
+ */
1416
+ type: string;
1417
+ /** The version of the dataset
1418
+ */
1419
+ version: number;
1420
1420
  }
1421
1421
 
1422
1422
  export interface DatasetVersionProjectFile {
1423
- project_name: string;
1424
- project: string;
1425
1423
  files: string[];
1424
+ project: string;
1425
+ project_name: string;
1426
1426
  }
1427
1427
 
1428
- /**
1429
- * The dictionary of label/value pairs
1430
-
1431
- */
1432
- export type DatasetVersionDetailLabels = { [key: string]: any };
1433
-
1434
1428
  /**
1435
1429
  * The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1436
1430
 
1437
1431
  */
1438
- export type DatasetVersionDetailProcessingStage =
1439
- (typeof DatasetVersionDetailProcessingStage)[keyof typeof DatasetVersionDetailProcessingStage];
1432
+ export type DatasetVersionDetailProcessingStage = typeof DatasetVersionDetailProcessingStage[keyof typeof DatasetVersionDetailProcessingStage];
1433
+
1440
1434
 
1441
1435
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1442
1436
  export const DatasetVersionDetailProcessingStage = {
1443
- COPYING: "COPYING",
1444
- FAILED: "FAILED",
1445
- FORMATTING: "FORMATTING",
1446
- LOADING: "LOADING",
1447
- DELETING: "DELETING",
1448
- DONE: "DONE",
1437
+ COPYING: 'COPYING',
1438
+ FAILED: 'FAILED',
1439
+ FORMATTING: 'FORMATTING',
1440
+ LOADING: 'LOADING',
1441
+ DELETING: 'DELETING',
1442
+ DONE: 'DONE',
1449
1443
  } as const;
1450
1444
 
1445
+ /**
1446
+ * The dictionary of label/value pairs
1447
+
1448
+ */
1449
+ export type DatasetVersionDetailLabels = { [key: string]: any };
1450
+
1451
1451
  export interface DatasetVersionDetail {
1452
- /** The owner of the Dataset version
1453
- */
1454
- owner: string;
1455
- /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1456
- */
1457
- source_ref: string;
1458
- /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1459
- */
1460
- published: string;
1461
- /** The Dataset MIME type
1462
- */
1463
- type: string;
1464
- /** The filename of the Dataset
1465
- */
1466
- file_name: string;
1467
- /** The list of
1468
- */
1469
- project_files: DatasetVersionProjectFile[];
1470
- /** The list of Project's the Dataset is attached to
1471
- */
1472
- projects: string[];
1473
- /** Any extra variables passed in during the upload and handed to the format-support container.
1474
- */
1475
- format_extra_variables?: string;
1476
- /** The version of the dataset
1477
- */
1478
- version: number;
1452
+ /** The code obtained from the Account Server
1453
+ */
1454
+ authorisation_code?: number;
1479
1455
  /** The name of the Pod handling the creation of the Dataset
1480
- */
1456
+ */
1481
1457
  creator_pod_name?: string;
1482
- /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1483
- */
1484
- processing_stage: DatasetVersionDetailProcessingStage;
1485
1458
  /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1486
- */
1459
+ */
1487
1460
  deleted?: string;
1488
1461
  /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1489
- */
1462
+ */
1490
1463
  deleting_user?: string;
1464
+ /** The filename of the Dataset
1465
+ */
1466
+ file_name: string;
1467
+ /** Any extra variables passed in during the upload and handed to the format-support container.
1468
+ */
1469
+ format_extra_variables?: string;
1491
1470
  /** The dictionary of label/value pairs
1492
- */
1471
+ */
1493
1472
  labels?: DatasetVersionDetailLabels;
1473
+ /** The owner of the Dataset version
1474
+ */
1475
+ owner: string;
1476
+ /** The processing stage. When loading a Dataset it typically passes through `COPYING`, `FORMATTING` and `LOADING` stages before reaching `DONE` (or `FAILED`). A Dataset can be used (and deleted) as long as it's passed the `FORMATTING` stage
1477
+ */
1478
+ processing_stage: DatasetVersionDetailProcessingStage;
1479
+ /** The list of
1480
+ */
1481
+ project_files: DatasetVersionProjectFile[];
1482
+ /** The list of Project's the Dataset is attached to
1483
+ */
1484
+ projects: string[];
1485
+ /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1486
+ */
1487
+ published: string;
1494
1488
  /** The size, in bytes, of the formatted Dataset
1495
- */
1489
+ */
1496
1490
  size?: number;
1497
- /** The code obtained from the Account Server
1498
- */
1499
- authorisation_code?: number;
1491
+ /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1492
+ */
1493
+ source_ref: string;
1494
+ /** The Dataset MIME type
1495
+ */
1496
+ type: string;
1497
+ /** The version of the dataset
1498
+ */
1499
+ version: number;
1500
1500
  }
1501
1501
 
1502
1502
  export interface DatasetSummary {
1503
1503
  /** The Dataset ID
1504
- */
1504
+ */
1505
1505
  dataset_id: string;
1506
1506
  /** The list of editors
1507
- */
1507
+ */
1508
1508
  editors: string[];
1509
1509
  /** The set of separate versions of the Dataset
1510
- */
1510
+ */
1511
1511
  versions: DatasetVersionSummary[];
1512
1512
  }
1513
1513
 
1514
1514
  export interface DatasetDetail {
1515
1515
  /** The Dataset ID
1516
- */
1516
+ */
1517
1517
  dataset_id: string;
1518
1518
  /** The list of editors
1519
- */
1519
+ */
1520
1520
  editors: string[];
1521
1521
  /** The owner of the Dataset
1522
- */
1522
+ */
1523
1523
  owner: string;
1524
1524
  /** The set of separate versions of the Dataset
1525
- */
1525
+ */
1526
1526
  versions: DatasetVersionDetail[];
1527
1527
  }
1528
1528
 
1529
1529
  export interface ApplicationSummary {
1530
- /** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
1531
- */
1532
- kind: string;
1533
- /** The application group
1534
- */
1535
- group?: string;
1536
1530
  /** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
1537
- */
1531
+ */
1538
1532
  application_id: string;
1533
+ /** The application group
1534
+ */
1535
+ group?: string;
1536
+ /** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
1537
+ */
1538
+ kind: string;
1539
1539
  /** The application's latest version as declared in The **Custom Resource Definition**
1540
- */
1540
+ */
1541
1541
  latest_version: string;
1542
1542
  }
1543
1543
 
1544
1544
  export interface ApplicationImageVariant {
1545
- name: string;
1546
1545
  image: string;
1546
+ name: string;
1547
1547
  }
1548
1548
 
1549
1549
  export interface ApplicationImageVariants {
@@ -1554,65 +1554,65 @@ export interface ApplicationImageVariants {
1554
1554
  * The REST method used. GET methods are not logged
1555
1555
 
1556
1556
  */
1557
- export type ApiLogDetailMethod =
1558
- (typeof ApiLogDetailMethod)[keyof typeof ApiLogDetailMethod];
1557
+ export type ApiLogDetailMethod = typeof ApiLogDetailMethod[keyof typeof ApiLogDetailMethod];
1558
+
1559
1559
 
1560
1560
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1561
1561
  export const ApiLogDetailMethod = {
1562
- DELETE: "DELETE",
1563
- PATCH: "PATCH",
1564
- POST: "POST",
1565
- PUT: "PUT",
1562
+ DELETE: 'DELETE',
1563
+ PATCH: 'PATCH',
1564
+ POST: 'POST',
1565
+ PUT: 'PUT',
1566
1566
  } as const;
1567
1567
 
1568
1568
  export interface ApiLogDetail {
1569
- /** The REST method used. GET methods are not logged
1570
- */
1571
- method: ApiLogDetailMethod;
1572
- /** The API path used, e.g. `/dataset`
1573
- */
1574
- path: string;
1575
1569
  /** The date/time the API call began
1576
- */
1570
+ */
1577
1571
  began: string;
1578
- /** The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400
1579
- */
1580
- duration_ns?: string;
1581
- /** The HTTP response status code
1582
- */
1583
- status_code?: number;
1584
- /** A JSON string representing the in-query properties used in the call
1585
- */
1586
- params?: string;
1587
1572
  /** A JSON string representing the in-body properties used in the call
1588
- */
1573
+ */
1589
1574
  body?: string;
1575
+ /** The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400
1576
+ */
1577
+ duration_ns?: string;
1590
1578
  /** Not all API calls using your user ID may have been executed by you, In cases where an administrator has executed a REST API call on your behalf, their user ID will be revealed using this property
1591
- */
1579
+ */
1592
1580
  impersonator?: string;
1581
+ /** The REST method used. GET methods are not logged
1582
+ */
1583
+ method: ApiLogDetailMethod;
1584
+ /** A JSON string representing the in-query properties used in the call
1585
+ */
1586
+ params?: string;
1587
+ /** The API path used, e.g. `/dataset`
1588
+ */
1589
+ path: string;
1590
+ /** The HTTP response status code
1591
+ */
1592
+ status_code?: number;
1593
1593
  }
1594
1594
 
1595
1595
  export interface ModeGetResponse {
1596
1596
  /** The Data Manager mode. The mode determines what features are available through the API. There are two modes, DEVELOPMENT, and PRODUCTION. In DEVELOPMENT mode some destructive operation are permitted (for example the removal of Job Definitions)
1597
- */
1597
+ */
1598
1598
  mode: string;
1599
1599
  }
1600
1600
 
1601
1601
  export interface VersionGetResponse {
1602
1602
  /** The Data Manager version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
1603
- */
1603
+ */
1604
1604
  version: string;
1605
1605
  }
1606
1606
 
1607
1607
  export interface UsersGetResponse {
1608
1608
  /** A list of Users that have used the Data Manager
1609
- */
1609
+ */
1610
1610
  users: UserSummary[];
1611
1611
  }
1612
1612
 
1613
1613
  export interface UserApiLogGetResponse {
1614
1614
  /** A list of API loc call records, with the oldest record first in the list
1615
- */
1615
+ */
1616
1616
  api_log: ApiLogDetail[];
1617
1617
  }
1618
1618
 
@@ -1620,13 +1620,13 @@ export type UserAccountGetResponse = UserAccountDetail;
1620
1620
 
1621
1621
  export interface TypesGetResponse {
1622
1622
  /** A list of available MIME types
1623
- */
1623
+ */
1624
1624
  types: TypeSummary[];
1625
1625
  }
1626
1626
 
1627
1627
  export interface TasksGetResponse {
1628
1628
  /** A list of Tasks
1629
- */
1629
+ */
1630
1630
  tasks: TaskSummary[];
1631
1631
  }
1632
1632
 
@@ -1634,56 +1634,56 @@ export interface TasksGetResponse {
1634
1634
  * The purpose of the task. Tasks are typically executed for the purpose of Dataset processing, attaching as Project Files or Application Instance execution. Other fields in this object are only valid if the purpose is known (i.e. is not `UNKNOWN`)
1635
1635
 
1636
1636
  */
1637
- export type TaskGetResponsePurpose =
1638
- (typeof TaskGetResponsePurpose)[keyof typeof TaskGetResponsePurpose];
1637
+ export type TaskGetResponsePurpose = typeof TaskGetResponsePurpose[keyof typeof TaskGetResponsePurpose];
1638
+
1639
1639
 
1640
1640
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1641
1641
  export const TaskGetResponsePurpose = {
1642
- DATASET: "DATASET",
1643
- FILE: "FILE",
1644
- INSTANCE: "INSTANCE",
1645
- PROJECT: "PROJECT",
1642
+ DATASET: 'DATASET',
1643
+ FILE: 'FILE',
1644
+ INSTANCE: 'INSTANCE',
1645
+ PROJECT: 'PROJECT',
1646
1646
  } as const;
1647
1647
 
1648
1648
  export interface TaskGetResponse {
1649
+ /** The date and time the task was created
1650
+ */
1651
+ created: string;
1652
+ /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
1653
+ */
1654
+ done: boolean;
1655
+ /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
1656
+ */
1657
+ events?: TaskEvent[];
1658
+ /** Present when `done` and zero if the task finished successfully.
1659
+ */
1660
+ exit_code?: number;
1661
+ /** If a container image is launched by the task the image name is available here
1662
+ */
1663
+ image?: string;
1664
+ /** Is the Task Purpose is `INSTANCE`, and the instance was given a `specification` the specification can be found here. For **Applications** the specification is returned verbatim.
1665
+ */
1666
+ instance_specification?: string;
1649
1667
  /** The purpose of the task. Tasks are typically executed for the purpose of Dataset processing, attaching as Project Files or Application Instance execution. Other fields in this object are only valid if the purpose is known (i.e. is not `UNKNOWN`)
1650
- */
1668
+ */
1651
1669
  purpose: TaskGetResponsePurpose;
1652
1670
  /** The identity of the purpose, where available. This will be the Dataset UUID if the purpose of the task is/was for Dataset processing.
1653
- */
1671
+ */
1654
1672
  purpose_id: string;
1655
1673
  /** The version number, relating to the object under control. For Datasets this will be the Dataset version.
1656
- */
1674
+ */
1657
1675
  purpose_version?: number;
1658
- /** Is the Task Purpose is `INSTANCE`, and the instance was given a `specification` the specification can be found here. For **Applications** the specification is returned verbatim.
1659
- */
1660
- instance_specification?: string;
1661
- /** If a container image is launched by the task the image name is available here
1662
- */
1663
- image?: string;
1664
- /** The date and time the task was created
1665
- */
1666
- created: string;
1667
- /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
1668
- */
1669
- done: boolean;
1670
1676
  /** True if the Task relates to an object removal, i.e. a DELETE
1671
- */
1677
+ */
1672
1678
  removal?: boolean;
1673
- /** Present when `done` and zero if the task finished successfully.
1674
- */
1675
- exit_code?: number;
1676
1679
  /** A (possibly empty) list of application states, the oldest state occupies the first position in the list.
1677
- */
1680
+ */
1678
1681
  states?: TaskState[];
1679
- /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
1680
- */
1681
- events?: TaskEvent[];
1682
1682
  }
1683
1683
 
1684
1684
  export interface ServiceErrorsGetResponse {
1685
1685
  /** A list of service errors
1686
- */
1686
+ */
1687
1687
  service_errors: ServiceErrorSummary[];
1688
1688
  }
1689
1689
 
@@ -1693,7 +1693,7 @@ export interface ProjectsGetResponse {
1693
1693
 
1694
1694
  export interface ProjectPostResponse {
1695
1695
  /** The project identity
1696
- */
1696
+ */
1697
1697
  project_id: string;
1698
1698
  }
1699
1699
 
@@ -1709,95 +1709,95 @@ export interface JobsGetResponse {
1709
1709
  * 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`)
1710
1710
 
1711
1711
  */
1712
- export type JobGetResponseImageType =
1713
- (typeof JobGetResponseImageType)[keyof typeof JobGetResponseImageType];
1712
+ export type JobGetResponseImageType = typeof JobGetResponseImageType[keyof typeof JobGetResponseImageType];
1713
+
1714
1714
 
1715
1715
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1716
1716
  export const JobGetResponseImageType = {
1717
- SIMPLE: "SIMPLE",
1718
- NEXTFLOW: "NEXTFLOW",
1717
+ SIMPLE: 'SIMPLE',
1718
+ NEXTFLOW: 'NEXTFLOW',
1719
1719
  } as const;
1720
1720
 
1721
1721
  export interface JobGetResponse {
1722
- /** The Job's unique ID
1723
- */
1724
- id: number;
1725
1722
  application: ApplicationSummary;
1723
+ /** The Job's category
1724
+ */
1725
+ category?: string;
1726
1726
  /** The Job collection
1727
- */
1727
+ */
1728
1728
  collection: string;
1729
- /** The Job name, unique within a given collection
1730
- */
1731
- job: string;
1732
- /** The Job version
1733
- */
1734
- version: string;
1735
1729
  /** The Job command (usually encoded)
1736
- */
1730
+ */
1737
1731
  command: string;
1738
1732
  /** The Job command encoding
1739
- */
1733
+ */
1740
1734
  command_encoding: string;
1741
- /** The name of the container image that houses the job
1742
- */
1743
- image_name: string;
1744
- /** The container image tag
1745
- */
1746
- image_tag: string;
1747
- /** The directory where the project volume will be mounted. The root path to the project files
1748
- */
1749
- image_project_directory: string;
1750
- /** The directory used as the container image working directory (if defined)
1751
- */
1752
- image_working_directory?: unknown;
1753
- /** 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`)
1754
- */
1755
- image_type?: JobGetResponseImageType;
1756
- /** The Job's descriptive name
1757
- */
1758
- name: string;
1759
1735
  /** English description of the job
1760
- */
1736
+ */
1761
1737
  description?: string;
1762
- /** A URL linking to the Job documentation
1763
- */
1764
- doc_url?: string;
1765
- /** The Job's category
1766
- */
1767
- category?: string;
1768
- /** The list of keywords assigned to the Job
1769
- */
1770
- keywords?: string[];
1771
- variables?: JobVariables;
1772
- exchange_rate: string;
1773
- /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1774
- */
1775
- required_assets: string[];
1776
- /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
1777
- */
1778
- missing_assets?: string[];
1779
1738
  /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1780
- */
1739
+ */
1781
1740
  disabled: boolean;
1782
1741
  /** A reason why the Job has been disabled.
1783
- */
1742
+ */
1784
1743
  disabled_reason?: string;
1785
1744
  /** A suggested remedy that accompanies the "disabled_reason". This provides the client with advice on how to avoid the reason that the Job's been disabled, for reasons that can be avoided (not all are).
1786
1745
 
1787
1746
  Where there is no remedy for a given reason the remedy will be "There is no remedy".
1788
1747
  */
1789
1748
  disabled_remedy?: string;
1790
- replaces?: JobReplacements;
1749
+ /** A URL linking to the Job documentation
1750
+ */
1751
+ doc_url?: string;
1752
+ exchange_rate: string;
1753
+ /** The Job's unique ID
1754
+ */
1755
+ id: number;
1756
+ /** The name of the container image that houses the job
1757
+ */
1758
+ image_name: string;
1759
+ /** The directory where the project volume will be mounted. The root path to the project files
1760
+ */
1761
+ image_project_directory: string;
1762
+ /** The container image tag
1763
+ */
1764
+ image_tag: string;
1765
+ /** 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`)
1766
+ */
1767
+ image_type?: JobGetResponseImageType;
1768
+ /** The directory used as the container image working directory (if defined)
1769
+ */
1770
+ image_working_directory?: unknown;
1771
+ /** The Job name, unique within a given collection
1772
+ */
1773
+ job: string;
1774
+ /** The list of keywords assigned to the Job
1775
+ */
1776
+ keywords?: string[];
1777
+ /** A list of Account Server "required_assets" that cannot be found. If assets cannot be found the user will receive a "disabled_reason" that should explain the problem.
1778
+ */
1779
+ missing_assets?: string[];
1780
+ /** The Job's descriptive name
1781
+ */
1782
+ name: string;
1791
1783
  replaced_by?: JobReplacements;
1784
+ replaces?: JobReplacements;
1785
+ /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1786
+ */
1787
+ required_assets: string[];
1788
+ variables?: JobVariables;
1789
+ /** The Job version
1790
+ */
1791
+ version: string;
1792
1792
  }
1793
1793
 
1794
- export type InstanceTaskPurpose =
1795
- (typeof InstanceTaskPurpose)[keyof typeof InstanceTaskPurpose];
1794
+ export type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
1795
+
1796
1796
 
1797
1797
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1798
1798
  export const InstanceTaskPurpose = {
1799
- CREATE: "CREATE",
1800
- DELETE: "DELETE",
1799
+ CREATE: 'CREATE',
1800
+ DELETE: 'DELETE',
1801
1801
  } as const;
1802
1802
 
1803
1803
  export interface InstanceTask {
@@ -1810,215 +1810,213 @@ export interface InstancesGetResponse {
1810
1810
  }
1811
1811
 
1812
1812
  /**
1813
- * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1813
+ * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1814
+ The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1814
1815
 
1815
1816
  */
1816
- export type InstanceGetResponseJobImageType =
1817
- (typeof InstanceGetResponseJobImageType)[keyof typeof InstanceGetResponseJobImageType];
1817
+ export type InstanceGetResponsePhase = typeof InstanceGetResponsePhase[keyof typeof InstanceGetResponsePhase];
1818
+
1818
1819
 
1819
1820
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1820
- export const InstanceGetResponseJobImageType = {
1821
- SIMPLE: "SIMPLE",
1822
- NEXTFLOW: "NEXTFLOW",
1821
+ export const InstanceGetResponsePhase = {
1822
+ COMPLETED: 'COMPLETED',
1823
+ CRASH_LOOP_BACKOFF: 'CRASH_LOOP_BACKOFF',
1824
+ FAILED: 'FAILED',
1825
+ IMAGE_PULL_BACKOFF: 'IMAGE_PULL_BACKOFF',
1826
+ PENDING: 'PENDING',
1827
+ RUNNING: 'RUNNING',
1828
+ SUCCEEDED: 'SUCCEEDED',
1829
+ UNKNOWN: 'UNKNOWN',
1823
1830
  } as const;
1824
1831
 
1825
1832
  /**
1826
- * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1827
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1833
+ * The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1828
1834
 
1829
1835
  */
1830
- export type InstanceGetResponsePhase =
1831
- (typeof InstanceGetResponsePhase)[keyof typeof InstanceGetResponsePhase];
1836
+ export type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
1837
+
1832
1838
 
1833
1839
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1834
- export const InstanceGetResponsePhase = {
1835
- COMPLETED: "COMPLETED",
1836
- CRASH_LOOP_BACKOFF: "CRASH_LOOP_BACKOFF",
1837
- FAILED: "FAILED",
1838
- IMAGE_PULL_BACKOFF: "IMAGE_PULL_BACKOFF",
1839
- PENDING: "PENDING",
1840
- RUNNING: "RUNNING",
1841
- SUCCEEDED: "SUCCEEDED",
1842
- UNKNOWN: "UNKNOWN",
1840
+ export const InstanceGetResponseJobImageType = {
1841
+ SIMPLE: 'SIMPLE',
1842
+ NEXTFLOW: 'NEXTFLOW',
1843
1843
  } as const;
1844
1844
 
1845
1845
  /**
1846
1846
  * The type of Application, which can be a `job` or an `application`
1847
1847
 
1848
1848
  */
1849
- export type InstanceGetResponseApplicationType =
1850
- (typeof InstanceGetResponseApplicationType)[keyof typeof InstanceGetResponseApplicationType];
1849
+ export type InstanceGetResponseApplicationType = typeof InstanceGetResponseApplicationType[keyof typeof InstanceGetResponseApplicationType];
1850
+
1851
1851
 
1852
1852
  // eslint-disable-next-line @typescript-eslint/no-redeclare
1853
1853
  export const InstanceGetResponseApplicationType = {
1854
- APPLICATION: "APPLICATION",
1855
- JOB: "JOB",
1854
+ APPLICATION: 'APPLICATION',
1855
+ JOB: 'JOB',
1856
1856
  } as const;
1857
1857
 
1858
1858
  export interface InstanceGetResponse {
1859
- /** The Project the Instance is running in
1860
- */
1861
- project_id: string;
1862
- /** The application name
1863
- */
1864
- name: string;
1865
- /** True if the instance is archived (protected from automatic deletion)
1866
- */
1867
- archived: boolean;
1868
- /** The type of Application, which can be a `job` or an `application`
1869
- */
1870
- application_type: InstanceGetResponseApplicationType;
1871
1859
  /** The application ID
1872
- */
1860
+ */
1873
1861
  application_id: string;
1874
- /** The application version
1875
- */
1876
- application_version: string;
1877
1862
  /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
1878
- */
1863
+ */
1879
1864
  application_specification?: string;
1865
+ /** The type of Application, which can be a `job` or an `application`
1866
+ */
1867
+ application_type: InstanceGetResponseApplicationType;
1868
+ /** The application version
1869
+ */
1870
+ application_version: string;
1871
+ /** True if the instance is archived (protected from automatic deletion)
1872
+ */
1873
+ archived: boolean;
1880
1874
  /** The code obtained from the Account Server
1881
- */
1875
+ */
1882
1876
  authorisation_code?: number;
1883
- /** The application owner, the person who launched the application and is the only user than can stop it.
1884
- */
1885
- owner: string;
1886
- /** The date and time the instance was started, an ISO-8601 format string.
1887
- */
1888
- launched: string;
1889
- /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available.
1890
- */
1891
- started?: string;
1892
- /** The date and time the instance stopped, an ISO-8601 format string.
1893
- */
1894
- stopped?: string;
1895
- /** The time the instance has spent running in the cluster. It's a string representation of a Python timedelta object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
1896
- */
1897
- run_time: string;
1898
- /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1899
- The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1877
+ /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'`
1900
1878
  */
1901
- phase: InstanceGetResponsePhase;
1902
- /** The application endpoint
1903
- */
1904
- url?: string;
1879
+ coins?: string;
1880
+ /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds).
1881
+ */
1882
+ collateral_cpu_hours?: string;
1883
+ /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned.
1884
+ */
1885
+ collateral_pod_count?: number;
1886
+ /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'`
1887
+ */
1888
+ cost?: string;
1889
+ /** An optional error message, used to report underlying problems.
1890
+ */
1891
+ error_message?: string;
1892
+ /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1893
+ */
1894
+ fix_permissions?: boolean;
1895
+ /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
1896
+ */
1897
+ has_valid_callback_token: boolean;
1905
1898
  /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1906
- */
1899
+ */
1907
1900
  job_collection?: string;
1901
+ /** The Job definition's unique ID
1902
+ */
1903
+ job_id?: number;
1904
+ /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1905
+ */
1906
+ job_image_type?: InstanceGetResponseJobImageType;
1908
1907
  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
1909
- */
1908
+ */
1910
1909
  job_job?: string;
1911
1910
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1912
- */
1911
+ */
1913
1912
  job_name?: string;
1914
- /** The Job definition's unique ID
1915
- */
1916
- job_id?: number;
1917
1913
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1918
- */
1914
+ */
1919
1915
  job_version?: string;
1920
- /** The Job container image type. Typically a single-container 'SIMPLE' (where only one container runs) or a workflow where multiple container images can be spawned (like NEXTFLOW)
1921
- */
1922
- job_image_type?: InstanceGetResponseJobImageType;
1916
+ /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'`
1917
+ */
1918
+ launch_exchange_rate?: string;
1919
+ /** The date and time the instance was started, an ISO-8601 format string.
1920
+ */
1921
+ launched: string;
1922
+ /** The application name
1923
+ */
1924
+ name: string;
1923
1925
  /** The JSON string representation of the JobDefinition's outputs
1924
- */
1926
+ */
1925
1927
  outputs?: string;
1926
- /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1927
- */
1928
- fix_permissions?: boolean;
1928
+ /** The application owner, the person who launched the application and is the only user than can stop it.
1929
+ */
1930
+ owner: string;
1931
+ /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1932
+ The initial phase, indicating that the Instance is preparing to run, is `PENDING`. The instance is running when the phase is `RUNNING`. `COMPLETED` indicates the Instance has finished successfully and `FAILED` when it's finished but unsuccessfully.
1933
+ */
1934
+ phase: InstanceGetResponsePhase;
1935
+ /** The Project the Instance is running in
1936
+ */
1937
+ project_id: string;
1938
+ /** The time the instance has spent running in the cluster. It's a string representation of a Python timedelta object, e.g. `0:12:32` for a run-time of 12 minutes and 32 seconds. The run-time must be considered as an _estimate_ until the instance has stopped and the instance is only considered to be running once `started` has been set.
1939
+ */
1940
+ run_time: string;
1941
+ /** The date and time the instance started running in the cluster. This is typically close to the launch time but contention may mean the instance starts only when resources are available.
1942
+ */
1943
+ started?: string;
1944
+ /** The date and time the instance stopped, an ISO-8601 format string.
1945
+ */
1946
+ stopped?: string;
1929
1947
  /** A list of Tasks related to the application. Tasks are responsible for creating and deleting the instance. You should fins at least one, assuming the corresponding task has not been deleted.
1930
- */
1948
+ */
1931
1949
  tasks: InstanceTask[];
1932
- /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
1933
- */
1934
- has_valid_callback_token: boolean;
1935
- /** The cost exchange rate that applies to the Job at the time of launch. This is a string representation of a Decimal, e.g. `'0.5'`
1936
- */
1937
- launch_exchange_rate?: string;
1938
- /** The accumulated cost accrued by the running Job. Depending on the the Job, this is either known when the Job completes or may change as the Job runs. This is a string representation of a Decimal value, e.g. `'32.8'`
1939
- */
1940
- cost?: string;
1941
- /** The accumulated coins accrued by the running Job. Coins are calculated based on the `cost` multiplied by the `launch_exchange_rate`. This is a string representation of a Decimal value, e.g. `'16.4'`
1942
- */
1943
- coins?: string;
1944
- /** Where available, this is the number of hours that the JOb would take if the collateral Pods had access to only one CPU core. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. A value of `'0.5'` implies the job would have run in 30 minutes on 1 core. The minimum time resolution is 0.001 (3.6 seconds).
1945
- */
1946
- collateral_cpu_hours?: string;
1947
- /** Where available, the number of collateral Pods spawned by the instance, typically used by Job instances. Collateral Pods are all the pods created by the Job that are in addition to the main (controlling) Pod. For `NEXTFLOW` jobs this is a count of the number of Task pods spawned.
1948
- */
1949
- collateral_pod_count?: number;
1950
- /** An optional error message, used to report underlying problems.
1951
- */
1952
- error_message?: string;
1950
+ /** The application endpoint
1951
+ */
1952
+ url?: string;
1953
1953
  }
1954
1954
 
1955
1955
  export type GetExchangeRatesResponseId = number | string;
1956
1956
 
1957
1957
  export interface GetExchangeRatesResponse {
1958
- id: GetExchangeRatesResponseId;
1959
1958
  exchange_rates: ExchangeRateDetail[];
1959
+ id: GetExchangeRatesResponseId;
1960
1960
  }
1961
1961
 
1962
- export type GetAllExchangeRatesResponseExchangeRatesItem =
1963
- | ApplicationExchangeRateSummary
1964
- | JobExchangeRateSummary;
1962
+ export type GetAllExchangeRatesResponseExchangeRatesItem = ApplicationExchangeRateSummary | JobExchangeRateSummary;
1965
1963
 
1966
1964
  export interface GetAllExchangeRatesResponse {
1967
- only_undefined: boolean;
1968
1965
  exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
1966
+ only_undefined: boolean;
1969
1967
  }
1970
1968
 
1971
1969
  export interface FilesGetResponse {
1972
- /** The project
1973
- */
1974
- project_id: string;
1975
- /** The project path
1976
- */
1977
- path: string;
1978
1970
  /** The dataset identity (not its name). A unique reference assigned automatically when uploaded
1979
- */
1971
+ */
1980
1972
  files: FilePathFile[];
1973
+ /** The project path
1974
+ */
1975
+ path: string;
1981
1976
  /** Sub-directories in the current path
1982
- */
1977
+ */
1983
1978
  paths: string[];
1979
+ /** The project
1980
+ */
1981
+ project_id: string;
1984
1982
  }
1985
1983
 
1986
1984
  export interface FilePostResponse {
1987
1985
  /** The Project File identity, assigned automatically when a Dataset is added to a Project
1988
- */
1986
+ */
1989
1987
  file_id: string;
1990
1988
  /** The name of the File that will appear in the Project
1991
- */
1989
+ */
1992
1990
  file_name: string;
1993
1991
  /** The path to the file in the Project, relative to the volume root (mount point). Files in the root of the project will have a path value of '/'
1994
- */
1992
+ */
1995
1993
  file_path: string;
1996
1994
  /** The File task identity. The task assigned to convert and attach the Dataset File to the Project
1997
- */
1995
+ */
1998
1996
  task_id: string;
1999
1997
  }
2000
1998
 
2001
1999
  export interface InstancePostResponse {
2002
- /** The application instance identity (not its name). Assigned automatically when created
2003
- */
2004
- instance_id: string;
2005
2000
  /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it. The token is only provided if asked for when the instance is launched.
2006
- */
2001
+ */
2007
2002
  callback_token?: string;
2008
- /** The instance task identity. The task assigned to process the instance
2009
- */
2010
- task_id: string;
2011
2003
  /** The instance expanded command. Applies only to Job instances.
2012
- */
2004
+ */
2013
2005
  command?: string;
2006
+ /** The application instance identity (not its name). Assigned automatically when created
2007
+ */
2008
+ instance_id: string;
2009
+ /** The instance task identity. The task assigned to process the instance
2010
+ */
2011
+ task_id: string;
2014
2012
  }
2015
2013
 
2016
2014
  export interface InstanceDryRunPostResponse {
2017
2015
  /** A token that can be used to access data in the project without further authentication. The token expires automatically or if the user revokes it.
2018
- */
2016
+ */
2019
2017
  callback_token?: string;
2020
2018
  /** The instance expanded command. Applies only to Job instances.
2021
- */
2019
+ */
2022
2020
  command?: string;
2023
2021
  }
2024
2022
 
@@ -2036,145 +2034,145 @@ export type DatasetVersionDeleteResponse = TaskIdentity;
2036
2034
  * The Metadata type (an object)
2037
2035
 
2038
2036
  */
2039
- export type DatasetSchemaGetResponseType =
2040
- (typeof DatasetSchemaGetResponseType)[keyof typeof DatasetSchemaGetResponseType];
2037
+ export type DatasetSchemaGetResponseType = typeof DatasetSchemaGetResponseType[keyof typeof DatasetSchemaGetResponseType];
2038
+
2041
2039
 
2042
2040
  // eslint-disable-next-line @typescript-eslint/no-redeclare
2043
2041
  export const DatasetSchemaGetResponseType = {
2044
- object: "object",
2042
+ object: 'object',
2045
2043
  } as const;
2046
2044
 
2047
2045
  export interface DatasetSchemaGetResponse {
2048
- /** The Metadata title
2049
- */
2050
- title: string;
2051
2046
  /** The Metadata description
2052
- */
2047
+ */
2053
2048
  description: string;
2054
- /** The Metadata type (an object)
2055
- */
2056
- type: DatasetSchemaGetResponseType;
2057
2049
  /** Required properties
2058
- */
2050
+ */
2059
2051
  required: string[];
2052
+ /** The Metadata title
2053
+ */
2054
+ title: string;
2055
+ /** The Metadata type (an object)
2056
+ */
2057
+ type: DatasetSchemaGetResponseType;
2060
2058
  [key: string]: any;
2061
- }
2059
+ }
2062
2060
 
2063
2061
  export interface DatasetMetaGetResponse {
2064
- /** The Metadata title
2065
- */
2066
- dataset_name: string;
2062
+ /** The Metadata's annotations
2063
+ */
2064
+ annotations: unknown[];
2065
+ /** The date and time of creation
2066
+ */
2067
+ created: string;
2068
+ /** The user who created the Metadata
2069
+ */
2070
+ created_by: string;
2067
2071
  /** The Metadata description
2068
- */
2072
+ */
2069
2073
  dataset_id: string;
2074
+ /** The Metadata title
2075
+ */
2076
+ dataset_name: string;
2070
2077
  /** The Metadata type (an object)
2071
- */
2078
+ */
2072
2079
  description: string;
2073
- /** The date and time of creation
2074
- */
2075
- created: string;
2080
+ /** The Metadata's labels
2081
+ */
2082
+ labels: unknown[];
2076
2083
  /** The date and time it was last updated
2077
- */
2084
+ */
2078
2085
  last_updated: string;
2079
- /** The user who created the Metadata
2080
- */
2081
- created_by: string;
2082
2086
  /** The Metadata version
2083
- */
2087
+ */
2084
2088
  metadata_version: string;
2085
- /** The Metadata's annotations
2086
- */
2087
- annotations: unknown[];
2088
- /** The Metadata's labels
2089
- */
2090
- labels: unknown[];
2091
2089
  [key: string]: any;
2092
- }
2090
+ }
2093
2091
 
2094
2092
  export interface DatasetDigestGetResponse {
2095
2093
  /** The Dataset matching the digest
2096
- */
2094
+ */
2097
2095
  dataset_id: string;
2098
2096
  /** The Dataset version
2099
- */
2097
+ */
2100
2098
  dataset_version: number;
2101
2099
  }
2102
2100
 
2103
2101
  export interface DatasetPutPostResponse {
2104
2102
  /** The dataset identity (not its name). Assigned automatically when uploaded
2105
- */
2103
+ */
2106
2104
  dataset_id: string;
2107
2105
  /** The dataset identity version. Assigned automatically when uploaded
2108
- */
2106
+ */
2109
2107
  dataset_version: number;
2110
2108
  /** The dataset task identity. The task assigned to process the dataset
2111
- */
2109
+ */
2112
2110
  task_id: string;
2113
2111
  }
2114
2112
 
2115
2113
  export interface ApplicationsGetResponse {
2116
2114
  /** A list of installed applications, which are application-compliant Kubernetes "operators"
2117
- */
2115
+ */
2118
2116
  applications: ApplicationSummary[];
2119
2117
  }
2120
2118
 
2121
2119
  export interface ApplicationGetResponse {
2122
- /** The Application's unique ID
2123
- */
2124
- id: string;
2125
2120
  /** The Application COST exchange rate
2126
- */
2121
+ */
2127
2122
  exchange_rate: string;
2128
- /** The application specification template. Used when creating application instances
2129
- */
2130
- template: string;
2131
- /** A list of instances of the application
2132
- */
2133
- instances: string[];
2134
2123
  /** The application group
2135
- */
2124
+ */
2136
2125
  group: string;
2126
+ /** The Application's unique ID
2127
+ */
2128
+ id: string;
2129
+ image_variants?: ApplicationImageVariants;
2130
+ /** A list of instances of the application
2131
+ */
2132
+ instances: string[];
2137
2133
  /** The name (kind) of the application
2138
- */
2134
+ */
2139
2135
  kind: string;
2136
+ /** The application specification template. Used when creating application instances
2137
+ */
2138
+ template: string;
2140
2139
  /** The list of available versions
2141
- */
2140
+ */
2142
2141
  versions: string[];
2143
- image_variants?: ApplicationImageVariants;
2144
2142
  }
2145
2143
 
2146
2144
  export interface AdminUsersGetResponse {
2147
2145
  /** A list of Users that have used the Data Manager
2148
- */
2146
+ */
2149
2147
  users: UserDetail[];
2150
2148
  }
2151
2149
 
2152
2150
  export type AdminUserPutResponse = UserAccountDetail;
2153
2151
 
2154
2152
  export interface AdminJobManifestLoadPutResponse {
2155
- /** True if successful, false otherwise
2156
- */
2157
- status: boolean;
2158
- /** The number of Job Manifests inspected
2159
- */
2160
- manifests_inspected: number;
2161
2153
  /** The number of Job Definitions inspected
2162
- */
2154
+ */
2163
2155
  job_definitions_inspected: number;
2164
2156
  /** The number of Jobs inspected
2165
- */
2157
+ */
2166
2158
  jobs_inspected: number;
2159
+ /** The number of Job Manifests inspected
2160
+ */
2161
+ manifests_inspected: number;
2162
+ /** True if successful, false otherwise
2163
+ */
2164
+ status: boolean;
2167
2165
  }
2168
2166
 
2169
2167
  export interface AdminJobManifestGetResponse {
2170
2168
  /** The list of known Job manifests
2171
- */
2169
+ */
2172
2170
  job_manifests: JobManifestDetail[];
2173
2171
  }
2174
2172
 
2175
2173
  export interface AccountServerGetNamespaceResponse {
2176
2174
  /** 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.
2177
- */
2175
+ */
2178
2176
  namespace: string;
2179
2177
  }
2180
2178
 
@@ -2186,6 +2184,7 @@ export interface AccountServerGetRegistrationResponse {
2186
2184
 
2187
2185
  export interface DmError {
2188
2186
  /** Brief error text that can be presented to the user
2189
- */
2187
+ */
2190
2188
  error: string;
2191
2189
  }
2190
+