@squonk/data-manager-client 3.3.0 → 3.3.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.map +1 -1
  2. package/accounting/accounting.d.cts +25 -25
  3. package/accounting/accounting.d.ts +25 -25
  4. package/accounting/accounting.js.map +1 -1
  5. package/admin/admin.cjs +16 -8
  6. package/admin/admin.cjs.map +1 -1
  7. package/admin/admin.d.cts +73 -73
  8. package/admin/admin.d.ts +73 -73
  9. package/admin/admin.js +16 -8
  10. package/admin/admin.js.map +1 -1
  11. package/application/application.cjs +1 -1
  12. package/application/application.cjs.map +1 -1
  13. package/application/application.d.cts +17 -17
  14. package/application/application.d.ts +17 -17
  15. package/application/application.js +1 -1
  16. package/application/application.js.map +1 -1
  17. package/configuration/configuration.cjs.map +1 -1
  18. package/configuration/configuration.d.cts +9 -9
  19. package/configuration/configuration.d.ts +9 -9
  20. package/configuration/configuration.js.map +1 -1
  21. package/dataset/dataset.cjs +16 -10
  22. package/dataset/dataset.cjs.map +1 -1
  23. package/dataset/dataset.d.cts +64 -64
  24. package/dataset/dataset.d.ts +64 -64
  25. package/dataset/dataset.js +16 -10
  26. package/dataset/dataset.js.map +1 -1
  27. package/digest/digest.cjs +1 -1
  28. package/digest/digest.cjs.map +1 -1
  29. package/digest/digest.d.cts +9 -9
  30. package/digest/digest.d.ts +9 -9
  31. package/digest/digest.js +1 -1
  32. package/digest/digest.js.map +1 -1
  33. package/exchange-rate/exchange-rate.cjs +6 -4
  34. package/exchange-rate/exchange-rate.cjs.map +1 -1
  35. package/exchange-rate/exchange-rate.d.cts +45 -45
  36. package/exchange-rate/exchange-rate.d.ts +45 -45
  37. package/exchange-rate/exchange-rate.js +6 -4
  38. package/exchange-rate/exchange-rate.js.map +1 -1
  39. package/file-and-path/file-and-path.cjs +18 -10
  40. package/file-and-path/file-and-path.cjs.map +1 -1
  41. package/file-and-path/file-and-path.d.cts +60 -60
  42. package/file-and-path/file-and-path.d.ts +60 -60
  43. package/file-and-path/file-and-path.js +18 -10
  44. package/file-and-path/file-and-path.js.map +1 -1
  45. package/index.cjs +8 -8
  46. package/index.cjs.map +1 -1
  47. package/index.d.cts +537 -537
  48. package/index.d.ts +537 -537
  49. package/index.js +8 -8
  50. package/index.js.map +1 -1
  51. package/instance/instance.cjs +17 -10
  52. package/instance/instance.cjs.map +1 -1
  53. package/instance/instance.d.cts +49 -49
  54. package/instance/instance.d.ts +49 -49
  55. package/instance/instance.js +17 -10
  56. package/instance/instance.js.map +1 -1
  57. package/inventory/inventory.cjs.map +1 -1
  58. package/inventory/inventory.d.cts +9 -9
  59. package/inventory/inventory.d.ts +9 -9
  60. package/inventory/inventory.js.map +1 -1
  61. package/job/job.cjs +1 -1
  62. package/job/job.cjs.map +1 -1
  63. package/job/job.d.cts +25 -25
  64. package/job/job.d.ts +25 -25
  65. package/job/job.js +1 -1
  66. package/job/job.js.map +1 -1
  67. package/metadata/metadata.cjs +12 -8
  68. package/metadata/metadata.cjs.map +1 -1
  69. package/metadata/metadata.d.cts +31 -31
  70. package/metadata/metadata.d.ts +31 -31
  71. package/metadata/metadata.js +12 -8
  72. package/metadata/metadata.js.map +1 -1
  73. package/package.json +11 -11
  74. package/project/project.cjs +26 -15
  75. package/project/project.cjs.map +1 -1
  76. package/project/project.d.cts +94 -94
  77. package/project/project.d.ts +94 -94
  78. package/project/project.js +26 -15
  79. package/project/project.js.map +1 -1
  80. package/src/accounting/accounting.ts +38 -37
  81. package/src/admin/admin.ts +142 -101
  82. package/src/application/application.ts +26 -25
  83. package/src/configuration/configuration.ts +14 -13
  84. package/src/data-manager-api.schemas.ts +545 -545
  85. package/src/dataset/dataset.ts +118 -91
  86. package/src/digest/digest.ts +14 -13
  87. package/src/exchange-rate/exchange-rate.ts +76 -65
  88. package/src/file-and-path/file-and-path.ts +120 -83
  89. package/src/instance/instance.ts +97 -69
  90. package/src/inventory/inventory.ts +14 -13
  91. package/src/job/job.ts +38 -37
  92. package/src/metadata/metadata.ts +58 -45
  93. package/src/project/project.ts +183 -131
  94. package/src/task/task.ts +39 -33
  95. package/src/type/type.ts +14 -13
  96. package/src/user/user.ts +51 -45
  97. package/task/task.cjs +3 -2
  98. package/task/task.cjs.map +1 -1
  99. package/task/task.d.cts +23 -23
  100. package/task/task.d.ts +23 -23
  101. package/task/task.js +3 -2
  102. package/task/task.js.map +1 -1
  103. package/type/type.cjs.map +1 -1
  104. package/type/type.d.cts +9 -9
  105. package/type/type.d.ts +9 -9
  106. package/type/type.js.map +1 -1
  107. package/user/user.cjs +2 -1
  108. package/user/user.cjs.map +1 -1
  109. package/user/user.d.cts +31 -31
  110. package/user/user.d.ts +31 -31
  111. package/user/user.js +2 -1
  112. package/user/user.js.map +1 -1
package/index.d.ts CHANGED
@@ -2,7 +2,7 @@ import * as axios from 'axios';
2
2
  import { AxiosRequestConfig, AxiosError } from 'axios';
3
3
 
4
4
  /**
5
- * Generated by orval v7.2.0 🍺
5
+ * Generated by orval v7.4.1 🍺
6
6
  * Do not edit manually.
7
7
  * Dataset Manager API
8
8
  * The Dataset Manager API service.
@@ -565,6 +565,9 @@ type UserPatchBodyBody = {
565
565
  suspend_message?: string;
566
566
  };
567
567
  type UserAccountPatchBodyBody = {
568
+ /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
569
+ */
570
+ private?: boolean;
568
571
  /** 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
569
572
  */
570
573
  become_admin?: boolean;
@@ -575,9 +578,6 @@ type UserAccountPatchBodyBody = {
575
578
  * @pattern ^(\w(?:\w*(?:[@.-]\w+)?)*|)$
576
579
  */
577
580
  impersonate?: string;
578
- /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
579
- */
580
- private?: boolean;
581
581
  /** 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`
582
582
  */
583
583
  use_impersonation?: boolean;
@@ -599,12 +599,13 @@ type ProjectPostBodyBody = {
599
599
  tier_product_id: string;
600
600
  };
601
601
  type ProjectPatchBodyBody = {
602
+ private?: boolean;
602
603
  /** The new name of the ptojct
603
604
  */
604
605
  name?: string;
605
- private?: boolean;
606
606
  };
607
607
  type ProjectFilePutBodyBody = {
608
+ file: Blob;
608
609
  /**
609
610
  * An alternative filename to use for the uploaded File
610
611
 
@@ -612,7 +613,6 @@ type ProjectFilePutBodyBody = {
612
613
  * @maxLength 128
613
614
  */
614
615
  as_filename?: string;
615
- file: Blob;
616
616
  /**
617
617
  * The Project path of the file.
618
618
 
@@ -623,17 +623,19 @@ type ProjectFilePutBodyBody = {
623
623
  path?: string;
624
624
  };
625
625
  type ExchangeRatePutBodyBody = {
626
+ /** 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.
627
+ */
628
+ rate: string;
626
629
  /**
627
630
  * A brief comment relating to the new rate
628
631
 
629
632
  * @maxLength 80
630
633
  */
631
634
  comment?: string;
632
- /** 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.
633
- */
634
- rate: string;
635
635
  };
636
636
  type JobManifestPutBodyBody = {
637
+ /** The URL of the Job Manifest */
638
+ url: string;
637
639
  /**
638
640
  * Optional URL header values (a JSON string)
639
641
  * @pattern ^|{.*}$
@@ -644,8 +646,6 @@ type JobManifestPutBodyBody = {
644
646
  * @pattern ^|{.*}$
645
647
  */
646
648
  params?: string;
647
- /** The URL of the Job Manifest */
648
- url: string;
649
649
  };
650
650
  type InstancePostBodyBody = {
651
651
  /**
@@ -657,6 +657,12 @@ type InstancePostBodyBody = {
657
657
  * @maxLength 80
658
658
  */
659
659
  application_id: string;
660
+ /**
661
+ * The project to attach
662
+
663
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
664
+ */
665
+ project_id: string;
660
666
  /**
661
667
  * The name to use for the instance
662
668
 
@@ -665,6 +671,9 @@ type InstancePostBodyBody = {
665
671
  * @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_. ]*[A-Za-z0-9]+$
666
672
  */
667
673
  as_name: string;
674
+ /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
675
+ */
676
+ callback_url?: string;
668
677
  /**
669
678
  * 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
670
679
 
@@ -672,6 +681,13 @@ type InstancePostBodyBody = {
672
681
  * @maxLength 256
673
682
  */
674
683
  callback_context?: string;
684
+ /** 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.
685
+
686
+ 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.
687
+
688
+ Tokens should therefore be revoked when they're no longer required
689
+ */
690
+ generate_callback_token?: boolean;
675
691
  /**
676
692
  * 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.
677
693
 
@@ -682,9 +698,6 @@ type InstancePostBodyBody = {
682
698
  * @pattern ^[2-9A-HJ-NP-Za-km-z]{22}$
683
699
  */
684
700
  callback_token?: string;
685
- /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
686
- */
687
- callback_url?: string;
688
701
  /** A debug value that may be used by the instance.
689
702
 
690
703
  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.
@@ -692,19 +705,6 @@ type InstancePostBodyBody = {
692
705
  The behaviour of **Application** instances using this property is undefined. It will depend on whether the application **CRD** handles the Data Manager debug field.
693
706
  */
694
707
  debug?: string;
695
- /** 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.
696
-
697
- 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.
698
-
699
- Tokens should therefore be revoked when they're no longer required
700
- */
701
- generate_callback_token?: boolean;
702
- /**
703
- * The project to attach
704
-
705
- * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
706
- */
707
- project_id: string;
708
708
  /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
709
709
 
710
710
  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"}`
@@ -718,12 +718,6 @@ type InstancePostBodyBody = {
718
718
  specification?: string;
719
719
  };
720
720
  type FilePostBodyBody = {
721
- /** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
722
- */
723
- as_type: string;
724
- /** 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
725
- */
726
- compress?: boolean;
727
721
  /**
728
722
  * The Dataset UUID for the File that you intend to attach
729
723
 
@@ -736,9 +730,15 @@ type FilePostBodyBody = {
736
730
  * @minimum 1
737
731
  */
738
732
  dataset_version: number;
739
- /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
733
+ /**
734
+ * The Project UUID you're attaching to
735
+
736
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
737
+ */
738
+ project_id: string;
739
+ /** The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset
740
740
  */
741
- immutable?: boolean;
741
+ as_type: string;
742
742
  /**
743
743
  * A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
744
744
 
@@ -746,33 +746,29 @@ type FilePostBodyBody = {
746
746
  * @pattern ^/.+$|^/$
747
747
  */
748
748
  path?: string;
749
- /**
750
- * The Project UUID you're attaching to
751
-
752
- * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
753
- */
754
- project_id: string;
749
+ /** 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
750
+ */
751
+ compress?: boolean;
752
+ /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
753
+ */
754
+ immutable?: boolean;
755
755
  };
756
756
  type DatasetPutBodyBody = {
757
- /**
758
- * 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.
759
-
760
- * @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
761
- */
762
- dataset_id?: string;
763
757
  /** The MIME type of the Dataset
764
758
  */
765
759
  dataset_type: string;
766
- /**
767
- * The file name of the file in the Project path to load as a new Dataset.
768
-
769
- * @minLength 1
770
- * @maxLength 128
771
- */
772
- file_name: string;
773
760
  /** 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.
774
761
  */
775
762
  format_extra_variables?: string;
763
+ /** 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
764
+ */
765
+ skip_molecule_load?: boolean;
766
+ /**
767
+ * The Project the file belongs to
768
+
769
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
770
+ */
771
+ project_id: string;
776
772
  /**
777
773
  * The Project path of the file.
778
774
 
@@ -782,14 +778,18 @@ type DatasetPutBodyBody = {
782
778
  */
783
779
  path: string;
784
780
  /**
785
- * The Project the file belongs to
781
+ * The file name of the file in the Project path to load as a new Dataset.
786
782
 
787
- * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
783
+ * @minLength 1
784
+ * @maxLength 128
788
785
  */
789
- project_id: string;
790
- /** 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
791
- */
792
- skip_molecule_load?: boolean;
786
+ file_name: string;
787
+ /**
788
+ * 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.
789
+
790
+ * @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
791
+ */
792
+ dataset_id?: string;
793
793
  /**
794
794
  * The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
795
795
 
@@ -798,22 +798,32 @@ type DatasetPutBodyBody = {
798
798
  unit_id?: string;
799
799
  };
800
800
  type DatasetVersionMetaPostBodyBody = {
801
+ /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
802
+ */
803
+ meta_properties?: string;
801
804
  /** 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.
802
805
  */
803
806
  annotations?: string;
807
+ };
808
+ type DatasetMetaPostBodyBody = {
804
809
  /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
805
810
  */
806
811
  meta_properties?: string;
807
- };
808
- type DatasetMetaPostBodyBody = {
809
812
  /** 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.
810
813
  */
811
814
  labels?: string;
812
- /** JSON string containing a list of parameter changes to the metadata. Only the description is currently allowed.
813
- */
814
- meta_properties?: string;
815
815
  };
816
816
  type DatasetPostBodyBody = {
817
+ dataset_file: Blob;
818
+ /** 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.
819
+ */
820
+ dataset_type: string;
821
+ /** 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.
822
+ */
823
+ format_extra_variables?: string;
824
+ /** 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
825
+ */
826
+ skip_molecule_load?: boolean;
817
827
  /**
818
828
  * An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
819
829
 
@@ -821,22 +831,12 @@ type DatasetPostBodyBody = {
821
831
  * @maxLength 128
822
832
  */
823
833
  as_filename?: string;
824
- dataset_file: Blob;
825
834
  /**
826
835
  * 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.
827
836
 
828
837
  * @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
829
838
  */
830
839
  dataset_id?: string;
831
- /** 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.
832
- */
833
- dataset_type: string;
834
- /** 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.
835
- */
836
- format_extra_variables?: string;
837
- /** 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
838
- */
839
- skip_molecule_load?: boolean;
840
840
  /**
841
841
  * The Organisational Unit you want the Dataset to belong to
842
842
 
@@ -845,20 +845,20 @@ type DatasetPostBodyBody = {
845
845
  unit_id: string;
846
846
  };
847
847
  interface AsAdditionalDataProcessingCharge {
848
- collateral_cpu_hours?: string;
849
- collateral_pod_count?: number;
850
848
  cost: string;
851
- cost_scale_factor: string;
852
849
  cost_to_coins_er: string;
853
- error_message?: string;
850
+ cost_scale_factor: string;
854
851
  instance_id: string;
855
852
  instance_name: string;
853
+ started: string;
854
+ stopped?: string;
855
+ run_time?: string;
856
+ error_message?: string;
856
857
  job_collection?: string;
857
858
  job_job?: string;
858
859
  job_version?: string;
859
- run_time?: string;
860
- started: string;
861
- stopped?: string;
860
+ collateral_pod_count?: number;
861
+ collateral_cpu_hours?: string;
862
862
  }
863
863
  interface UserSummary {
864
864
  /** The user's preferred username
@@ -866,18 +866,15 @@ interface UserSummary {
866
866
  username: string;
867
867
  }
868
868
  interface UserDetail {
869
- /** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
869
+ /** The user's preferred username
870
870
  */
871
- become_admin?: boolean;
871
+ username: string;
872
872
  /** The user's filesystem user uid
873
873
  */
874
874
  f_uid?: number;
875
875
  /** The date and time the user was first seen (an ISO-8601 formatted string in UTC)
876
876
  */
877
877
  first_seen?: string;
878
- /** For admin accounts, whether the user is impersonating another user
879
- */
880
- impersonate?: string;
881
878
  /** The date the user was last seen
882
879
  */
883
880
  last_seen_date?: string;
@@ -890,16 +887,19 @@ interface UserDetail {
890
887
  /** If the account is suspended this typically displays a reason for suspension
891
888
  */
892
889
  suspension_message?: string;
893
- /** The user's preferred username
890
+ /** For admin accounts, whether the user is acting in an administrative capacity, i.e. acting as everyone
894
891
  */
895
- username: string;
892
+ become_admin?: boolean;
893
+ /** For admin accounts, whether the user is impersonating another user
894
+ */
895
+ impersonate?: string;
896
896
  }
897
897
  interface UserAccountDetail {
898
+ user: UserDetail;
898
899
  /** Whether the caller has admin privilege */
899
900
  caller_has_admin_privilege: boolean;
900
901
  /** The Data Manager roles the user has */
901
902
  data_manager_roles: string[];
902
- user: UserDetail;
903
903
  }
904
904
  /**
905
905
  * The Schema type (an object)
@@ -914,33 +914,33 @@ declare const TypeSummaryFormatterOptionsType: {
914
914
 
915
915
  */
916
916
  type TypeSummaryFormatterOptions = {
917
- /** Required properties
918
- */
919
- required: string[];
920
917
  /** The title of the Formatter object
921
918
  */
922
919
  title: string;
923
920
  /** The Schema type (an object)
924
921
  */
925
922
  type: TypeSummaryFormatterOptionsType;
923
+ /** Required properties
924
+ */
925
+ required: string[];
926
926
  [key: string]: unknown;
927
927
  };
928
928
  interface TypeSummary {
929
+ /** The File Type MIME
930
+ */
931
+ mime: string;
929
932
  /** 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`).
930
933
  */
931
934
  file_extensions: string[];
932
935
  /** 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.
933
936
  */
934
937
  formatter_image?: string;
935
- /** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
936
- */
937
- formatter_options?: TypeSummaryFormatterOptions;
938
938
  /** True if Datasets uploaded using this type's support loading of data into the Data Manager data-base.
939
939
  */
940
940
  formatter_supports_db_load?: boolean;
941
- /** The File Type MIME
941
+ /** If present, contains the formatter_options that can be entered in the format_extra_variables field in the POST /dataset api.
942
942
  */
943
- mime: string;
943
+ formatter_options?: TypeSummaryFormatterOptions;
944
944
  }
945
945
  /**
946
946
  * 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
@@ -956,24 +956,24 @@ declare const TaskSummaryProcessingStage: {
956
956
  readonly DONE: "DONE";
957
957
  };
958
958
  interface TaskSummary {
959
+ /** The Task UUID
960
+ */
961
+ id: string;
962
+ /** If a container image is launched by the task the image name is available here
963
+ */
964
+ image?: string;
959
965
  /** The date and time the task was created
960
966
  */
961
967
  created: string;
962
968
  /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
963
969
  */
964
970
  done: boolean;
971
+ /** True if the Task relates to an object removal, i.e. a DELETE
972
+ */
973
+ removal?: boolean;
965
974
  /** Present when `done` and zero if the task finished successfully.
966
975
  */
967
976
  exit_code?: number;
968
- /** The Task UUID
969
- */
970
- id: string;
971
- /** If a container image is launched by the task the image name is available here
972
- */
973
- image?: string;
974
- /** 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
975
- */
976
- processing_stage?: TaskSummaryProcessingStage;
977
977
  /** 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_.
978
978
  */
979
979
  purpose: string;
@@ -983,9 +983,9 @@ interface TaskSummary {
983
983
  /** The related object version for the Task purpose. This field will only be set if the **purpose** is `DATASET`.
984
984
  */
985
985
  purpose_version?: number;
986
- /** True if the Task relates to an object removal, i.e. a DELETE
986
+ /** 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
987
987
  */
988
- removal?: boolean;
988
+ processing_stage?: TaskSummaryProcessingStage;
989
989
  }
990
990
  /**
991
991
  * The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
@@ -1000,12 +1000,12 @@ declare const TaskStateState: {
1000
1000
  readonly FAILURE: "FAILURE";
1001
1001
  };
1002
1002
  interface TaskState {
1003
- /** A short message accompanying the state, generally only found when the state is `FAILURE`
1004
- */
1005
- message?: string;
1006
1003
  /** The task state. The typical state sequence is `PENDING`, then `STARTED` and finally `SUCCESS`
1007
1004
  */
1008
1005
  state: TaskStateState;
1006
+ /** A short message accompanying the state, generally only found when the state is `FAILURE`
1007
+ */
1008
+ message?: string;
1009
1009
  /** The date and time of the state change
1010
1010
  */
1011
1011
  time: string;
@@ -1026,15 +1026,15 @@ declare const TaskEventLevel: {
1026
1026
  readonly DEBUG: "DEBUG";
1027
1027
  };
1028
1028
  interface TaskEvent {
1029
- /** The level of the message, a typical logging framework value
1029
+ /** The event sequence number. The first event is always '1'.
1030
1030
  */
1031
- level: TaskEventLevel;
1031
+ ordinal: number;
1032
1032
  /** A short message.
1033
1033
  */
1034
1034
  message: string;
1035
- /** The event sequence number. The first event is always '1'.
1035
+ /** The level of the message, a typical logging framework value
1036
1036
  */
1037
- ordinal: number;
1037
+ level: TaskEventLevel;
1038
1038
  /** The date and time the event was generated
1039
1039
  */
1040
1040
  time: string;
@@ -1046,16 +1046,16 @@ declare const ServiceErrorSummarySeverity: {
1046
1046
  readonly WARNING: "WARNING";
1047
1047
  };
1048
1048
  interface ServiceErrorSummary {
1049
- acknowledged: boolean;
1050
- acknowledged_at?: string;
1051
- acknowledging_user?: string;
1052
- created: string;
1053
- error_code?: number;
1054
- hostname: string;
1055
1049
  id: number;
1050
+ created: string;
1051
+ summary: string;
1056
1052
  severity: ServiceErrorSummarySeverity;
1053
+ hostname: string;
1054
+ error_code?: number;
1057
1055
  stack_trace: string;
1058
- summary: string;
1056
+ acknowledged: boolean;
1057
+ acknowledged_at?: string;
1058
+ acknowledging_user?: string;
1059
1059
  }
1060
1060
  interface ProjectFileDetail {
1061
1061
  /** The code obtained from the Account Server
@@ -1079,50 +1079,50 @@ interface ProjectFileDetail {
1079
1079
  /** True if the ProjectFile cannot be modified while in the Project
1080
1080
  */
1081
1081
  immutable: boolean;
1082
- /** The ProjectFile MIME type
1083
- */
1084
- mime_type: string;
1085
1082
  /** The owner of the ProjectFile. This is the user that added the Dataset (as this file) to the Project
1086
1083
  */
1087
1084
  owner: string;
1088
1085
  /** The Project the ProjectFile belongs to
1089
1086
  */
1090
1087
  project_id?: string;
1088
+ /** The ProjectFile MIME type
1089
+ */
1090
+ mime_type: string;
1091
1091
  }
1092
1092
  interface ProjectDetail {
1093
- /** An administrator (user_id) of the project */
1094
- administrators: string[];
1095
- created: string;
1096
- /** The user who created the project
1093
+ /** The project name
1097
1094
  */
1098
- creator: string;
1099
- /** An editor (user_id) of the project */
1100
- editors: string[];
1101
- /** A list of managed files in the Project
1095
+ name: string;
1096
+ /** The project unique reference
1102
1097
  */
1103
- files?: ProjectFileDetail[];
1104
- /** The project name
1098
+ project_id: string;
1099
+ /** The user who created the project
1105
1100
  */
1106
- name: string;
1107
- /** An observer (user_id) of the project */
1108
- observers: string[];
1101
+ creator: string;
1102
+ created: string;
1103
+ /** The Account Server Product the Project belongs to
1104
+ */
1105
+ product_id?: string;
1109
1106
  /** The Account Server Organisation the Project Product Unit belongs to
1110
1107
  */
1111
1108
  organisation_id?: string;
1109
+ /** The Account Server Unit the Project Product belongs to
1110
+ */
1111
+ unit_id?: string;
1112
1112
  /** True if the project is private. Private projects are only visible to editors.
1113
1113
  */
1114
1114
  private: boolean;
1115
- /** The Account Server Product the Project belongs to
1116
- */
1117
- product_id?: string;
1118
- /** The project unique reference
1119
- */
1120
- project_id: string;
1115
+ /** An administrator (user_id) of the project */
1116
+ administrators: string[];
1117
+ /** An editor (user_id) of the project */
1118
+ editors: string[];
1119
+ /** An observer (user_id) of the project */
1120
+ observers: string[];
1121
1121
  /** 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 */
1122
1122
  size: number;
1123
- /** The Account Server Unit the Project Product belongs to
1123
+ /** A list of managed files in the Project
1124
1124
  */
1125
- unit_id?: string;
1125
+ files?: ProjectFileDetail[];
1126
1126
  }
1127
1127
  interface JobReplacement {
1128
1128
  collection: string;
@@ -1137,17 +1137,17 @@ interface JobOrderDetail {
1137
1137
  options: string[];
1138
1138
  }
1139
1139
  /**
1140
- * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1140
+ * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1141
1141
 
1142
1142
  */
1143
- type JobVariablesOutputs = {
1143
+ type JobVariablesOptions = {
1144
1144
  [key: string]: unknown;
1145
1145
  };
1146
1146
  /**
1147
- * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1147
+ * The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1148
1148
 
1149
1149
  */
1150
- type JobVariablesOptions = {
1150
+ type JobVariablesOutputs = {
1151
1151
  [key: string]: unknown;
1152
1152
  };
1153
1153
  /**
@@ -1158,16 +1158,16 @@ type JobVariablesInputs = {
1158
1158
  [key: string]: unknown;
1159
1159
  };
1160
1160
  interface JobVariables {
1161
+ order?: JobOrderDetail;
1161
1162
  /** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
1162
1163
  */
1163
1164
  inputs?: JobVariablesInputs;
1164
- /** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1165
- */
1166
- options?: JobVariablesOptions;
1167
- order?: JobOrderDetail;
1168
1165
  /** The Job command's outputs. The JSONSchema for the command's inputs, essentially the **variables/outputs** block of the Job's JobDefinition.
1169
1166
  */
1170
1167
  outputs?: JobVariablesOutputs;
1168
+ /** The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1169
+ */
1170
+ options?: JobVariablesOptions;
1171
1171
  }
1172
1172
  /**
1173
1173
  * 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)
@@ -1179,83 +1179,83 @@ declare const JobSummaryImageType: {
1179
1179
  readonly NEXTFLOW: "NEXTFLOW";
1180
1180
  };
1181
1181
  interface JobSummary {
1182
- /** The Job's category
1182
+ /** The Job's unique ID
1183
1183
  */
1184
- category?: string;
1184
+ id: number;
1185
1185
  /** The Job namespace
1186
1186
  */
1187
1187
  collection: string;
1188
- /** The description of the job in English
1189
- */
1190
- description?: string;
1191
- /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1192
- */
1193
- disabled: boolean;
1194
- /** A reason why the Job has been disabled.
1195
- */
1196
- disabled_reason?: string;
1197
- /** 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).
1198
-
1199
- Where there is no remedy for a given reason the remedy will be "There is no remedy".
1200
- */
1201
- disabled_remedy?: string;
1202
- /** A URL linking to the Job documentation
1188
+ /** The Job name, unique within a given namespace
1203
1189
  */
1204
- doc_url?: string;
1205
- /** The Job's unique ID
1190
+ job: string;
1191
+ /** The Job version
1206
1192
  */
1207
- id: number;
1193
+ version: string;
1208
1194
  /** 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)
1209
1195
  */
1210
1196
  image_type: JobSummaryImageType;
1211
- /** The Job name, unique within a given namespace
1197
+ /** The Job's category
1212
1198
  */
1213
- job: string;
1199
+ category?: string;
1214
1200
  /** The list of keywords assigned to the Job
1215
1201
  */
1216
1202
  keywords?: string[];
1217
- /** 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.
1218
- */
1219
- missing_assets?: string[];
1220
1203
  /** The name of the job in English
1221
1204
  */
1222
1205
  name: string;
1223
- replaced_by?: JobReplacements;
1224
- replaces?: JobReplacements;
1206
+ /** The description of the job in English
1207
+ */
1208
+ description?: string;
1209
+ /** A URL linking to the Job documentation
1210
+ */
1211
+ doc_url?: string;
1225
1212
  /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1226
1213
  */
1227
1214
  required_assets: string[];
1228
- /** The Job version
1215
+ /** 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.
1229
1216
  */
1230
- version: string;
1217
+ missing_assets?: string[];
1218
+ /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1219
+ */
1220
+ disabled: boolean;
1221
+ /** A reason why the Job has been disabled.
1222
+ */
1223
+ disabled_reason?: string;
1224
+ /** 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).
1225
+
1226
+ Where there is no remedy for a given reason the remedy will be "There is no remedy".
1227
+ */
1228
+ disabled_remedy?: string;
1229
+ replaces?: JobReplacements;
1230
+ replaced_by?: JobReplacements;
1231
1231
  }
1232
1232
  interface JobManifestDetail {
1233
+ /** The Job Manifest record ID */
1234
+ id: number;
1235
+ url: string;
1236
+ header?: string;
1237
+ params?: string;
1233
1238
  /** The Date (and time) the manifest was created
1234
1239
  */
1235
1240
  created: string;
1236
1241
  /** The (admin) user who created the manifest
1237
1242
  */
1238
1243
  creator?: string;
1239
- header?: string;
1240
- /** The Job Manifest record ID */
1241
- id: number;
1242
1244
  /** The number of job definition files loaded during the most recent successful load
1243
1245
  */
1244
1246
  job_definition_files_loaded?: number;
1245
1247
  /** The number of job definitions loaded during the most recent successful load
1246
1248
  */
1247
1249
  job_definitions_loaded?: number;
1248
- /** 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`
1250
+ /** The Date (and time) the manifest was last loaded successfully
1249
1251
  */
1250
- last_load_status: string;
1252
+ last_successful_load_time?: string;
1251
1253
  /** 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
1252
1254
  */
1253
1255
  last_load_time?: string;
1254
- /** The Date (and time) the manifest was last loaded successfully
1256
+ /** 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`
1255
1257
  */
1256
- last_successful_load_time?: string;
1257
- params?: string;
1258
- url: string;
1258
+ last_load_status: string;
1259
1259
  }
1260
1260
  interface JobApplication {
1261
1261
  /** The Job's operator ID */
@@ -1263,6 +1263,15 @@ interface JobApplication {
1263
1263
  /** The Job's operator version */
1264
1264
  version: string;
1265
1265
  }
1266
+ /**
1267
+ * 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)
1268
+
1269
+ */
1270
+ type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
1271
+ declare const InstanceSummaryJobImageType: {
1272
+ readonly SIMPLE: "SIMPLE";
1273
+ readonly NEXTFLOW: "NEXTFLOW";
1274
+ };
1266
1275
  /**
1267
1276
  * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1268
1277
  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.
@@ -1279,15 +1288,6 @@ declare const InstanceSummaryPhase: {
1279
1288
  readonly SUCCEEDED: "SUCCEEDED";
1280
1289
  readonly UNKNOWN: "UNKNOWN";
1281
1290
  };
1282
- /**
1283
- * 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)
1284
-
1285
- */
1286
- type InstanceSummaryJobImageType = typeof InstanceSummaryJobImageType[keyof typeof InstanceSummaryJobImageType];
1287
- declare const InstanceSummaryJobImageType: {
1288
- readonly SIMPLE: "SIMPLE";
1289
- readonly NEXTFLOW: "NEXTFLOW";
1290
- };
1291
1291
  /**
1292
1292
  * The type of Application, which can be a `job` or an `application`
1293
1293
 
@@ -1298,110 +1298,107 @@ declare const InstanceSummaryApplicationType: {
1298
1298
  readonly JOB: "JOB";
1299
1299
  };
1300
1300
  interface InstanceSummary {
1301
+ /** The application instance ID
1302
+ */
1303
+ id: string;
1304
+ /** True if the instance is archived (protected from automatic deletion)
1305
+ */
1306
+ archived: boolean;
1301
1307
  /** The application ID
1302
1308
  */
1303
1309
  application_id: string;
1310
+ /** The application version
1311
+ */
1312
+ application_version: string;
1304
1313
  /** The User's specification, provided when the application was launched
1305
1314
  */
1306
1315
  application_specification?: string;
1307
1316
  /** The type of Application, which can be a `job` or an `application`
1308
1317
  */
1309
1318
  application_type: InstanceSummaryApplicationType;
1310
- /** The application version
1311
- */
1312
- application_version: string;
1313
- /** True if the instance is archived (protected from automatic deletion)
1314
- */
1315
- archived: boolean;
1316
1319
  /** The code obtained from the Account Server
1317
1320
  */
1318
1321
  authorisation_code?: number;
1319
- /** The current running coin cost of the instance.
1322
+ /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1323
+ 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.
1320
1324
  */
1321
- coins?: string;
1322
- /** If the instance has failed, this will be the error message
1325
+ phase: InstanceSummaryPhase;
1326
+ /** The data and time (UTC) the instance was launched
1323
1327
  */
1324
- error_message?: string;
1325
- /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1328
+ launched: string;
1329
+ /** The data and time (UTC) the instance started running
1326
1330
  */
1327
- fix_permissions?: boolean;
1328
- /** The application instance ID
1331
+ started?: string;
1332
+ /** The data and time (UTC) the instance stopped running
1329
1333
  */
1330
- id: string;
1331
- /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1334
+ stopped?: string;
1335
+ /** 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.
1332
1336
  */
1333
- job_collection?: string;
1334
- /** The Job definition's unique ID
1337
+ run_time: string;
1338
+ /** The application instance owner, the person who launched the application and is the only user than can stop it.
1335
1339
  */
1336
- job_id?: number;
1337
- /** 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)
1340
+ owner: string;
1341
+ /** The Project the instances is running in.
1338
1342
  */
1339
- job_image_type?: InstanceSummaryJobImageType;
1343
+ project_id: string;
1344
+ /** The Instance name
1345
+ */
1346
+ name: string;
1347
+ /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
1348
+ */
1349
+ url?: string;
1350
+ /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1351
+ */
1352
+ job_collection?: string;
1340
1353
  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
1341
1354
  */
1342
1355
  job_job?: string;
1343
1356
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1344
1357
  */
1345
1358
  job_name?: string;
1359
+ /** The Job definition's unique ID
1360
+ */
1361
+ job_id?: number;
1346
1362
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
1347
1363
  */
1348
1364
  job_version?: string;
1349
- /** The data and time (UTC) the instance was launched
1350
- */
1351
- launched: string;
1352
- /** The Instance name
1365
+ /** 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)
1353
1366
  */
1354
- name: string;
1367
+ job_image_type?: InstanceSummaryJobImageType;
1355
1368
  /** The instance's known outputs, a JSON string defining a map of all the outputs. Typically applied only to JOB application types
1356
1369
  */
1357
1370
  outputs?: string;
1358
- /** The application instance owner, the person who launched the application and is the only user than can stop it.
1359
- */
1360
- owner: string;
1361
- /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1362
- 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.
1363
- */
1364
- phase: InstanceSummaryPhase;
1365
- /** The Project the instances is running in.
1366
- */
1367
- project_id: string;
1368
- /** 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.
1369
- */
1370
- run_time: string;
1371
- /** The data and time (UTC) the instance started running
1371
+ /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1372
1372
  */
1373
- started?: string;
1374
- /** The data and time (UTC) the instance stopped running
1373
+ fix_permissions?: boolean;
1374
+ /** The current running coin cost of the instance.
1375
1375
  */
1376
- stopped?: string;
1377
- /** For applications (not Jobs) this is the URL the application has exposed. It will only be available when the application has started.
1376
+ coins?: string;
1377
+ /** If the instance has failed, this will be the error message
1378
1378
  */
1379
- url?: string;
1379
+ error_message?: string;
1380
1380
  }
1381
1381
  interface FileStat {
1382
- /** The date and time (UTC) of the last modification
1383
- */
1384
- modified: string;
1385
1382
  /** The size of the file in bytes
1386
1383
  */
1387
1384
  size: number;
1385
+ /** The date and time (UTC) of the last modification
1386
+ */
1387
+ modified: string;
1388
1388
  }
1389
1389
  interface FilePathFile {
1390
- /** The code obtained from the Account Server
1391
- */
1392
- authorisation_code?: number;
1393
1390
  /** The file's Dataset ID (if the file belongs to a Dataset)
1394
1391
  */
1395
1392
  dataset_id?: string;
1396
1393
  /** The file's Dataset version (if the file belongs to a Dataset)
1397
1394
  */
1398
1395
  dataset_version?: number;
1399
- /** The ID of the file (if the file belongs to a Dataset)
1400
- */
1401
- file_id?: string;
1402
1396
  /** The file name
1403
1397
  */
1404
1398
  file_name: string;
1399
+ /** The ID of the file (if the file belongs to a Dataset)
1400
+ */
1401
+ file_id?: string;
1405
1402
  /** Whether the file is immutable (read-only)
1406
1403
  */
1407
1404
  immutable?: boolean;
@@ -1411,13 +1408,16 @@ interface FilePathFile {
1411
1408
  /** The file's owner
1412
1409
  */
1413
1410
  owner: string;
1411
+ /** The code obtained from the Account Server
1412
+ */
1413
+ authorisation_code?: number;
1414
1414
  stat: FileStat;
1415
1415
  }
1416
1416
  interface JobExchangeRateSummary {
1417
- collection: string;
1418
1417
  id: number;
1419
- job: string;
1420
1418
  rate?: string;
1419
+ collection: string;
1420
+ job: string;
1421
1421
  version: string;
1422
1422
  }
1423
1423
  interface ApplicationExchangeRateSummary {
@@ -1425,12 +1425,19 @@ interface ApplicationExchangeRateSummary {
1425
1425
  rate?: string;
1426
1426
  }
1427
1427
  interface ExchangeRateDetail {
1428
- comment?: string;
1429
- created: string;
1430
1428
  id: number;
1431
1429
  rate: string;
1430
+ created: string;
1432
1431
  user_id: string;
1432
+ comment?: string;
1433
1433
  }
1434
+ /**
1435
+ * The dictionary of label/value pairs
1436
+
1437
+ */
1438
+ type DatasetVersionSummaryLabels = {
1439
+ [key: string]: unknown;
1440
+ };
1434
1441
  /**
1435
1442
  * 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
1443
 
@@ -1444,65 +1451,65 @@ declare const DatasetVersionSummaryProcessingStage: {
1444
1451
  readonly DELETING: "DELETING";
1445
1452
  readonly DONE: "DONE";
1446
1453
  };
1447
- /**
1448
- * The dictionary of label/value pairs
1449
-
1450
- */
1451
- type DatasetVersionSummaryLabels = {
1452
- [key: string]: unknown;
1453
- };
1454
1454
  interface DatasetVersionSummary {
1455
- /** The code obtained from the Account Server
1455
+ /** The owner of the Dataset version
1456
1456
  */
1457
- authorisation_code?: number;
1458
- /** The name of the Pod handling the creation of the Dataset
1457
+ owner?: string;
1458
+ /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1459
1459
  */
1460
- creator_pod_name?: string;
1461
- /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1460
+ source_ref: string;
1461
+ /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1462
1462
  */
1463
- deleted?: string;
1464
- /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1463
+ published: string;
1464
+ /** The Dataset MIME type
1465
1465
  */
1466
- deleting_user?: string;
1466
+ type: string;
1467
1467
  /** The filename of the Dataset
1468
1468
  */
1469
1469
  file_name: string;
1470
+ /** The list of Project's the Dataset is attached to
1471
+ */
1472
+ projects: string[];
1470
1473
  /** Any extra variables passed in during the upload and handed to the format-support container.
1471
1474
  */
1472
1475
  format_extra_variables?: string;
1473
- /** The dictionary of label/value pairs
1476
+ /** The version of the dataset
1474
1477
  */
1475
- labels?: DatasetVersionSummaryLabels;
1476
- /** The owner of the Dataset version
1478
+ version: number;
1479
+ /** The name of the Pod handling the creation of the Dataset
1477
1480
  */
1478
- owner?: string;
1481
+ creator_pod_name?: string;
1479
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
1480
1483
  */
1481
1484
  processing_stage: DatasetVersionSummaryProcessingStage;
1482
- /** The list of Project's the Dataset is attached to
1485
+ /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1486
+ */
1487
+ deleted?: string;
1488
+ /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1483
1489
  */
1484
- projects: string[];
1485
- /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1490
+ deleting_user?: string;
1491
+ /** The dictionary of label/value pairs
1486
1492
  */
1487
- published: string;
1493
+ labels?: DatasetVersionSummaryLabels;
1488
1494
  /** The size, in bytes, of the formatted Dataset
1489
1495
  */
1490
1496
  size?: 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
1497
+ /** The code obtained from the Account Server
1498
1498
  */
1499
- version: number;
1499
+ authorisation_code?: number;
1500
1500
  }
1501
1501
  interface DatasetVersionProjectFile {
1502
- files: string[];
1503
- project: string;
1504
1502
  project_name: string;
1503
+ project: string;
1504
+ files: string[];
1505
1505
  }
1506
+ /**
1507
+ * The dictionary of label/value pairs
1508
+
1509
+ */
1510
+ type DatasetVersionDetailLabels = {
1511
+ [key: string]: unknown;
1512
+ };
1506
1513
  /**
1507
1514
  * 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
1508
1515
 
@@ -1516,62 +1523,55 @@ declare const DatasetVersionDetailProcessingStage: {
1516
1523
  readonly DELETING: "DELETING";
1517
1524
  readonly DONE: "DONE";
1518
1525
  };
1519
- /**
1520
- * The dictionary of label/value pairs
1521
-
1522
- */
1523
- type DatasetVersionDetailLabels = {
1524
- [key: string]: unknown;
1525
- };
1526
1526
  interface DatasetVersionDetail {
1527
- /** The code obtained from the Account Server
1527
+ /** The owner of the Dataset version
1528
1528
  */
1529
- authorisation_code?: number;
1530
- /** The name of the Pod handling the creation of the Dataset
1529
+ owner: string;
1530
+ /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1531
1531
  */
1532
- creator_pod_name?: string;
1533
- /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1532
+ source_ref: string;
1533
+ /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1534
1534
  */
1535
- deleted?: string;
1536
- /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1535
+ published: string;
1536
+ /** The Dataset MIME type
1537
1537
  */
1538
- deleting_user?: string;
1538
+ type: string;
1539
1539
  /** The filename of the Dataset
1540
1540
  */
1541
1541
  file_name: string;
1542
+ /** The list of
1543
+ */
1544
+ project_files: DatasetVersionProjectFile[];
1545
+ /** The list of Project's the Dataset is attached to
1546
+ */
1547
+ projects: string[];
1542
1548
  /** Any extra variables passed in during the upload and handed to the format-support container.
1543
1549
  */
1544
1550
  format_extra_variables?: string;
1545
- /** The dictionary of label/value pairs
1551
+ /** The version of the dataset
1546
1552
  */
1547
- labels?: DatasetVersionDetailLabels;
1548
- /** The owner of the Dataset version
1553
+ version: number;
1554
+ /** The name of the Pod handling the creation of the Dataset
1549
1555
  */
1550
- owner: string;
1556
+ creator_pod_name?: string;
1551
1557
  /** 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
1552
1558
  */
1553
1559
  processing_stage: DatasetVersionDetailProcessingStage;
1554
- /** The list of
1560
+ /** If this is a Deleted dataset this is the date and time the dataset was deleted (an ISO-8601 formatted string in UTC)
1555
1561
  */
1556
- project_files: DatasetVersionProjectFile[];
1557
- /** The list of Project's the Dataset is attached to
1562
+ deleted?: string;
1563
+ /** If this is a Deleted dataset this is the username of the user that deleted the Dataset
1558
1564
  */
1559
- projects: string[];
1560
- /** The date and time the Dataset was uploaded (an ISO-8601 formatted string in UTC)
1565
+ deleting_user?: string;
1566
+ /** The dictionary of label/value pairs
1561
1567
  */
1562
- published: string;
1568
+ labels?: DatasetVersionDetailLabels;
1563
1569
  /** The size, in bytes, of the formatted Dataset
1564
1570
  */
1565
1571
  size?: number;
1566
- /** The source of the Dataset - typically the name of the Dataset that was uploaded or a URL reference
1567
- */
1568
- source_ref: string;
1569
- /** The Dataset MIME type
1570
- */
1571
- type: string;
1572
- /** The version of the dataset
1572
+ /** The code obtained from the Account Server
1573
1573
  */
1574
- version: number;
1574
+ authorisation_code?: number;
1575
1575
  }
1576
1576
  interface DatasetSummary {
1577
1577
  /** The Dataset ID
@@ -1602,22 +1602,22 @@ interface DatasetDetail {
1602
1602
  versions: DatasetVersionDetail[];
1603
1603
  }
1604
1604
  interface ApplicationSummary {
1605
- /** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
1605
+ /** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
1606
1606
  */
1607
- application_id: string;
1607
+ kind: string;
1608
1608
  /** The application group
1609
1609
  */
1610
1610
  group?: string;
1611
- /** The application name, the value of the Kubernetes **Custom Resource Definition** `spec.names.kind` property
1611
+ /** The application unique reference, the value of the Kubernetes **Custom Resource Definition** `metadata.name` property
1612
1612
  */
1613
- kind: string;
1613
+ application_id: string;
1614
1614
  /** The application's latest version as declared in The **Custom Resource Definition**
1615
1615
  */
1616
1616
  latest_version: string;
1617
1617
  }
1618
1618
  interface ApplicationImageVariant {
1619
- image: string;
1620
1619
  name: string;
1620
+ image: string;
1621
1621
  }
1622
1622
  interface ApplicationImageVariants {
1623
1623
  public?: ApplicationImageVariant[];
@@ -1634,30 +1634,30 @@ declare const ApiLogDetailMethod: {
1634
1634
  readonly PUT: "PUT";
1635
1635
  };
1636
1636
  interface ApiLogDetail {
1637
+ /** The REST method used. GET methods are not logged
1638
+ */
1639
+ method: ApiLogDetailMethod;
1640
+ /** The API path used, e.g. `/dataset`
1641
+ */
1642
+ path: string;
1637
1643
  /** The date/time the API call began
1638
1644
  */
1639
1645
  began: string;
1640
- /** A JSON string representing the in-body properties used in the call
1641
- */
1642
- body?: string;
1643
1646
  /** The REST method approximate execution time (nS) in a humanised form, where 7969400 is presented as 7,969,400
1644
1647
  */
1645
1648
  duration_ns?: string;
1646
- /** 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
1647
- */
1648
- impersonator?: string;
1649
- /** The REST method used. GET methods are not logged
1649
+ /** The HTTP response status code
1650
1650
  */
1651
- method: ApiLogDetailMethod;
1651
+ status_code?: number;
1652
1652
  /** A JSON string representing the in-query properties used in the call
1653
1653
  */
1654
1654
  params?: string;
1655
- /** The API path used, e.g. `/dataset`
1655
+ /** A JSON string representing the in-body properties used in the call
1656
1656
  */
1657
- path: string;
1658
- /** The HTTP response status code
1657
+ body?: string;
1658
+ /** 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
1659
1659
  */
1660
- status_code?: number;
1660
+ impersonator?: string;
1661
1661
  }
1662
1662
  interface ModeGetResponse {
1663
1663
  /** 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)
@@ -1676,43 +1676,43 @@ interface UsersGetResponse {
1676
1676
  users: UserSummary[];
1677
1677
  }
1678
1678
  interface UserApiLogGetResponse {
1679
+ count: number;
1679
1680
  /** A list of API loc call records, with the oldest record first in the list
1680
1681
  */
1681
1682
  api_log: ApiLogDetail[];
1682
- count: number;
1683
1683
  }
1684
1684
  interface UserActivityDetailPeriod {
1685
- /** 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)
1685
+ /** The period over which the activity is monitored
1686
1686
  */
1687
- active_dates?: string[];
1687
+ monitoring_period: string;
1688
1688
  /** The number of days the API has been used
1689
1689
  */
1690
1690
  active_days: number;
1691
- /** Active days, as a percentage, over the monitoring period.
1692
- */
1693
- activity: string;
1694
1691
  /** The number of days the API has not been used
1695
1692
  */
1696
1693
  inactive_days: number;
1697
- /** The period over which the activity is monitored
1694
+ /** Active days, as a percentage, over the monitoring period.
1698
1695
  */
1699
- monitoring_period: string;
1696
+ activity: string;
1697
+ /** 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)
1698
+ */
1699
+ active_dates?: string[];
1700
1700
  }
1701
1701
  interface UserActivityDetail {
1702
- period_a: UserActivityDetailPeriod;
1703
- period_b?: UserActivityDetailPeriod;
1704
- /** The total percentage activity since first seen
1702
+ /** The total number of days since the user was first seen, including the day the user was first seen
1705
1703
  */
1706
- total_activity: string;
1704
+ total_days_since_first_seen: number;
1707
1705
  /** The total number of days active since first seen
1708
1706
  */
1709
1707
  total_days_active: number;
1710
1708
  /** The total number of days inactive since first seen
1711
1709
  */
1712
1710
  total_days_inactive: number;
1713
- /** The total number of days since the user was first seen, including the day the user was first seen
1711
+ /** The total percentage activity since first seen
1714
1712
  */
1715
- total_days_since_first_seen: number;
1713
+ total_activity: string;
1714
+ period_a: UserActivityDetailPeriod;
1715
+ period_b?: UserActivityDetailPeriod;
1716
1716
  }
1717
1717
  type UserAccountGetResponse = UserAccountDetail;
1718
1718
  interface TypesGetResponse {
@@ -1739,24 +1739,6 @@ declare const TaskGetResponsePurpose: {
1739
1739
  readonly PROJECT: "PROJECT";
1740
1740
  };
1741
1741
  interface TaskGetResponse {
1742
- /** The date and time the task was created
1743
- */
1744
- created: string;
1745
- /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
1746
- */
1747
- done: boolean;
1748
- /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
1749
- */
1750
- events?: TaskEvent[];
1751
- /** Present when `done` and zero if the task finished successfully.
1752
- */
1753
- exit_code?: number;
1754
- /** If a container image is launched by the task the image name is available here
1755
- */
1756
- image?: string;
1757
- /** 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.
1758
- */
1759
- instance_specification?: string;
1760
1742
  /** 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`)
1761
1743
  */
1762
1744
  purpose: TaskGetResponsePurpose;
@@ -1766,12 +1748,30 @@ interface TaskGetResponse {
1766
1748
  /** The version number, relating to the object under control. For Datasets this will be the Dataset version.
1767
1749
  */
1768
1750
  purpose_version?: number;
1751
+ /** 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.
1752
+ */
1753
+ instance_specification?: string;
1754
+ /** If a container image is launched by the task the image name is available here
1755
+ */
1756
+ image?: string;
1757
+ /** The date and time the task was created
1758
+ */
1759
+ created: string;
1760
+ /** True if the task has run to completion. If the task finished successfully the `exit_code` will be zero.
1761
+ */
1762
+ done: boolean;
1769
1763
  /** True if the Task relates to an object removal, i.e. a DELETE
1770
1764
  */
1771
1765
  removal?: boolean;
1766
+ /** Present when `done` and zero if the task finished successfully.
1767
+ */
1768
+ exit_code?: number;
1772
1769
  /** A (possibly empty) list of application states, the oldest state occupies the first position in the list.
1773
1770
  */
1774
1771
  states?: TaskState[];
1772
+ /** A (possibly empty) list of application events. The oldest event occupies the first position in the list.
1773
+ */
1774
+ events?: TaskEvent[];
1775
1775
  }
1776
1776
  interface ServiceErrorsGetResponse {
1777
1777
  /** The number of service errors
@@ -1806,76 +1806,76 @@ declare const JobGetResponseImageType: {
1806
1806
  readonly NEXTFLOW: "NEXTFLOW";
1807
1807
  };
1808
1808
  interface JobGetResponse {
1809
- application: ApplicationSummary;
1810
- /** The Job's category
1809
+ /** The Job's unique ID
1811
1810
  */
1812
- category?: string;
1811
+ id: number;
1812
+ application: ApplicationSummary;
1813
1813
  /** The Job collection
1814
1814
  */
1815
1815
  collection: string;
1816
+ /** The Job name, unique within a given collection
1817
+ */
1818
+ job: string;
1819
+ /** The Job version
1820
+ */
1821
+ version: string;
1816
1822
  /** The Job command (usually encoded)
1817
1823
  */
1818
1824
  command: string;
1819
1825
  /** The Job command encoding
1820
1826
  */
1821
1827
  command_encoding: string;
1822
- /** English description of the job
1823
- */
1824
- description?: string;
1825
- /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1826
- */
1827
- disabled: boolean;
1828
- /** A reason why the Job has been disabled.
1829
- */
1830
- disabled_reason?: string;
1831
- /** 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).
1832
-
1833
- Where there is no remedy for a given reason the remedy will be "There is no remedy".
1834
- */
1835
- disabled_remedy?: string;
1836
- /** A URL linking to the Job documentation
1837
- */
1838
- doc_url?: string;
1839
- exchange_rate: string;
1840
- /** The Job's unique ID
1841
- */
1842
- id: number;
1843
1828
  /** The name of the container image that houses the job
1844
1829
  */
1845
1830
  image_name: string;
1831
+ /** The container image tag
1832
+ */
1833
+ image_tag: string;
1846
1834
  /** The directory where the project volume will be mounted. The root path to the project files
1847
1835
  */
1848
1836
  image_project_directory: string;
1849
- /** The container image tag
1837
+ /** The directory used as the container image working directory (if defined)
1850
1838
  */
1851
- image_tag: string;
1839
+ image_working_directory?: unknown;
1852
1840
  /** 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`)
1853
1841
  */
1854
1842
  image_type?: JobGetResponseImageType;
1855
- /** The directory used as the container image working directory (if defined)
1843
+ /** The Job's descriptive name
1856
1844
  */
1857
- image_working_directory?: unknown;
1858
- /** The Job name, unique within a given collection
1845
+ name: string;
1846
+ /** English description of the job
1859
1847
  */
1860
- job: string;
1848
+ description?: string;
1849
+ /** A URL linking to the Job documentation
1850
+ */
1851
+ doc_url?: string;
1852
+ /** The Job's category
1853
+ */
1854
+ category?: string;
1861
1855
  /** The list of keywords assigned to the Job
1862
1856
  */
1863
1857
  keywords?: string[];
1858
+ variables?: JobVariables;
1859
+ exchange_rate: string;
1860
+ /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1861
+ */
1862
+ required_assets: string[];
1864
1863
  /** 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.
1865
1864
  */
1866
1865
  missing_assets?: string[];
1867
- /** The Job's descriptive name
1866
+ /** True if disabled. Disabled Jobs cannot be executed. If disabled a reason will be found in `disabled_reason`
1868
1867
  */
1869
- name: string;
1870
- replaced_by?: JobReplacements;
1871
- replaces?: JobReplacements;
1872
- /** A list of Account Server assets names required to run the Job. You need access to these assets in order to run the Job
1868
+ disabled: boolean;
1869
+ /** A reason why the Job has been disabled.
1873
1870
  */
1874
- required_assets: string[];
1875
- variables?: JobVariables;
1876
- /** The Job version
1871
+ disabled_reason?: string;
1872
+ /** 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).
1873
+
1874
+ Where there is no remedy for a given reason the remedy will be "There is no remedy".
1877
1875
  */
1878
- version: string;
1876
+ disabled_remedy?: string;
1877
+ replaces?: JobReplacements;
1878
+ replaced_by?: JobReplacements;
1879
1879
  }
1880
1880
  interface InventoryProjectDetail {
1881
1881
  id: string;
@@ -1883,28 +1883,28 @@ interface InventoryProjectDetail {
1883
1883
  unit_id: string;
1884
1884
  }
1885
1885
  interface InventoryDatasetDetail {
1886
- filename: string;
1887
1886
  id: string;
1888
- unit_id: string;
1889
1887
  version: number;
1888
+ filename: string;
1889
+ unit_id: string;
1890
1890
  }
1891
+ type InventoryUserDetailDatasets = {
1892
+ owner?: InventoryDatasetDetail[];
1893
+ editor?: InventoryDatasetDetail[];
1894
+ };
1891
1895
  type InventoryUserDetailProjects = {
1892
1896
  administrator: InventoryProjectDetail[];
1893
1897
  editor: InventoryProjectDetail[];
1894
1898
  observer: InventoryProjectDetail[];
1895
1899
  };
1896
- type InventoryUserDetailDatasets = {
1897
- editor?: InventoryDatasetDetail[];
1898
- owner?: InventoryDatasetDetail[];
1899
- };
1900
1900
  interface InventoryUserDetail {
1901
- activity: UserActivityDetail;
1902
- datasets: InventoryUserDetailDatasets;
1903
1901
  f_uid: number;
1904
1902
  first_seen: string;
1905
1903
  last_seen_date: string;
1906
- projects: InventoryUserDetailProjects;
1907
1904
  username: string;
1905
+ projects: InventoryUserDetailProjects;
1906
+ datasets: InventoryUserDetailDatasets;
1907
+ activity: UserActivityDetail;
1908
1908
  }
1909
1909
  type InstanceTaskPurpose = typeof InstanceTaskPurpose[keyof typeof InstanceTaskPurpose];
1910
1910
  declare const InstanceTaskPurpose: {
@@ -1919,6 +1919,15 @@ interface InstancesGetResponse {
1919
1919
  count: number;
1920
1920
  instances: InstanceSummary[];
1921
1921
  }
1922
+ /**
1923
+ * 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)
1924
+
1925
+ */
1926
+ type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
1927
+ declare const InstanceGetResponseJobImageType: {
1928
+ readonly SIMPLE: "SIMPLE";
1929
+ readonly NEXTFLOW: "NEXTFLOW";
1930
+ };
1922
1931
  /**
1923
1932
  * The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1924
1933
  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.
@@ -1935,15 +1944,6 @@ declare const InstanceGetResponsePhase: {
1935
1944
  readonly SUCCEEDED: "SUCCEEDED";
1936
1945
  readonly UNKNOWN: "UNKNOWN";
1937
1946
  };
1938
- /**
1939
- * 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)
1940
-
1941
- */
1942
- type InstanceGetResponseJobImageType = typeof InstanceGetResponseJobImageType[keyof typeof InstanceGetResponseJobImageType];
1943
- declare const InstanceGetResponseJobImageType: {
1944
- readonly SIMPLE: "SIMPLE";
1945
- readonly NEXTFLOW: "NEXTFLOW";
1946
- };
1947
1947
  /**
1948
1948
  * The type of Application, which can be a `job` or an `application`
1949
1949
 
@@ -1954,132 +1954,132 @@ declare const InstanceGetResponseApplicationType: {
1954
1954
  readonly JOB: "JOB";
1955
1955
  };
1956
1956
  interface InstanceGetResponse {
1957
- /** The application ID
1957
+ /** The Project the Instance is running in
1958
1958
  */
1959
- application_id: string;
1960
- /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
1959
+ project_id: string;
1960
+ /** The application name
1961
1961
  */
1962
- application_specification?: string;
1962
+ name: string;
1963
+ /** True if the instance is archived (protected from automatic deletion)
1964
+ */
1965
+ archived: boolean;
1963
1966
  /** The type of Application, which can be a `job` or an `application`
1964
1967
  */
1965
1968
  application_type: InstanceGetResponseApplicationType;
1969
+ /** The application ID
1970
+ */
1971
+ application_id: string;
1966
1972
  /** The application version
1967
1973
  */
1968
1974
  application_version: string;
1969
- /** True if the instance is archived (protected from automatic deletion)
1975
+ /** The optional application specification. For **Applications** this is returned verbatim. For **Jobs** additional material will be found.
1970
1976
  */
1971
- archived: boolean;
1977
+ application_specification?: string;
1972
1978
  /** The code obtained from the Account Server
1973
1979
  */
1974
1980
  authorisation_code?: number;
1975
- /** 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'`
1981
+ /** The application owner, the person who launched the application and is the only user than can stop it.
1976
1982
  */
1977
- coins?: string;
1978
- /** 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).
1983
+ owner: string;
1984
+ /** The date and time the instance was started, an ISO-8601 format string.
1979
1985
  */
1980
- collateral_cpu_hours?: string;
1981
- /** 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.
1986
+ launched: string;
1987
+ /** 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.
1982
1988
  */
1983
- collateral_pod_count?: number;
1984
- /** 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'`
1989
+ started?: string;
1990
+ /** The date and time the instance stopped, an ISO-8601 format string.
1985
1991
  */
1986
- cost?: string;
1987
- /** An optional error message, used to report underlying problems.
1992
+ stopped?: string;
1993
+ /** 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.
1988
1994
  */
1989
- error_message?: string;
1990
- /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
1995
+ run_time: string;
1996
+ /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
1997
+ 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.
1991
1998
  */
1992
- fix_permissions?: boolean;
1993
- /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
1999
+ phase: InstanceGetResponsePhase;
2000
+ /** The application endpoint
1994
2001
  */
1995
- has_valid_callback_token: boolean;
2002
+ url?: string;
1996
2003
  /** If the instance relates to a job, this will be the job collection, as defined in the original collection's job definition.
1997
2004
  */
1998
2005
  job_collection?: string;
1999
- /** The Job definition's unique ID
2000
- */
2001
- job_id?: number;
2002
- /** 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)
2003
- */
2004
- job_image_type?: InstanceGetResponseJobImageType;
2005
2006
  /** If the instance relates to a job, this will be the job, as defined in the original collection's job definition.
2006
2007
  */
2007
2008
  job_job?: string;
2008
2009
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
2009
2010
  */
2010
2011
  job_name?: string;
2012
+ /** The Job definition's unique ID
2013
+ */
2014
+ job_id?: number;
2011
2015
  /** If the instance relates to a job, this will be the job's name, as defined in the original collection's job definition.
2012
2016
  */
2013
2017
  job_version?: string;
2014
- /** 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'`
2015
- */
2016
- launch_exchange_rate?: string;
2017
- /** The date and time the instance was started, an ISO-8601 format string.
2018
- */
2019
- launched: string;
2020
- /** The application name
2018
+ /** 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)
2021
2019
  */
2022
- name: string;
2020
+ job_image_type?: InstanceGetResponseJobImageType;
2023
2021
  /** The JSON string representation of the JobDefinition's outputs
2024
2022
  */
2025
2023
  outputs?: string;
2026
- /** The application owner, the person who launched the application and is the only user than can stop it.
2024
+ /** Set if the instance output file permissions are expected to be fixed by the Data Manager when the Instance completes.
2027
2025
  */
2028
- owner: string;
2029
- /** The phase of the application. This is a string, one of a limited number of values that are defined internally within the Data Manager.
2030
- 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.
2026
+ fix_permissions?: boolean;
2027
+ /** 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.
2031
2028
  */
2032
- phase: InstanceGetResponsePhase;
2033
- /** The Project the Instance is running in
2029
+ tasks: InstanceTask[];
2030
+ /** Set if the instance has a valid callback token. Instances with a valid token allow users to read files form the project without authentication
2034
2031
  */
2035
- project_id: string;
2036
- /** 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.
2032
+ has_valid_callback_token: boolean;
2033
+ /** 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'`
2037
2034
  */
2038
- run_time: string;
2039
- /** 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.
2035
+ launch_exchange_rate?: string;
2036
+ /** 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'`
2040
2037
  */
2041
- started?: string;
2042
- /** The date and time the instance stopped, an ISO-8601 format string.
2038
+ cost?: string;
2039
+ /** 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'`
2043
2040
  */
2044
- stopped?: string;
2045
- /** 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.
2041
+ coins?: string;
2042
+ /** 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).
2046
2043
  */
2047
- tasks: InstanceTask[];
2048
- /** The application endpoint
2044
+ collateral_cpu_hours?: string;
2045
+ /** 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.
2049
2046
  */
2050
- url?: string;
2047
+ collateral_pod_count?: number;
2048
+ /** An optional error message, used to report underlying problems.
2049
+ */
2050
+ error_message?: string;
2051
2051
  /** A list of Project-relative annotation files.
2052
2052
  */
2053
2053
  written_job_annotation_files?: string[];
2054
2054
  }
2055
2055
  type GetExchangeRatesResponseId = number | string;
2056
2056
  interface GetExchangeRatesResponse {
2057
+ id: GetExchangeRatesResponseId;
2057
2058
  count: number;
2058
2059
  exchange_rates: ExchangeRateDetail[];
2059
- id: GetExchangeRatesResponseId;
2060
2060
  }
2061
2061
  type GetAllExchangeRatesResponseExchangeRatesItem = ApplicationExchangeRateSummary | JobExchangeRateSummary;
2062
2062
  interface GetAllExchangeRatesResponse {
2063
2063
  count: number;
2064
- exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
2065
2064
  only_undefined: boolean;
2065
+ exchange_rates: GetAllExchangeRatesResponseExchangeRatesItem[];
2066
2066
  }
2067
2067
  interface FilesGetResponse {
2068
2068
  /** The number of files in the Project path
2069
2069
  */
2070
2070
  count: number;
2071
- /** The dataset identity (not its name). A unique reference assigned automatically when uploaded
2071
+ /** The project
2072
2072
  */
2073
- files: FilePathFile[];
2073
+ project_id: string;
2074
2074
  /** The project path
2075
2075
  */
2076
2076
  path: string;
2077
+ /** The dataset identity (not its name). A unique reference assigned automatically when uploaded
2078
+ */
2079
+ files: FilePathFile[];
2077
2080
  /** Sub-directories in the current path
2078
2081
  */
2079
2082
  paths: string[];
2080
- /** The project
2081
- */
2082
- project_id: string;
2083
2083
  }
2084
2084
  interface FilePostResponse {
2085
2085
  /** The Project File identity, assigned automatically when a Dataset is added to a Project
@@ -2096,18 +2096,18 @@ interface FilePostResponse {
2096
2096
  task_id: string;
2097
2097
  }
2098
2098
  interface InstancePostResponse {
2099
- /** 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.
2100
- */
2101
- callback_token?: string;
2102
- /** The instance expanded command. Applies only to Job instances.
2103
- */
2104
- command?: string;
2105
2099
  /** The application instance identity (not its name). Assigned automatically when created
2106
2100
  */
2107
2101
  instance_id: string;
2102
+ /** 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.
2103
+ */
2104
+ callback_token?: string;
2108
2105
  /** The instance task identity. The task assigned to process the instance
2109
2106
  */
2110
2107
  task_id: string;
2108
+ /** The instance expanded command. Applies only to Job instances.
2109
+ */
2110
+ command?: string;
2111
2111
  }
2112
2112
  interface InstanceDryRunPostResponse {
2113
2113
  /** 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.
@@ -2133,48 +2133,48 @@ declare const DatasetSchemaGetResponseType: {
2133
2133
  readonly object: "object";
2134
2134
  };
2135
2135
  interface DatasetSchemaGetResponse {
2136
- /** The Metadata description
2137
- */
2138
- description: string;
2139
- /** Required properties
2140
- */
2141
- required: string[];
2142
2136
  /** The Metadata title
2143
2137
  */
2144
2138
  title: string;
2139
+ /** The Metadata description
2140
+ */
2141
+ description: string;
2145
2142
  /** The Metadata type (an object)
2146
2143
  */
2147
2144
  type: DatasetSchemaGetResponseType;
2145
+ /** Required properties
2146
+ */
2147
+ required: string[];
2148
2148
  [key: string]: unknown;
2149
2149
  }
2150
2150
  interface DatasetMetaGetResponse {
2151
- /** The Metadata's annotations
2152
- */
2153
- annotations: unknown[];
2154
- /** The date and time of creation
2155
- */
2156
- created: string;
2157
- /** The user who created the Metadata
2151
+ /** The Metadata title
2158
2152
  */
2159
- created_by: string;
2153
+ dataset_name: string;
2160
2154
  /** The Metadata description
2161
2155
  */
2162
2156
  dataset_id: string;
2163
- /** The Metadata title
2164
- */
2165
- dataset_name: string;
2166
2157
  /** The Metadata type (an object)
2167
2158
  */
2168
2159
  description: string;
2169
- /** The Metadata's labels
2160
+ /** The date and time of creation
2170
2161
  */
2171
- labels: unknown[];
2162
+ created: string;
2172
2163
  /** The date and time it was last updated
2173
2164
  */
2174
2165
  last_updated: string;
2166
+ /** The user who created the Metadata
2167
+ */
2168
+ created_by: string;
2175
2169
  /** The Metadata version
2176
2170
  */
2177
2171
  metadata_version: string;
2172
+ /** The Metadata's annotations
2173
+ */
2174
+ annotations: unknown[];
2175
+ /** The Metadata's labels
2176
+ */
2177
+ labels: unknown[];
2178
2178
  [key: string]: unknown;
2179
2179
  }
2180
2180
  interface DatasetDigestGetResponse {
@@ -2200,36 +2200,36 @@ interface DatasetPutPostResponse {
2200
2200
  task_id: string;
2201
2201
  }
2202
2202
  interface ApplicationsGetResponse {
2203
- /** A list of installed applications, which are application-compliant Kubernetes "operators"
2204
- */
2205
- applications: ApplicationSummary[];
2206
2203
  /** The number of known Applications
2207
2204
  */
2208
2205
  count: number;
2206
+ /** A list of installed applications, which are application-compliant Kubernetes "operators"
2207
+ */
2208
+ applications: ApplicationSummary[];
2209
2209
  }
2210
2210
  interface ApplicationGetResponse {
2211
+ /** The Application's unique ID
2212
+ */
2213
+ id: string;
2211
2214
  /** The Application COST exchange rate
2212
2215
  */
2213
2216
  exchange_rate: string;
2214
- /** The application group
2215
- */
2216
- group: string;
2217
- /** The Application's unique ID
2217
+ /** The application specification template. Used when creating application instances
2218
2218
  */
2219
- id: string;
2220
- image_variants?: ApplicationImageVariants;
2219
+ template: string;
2221
2220
  /** A list of instances of the application
2222
2221
  */
2223
2222
  instances: string[];
2223
+ /** The application group
2224
+ */
2225
+ group: string;
2224
2226
  /** The name (kind) of the application
2225
2227
  */
2226
2228
  kind: string;
2227
- /** The application specification template. Used when creating application instances
2228
- */
2229
- template: string;
2230
2229
  /** The list of available versions
2231
2230
  */
2232
2231
  versions: string[];
2232
+ image_variants?: ApplicationImageVariants;
2233
2233
  }
2234
2234
  interface AdminUsersGetResponse {
2235
2235
  /** The number of Users that have used the Data Manager
@@ -2241,15 +2241,12 @@ interface AdminUsersGetResponse {
2241
2241
  }
2242
2242
  type AdminUserPutResponse = UserAccountDetail;
2243
2243
  interface AdminJobManifestLoadPutResponse {
2244
- /** Errors raised during the processing of individual Job Definitions
2245
- */
2246
- job_definition_failures?: string[];
2247
- /** Errors raised during Job Definition file processing
2244
+ /** True if there are no errors, false otherwise
2248
2245
  */
2249
- job_definition_file_failures?: string[];
2250
- /** Errors raised during Manifests file processing
2246
+ status: boolean;
2247
+ /** The number of Job Manifests inspected
2251
2248
  */
2252
- manifest_file_failures?: string[];
2249
+ num_manifest_files_inspected: number;
2253
2250
  /** The number of Job Definitions inspected
2254
2251
  */
2255
2252
  num_job_definition_files_inspected: number;
@@ -2262,12 +2259,15 @@ interface AdminJobManifestLoadPutResponse {
2262
2259
  /** The number of Jobs removed
2263
2260
  */
2264
2261
  num_jobs_purged?: number;
2265
- /** The number of Job Manifests inspected
2262
+ /** Errors raised during Manifests file processing
2266
2263
  */
2267
- num_manifest_files_inspected: number;
2268
- /** True if there are no errors, false otherwise
2264
+ manifest_file_failures?: string[];
2265
+ /** Errors raised during Job Definition file processing
2269
2266
  */
2270
- status: boolean;
2267
+ job_definition_file_failures?: string[];
2268
+ /** Errors raised during the processing of individual Job Definitions
2269
+ */
2270
+ job_definition_failures?: string[];
2271
2271
  }
2272
2272
  interface InventoryUserGetResponse {
2273
2273
  today: string;