@squonk/data-manager-client 4.1.0 → 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.
- package/accounting/accounting.cjs +44 -1
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.d.cts +58 -1
- package/accounting/accounting.d.ts +58 -1
- package/accounting/accounting.js +44 -1
- package/accounting/accounting.js.map +1 -1
- package/index.cjs +10 -1
- package/index.cjs.map +1 -1
- package/index.d.cts +73 -6
- package/index.d.ts +73 -6
- package/index.js +9 -0
- package/index.js.map +1 -1
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.cts +2 -0
- package/instance/instance.d.ts +2 -0
- package/instance/instance.js.map +1 -1
- package/package.json +1 -1
- package/src/accounting/accounting.ts +141 -0
- package/src/data-manager-api.schemas.ts +76 -5
- package/src/instance/instance.ts +2 -0
- package/src/workflow/workflow.ts +24 -20
- package/workflow/workflow.cjs +14 -13
- package/workflow/workflow.cjs.map +1 -1
- package/workflow/workflow.d.cts +13 -11
- package/workflow/workflow.d.ts +13 -11
- package/workflow/workflow.js +14 -13
- package/workflow/workflow.js.map +1 -1
package/index.d.cts
CHANGED
|
@@ -51,6 +51,13 @@ type AdminGetServiceErrorsParams = {
|
|
|
51
51
|
*/
|
|
52
52
|
include_acknowledged?: QIncludeAcknowledgedParameter;
|
|
53
53
|
};
|
|
54
|
+
type GetRunningWorkflowsParams = {
|
|
55
|
+
/**
|
|
56
|
+
* A workflow ID
|
|
57
|
+
|
|
58
|
+
*/
|
|
59
|
+
workflow_id?: QWorkflowIdParameter;
|
|
60
|
+
};
|
|
54
61
|
type GetUserApiLogParams = {
|
|
55
62
|
/**
|
|
56
63
|
* A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
|
|
@@ -77,10 +84,18 @@ type PatchInstanceParams = {
|
|
|
77
84
|
archive?: QInstanceArchiveParameter;
|
|
78
85
|
};
|
|
79
86
|
type GetInstancesParams = {
|
|
87
|
+
/**
|
|
88
|
+
* An Organisation identity
|
|
89
|
+
*/
|
|
90
|
+
org_id?: QOrgIdParameter;
|
|
80
91
|
/**
|
|
81
92
|
* A Project identity
|
|
82
93
|
*/
|
|
83
94
|
project_id?: QProjectIdParameter;
|
|
95
|
+
/**
|
|
96
|
+
* A Unit identity
|
|
97
|
+
*/
|
|
98
|
+
unit_id?: QUnitIdParameter;
|
|
84
99
|
};
|
|
85
100
|
type GetJobExchangeRatesParams = {
|
|
86
101
|
/**
|
|
@@ -176,10 +191,18 @@ type GetTasksParams = {
|
|
|
176
191
|
|
|
177
192
|
*/
|
|
178
193
|
exclude_purpose?: QExcludePurposeParameter;
|
|
194
|
+
/**
|
|
195
|
+
* An Organisation identity
|
|
196
|
+
*/
|
|
197
|
+
org_id?: QOrgIdParameter;
|
|
179
198
|
/**
|
|
180
199
|
* A Project identity
|
|
181
200
|
*/
|
|
182
201
|
project_id?: QProjectIdParameter;
|
|
202
|
+
/**
|
|
203
|
+
* A Unit identity
|
|
204
|
+
*/
|
|
205
|
+
unit_id?: QUnitIdParameter;
|
|
183
206
|
/**
|
|
184
207
|
* An instance callback context string
|
|
185
208
|
*/
|
|
@@ -358,6 +381,11 @@ type CreatePathParams = {
|
|
|
358
381
|
*/
|
|
359
382
|
path?: QFilePathParameter;
|
|
360
383
|
};
|
|
384
|
+
/**
|
|
385
|
+
* A workflow ID
|
|
386
|
+
|
|
387
|
+
*/
|
|
388
|
+
type QWorkflowIdParameter = string;
|
|
361
389
|
/**
|
|
362
390
|
* A comma-separated list of editors
|
|
363
391
|
|
|
@@ -1152,6 +1180,19 @@ interface RunningWorkflowWorkflow {
|
|
|
1152
1180
|
*/
|
|
1153
1181
|
name?: string;
|
|
1154
1182
|
}
|
|
1183
|
+
/**
|
|
1184
|
+
* The processing stage.
|
|
1185
|
+
|
|
1186
|
+
*/
|
|
1187
|
+
type ProjectFileDetailProcessingStage = typeof ProjectFileDetailProcessingStage[keyof typeof ProjectFileDetailProcessingStage];
|
|
1188
|
+
declare const ProjectFileDetailProcessingStage: {
|
|
1189
|
+
readonly COPYING: "COPYING";
|
|
1190
|
+
readonly FAILED: "FAILED";
|
|
1191
|
+
readonly FORMATTING: "FORMATTING";
|
|
1192
|
+
readonly LOADING: "LOADING";
|
|
1193
|
+
readonly DELETING: "DELETING";
|
|
1194
|
+
readonly DONE: "DONE";
|
|
1195
|
+
};
|
|
1155
1196
|
interface ProjectFileDetail {
|
|
1156
1197
|
/** The code obtained from the Account Server
|
|
1157
1198
|
*/
|
|
@@ -1171,6 +1212,9 @@ interface ProjectFileDetail {
|
|
|
1171
1212
|
/** The ProjectFile's path within the Project volume
|
|
1172
1213
|
*/
|
|
1173
1214
|
file_path: string;
|
|
1215
|
+
/** The processing stage.
|
|
1216
|
+
*/
|
|
1217
|
+
processing_stage?: ProjectFileDetailProcessingStage;
|
|
1174
1218
|
/** True if the ProjectFile cannot be modified while in the Project
|
|
1175
1219
|
*/
|
|
1176
1220
|
immutable: boolean;
|
|
@@ -1856,9 +1900,17 @@ interface RunningWorkflowSummary {
|
|
|
1856
1900
|
/** The name attached to this running workflow
|
|
1857
1901
|
*/
|
|
1858
1902
|
name: string;
|
|
1903
|
+
error_num?: number;
|
|
1904
|
+
error_msg?: string;
|
|
1859
1905
|
/** The status of the running workflow */
|
|
1860
|
-
status
|
|
1861
|
-
workflow
|
|
1906
|
+
status: RunningWorkflowSummaryStatus;
|
|
1907
|
+
/** The date and time the running workflow was started */
|
|
1908
|
+
started?: string;
|
|
1909
|
+
/** The date and time the running workflow was stopped
|
|
1910
|
+
*/
|
|
1911
|
+
stopped?: string;
|
|
1912
|
+
workflow: RunningWorkflowWorkflow;
|
|
1913
|
+
project: RunningWorkflowProject;
|
|
1862
1914
|
}
|
|
1863
1915
|
interface PriorRunningWorkflowStep {
|
|
1864
1916
|
/** The Running Workflows Step's unique ID that ran prior to this step
|
|
@@ -1875,13 +1927,20 @@ interface WorkflowVersionPutResponse {
|
|
|
1875
1927
|
/** A new workflow ID */
|
|
1876
1928
|
id: string;
|
|
1877
1929
|
}
|
|
1930
|
+
/**
|
|
1931
|
+
* The step specification
|
|
1932
|
+
|
|
1933
|
+
*/
|
|
1934
|
+
type WorkflowStepSummarySpecification = {
|
|
1935
|
+
[key: string]: unknown;
|
|
1936
|
+
};
|
|
1878
1937
|
interface WorkflowStepSummary {
|
|
1879
1938
|
/** The name of the step
|
|
1880
1939
|
*/
|
|
1881
1940
|
name: string;
|
|
1882
|
-
/** The
|
|
1941
|
+
/** The step specification
|
|
1883
1942
|
*/
|
|
1884
|
-
specification:
|
|
1943
|
+
specification: WorkflowStepSummarySpecification;
|
|
1885
1944
|
}
|
|
1886
1945
|
interface WorkflowRunPostResponse {
|
|
1887
1946
|
/** A running workflow ID */
|
|
@@ -1891,6 +1950,12 @@ interface WorkflowDefinitionGetResponse {
|
|
|
1891
1950
|
/** YAML as a string */
|
|
1892
1951
|
definition: string;
|
|
1893
1952
|
}
|
|
1953
|
+
/**
|
|
1954
|
+
* The workflow control variables
|
|
1955
|
+
*/
|
|
1956
|
+
type WorkflowGetResponseVariables = {
|
|
1957
|
+
[key: string]: unknown;
|
|
1958
|
+
};
|
|
1894
1959
|
/**
|
|
1895
1960
|
* The scope of the workflow.
|
|
1896
1961
|
*/
|
|
@@ -1933,6 +1998,8 @@ interface WorkflowGetResponse {
|
|
|
1933
1998
|
/** A list of validation errors. Only present if the workflow has been validated and errors were found.
|
|
1934
1999
|
*/
|
|
1935
2000
|
validation_error_msg?: string[];
|
|
2001
|
+
/** The workflow control variables */
|
|
2002
|
+
variables?: WorkflowGetResponseVariables;
|
|
1936
2003
|
/** The steps, if the Workflow has been validated and has no errors.
|
|
1937
2004
|
*/
|
|
1938
2005
|
steps?: WorkflowStepSummary[];
|
|
@@ -1989,7 +2056,7 @@ interface WorkflowGetAllResponse {
|
|
|
1989
2056
|
workflows: WorkflowSummary[];
|
|
1990
2057
|
}
|
|
1991
2058
|
interface VersionGetResponse {
|
|
1992
|
-
/**
|
|
2059
|
+
/** 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
|
|
1993
2060
|
*/
|
|
1994
2061
|
version: string;
|
|
1995
2062
|
}
|
|
@@ -2652,4 +2719,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
|
|
|
2652
2719
|
declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
|
|
2653
2720
|
type ErrorType<TError> = AxiosError<TError>;
|
|
2654
2721
|
|
|
2655
|
-
export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InputHandlerDetail, type InputHandlerGetResponse, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type PriorRunningWorkflowStep, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type RunningWorkflowGetAllResponse, type RunningWorkflowGetResponse, RunningWorkflowGetResponseStatus, type RunningWorkflowGetResponseVariables, type RunningWorkflowProject, type RunningWorkflowStep, RunningWorkflowStepStatus, type RunningWorkflowStepVariables, type RunningWorkflowStepsGetResponse, type RunningWorkflowSummary, RunningWorkflowSummaryStatus, type RunningWorkflowWorkflow, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, type WorkflowDefinitionGetResponse, type WorkflowGetAllResponse, type WorkflowGetResponse, WorkflowGetResponseScope, type WorkflowPatchBodyBody, type WorkflowPatchResponse, type WorkflowPostBodyBody, WorkflowPostBodyBodyScope, type WorkflowPostResponse, type WorkflowRunPostBodyBody, type WorkflowRunPostResponse, type WorkflowStepSummary, type WorkflowSummary, WorkflowSummaryScope, type WorkflowVersionPutBodyBody, type WorkflowVersionPutResponse, customInstance, setAuthToken, setBaseUrl };
|
|
2722
|
+
export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetRunningWorkflowsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InputHandlerDetail, type InputHandlerGetResponse, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type PriorRunningWorkflowStep, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, ProjectFileDetailProcessingStage, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type QWorkflowIdParameter, type RunningWorkflowGetAllResponse, type RunningWorkflowGetResponse, RunningWorkflowGetResponseStatus, type RunningWorkflowGetResponseVariables, type RunningWorkflowProject, type RunningWorkflowStep, RunningWorkflowStepStatus, type RunningWorkflowStepVariables, type RunningWorkflowStepsGetResponse, type RunningWorkflowSummary, RunningWorkflowSummaryStatus, type RunningWorkflowWorkflow, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, type WorkflowDefinitionGetResponse, type WorkflowGetAllResponse, type WorkflowGetResponse, WorkflowGetResponseScope, type WorkflowGetResponseVariables, type WorkflowPatchBodyBody, type WorkflowPatchResponse, type WorkflowPostBodyBody, WorkflowPostBodyBodyScope, type WorkflowPostResponse, type WorkflowRunPostBodyBody, type WorkflowRunPostResponse, type WorkflowStepSummary, type WorkflowStepSummarySpecification, type WorkflowSummary, WorkflowSummaryScope, type WorkflowVersionPutBodyBody, type WorkflowVersionPutResponse, customInstance, setAuthToken, setBaseUrl };
|
package/index.d.ts
CHANGED
|
@@ -51,6 +51,13 @@ type AdminGetServiceErrorsParams = {
|
|
|
51
51
|
*/
|
|
52
52
|
include_acknowledged?: QIncludeAcknowledgedParameter;
|
|
53
53
|
};
|
|
54
|
+
type GetRunningWorkflowsParams = {
|
|
55
|
+
/**
|
|
56
|
+
* A workflow ID
|
|
57
|
+
|
|
58
|
+
*/
|
|
59
|
+
workflow_id?: QWorkflowIdParameter;
|
|
60
|
+
};
|
|
54
61
|
type GetUserApiLogParams = {
|
|
55
62
|
/**
|
|
56
63
|
* A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
|
|
@@ -77,10 +84,18 @@ type PatchInstanceParams = {
|
|
|
77
84
|
archive?: QInstanceArchiveParameter;
|
|
78
85
|
};
|
|
79
86
|
type GetInstancesParams = {
|
|
87
|
+
/**
|
|
88
|
+
* An Organisation identity
|
|
89
|
+
*/
|
|
90
|
+
org_id?: QOrgIdParameter;
|
|
80
91
|
/**
|
|
81
92
|
* A Project identity
|
|
82
93
|
*/
|
|
83
94
|
project_id?: QProjectIdParameter;
|
|
95
|
+
/**
|
|
96
|
+
* A Unit identity
|
|
97
|
+
*/
|
|
98
|
+
unit_id?: QUnitIdParameter;
|
|
84
99
|
};
|
|
85
100
|
type GetJobExchangeRatesParams = {
|
|
86
101
|
/**
|
|
@@ -176,10 +191,18 @@ type GetTasksParams = {
|
|
|
176
191
|
|
|
177
192
|
*/
|
|
178
193
|
exclude_purpose?: QExcludePurposeParameter;
|
|
194
|
+
/**
|
|
195
|
+
* An Organisation identity
|
|
196
|
+
*/
|
|
197
|
+
org_id?: QOrgIdParameter;
|
|
179
198
|
/**
|
|
180
199
|
* A Project identity
|
|
181
200
|
*/
|
|
182
201
|
project_id?: QProjectIdParameter;
|
|
202
|
+
/**
|
|
203
|
+
* A Unit identity
|
|
204
|
+
*/
|
|
205
|
+
unit_id?: QUnitIdParameter;
|
|
183
206
|
/**
|
|
184
207
|
* An instance callback context string
|
|
185
208
|
*/
|
|
@@ -358,6 +381,11 @@ type CreatePathParams = {
|
|
|
358
381
|
*/
|
|
359
382
|
path?: QFilePathParameter;
|
|
360
383
|
};
|
|
384
|
+
/**
|
|
385
|
+
* A workflow ID
|
|
386
|
+
|
|
387
|
+
*/
|
|
388
|
+
type QWorkflowIdParameter = string;
|
|
361
389
|
/**
|
|
362
390
|
* A comma-separated list of editors
|
|
363
391
|
|
|
@@ -1152,6 +1180,19 @@ interface RunningWorkflowWorkflow {
|
|
|
1152
1180
|
*/
|
|
1153
1181
|
name?: string;
|
|
1154
1182
|
}
|
|
1183
|
+
/**
|
|
1184
|
+
* The processing stage.
|
|
1185
|
+
|
|
1186
|
+
*/
|
|
1187
|
+
type ProjectFileDetailProcessingStage = typeof ProjectFileDetailProcessingStage[keyof typeof ProjectFileDetailProcessingStage];
|
|
1188
|
+
declare const ProjectFileDetailProcessingStage: {
|
|
1189
|
+
readonly COPYING: "COPYING";
|
|
1190
|
+
readonly FAILED: "FAILED";
|
|
1191
|
+
readonly FORMATTING: "FORMATTING";
|
|
1192
|
+
readonly LOADING: "LOADING";
|
|
1193
|
+
readonly DELETING: "DELETING";
|
|
1194
|
+
readonly DONE: "DONE";
|
|
1195
|
+
};
|
|
1155
1196
|
interface ProjectFileDetail {
|
|
1156
1197
|
/** The code obtained from the Account Server
|
|
1157
1198
|
*/
|
|
@@ -1171,6 +1212,9 @@ interface ProjectFileDetail {
|
|
|
1171
1212
|
/** The ProjectFile's path within the Project volume
|
|
1172
1213
|
*/
|
|
1173
1214
|
file_path: string;
|
|
1215
|
+
/** The processing stage.
|
|
1216
|
+
*/
|
|
1217
|
+
processing_stage?: ProjectFileDetailProcessingStage;
|
|
1174
1218
|
/** True if the ProjectFile cannot be modified while in the Project
|
|
1175
1219
|
*/
|
|
1176
1220
|
immutable: boolean;
|
|
@@ -1856,9 +1900,17 @@ interface RunningWorkflowSummary {
|
|
|
1856
1900
|
/** The name attached to this running workflow
|
|
1857
1901
|
*/
|
|
1858
1902
|
name: string;
|
|
1903
|
+
error_num?: number;
|
|
1904
|
+
error_msg?: string;
|
|
1859
1905
|
/** The status of the running workflow */
|
|
1860
|
-
status
|
|
1861
|
-
workflow
|
|
1906
|
+
status: RunningWorkflowSummaryStatus;
|
|
1907
|
+
/** The date and time the running workflow was started */
|
|
1908
|
+
started?: string;
|
|
1909
|
+
/** The date and time the running workflow was stopped
|
|
1910
|
+
*/
|
|
1911
|
+
stopped?: string;
|
|
1912
|
+
workflow: RunningWorkflowWorkflow;
|
|
1913
|
+
project: RunningWorkflowProject;
|
|
1862
1914
|
}
|
|
1863
1915
|
interface PriorRunningWorkflowStep {
|
|
1864
1916
|
/** The Running Workflows Step's unique ID that ran prior to this step
|
|
@@ -1875,13 +1927,20 @@ interface WorkflowVersionPutResponse {
|
|
|
1875
1927
|
/** A new workflow ID */
|
|
1876
1928
|
id: string;
|
|
1877
1929
|
}
|
|
1930
|
+
/**
|
|
1931
|
+
* The step specification
|
|
1932
|
+
|
|
1933
|
+
*/
|
|
1934
|
+
type WorkflowStepSummarySpecification = {
|
|
1935
|
+
[key: string]: unknown;
|
|
1936
|
+
};
|
|
1878
1937
|
interface WorkflowStepSummary {
|
|
1879
1938
|
/** The name of the step
|
|
1880
1939
|
*/
|
|
1881
1940
|
name: string;
|
|
1882
|
-
/** The
|
|
1941
|
+
/** The step specification
|
|
1883
1942
|
*/
|
|
1884
|
-
specification:
|
|
1943
|
+
specification: WorkflowStepSummarySpecification;
|
|
1885
1944
|
}
|
|
1886
1945
|
interface WorkflowRunPostResponse {
|
|
1887
1946
|
/** A running workflow ID */
|
|
@@ -1891,6 +1950,12 @@ interface WorkflowDefinitionGetResponse {
|
|
|
1891
1950
|
/** YAML as a string */
|
|
1892
1951
|
definition: string;
|
|
1893
1952
|
}
|
|
1953
|
+
/**
|
|
1954
|
+
* The workflow control variables
|
|
1955
|
+
*/
|
|
1956
|
+
type WorkflowGetResponseVariables = {
|
|
1957
|
+
[key: string]: unknown;
|
|
1958
|
+
};
|
|
1894
1959
|
/**
|
|
1895
1960
|
* The scope of the workflow.
|
|
1896
1961
|
*/
|
|
@@ -1933,6 +1998,8 @@ interface WorkflowGetResponse {
|
|
|
1933
1998
|
/** A list of validation errors. Only present if the workflow has been validated and errors were found.
|
|
1934
1999
|
*/
|
|
1935
2000
|
validation_error_msg?: string[];
|
|
2001
|
+
/** The workflow control variables */
|
|
2002
|
+
variables?: WorkflowGetResponseVariables;
|
|
1936
2003
|
/** The steps, if the Workflow has been validated and has no errors.
|
|
1937
2004
|
*/
|
|
1938
2005
|
steps?: WorkflowStepSummary[];
|
|
@@ -1989,7 +2056,7 @@ interface WorkflowGetAllResponse {
|
|
|
1989
2056
|
workflows: WorkflowSummary[];
|
|
1990
2057
|
}
|
|
1991
2058
|
interface VersionGetResponse {
|
|
1992
|
-
/**
|
|
2059
|
+
/** 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
|
|
1993
2060
|
*/
|
|
1994
2061
|
version: string;
|
|
1995
2062
|
}
|
|
@@ -2652,4 +2719,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
|
|
|
2652
2719
|
declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
|
|
2653
2720
|
type ErrorType<TError> = AxiosError<TError>;
|
|
2654
2721
|
|
|
2655
|
-
export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InputHandlerDetail, type InputHandlerGetResponse, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type PriorRunningWorkflowStep, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type RunningWorkflowGetAllResponse, type RunningWorkflowGetResponse, RunningWorkflowGetResponseStatus, type RunningWorkflowGetResponseVariables, type RunningWorkflowProject, type RunningWorkflowStep, RunningWorkflowStepStatus, type RunningWorkflowStepVariables, type RunningWorkflowStepsGetResponse, type RunningWorkflowSummary, RunningWorkflowSummaryStatus, type RunningWorkflowWorkflow, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, type WorkflowDefinitionGetResponse, type WorkflowGetAllResponse, type WorkflowGetResponse, WorkflowGetResponseScope, type WorkflowPatchBodyBody, type WorkflowPatchResponse, type WorkflowPostBodyBody, WorkflowPostBodyBodyScope, type WorkflowPostResponse, type WorkflowRunPostBodyBody, type WorkflowRunPostResponse, type WorkflowStepSummary, type WorkflowSummary, WorkflowSummaryScope, type WorkflowVersionPutBodyBody, type WorkflowVersionPutResponse, customInstance, setAuthToken, setBaseUrl };
|
|
2722
|
+
export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetRunningWorkflowsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InputHandlerDetail, type InputHandlerGetResponse, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type PriorRunningWorkflowStep, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, ProjectFileDetailProcessingStage, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type QWorkflowIdParameter, type RunningWorkflowGetAllResponse, type RunningWorkflowGetResponse, RunningWorkflowGetResponseStatus, type RunningWorkflowGetResponseVariables, type RunningWorkflowProject, type RunningWorkflowStep, RunningWorkflowStepStatus, type RunningWorkflowStepVariables, type RunningWorkflowStepsGetResponse, type RunningWorkflowSummary, RunningWorkflowSummaryStatus, type RunningWorkflowWorkflow, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, type WorkflowDefinitionGetResponse, type WorkflowGetAllResponse, type WorkflowGetResponse, WorkflowGetResponseScope, type WorkflowGetResponseVariables, type WorkflowPatchBodyBody, type WorkflowPatchResponse, type WorkflowPostBodyBody, WorkflowPostBodyBodyScope, type WorkflowPostResponse, type WorkflowRunPostBodyBody, type WorkflowRunPostResponse, type WorkflowStepSummary, type WorkflowStepSummarySpecification, type WorkflowSummary, WorkflowSummaryScope, type WorkflowVersionPutBodyBody, type WorkflowVersionPutResponse, customInstance, setAuthToken, setBaseUrl };
|
package/index.js
CHANGED
|
@@ -47,6 +47,14 @@ var ServiceErrorSummarySeverity = {
|
|
|
47
47
|
ERROR: "ERROR",
|
|
48
48
|
WARNING: "WARNING"
|
|
49
49
|
};
|
|
50
|
+
var ProjectFileDetailProcessingStage = {
|
|
51
|
+
COPYING: "COPYING",
|
|
52
|
+
FAILED: "FAILED",
|
|
53
|
+
FORMATTING: "FORMATTING",
|
|
54
|
+
LOADING: "LOADING",
|
|
55
|
+
DELETING: "DELETING",
|
|
56
|
+
DONE: "DONE"
|
|
57
|
+
};
|
|
50
58
|
var JobSummaryImageType = {
|
|
51
59
|
SIMPLE: "SIMPLE",
|
|
52
60
|
NEXTFLOW: "NEXTFLOW"
|
|
@@ -168,6 +176,7 @@ export {
|
|
|
168
176
|
InstanceTaskPurpose,
|
|
169
177
|
JobGetResponseImageType,
|
|
170
178
|
JobSummaryImageType,
|
|
179
|
+
ProjectFileDetailProcessingStage,
|
|
171
180
|
QPurposeParameter,
|
|
172
181
|
RunningWorkflowGetResponseStatus,
|
|
173
182
|
RunningWorkflowStepStatus,
|