@squonk/data-manager-client 4.1.5 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -90,10 +90,18 @@ archive?: QInstanceArchiveParameter;
90
90
  };
91
91
 
92
92
  export type GetInstancesParams = {
93
+ /**
94
+ * An Organisation identity
95
+ */
96
+ org_id?: QOrgIdParameter;
93
97
  /**
94
98
  * A Project identity
95
99
  */
96
100
  project_id?: QProjectIdParameter;
101
+ /**
102
+ * A Unit identity
103
+ */
104
+ unit_id?: QUnitIdParameter;
97
105
  };
98
106
 
99
107
  export type GetJobExchangeRatesParams = {
@@ -198,10 +206,18 @@ exclude_removal?: QExcludeRemovalParameter;
198
206
 
199
207
  */
200
208
  exclude_purpose?: QExcludePurposeParameter;
209
+ /**
210
+ * An Organisation identity
211
+ */
212
+ org_id?: QOrgIdParameter;
201
213
  /**
202
214
  * A Project identity
203
215
  */
204
216
  project_id?: QProjectIdParameter;
217
+ /**
218
+ * A Unit identity
219
+ */
220
+ unit_id?: QUnitIdParameter;
205
221
  /**
206
222
  * An instance callback context string
207
223
  */
@@ -1292,6 +1308,23 @@ export interface RunningWorkflowWorkflow {
1292
1308
  name?: string;
1293
1309
  }
1294
1310
 
1311
+ /**
1312
+ * The processing stage.
1313
+
1314
+ */
1315
+ export type ProjectFileDetailProcessingStage = typeof ProjectFileDetailProcessingStage[keyof typeof ProjectFileDetailProcessingStage];
1316
+
1317
+
1318
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
1319
+ export const ProjectFileDetailProcessingStage = {
1320
+ COPYING: 'COPYING',
1321
+ FAILED: 'FAILED',
1322
+ FORMATTING: 'FORMATTING',
1323
+ LOADING: 'LOADING',
1324
+ DELETING: 'DELETING',
1325
+ DONE: 'DONE',
1326
+ } as const;
1327
+
1295
1328
  export interface ProjectFileDetail {
1296
1329
  /** The code obtained from the Account Server
1297
1330
  */
@@ -1311,6 +1344,9 @@ export interface ProjectFileDetail {
1311
1344
  /** The ProjectFile's path within the Project volume
1312
1345
  */
1313
1346
  file_path: string;
1347
+ /** The processing stage.
1348
+ */
1349
+ processing_stage?: ProjectFileDetailProcessingStage;
1314
1350
  /** True if the ProjectFile cannot be modified while in the Project
1315
1351
  */
1316
1352
  immutable: boolean;
@@ -2057,9 +2093,17 @@ export interface RunningWorkflowSummary {
2057
2093
  /** The name attached to this running workflow
2058
2094
  */
2059
2095
  name: string;
2096
+ error_num?: number;
2097
+ error_msg?: string;
2060
2098
  /** The status of the running workflow */
2061
- status?: RunningWorkflowSummaryStatus;
2062
- workflow?: RunningWorkflowWorkflow;
2099
+ status: RunningWorkflowSummaryStatus;
2100
+ /** The date and time the running workflow was started */
2101
+ started?: string;
2102
+ /** The date and time the running workflow was stopped
2103
+ */
2104
+ stopped?: string;
2105
+ workflow: RunningWorkflowWorkflow;
2106
+ project: RunningWorkflowProject;
2063
2107
  }
2064
2108
 
2065
2109
  export interface PriorRunningWorkflowStep {
@@ -2223,7 +2267,7 @@ export interface WorkflowGetAllResponse {
2223
2267
  }
2224
2268
 
2225
2269
  export interface VersionGetResponse {
2226
- /** 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
2270
+ /** A 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
2227
2271
  */
2228
2272
  version: string;
2229
2273
  }
@@ -143,6 +143,8 @@ export const useCreateInstance = <TData = Awaited<ReturnType<typeof createInstan
143
143
  /**
144
144
  * Returns a summary of all running instances. Instances can be running as an Application or as a Job. The response will contain an `application_type` field that is either `job` or `application`
145
145
 
146
+ Results can be filtered by **Project**, **Unit** or **Organisation**.
147
+
146
148
  * @summary Get summary information about all Job and Application instances
147
149
  */
148
150
  export const getInstances = (