@squonk/data-manager-client 3.1.0-beta.2 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/accounting/accounting.cjs +12 -12
  2. package/accounting/accounting.cjs.map +1 -1
  3. package/accounting/accounting.d.cts +103 -49
  4. package/accounting/accounting.d.ts +103 -49
  5. package/accounting/accounting.js +12 -12
  6. package/accounting/accounting.js.map +1 -1
  7. package/admin/admin.cjs +12 -12
  8. package/admin/admin.cjs.map +1 -1
  9. package/admin/admin.d.cts +168 -115
  10. package/admin/admin.d.ts +168 -115
  11. package/admin/admin.js +12 -12
  12. package/admin/admin.js.map +1 -1
  13. package/application/application.cjs +8 -8
  14. package/application/application.cjs.map +1 -1
  15. package/application/application.d.cts +69 -33
  16. package/application/application.d.ts +69 -33
  17. package/application/application.js +8 -8
  18. package/application/application.js.map +1 -1
  19. package/chunk-TKLTUR4R.cjs.map +1 -1
  20. package/configuration/configuration.cjs +4 -4
  21. package/configuration/configuration.cjs.map +1 -1
  22. package/configuration/configuration.d.cts +35 -17
  23. package/configuration/configuration.d.ts +35 -17
  24. package/configuration/configuration.js +4 -4
  25. package/configuration/configuration.js.map +1 -1
  26. package/dataset/dataset.cjs +16 -16
  27. package/dataset/dataset.cjs.map +1 -1
  28. package/dataset/dataset.d.cts +181 -110
  29. package/dataset/dataset.d.ts +181 -110
  30. package/dataset/dataset.js +16 -16
  31. package/dataset/dataset.js.map +1 -1
  32. package/digest/digest.cjs +4 -4
  33. package/digest/digest.cjs.map +1 -1
  34. package/digest/digest.d.cts +35 -17
  35. package/digest/digest.d.ts +35 -17
  36. package/digest/digest.js +4 -4
  37. package/digest/digest.js.map +1 -1
  38. package/exchange-rate/exchange-rate.cjs +16 -16
  39. package/exchange-rate/exchange-rate.cjs.map +1 -1
  40. package/exchange-rate/exchange-rate.d.cts +155 -84
  41. package/exchange-rate/exchange-rate.d.ts +155 -84
  42. package/exchange-rate/exchange-rate.js +16 -16
  43. package/exchange-rate/exchange-rate.js.map +1 -1
  44. package/file-and-path/file-and-path.cjs +8 -8
  45. package/file-and-path/file-and-path.cjs.map +1 -1
  46. package/file-and-path/file-and-path.d.cts +133 -98
  47. package/file-and-path/file-and-path.d.ts +133 -98
  48. package/file-and-path/file-and-path.js +8 -8
  49. package/file-and-path/file-and-path.js.map +1 -1
  50. package/index.cjs.map +1 -1
  51. package/index.d.cts +156 -68
  52. package/index.d.ts +156 -68
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +8 -8
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +106 -71
  57. package/instance/instance.d.ts +106 -71
  58. package/instance/instance.js +8 -8
  59. package/instance/instance.js.map +1 -1
  60. package/inventory/inventory.cjs +4 -4
  61. package/inventory/inventory.cjs.map +1 -1
  62. package/inventory/inventory.d.cts +35 -17
  63. package/inventory/inventory.d.ts +35 -17
  64. package/inventory/inventory.js +4 -4
  65. package/inventory/inventory.js.map +1 -1
  66. package/job/job.cjs +12 -12
  67. package/job/job.cjs.map +1 -1
  68. package/job/job.d.cts +103 -49
  69. package/job/job.d.ts +103 -49
  70. package/job/job.js +12 -12
  71. package/job/job.js.map +1 -1
  72. package/metadata/metadata.cjs +8 -8
  73. package/metadata/metadata.cjs.map +1 -1
  74. package/metadata/metadata.d.cts +81 -46
  75. package/metadata/metadata.d.ts +81 -46
  76. package/metadata/metadata.js +8 -8
  77. package/metadata/metadata.js.map +1 -1
  78. package/package.json +7 -7
  79. package/project/project.cjs +16 -16
  80. package/project/project.cjs.map +1 -1
  81. package/project/project.d.cts +225 -154
  82. package/project/project.d.ts +225 -154
  83. package/project/project.js +16 -16
  84. package/project/project.js.map +1 -1
  85. package/src/accounting/accounting.ts +137 -13
  86. package/src/admin/admin.ts +217 -52
  87. package/src/application/application.ts +93 -9
  88. package/src/configuration/configuration.ts +49 -5
  89. package/src/data-manager-api.schemas.ts +156 -70
  90. package/src/dataset/dataset.ts +250 -42
  91. package/src/digest/digest.ts +49 -5
  92. package/src/exchange-rate/exchange-rate.ts +216 -29
  93. package/src/file-and-path/file-and-path.ts +172 -52
  94. package/src/instance/instance.ts +137 -27
  95. package/src/inventory/inventory.ts +49 -5
  96. package/src/job/job.ts +143 -13
  97. package/src/metadata/metadata.ts +116 -15
  98. package/src/project/project.ts +302 -75
  99. package/src/task/task.ts +111 -15
  100. package/src/type/type.ts +49 -5
  101. package/src/user/user.ts +149 -19
  102. package/task/task.cjs +8 -8
  103. package/task/task.cjs.map +1 -1
  104. package/task/task.d.cts +78 -43
  105. package/task/task.d.ts +78 -43
  106. package/task/task.js +8 -8
  107. package/task/task.js.map +1 -1
  108. package/type/type.cjs +4 -4
  109. package/type/type.cjs.map +1 -1
  110. package/type/type.d.cts +35 -17
  111. package/type/type.d.ts +35 -17
  112. package/type/type.js +4 -4
  113. package/type/type.js.map +1 -1
  114. package/user/user.cjs +12 -12
  115. package/user/user.cjs.map +1 -1
  116. package/user/user.d.cts +112 -59
  117. package/user/user.d.ts +112 -59
  118. package/user/user.js +12 -12
  119. 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 v6.25.0 🍺
5
+ * Generated by orval v7.2.0 🍺
6
6
  * Do not edit manually.
7
7
  * Dataset Manager API
8
8
  * The Dataset Manager API service.
@@ -568,8 +568,12 @@ type UserAccountPatchBodyBody = {
568
568
  /** 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
569
  */
570
570
  become_admin?: boolean;
571
- /** For `admin` accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
572
- */
571
+ /**
572
+ * For `admin` accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set `become_admin`
573
+
574
+ * @maxLength 80
575
+ * @pattern ^(\w(?:\w*(?:[@.-]\w+)?)*|)$
576
+ */
573
577
  impersonate?: string;
574
578
  /** If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
575
579
  */
@@ -579,12 +583,19 @@ type UserAccountPatchBodyBody = {
579
583
  use_impersonation?: boolean;
580
584
  };
581
585
  type ProjectPostBodyBody = {
586
+ /**
587
+ * @minLength 2
588
+ * @maxLength 80
589
+ */
582
590
  name: string;
583
591
  /** Whether the project is private. You may not be permitted to make the project private, that will depend on the project product you're using to create the project
584
592
  */
585
593
  private?: boolean;
586
- /** The Data Manager *Tier Product ID* you're using to create the Project
587
- */
594
+ /**
595
+ * The Data Manager *Tier Product ID* you're using to create the Project
596
+
597
+ * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
598
+ */
588
599
  tier_product_id: string;
589
600
  };
590
601
  type ProjectPatchBodyBody = {
@@ -594,46 +605,82 @@ type ProjectPatchBodyBody = {
594
605
  private?: boolean;
595
606
  };
596
607
  type ProjectFilePutBodyBody = {
597
- /** An alternative filename to use for the uploaded File
598
- */
608
+ /**
609
+ * An alternative filename to use for the uploaded File
610
+
611
+ * @minLength 1
612
+ * @maxLength 128
613
+ */
599
614
  as_filename?: string;
600
615
  file: Blob;
601
- /** The Project path of the file.
602
- */
616
+ /**
617
+ * The Project path of the file.
618
+
619
+ * @minLength 1
620
+ * @maxLength 260
621
+ * @pattern ^/.+$|^/$
622
+ */
603
623
  path?: string;
604
624
  };
605
625
  type ExchangeRatePutBodyBody = {
606
- /** A brief comment relating to the new rate
607
- */
626
+ /**
627
+ * A brief comment relating to the new rate
628
+
629
+ * @maxLength 80
630
+ */
608
631
  comment?: string;
609
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.
610
633
  */
611
634
  rate: string;
612
635
  };
613
636
  type JobManifestPutBodyBody = {
614
- /** Optional URL header values (a JSON string) */
637
+ /**
638
+ * Optional URL header values (a JSON string)
639
+ * @pattern ^|{.*}$
640
+ */
615
641
  header?: string;
616
- /** Optional URL parameter values (a JSON string) */
642
+ /**
643
+ * Optional URL parameter values (a JSON string)
644
+ * @pattern ^|{.*}$
645
+ */
617
646
  params?: string;
618
647
  /** The URL of the Job Manifest */
619
648
  url: string;
620
649
  };
621
650
  type InstancePostBodyBody = {
622
- /** A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
651
+ /**
652
+ * A supported application. Applications instances are managed using pre-deployed Kubernetes **Operators**. The application ID is a combination of the operator _plural_ and _group_.
623
653
 
624
654
  Application IDs currently supported include `datamanagerjobs.squonk.it` and `jupyternotebooks.squonk.it`
625
- */
655
+
656
+ * @minLength 1
657
+ * @maxLength 80
658
+ */
626
659
  application_id: string;
627
- /** The name to use for the instance
628
- */
660
+ /**
661
+ * The name to use for the instance
662
+
663
+ * @minLength 2
664
+ * @maxLength 80
665
+ * @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_. ]*[A-Za-z0-9]+$
666
+ */
629
667
  as_name: string;
630
- /** 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
631
- */
668
+ /**
669
+ * 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
+
671
+ * @minLength 1
672
+ * @maxLength 256
673
+ */
632
674
  callback_context?: string;
633
- /** 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.
675
+ /**
676
+ * 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.
634
677
 
635
678
  See the Python module's `shortuuid.get_alphabet()` for the full list of permitted characters
636
- */
679
+
680
+ * @minLength 22
681
+ * @maxLength 22
682
+ * @pattern ^[2-9A-HJ-NP-Za-km-z]{22}$
683
+ */
637
684
  callback_token?: string;
638
685
  /** A URL the DM will use to PUT job progress messages as the requested instance runs. Used, at the moment, for Job execution
639
686
  */
@@ -652,8 +699,11 @@ type InstancePostBodyBody = {
652
699
  Tokens should therefore be revoked when they're no longer required
653
700
  */
654
701
  generate_callback_token?: boolean;
655
- /** The project to attach
656
- */
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
+ */
657
707
  project_id: string;
658
708
  /** The instance specification. A JSON string that's application-specific and controls the application's behaviour.
659
709
 
@@ -674,46 +724,77 @@ type FilePostBodyBody = {
674
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
675
725
  */
676
726
  compress?: boolean;
677
- /** The Dataset UUID for the File that you intend to attach
678
- */
727
+ /**
728
+ * The Dataset UUID for the File that you intend to attach
729
+
730
+ * @pattern ^dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
731
+ */
679
732
  dataset_id: string;
680
- /** The Dataset version to attach
681
- */
733
+ /**
734
+ * The Dataset version to attach
735
+
736
+ * @minimum 1
737
+ */
682
738
  dataset_version: number;
683
739
  /** Whether the Dataset File can be modified while in the Project. By default the File cannot be modified
684
740
  */
685
741
  immutable?: boolean;
686
- /** A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'
687
- */
742
+ /**
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
+
745
+ * @maxLength 260
746
+ * @pattern ^/.+$|^/$
747
+ */
688
748
  path?: string;
689
- /** The Project UUID you're attaching to
690
- */
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
+ */
691
754
  project_id: string;
692
755
  };
693
756
  type DatasetPutBodyBody = {
694
- /** 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.
695
- */
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
+ */
696
762
  dataset_id?: string;
697
763
  /** The MIME type of the Dataset
698
764
  */
699
765
  dataset_type: string;
700
- /** The file name of the file in the Project path to load as a new Dataset.
701
- */
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
+ */
702
772
  file_name: string;
703
773
  /** 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.
704
774
  */
705
775
  format_extra_variables?: string;
706
- /** The Project path of the file.
707
- */
776
+ /**
777
+ * The Project path of the file.
778
+
779
+ * @minLength 1
780
+ * @maxLength 260
781
+ * @pattern ^/.+$|^/$
782
+ */
708
783
  path: string;
709
- /** The Project the file belongs to
710
- */
784
+ /**
785
+ * The Project the file belongs to
786
+
787
+ * @pattern ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
788
+ */
711
789
  project_id: string;
712
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
713
791
  */
714
792
  skip_molecule_load?: boolean;
715
- /** The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
716
- */
793
+ /**
794
+ * The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used
795
+
796
+ * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
797
+ */
717
798
  unit_id?: string;
718
799
  };
719
800
  type DatasetVersionMetaPostBodyBody = {
@@ -733,12 +814,19 @@ type DatasetMetaPostBodyBody = {
733
814
  meta_properties?: string;
734
815
  };
735
816
  type DatasetPostBodyBody = {
736
- /** An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
737
- */
817
+ /**
818
+ * An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.
819
+
820
+ * @minLength 1
821
+ * @maxLength 128
822
+ */
738
823
  as_filename?: string;
739
824
  dataset_file: Blob;
740
- /** 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.
741
- */
825
+ /**
826
+ * 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
+
828
+ * @pattern ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$
829
+ */
742
830
  dataset_id?: string;
743
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.
744
832
  */
@@ -749,8 +837,11 @@ type DatasetPostBodyBody = {
749
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
750
838
  */
751
839
  skip_molecule_load?: boolean;
752
- /** The Organisational Unit you want the Dataset to belong to
753
- */
840
+ /**
841
+ * The Organisational Unit you want the Dataset to belong to
842
+
843
+ * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
844
+ */
754
845
  unit_id: string;
755
846
  };
756
847
  interface AsAdditionalDataProcessingCharge {
@@ -832,7 +923,7 @@ type TypeSummaryFormatterOptions = {
832
923
  /** The Schema type (an object)
833
924
  */
834
925
  type: TypeSummaryFormatterOptionsType;
835
- [key: string]: any;
926
+ [key: string]: unknown;
836
927
  };
837
928
  interface TypeSummary {
838
929
  /** 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`).
@@ -1050,21 +1141,21 @@ interface JobOrderDetail {
1050
1141
 
1051
1142
  */
1052
1143
  type JobVariablesOutputs = {
1053
- [key: string]: any;
1144
+ [key: string]: unknown;
1054
1145
  };
1055
1146
  /**
1056
1147
  * The Job command's options. The JSONSchema for the command's options, essentially the **variables/options** block of the Job's JobDefinition.
1057
1148
 
1058
1149
  */
1059
1150
  type JobVariablesOptions = {
1060
- [key: string]: any;
1151
+ [key: string]: unknown;
1061
1152
  };
1062
1153
  /**
1063
1154
  * The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
1064
1155
 
1065
1156
  */
1066
1157
  type JobVariablesInputs = {
1067
- [key: string]: any;
1158
+ [key: string]: unknown;
1068
1159
  };
1069
1160
  interface JobVariables {
1070
1161
  /** The Job command's inputs. The JSONSchema for the command's inputs, essentially the **variables/inputs** block of the Job's JobDefinition.
@@ -1358,7 +1449,7 @@ declare const DatasetVersionSummaryProcessingStage: {
1358
1449
 
1359
1450
  */
1360
1451
  type DatasetVersionSummaryLabels = {
1361
- [key: string]: any;
1452
+ [key: string]: unknown;
1362
1453
  };
1363
1454
  interface DatasetVersionSummary {
1364
1455
  /** The code obtained from the Account Server
@@ -1430,7 +1521,7 @@ declare const DatasetVersionDetailProcessingStage: {
1430
1521
 
1431
1522
  */
1432
1523
  type DatasetVersionDetailLabels = {
1433
- [key: string]: any;
1524
+ [key: string]: unknown;
1434
1525
  };
1435
1526
  interface DatasetVersionDetail {
1436
1527
  /** The code obtained from the Account Server
@@ -1705,11 +1796,6 @@ interface JobsGetResponse {
1705
1796
  count: number;
1706
1797
  jobs: JobSummary[];
1707
1798
  }
1708
- /**
1709
- * The directory used as the container image working directory (if defined)
1710
-
1711
- */
1712
- type JobGetResponseImageWorkingDirectory = {};
1713
1799
  /**
1714
1800
  * 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`)
1715
1801
 
@@ -1768,7 +1854,7 @@ interface JobGetResponse {
1768
1854
  image_type?: JobGetResponseImageType;
1769
1855
  /** The directory used as the container image working directory (if defined)
1770
1856
  */
1771
- image_working_directory?: JobGetResponseImageWorkingDirectory;
1857
+ image_working_directory?: unknown;
1772
1858
  /** The Job name, unique within a given collection
1773
1859
  */
1774
1860
  job: string;
@@ -2056,14 +2142,12 @@ interface DatasetSchemaGetResponse {
2056
2142
  /** The Metadata type (an object)
2057
2143
  */
2058
2144
  type: DatasetSchemaGetResponseType;
2059
- [key: string]: any;
2145
+ [key: string]: unknown;
2060
2146
  }
2061
- type DatasetMetaGetResponseLabelsItem = {};
2062
- type DatasetMetaGetResponseAnnotationsItem = {};
2063
2147
  interface DatasetMetaGetResponse {
2064
2148
  /** The Metadata's annotations
2065
2149
  */
2066
- annotations: DatasetMetaGetResponseAnnotationsItem[];
2150
+ annotations: unknown[];
2067
2151
  /** The date and time of creation
2068
2152
  */
2069
2153
  created: string;
@@ -2081,21 +2165,24 @@ interface DatasetMetaGetResponse {
2081
2165
  description: string;
2082
2166
  /** The Metadata's labels
2083
2167
  */
2084
- labels: DatasetMetaGetResponseLabelsItem[];
2168
+ labels: unknown[];
2085
2169
  /** The date and time it was last updated
2086
2170
  */
2087
2171
  last_updated: string;
2088
2172
  /** The Metadata version
2089
2173
  */
2090
2174
  metadata_version: string;
2091
- [key: string]: any;
2175
+ [key: string]: unknown;
2092
2176
  }
2093
2177
  interface DatasetDigestGetResponse {
2094
2178
  /** The Dataset matching the digest
2095
2179
  */
2096
2180
  dataset_id: string;
2097
- /** The Dataset version
2098
- */
2181
+ /**
2182
+ * The Dataset version
2183
+
2184
+ * @minimum 1
2185
+ */
2099
2186
  dataset_version: number;
2100
2187
  }
2101
2188
  interface DatasetPutPostResponse {
@@ -2199,6 +2286,7 @@ interface AccountServerGetNamespaceResponse {
2199
2286
  namespace: string;
2200
2287
  }
2201
2288
  interface AccountServerGetRegistrationResponse {
2289
+ /** @minimum 1 */
2202
2290
  merchant_id: number;
2203
2291
  name: string;
2204
2292
  registered: string;
@@ -2224,4 +2312,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
2224
2312
  declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
2225
2313
  type ErrorType<TError> = AxiosError<TError>;
2226
2314
 
2227
- export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaGetResponseAnnotationsItem, type DatasetMetaGetResponseLabelsItem, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobGetResponseImageWorkingDirectory, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };
2315
+ export { AXIOS_INSTANCE, type AccountServerGetNamespaceResponse, type AccountServerGetRegistrationResponse, type AdminDeleteJobManifestParams, type AdminGetServiceErrorsParams, type AdminGetUsersParams, type AdminJobManifestGetResponse, type AdminJobManifestLoadPutResponse, type AdminUserPutResponse, type AdminUsersGetResponse, type ApiLogDetail, ApiLogDetailMethod, type ApplicationExchangeRateSummary, type ApplicationGetResponse, type ApplicationImageVariant, type ApplicationImageVariants, type ApplicationSummary, type ApplicationsGetResponse, type AsAdditionalDataProcessingCharge, type CreatePathParams, type DatasetDetail, type DatasetDigestGetResponse, type DatasetMetaGetResponse, type DatasetMetaPostBodyBody, type DatasetPostBodyBody, type DatasetPutBodyBody, type DatasetPutPostResponse, type DatasetSchemaGetResponse, DatasetSchemaGetResponseType, type DatasetSummary, type DatasetVersionDeleteResponse, type DatasetVersionDetail, type DatasetVersionDetailLabels, DatasetVersionDetailProcessingStage, type DatasetVersionMetaPostBodyBody, type DatasetVersionProjectFile, type DatasetVersionSummary, type DatasetVersionSummaryLabels, DatasetVersionSummaryProcessingStage, type DatasetVersionsGetResponse, type DatasetsGetResponse, type DeleteDatasetParams, type DeletePathParams, type DeleteUnmanagedFileParams, type DmError, type ErrorType, type ExchangeRateDetail, type ExchangeRatePutBodyBody, type FilePathFile, type FilePostBodyBody, type FilePostResponse, type FileStat, type FilesGetResponse, type GetAllApplicationExchangeRatesParams, type GetAllExchangeRatesResponse, type GetAllExchangeRatesResponseExchangeRatesItem, type GetAllJobExchangeRatesParams, type GetApplicationExchangeRatesParams, type GetDatasetsParams, type GetExchangeRatesResponse, type GetExchangeRatesResponseId, type GetFilesParams, type GetInstancesParams, type GetJobByVersionParams, type GetJobExchangeRatesParams, type GetJobParams, type GetJobsParams, type GetProjectFileParams, type GetProjectFileWithTokenParams, type GetProjectsParams, type GetTaskParams, type GetTasksParams, type GetUserAccountParams, type GetUserApiLogParams, type GetUserInventoryParams, type GetVersionsParams, type InstanceDeleteResponse, type InstanceDryRunPostResponse, type InstanceGetResponse, InstanceGetResponseApplicationType, InstanceGetResponseJobImageType, InstanceGetResponsePhase, type InstancePostBodyBody, type InstancePostResponse, type InstanceSummary, InstanceSummaryApplicationType, InstanceSummaryJobImageType, InstanceSummaryPhase, type InstanceTask, InstanceTaskPurpose, type InstancesGetResponse, type InventoryDatasetDetail, type InventoryProjectDetail, type InventoryUserDetail, type InventoryUserDetailDatasets, type InventoryUserDetailProjects, type InventoryUserGetResponse, type JobApplication, type JobExchangeRateSummary, type JobGetResponse, JobGetResponseImageType, type JobManifestDetail, type JobManifestPutBodyBody, type JobOrderDetail, type JobReplacement, type JobReplacements, type JobSummary, JobSummaryImageType, type JobVariables, type JobVariablesInputs, type JobVariablesOptions, type JobVariablesOutputs, type JobsGetResponse, type ModeGetResponse, type MoveFileInProjectParams, type MovePathParams, type PatchInstanceParams, type ProjectDeleteResponse, type ProjectDetail, type ProjectFileDetail, type ProjectFilePutBodyBody, type ProjectGetResponse, type ProjectPatchBodyBody, type ProjectPostBodyBody, type ProjectPostResponse, type ProjectsGetResponse, type QActiveDaysParameter, type QApplicationIdParameter, type QCurrentParameter, type QDatasetMimeTypeParameter, type QDoNotImpersonateParameter, type QDstFileParameter, type QEditorsParameter, type QEventLimitParameter, type QEventPriorOrdinalParameter, type QExcludeDoneParameter, type QExcludePurposeParameter, type QExcludeRemovalParameter, type QFileDstPathParameter, type QFileParameter, type QFilePathParameter, type QFileProjectIdParameter, type QFileSrcPathParameter, type QFromParameter, type QIdleDaysParameter, type QIncludeAcknowledgedParameter, type QIncludeDeletedParameter, type QIncludeHiddenParameter, type QInstanceArchiveParameter, type QInstanceCallbackContextParameter, type QJobCollectionParameter, type QJobIdParameter, type QJobJobParameter, type QJobVersionParameter, type QKeepProjectFilesParameter, type QLabelsParameter, type QOnlyUndefinedParameter, type QOrgIdParameter, type QOwnersParameter, type QProjectIdParameter, type QProjectNameParameter, type QPurgeParameter, QPurposeParameter, type QTokenParameter, type QUnitIdParameter, type QUntilParameter, type QUsernameParameter, type QUsernamesParameter, type ServiceErrorSummary, ServiceErrorSummarySeverity, type ServiceErrorsGetResponse, type TaskEvent, TaskEventLevel, type TaskGetResponse, TaskGetResponsePurpose, type TaskIdentity, type TaskState, TaskStateState, type TaskSummary, TaskSummaryProcessingStage, type TasksGetResponse, type TypeSummary, type TypeSummaryFormatterOptions, TypeSummaryFormatterOptionsType, type TypesGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserAccountPatchBodyBody, type UserActivityDetail, type UserActivityDetailPeriod, type UserApiLogGetResponse, type UserDetail, type UserPatchBodyBody, type UserSummary, type UsersGetResponse, type VersionGetResponse, customInstance, setAuthToken, setBaseUrl };