@squonk/data-manager-client 1.2.9 → 2.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/accounting/accounting.cjs.map +1 -1
  2. package/accounting/accounting.js.map +1 -1
  3. package/admin/admin.cjs.map +1 -1
  4. package/admin/admin.js.map +1 -1
  5. package/application/application.cjs.map +1 -1
  6. package/application/application.js.map +1 -1
  7. package/configuration/configuration.cjs.map +1 -1
  8. package/configuration/configuration.js.map +1 -1
  9. package/dataset/dataset.cjs.map +1 -1
  10. package/dataset/dataset.js.map +1 -1
  11. package/exchange-rate/exchange-rate.cjs.map +1 -1
  12. package/exchange-rate/exchange-rate.js.map +1 -1
  13. package/file-and-path/file-and-path.cjs.map +1 -1
  14. package/file-and-path/file-and-path.d.cts +5 -5
  15. package/file-and-path/file-and-path.d.ts +5 -5
  16. package/file-and-path/file-and-path.js.map +1 -1
  17. package/index.cjs.map +1 -1
  18. package/index.d.cts +118 -37
  19. package/index.d.ts +118 -37
  20. package/index.js.map +1 -1
  21. package/instance/instance.cjs.map +1 -1
  22. package/instance/instance.js.map +1 -1
  23. package/inventory/inventory.cjs +56 -0
  24. package/inventory/inventory.cjs.map +1 -0
  25. package/inventory/inventory.d.cts +50 -0
  26. package/inventory/inventory.d.ts +50 -0
  27. package/inventory/inventory.js +56 -0
  28. package/inventory/inventory.js.map +1 -0
  29. package/inventory/package.json +7 -0
  30. package/job/job.cjs.map +1 -1
  31. package/job/job.js.map +1 -1
  32. package/metadata/metadata.cjs.map +1 -1
  33. package/metadata/metadata.js.map +1 -1
  34. package/package.json +1 -1
  35. package/project/project.cjs +49 -1
  36. package/project/project.cjs.map +1 -1
  37. package/project/project.d.cts +78 -10
  38. package/project/project.d.ts +78 -10
  39. package/project/project.js +48 -0
  40. package/project/project.js.map +1 -1
  41. package/src/accounting/accounting.ts +1 -1
  42. package/src/admin/admin.ts +1 -1
  43. package/src/application/application.ts +1 -1
  44. package/src/configuration/configuration.ts +1 -1
  45. package/src/data-manager-api.schemas.ts +133 -41
  46. package/src/dataset/dataset.ts +1 -1
  47. package/src/exchange-rate/exchange-rate.ts +1 -1
  48. package/src/file-and-path/file-and-path.ts +6 -6
  49. package/src/instance/instance.ts +1 -1
  50. package/src/inventory/inventory.ts +140 -0
  51. package/src/job/job.ts +1 -1
  52. package/src/metadata/metadata.ts +1 -1
  53. package/src/project/project.ts +122 -10
  54. package/src/task/task.ts +1 -1
  55. package/src/type/type.ts +1 -1
  56. package/src/user/user.ts +1 -1
  57. package/task/task.cjs.map +1 -1
  58. package/task/task.js.map +1 -1
  59. package/type/type.cjs.map +1 -1
  60. package/type/type.js.map +1 -1
  61. package/user/user.cjs.map +1 -1
  62. package/user/user.js.map +1 -1
package/index.d.cts CHANGED
@@ -9,8 +9,23 @@ import { AxiosRequestConfig, AxiosError } from 'axios';
9
9
 
10
10
  A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
11
11
 
12
- * OpenAPI spec version: 1.2
12
+ * OpenAPI spec version: 2.0
13
13
  */
14
+ type GetUserInventoryParams = {
15
+ /**
16
+ * An Organisation identity
17
+ */
18
+ org_id?: QOrgIdParameter;
19
+ /**
20
+ * A Unit identity
21
+ */
22
+ unit_id?: QUnitIdParameter;
23
+ /**
24
+ * A comma-separated list of usernames
25
+
26
+ */
27
+ usernames?: QUsernamesParameter;
28
+ };
14
29
  type AdminDeleteJobManifestParams = {
15
30
  /**
16
31
  * Purge unreferenced Jobs
@@ -29,11 +44,6 @@ type AdminGetUsersParams = {
29
44
  */
30
45
  active_days?: QActiveDaysParameter;
31
46
  };
32
- /**
33
- * Set to include acknowledged items
34
-
35
- */
36
- type QIncludeAcknowlegedParameter = boolean;
37
47
  type AdminGetServiceErrorsParams = {
38
48
  /**
39
49
  * Set to include acknowledged items
@@ -41,11 +51,6 @@ type AdminGetServiceErrorsParams = {
41
51
  */
42
52
  include_acknowleged?: QIncludeAcknowlegedParameter;
43
53
  };
44
- /**
45
- * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
46
-
47
- */
48
- type QFromParameter = string;
49
54
  type GetUserApiLogParams = {
50
55
  /**
51
56
  * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
@@ -104,7 +109,7 @@ type GetJobByVersionParams = {
104
109
  */
105
110
  collection: QJobCollectionParameter;
106
111
  /**
107
- * The Job, i.e. "nop"
112
+ * The Job, i.e. "coin-test"
108
113
 
109
114
  */
110
115
  job: QJobJobParameter;
@@ -180,20 +185,6 @@ type GetTasksParams = {
180
185
  */
181
186
  instance_callback_context?: QInstanceCallbackContextParameter;
182
187
  };
183
- /**
184
- * The Project identity
185
- */
186
- type QFileProjectIdParameter = string;
187
- /**
188
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
189
-
190
- */
191
- type QFilePathParameter = string;
192
- /**
193
- * A project file.
194
-
195
- */
196
- type QFileParameter = string;
197
188
  type DeleteUnmanagedFileParams = {
198
189
  /**
199
190
  * A project file.
@@ -254,12 +245,12 @@ type GetDatasetsParams = {
254
245
  */
255
246
  dataset_mime_type?: QDatasetMimeTypeParameter;
256
247
  /**
257
- * Filter the datasets by a comma separated list of owners
248
+ * A comma-separated list of owners
258
249
 
259
250
  */
260
251
  owners?: QOwnersParameter;
261
252
  /**
262
- * Filter the datasets by a comma separated list of editors
253
+ * A comma-separated list of editors
263
254
 
264
255
  */
265
256
  editors?: QEditorsParameter;
@@ -326,7 +317,7 @@ type CreatePathParams = {
326
317
  path?: QFilePathParameter;
327
318
  };
328
319
  /**
329
- * Filter the datasets by a comma separated list of editors
320
+ * A comma-separated list of editors
330
321
 
331
322
  */
332
323
  type QEditorsParameter = string;
@@ -335,10 +326,15 @@ type QEditorsParameter = string;
335
326
  */
336
327
  type QPurgeParameter = boolean;
337
328
  /**
338
- * Filter the datasets by a comma separated list of owners
329
+ * A comma-separated list of owners
339
330
 
340
331
  */
341
332
  type QOwnersParameter = string;
333
+ /**
334
+ * A comma-separated list of usernames
335
+
336
+ */
337
+ type QUsernamesParameter = string;
342
338
  /**
343
339
  * Filter the datasets by username
344
340
 
@@ -349,6 +345,10 @@ type QUsernameParameter = string;
349
345
 
350
346
  */
351
347
  type QUntilParameter = string;
348
+ /**
349
+ * A Unit identity
350
+ */
351
+ type QUnitIdParameter = string;
352
352
  /**
353
353
  * A token
354
354
  */
@@ -365,6 +365,10 @@ type QProjectNameParameter = string;
365
365
  * A Project identity
366
366
  */
367
367
  type QProjectIdParameter = string;
368
+ /**
369
+ * An Organisation identity
370
+ */
371
+ type QOrgIdParameter = string;
368
372
  /**
369
373
  * 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"}'
370
374
 
@@ -386,7 +390,7 @@ type QKeepProjectFilesParameter = boolean;
386
390
  */
387
391
  type QJobVersionParameter = string;
388
392
  /**
389
- * The Job, i.e. "nop"
393
+ * The Job, i.e. "coin-test"
390
394
 
391
395
  */
392
396
  type QJobJobParameter = string;
@@ -412,6 +416,30 @@ type QIncludeHiddenParameter = boolean;
412
416
  * Whether to include records that are deleted
413
417
  */
414
418
  type QIncludeDeletedParameter = boolean;
419
+ /**
420
+ * Set to include acknowledged items
421
+
422
+ */
423
+ type QIncludeAcknowlegedParameter = boolean;
424
+ /**
425
+ * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
426
+
427
+ */
428
+ type QFromParameter = string;
429
+ /**
430
+ * The Project identity
431
+ */
432
+ type QFileProjectIdParameter = string;
433
+ /**
434
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
435
+
436
+ */
437
+ type QFilePathParameter = string;
438
+ /**
439
+ * A project file.
440
+
441
+ */
442
+ type QFileParameter = string;
415
443
  /**
416
444
  * 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.
417
445
 
@@ -577,7 +605,7 @@ type InstancePostBodyBody = {
577
605
  project_id: string;
578
606
  /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
579
607
 
580
- 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"}`
608
+ 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":"coin-test","version":"1.0.0"}`
581
609
 
582
610
  Jobs that offer commands will often advertise a series of **inputs** and **options** where the values can be provided using a **variables** map in the specification. Something like `"variables":{"x":7}`.
583
611
 
@@ -919,7 +947,12 @@ interface ProjectFileDetail {
919
947
  project_id?: string;
920
948
  }
921
949
  interface ProjectDetail {
950
+ /** An administrator (user_id) of the project */
951
+ administrators: string[];
922
952
  created: string;
953
+ /** The user who created the project
954
+ */
955
+ creator: string;
923
956
  /** An editor (user_id) of the project */
924
957
  editors: string[];
925
958
  /** A list of managed files in the Project
@@ -933,10 +966,7 @@ interface ProjectDetail {
933
966
  /** The Account Server Organisation the Project Product Unit belongs to
934
967
  */
935
968
  organisation_id?: string;
936
- /** The project (owner) creator
937
- */
938
- owner: string;
939
- /** True if the project is private. Private projects are only visible to the owner and its editors.
969
+ /** True if the project is private. Private projects are only visible to editors.
940
970
  */
941
971
  private: boolean;
942
972
  /** The Account Server Product the Project belongs to
@@ -1502,6 +1532,23 @@ interface UserApiLogGetResponse {
1502
1532
  */
1503
1533
  api_log: ApiLogDetail[];
1504
1534
  }
1535
+ interface UserActivityDetail {
1536
+ /** A list of dates where the API has been used during the monitoring period. Dates are returned if when the activity is not 100% and active dates are present. Dates are listed in reverse chronological order (i.e. the most recent first)
1537
+ */
1538
+ active_dates?: string[];
1539
+ /** The number of days the API has been used
1540
+ */
1541
+ active_days: number;
1542
+ /** Active days, as a percentage, over the monitoring period.
1543
+ */
1544
+ activity: string;
1545
+ /** The number of days the API has not been used
1546
+ */
1547
+ inactive_days: number;
1548
+ /** The period over which the activity is monitored
1549
+ */
1550
+ monitoring_period: string;
1551
+ }
1505
1552
  type UserAccountGetResponse = UserAccountDetail;
1506
1553
  interface TypesGetResponse {
1507
1554
  /** A list of available MIME types
@@ -1663,6 +1710,35 @@ interface JobGetResponse {
1663
1710
  */
1664
1711
  version: string;
1665
1712
  }
1713
+ interface InventoryProjectDetail {
1714
+ id: string;
1715
+ name: string;
1716
+ unit_id: string;
1717
+ }
1718
+ interface InventoryDatasetDetail {
1719
+ filename: string;
1720
+ id: string;
1721
+ unit_id: string;
1722
+ version: number;
1723
+ }
1724
+ type InventoryUserDetailProjects = {
1725
+ administrator: InventoryProjectDetail[];
1726
+ editor: InventoryProjectDetail[];
1727
+ observer: InventoryProjectDetail[];
1728
+ };
1729
+ type InventoryUserDetailDatasets = {
1730
+ editor?: InventoryDatasetDetail[];
1731
+ owner?: InventoryDatasetDetail[];
1732
+ };
1733
+ interface InventoryUserDetail {
1734
+ activity: UserActivityDetail;
1735
+ datasets: InventoryUserDetailDatasets;
1736
+ f_uid: number;
1737
+ first_seen: string;
1738
+ last_seen_date: string;
1739
+ projects: InventoryUserDetailProjects;
1740
+ username: string;
1741
+ }
1666
1742
  type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
1667
1743
  declare const InstanceTaskPurpose: {
1668
1744
  readonly CREATE: "CREATE";
@@ -1994,6 +2070,11 @@ interface AdminJobManifestLoadPutResponse {
1994
2070
  */
1995
2071
  status: boolean;
1996
2072
  }
2073
+ interface InventoryUserGetResponse {
2074
+ /** The list of known Users
2075
+ */
2076
+ users: InventoryUserDetail[];
2077
+ }
1997
2078
  interface AdminJobManifestGetResponse {
1998
2079
  /** The list of known Job manifests
1999
2080
  */
@@ -2030,4 +2111,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
2030
2111
  declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
2031
2112
  type ErrorType<TError> = AxiosError<TError>;
2032
2113
 
2033
- 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 DatasetMetaGetResponseAnnotationsItem, type DatasetMetaGetResponseLabelsItem, 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 GetVersionsParams, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobGetResponseImageWorkingDirectory, 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 PatchInstanceParams, 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 QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowlegedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUntilParameter, type QUsernameParameter, 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 UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };
2114
+ 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 DatasetMetaGetResponseAnnotationsItem, type DatasetMetaGetResponseLabelsItem, 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 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 JobGetResponseImageWorkingDirectory, 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 PatchInstanceParams, 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 QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowlegedParameter, 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 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 UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };
package/index.d.ts CHANGED
@@ -9,8 +9,23 @@ import { AxiosRequestConfig, AxiosError } from 'axios';
9
9
 
10
10
  A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
11
11
 
12
- * OpenAPI spec version: 1.2
12
+ * OpenAPI spec version: 2.0
13
13
  */
14
+ type GetUserInventoryParams = {
15
+ /**
16
+ * An Organisation identity
17
+ */
18
+ org_id?: QOrgIdParameter;
19
+ /**
20
+ * A Unit identity
21
+ */
22
+ unit_id?: QUnitIdParameter;
23
+ /**
24
+ * A comma-separated list of usernames
25
+
26
+ */
27
+ usernames?: QUsernamesParameter;
28
+ };
14
29
  type AdminDeleteJobManifestParams = {
15
30
  /**
16
31
  * Purge unreferenced Jobs
@@ -29,11 +44,6 @@ type AdminGetUsersParams = {
29
44
  */
30
45
  active_days?: QActiveDaysParameter;
31
46
  };
32
- /**
33
- * Set to include acknowledged items
34
-
35
- */
36
- type QIncludeAcknowlegedParameter = boolean;
37
47
  type AdminGetServiceErrorsParams = {
38
48
  /**
39
49
  * Set to include acknowledged items
@@ -41,11 +51,6 @@ type AdminGetServiceErrorsParams = {
41
51
  */
42
52
  include_acknowleged?: QIncludeAcknowlegedParameter;
43
53
  };
44
- /**
45
- * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
46
-
47
- */
48
- type QFromParameter = string;
49
54
  type GetUserApiLogParams = {
50
55
  /**
51
56
  * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
@@ -104,7 +109,7 @@ type GetJobByVersionParams = {
104
109
  */
105
110
  collection: QJobCollectionParameter;
106
111
  /**
107
- * The Job, i.e. "nop"
112
+ * The Job, i.e. "coin-test"
108
113
 
109
114
  */
110
115
  job: QJobJobParameter;
@@ -180,20 +185,6 @@ type GetTasksParams = {
180
185
  */
181
186
  instance_callback_context?: QInstanceCallbackContextParameter;
182
187
  };
183
- /**
184
- * The Project identity
185
- */
186
- type QFileProjectIdParameter = string;
187
- /**
188
- * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
189
-
190
- */
191
- type QFilePathParameter = string;
192
- /**
193
- * A project file.
194
-
195
- */
196
- type QFileParameter = string;
197
188
  type DeleteUnmanagedFileParams = {
198
189
  /**
199
190
  * A project file.
@@ -254,12 +245,12 @@ type GetDatasetsParams = {
254
245
  */
255
246
  dataset_mime_type?: QDatasetMimeTypeParameter;
256
247
  /**
257
- * Filter the datasets by a comma separated list of owners
248
+ * A comma-separated list of owners
258
249
 
259
250
  */
260
251
  owners?: QOwnersParameter;
261
252
  /**
262
- * Filter the datasets by a comma separated list of editors
253
+ * A comma-separated list of editors
263
254
 
264
255
  */
265
256
  editors?: QEditorsParameter;
@@ -326,7 +317,7 @@ type CreatePathParams = {
326
317
  path?: QFilePathParameter;
327
318
  };
328
319
  /**
329
- * Filter the datasets by a comma separated list of editors
320
+ * A comma-separated list of editors
330
321
 
331
322
  */
332
323
  type QEditorsParameter = string;
@@ -335,10 +326,15 @@ type QEditorsParameter = string;
335
326
  */
336
327
  type QPurgeParameter = boolean;
337
328
  /**
338
- * Filter the datasets by a comma separated list of owners
329
+ * A comma-separated list of owners
339
330
 
340
331
  */
341
332
  type QOwnersParameter = string;
333
+ /**
334
+ * A comma-separated list of usernames
335
+
336
+ */
337
+ type QUsernamesParameter = string;
342
338
  /**
343
339
  * Filter the datasets by username
344
340
 
@@ -349,6 +345,10 @@ type QUsernameParameter = string;
349
345
 
350
346
  */
351
347
  type QUntilParameter = string;
348
+ /**
349
+ * A Unit identity
350
+ */
351
+ type QUnitIdParameter = string;
352
352
  /**
353
353
  * A token
354
354
  */
@@ -365,6 +365,10 @@ type QProjectNameParameter = string;
365
365
  * A Project identity
366
366
  */
367
367
  type QProjectIdParameter = string;
368
+ /**
369
+ * An Organisation identity
370
+ */
371
+ type QOrgIdParameter = string;
368
372
  /**
369
373
  * 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"}'
370
374
 
@@ -386,7 +390,7 @@ type QKeepProjectFilesParameter = boolean;
386
390
  */
387
391
  type QJobVersionParameter = string;
388
392
  /**
389
- * The Job, i.e. "nop"
393
+ * The Job, i.e. "coin-test"
390
394
 
391
395
  */
392
396
  type QJobJobParameter = string;
@@ -412,6 +416,30 @@ type QIncludeHiddenParameter = boolean;
412
416
  * Whether to include records that are deleted
413
417
  */
414
418
  type QIncludeDeletedParameter = boolean;
419
+ /**
420
+ * Set to include acknowledged items
421
+
422
+ */
423
+ type QIncludeAcknowlegedParameter = boolean;
424
+ /**
425
+ * A from (inclusive) date-time. If provided no API calls prior to this will be returned. UTC is assumed if no timezone is provided
426
+
427
+ */
428
+ type QFromParameter = string;
429
+ /**
430
+ * The Project identity
431
+ */
432
+ type QFileProjectIdParameter = string;
433
+ /**
434
+ * A project path. If provided it must begin `/` and refers to a path where `/` represents the project's root directory
435
+
436
+ */
437
+ type QFilePathParameter = string;
438
+ /**
439
+ * A project file.
440
+
441
+ */
442
+ type QFileParameter = string;
415
443
  /**
416
444
  * 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.
417
445
 
@@ -577,7 +605,7 @@ type InstancePostBodyBody = {
577
605
  project_id: string;
578
606
  /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
579
607
 
580
- 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"}`
608
+ 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":"coin-test","version":"1.0.0"}`
581
609
 
582
610
  Jobs that offer commands will often advertise a series of **inputs** and **options** where the values can be provided using a **variables** map in the specification. Something like `"variables":{"x":7}`.
583
611
 
@@ -919,7 +947,12 @@ interface ProjectFileDetail {
919
947
  project_id?: string;
920
948
  }
921
949
  interface ProjectDetail {
950
+ /** An administrator (user_id) of the project */
951
+ administrators: string[];
922
952
  created: string;
953
+ /** The user who created the project
954
+ */
955
+ creator: string;
923
956
  /** An editor (user_id) of the project */
924
957
  editors: string[];
925
958
  /** A list of managed files in the Project
@@ -933,10 +966,7 @@ interface ProjectDetail {
933
966
  /** The Account Server Organisation the Project Product Unit belongs to
934
967
  */
935
968
  organisation_id?: string;
936
- /** The project (owner) creator
937
- */
938
- owner: string;
939
- /** True if the project is private. Private projects are only visible to the owner and its editors.
969
+ /** True if the project is private. Private projects are only visible to editors.
940
970
  */
941
971
  private: boolean;
942
972
  /** The Account Server Product the Project belongs to
@@ -1502,6 +1532,23 @@ interface UserApiLogGetResponse {
1502
1532
  */
1503
1533
  api_log: ApiLogDetail[];
1504
1534
  }
1535
+ interface UserActivityDetail {
1536
+ /** A list of dates where the API has been used during the monitoring period. Dates are returned if when the activity is not 100% and active dates are present. Dates are listed in reverse chronological order (i.e. the most recent first)
1537
+ */
1538
+ active_dates?: string[];
1539
+ /** The number of days the API has been used
1540
+ */
1541
+ active_days: number;
1542
+ /** Active days, as a percentage, over the monitoring period.
1543
+ */
1544
+ activity: string;
1545
+ /** The number of days the API has not been used
1546
+ */
1547
+ inactive_days: number;
1548
+ /** The period over which the activity is monitored
1549
+ */
1550
+ monitoring_period: string;
1551
+ }
1505
1552
  type UserAccountGetResponse = UserAccountDetail;
1506
1553
  interface TypesGetResponse {
1507
1554
  /** A list of available MIME types
@@ -1663,6 +1710,35 @@ interface JobGetResponse {
1663
1710
  */
1664
1711
  version: string;
1665
1712
  }
1713
+ interface InventoryProjectDetail {
1714
+ id: string;
1715
+ name: string;
1716
+ unit_id: string;
1717
+ }
1718
+ interface InventoryDatasetDetail {
1719
+ filename: string;
1720
+ id: string;
1721
+ unit_id: string;
1722
+ version: number;
1723
+ }
1724
+ type InventoryUserDetailProjects = {
1725
+ administrator: InventoryProjectDetail[];
1726
+ editor: InventoryProjectDetail[];
1727
+ observer: InventoryProjectDetail[];
1728
+ };
1729
+ type InventoryUserDetailDatasets = {
1730
+ editor?: InventoryDatasetDetail[];
1731
+ owner?: InventoryDatasetDetail[];
1732
+ };
1733
+ interface InventoryUserDetail {
1734
+ activity: UserActivityDetail;
1735
+ datasets: InventoryUserDetailDatasets;
1736
+ f_uid: number;
1737
+ first_seen: string;
1738
+ last_seen_date: string;
1739
+ projects: InventoryUserDetailProjects;
1740
+ username: string;
1741
+ }
1666
1742
  type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
1667
1743
  declare const InstanceTaskPurpose: {
1668
1744
  readonly CREATE: "CREATE";
@@ -1994,6 +2070,11 @@ interface AdminJobManifestLoadPutResponse {
1994
2070
  */
1995
2071
  status: boolean;
1996
2072
  }
2073
+ interface InventoryUserGetResponse {
2074
+ /** The list of known Users
2075
+ */
2076
+ users: InventoryUserDetail[];
2077
+ }
1997
2078
  interface AdminJobManifestGetResponse {
1998
2079
  /** The list of known Job manifests
1999
2080
  */
@@ -2030,4 +2111,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
2030
2111
  declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
2031
2112
  type ErrorType<TError> = AxiosError<TError>;
2032
2113
 
2033
- 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 DatasetMetaGetResponseAnnotationsItem, type DatasetMetaGetResponseLabelsItem, 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 GetVersionsParams, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobGetResponseImageWorkingDirectory, 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 PatchInstanceParams, 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 QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowlegedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUntilParameter, type QUsernameParameter, 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 UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };
2114
+ 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 DatasetMetaGetResponseAnnotationsItem, type DatasetMetaGetResponseLabelsItem, 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 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 JobGetResponseImageWorkingDirectory, 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 PatchInstanceParams, 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 QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowlegedParameter, 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 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 UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };