@coscine/api-client 3.3.0 → 3.3.2-package.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 (243) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +5 -2
  3. package/dist/index.js +6939 -9529
  4. package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +393 -0
  5. package/dist/types/Coscine.Api/@coscine/api/application-profile-api.d.ts +315 -0
  6. package/dist/types/Coscine.Api/@coscine/api/blob-api.d.ts +358 -0
  7. package/dist/types/Coscine.Api/@coscine/api/discipline-api.d.ts +179 -0
  8. package/dist/types/Coscine.Api/@coscine/api/language-api.d.ts +179 -0
  9. package/dist/types/Coscine.Api/@coscine/api/license-api.d.ts +179 -0
  10. package/dist/types/Coscine.Api/@coscine/api/maintenance-api.d.ts +99 -0
  11. package/dist/types/Coscine.Api/@coscine/api/organization-api.d.ts +187 -0
  12. package/dist/types/Coscine.Api/@coscine/api/pid-api.d.ts +187 -0
  13. package/dist/types/Coscine.Api/@coscine/api/project-api.d.ts +343 -0
  14. package/dist/types/Coscine.Api/@coscine/api/project-invitation-api.d.ts +321 -0
  15. package/dist/types/Coscine.Api/@coscine/api/project-member-api.d.ts +384 -0
  16. package/dist/types/Coscine.Api/@coscine/api/project-quota-api.d.ts +275 -0
  17. package/dist/types/Coscine.Api/@coscine/api/project-resource-api.d.ts +384 -0
  18. package/dist/types/Coscine.Api/@coscine/api/project-resource-quota-api.d.ts +149 -0
  19. package/dist/types/Coscine.Api/@coscine/api/project-resource-type-api.d.ts +133 -0
  20. package/dist/types/Coscine.Api/@coscine/api/resource-api.d.ts +116 -0
  21. package/dist/types/Coscine.Api/@coscine/api/resource-type-api.d.ts +327 -0
  22. package/dist/types/Coscine.Api/@coscine/api/role-api.d.ts +179 -0
  23. package/dist/types/Coscine.Api/@coscine/api/search-api.d.ts +165 -0
  24. package/dist/types/Coscine.Api/@coscine/api/self-api-token-api.d.ts +272 -0
  25. package/dist/types/Coscine.Api/@coscine/api/self-api.d.ts +334 -0
  26. package/dist/types/Coscine.Api/@coscine/api/title-api.d.ts +179 -0
  27. package/dist/types/Coscine.Api/@coscine/api/tos-api.d.ts +99 -0
  28. package/dist/types/Coscine.Api/@coscine/api/tree-api.d.ts +404 -0
  29. package/dist/types/Coscine.Api/@coscine/api/user-api.d.ts +124 -0
  30. package/dist/types/Coscine.Api/@coscine/api/visibility-api.d.ts +179 -0
  31. package/dist/types/Coscine.Api/@coscine/api/vocabulary-api.d.ts +291 -0
  32. package/dist/types/Coscine.Api/@coscine/model/accepted-language.d.ts +21 -0
  33. package/dist/types/Coscine.Api/@coscine/model/api-token-dto-paged-response.d.ts +50 -0
  34. package/dist/types/Coscine.Api/@coscine/model/api-token-dto-response.d.ts +43 -0
  35. package/dist/types/Coscine.Api/@coscine/model/api-token-dto.d.ts +55 -0
  36. package/dist/types/Coscine.Api/@coscine/model/api-token-for-creation-dto.d.ts +30 -0
  37. package/dist/types/Coscine.Api/@coscine/model/application-profile-dto-paged-response.d.ts +50 -0
  38. package/dist/types/Coscine.Api/@coscine/model/application-profile-dto-response.d.ts +43 -0
  39. package/dist/types/Coscine.Api/@coscine/model/application-profile-dto.d.ts +43 -0
  40. package/dist/types/Coscine.Api/@coscine/model/application-profile-for-creation-dto-response.d.ts +43 -0
  41. package/dist/types/Coscine.Api/@coscine/model/application-profile-for-creation-dto.d.ts +37 -0
  42. package/dist/types/Coscine.Api/@coscine/model/application-profile-for-resource-creation-dto.d.ts +24 -0
  43. package/dist/types/Coscine.Api/@coscine/model/application-profile-minimal-dto.d.ts +24 -0
  44. package/dist/types/Coscine.Api/@coscine/model/discipline-dto-paged-response.d.ts +50 -0
  45. package/dist/types/Coscine.Api/@coscine/model/discipline-dto-response.d.ts +43 -0
  46. package/dist/types/Coscine.Api/@coscine/model/discipline-dto.d.ts +42 -0
  47. package/dist/types/Coscine.Api/@coscine/model/discipline-for-project-manipulation-dto.d.ts +24 -0
  48. package/dist/types/Coscine.Api/@coscine/model/discipline-for-resource-manipulation-dto.d.ts +24 -0
  49. package/dist/types/Coscine.Api/@coscine/model/discipline-for-user-manipulation-dto.d.ts +24 -0
  50. package/dist/types/Coscine.Api/@coscine/model/file-action-dto.d.ts +31 -0
  51. package/dist/types/Coscine.Api/@coscine/model/file-action-http-method.d.ts +23 -0
  52. package/dist/types/Coscine.Api/@coscine/model/file-actions-dto.d.ts +25 -0
  53. package/dist/types/Coscine.Api/@coscine/model/file-tree-dto-paged-response.d.ts +50 -0
  54. package/dist/types/Coscine.Api/@coscine/model/file-tree-dto.d.ts +74 -0
  55. package/dist/types/Coscine.Api/@coscine/model/fixed-value-for-resource-manipulation-dto.d.ts +42 -0
  56. package/dist/types/Coscine.Api/@coscine/model/git-lab-options-dto.d.ts +42 -0
  57. package/dist/types/Coscine.Api/@coscine/model/gitlab-branch-dto-ienumerable-response.d.ts +43 -0
  58. package/dist/types/Coscine.Api/@coscine/model/gitlab-branch-dto.d.ts +60 -0
  59. package/dist/types/Coscine.Api/@coscine/model/gitlab-project-dto-ienumerable-response.d.ts +43 -0
  60. package/dist/types/Coscine.Api/@coscine/model/gitlab-project-dto-response.d.ts +43 -0
  61. package/dist/types/Coscine.Api/@coscine/model/gitlab-project-dto.d.ts +96 -0
  62. package/dist/types/Coscine.Api/@coscine/model/gitlab-resource-type-options-for-creation-dto.d.ts +48 -0
  63. package/dist/types/Coscine.Api/@coscine/model/gitlab-resource-type-options-for-update-dto.d.ts +30 -0
  64. package/dist/types/Coscine.Api/@coscine/model/identity-provider-dto.d.ts +30 -0
  65. package/dist/types/Coscine.Api/@coscine/model/identity-providers.d.ts +21 -0
  66. package/dist/types/Coscine.Api/@coscine/model/index.d.ts +158 -0
  67. package/dist/types/Coscine.Api/@coscine/model/language-dto-ienumerable-response.d.ts +43 -0
  68. package/dist/types/Coscine.Api/@coscine/model/language-dto-paged-response.d.ts +50 -0
  69. package/dist/types/Coscine.Api/@coscine/model/language-dto-response.d.ts +43 -0
  70. package/dist/types/Coscine.Api/@coscine/model/language-dto.d.ts +36 -0
  71. package/dist/types/Coscine.Api/@coscine/model/language-for-user-manipulation-dto.d.ts +24 -0
  72. package/dist/types/Coscine.Api/@coscine/model/license-dto-paged-response.d.ts +50 -0
  73. package/dist/types/Coscine.Api/@coscine/model/license-dto-response.d.ts +43 -0
  74. package/dist/types/Coscine.Api/@coscine/model/license-dto.d.ts +30 -0
  75. package/dist/types/Coscine.Api/@coscine/model/license-for-resource-manipulation-dto.d.ts +24 -0
  76. package/dist/types/Coscine.Api/@coscine/model/maintenance-dto-paged-response.d.ts +50 -0
  77. package/dist/types/Coscine.Api/@coscine/model/maintenance-dto.d.ts +54 -0
  78. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto-paged-response.d.ts +50 -0
  79. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto-response.d.ts +43 -0
  80. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto.d.ts +50 -0
  81. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-for-creation-dto.d.ts +31 -0
  82. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-for-update-dto.d.ts +31 -0
  83. package/dist/types/Coscine.Api/@coscine/model/metadata-update-admin-parameters.d.ts +31 -0
  84. package/dist/types/Coscine.Api/@coscine/model/organization-dto-paged-response.d.ts +50 -0
  85. package/dist/types/Coscine.Api/@coscine/model/organization-dto-response.d.ts +43 -0
  86. package/dist/types/Coscine.Api/@coscine/model/organization-dto.d.ts +36 -0
  87. package/dist/types/Coscine.Api/@coscine/model/organization-for-project-manipulation-dto.d.ts +24 -0
  88. package/dist/types/Coscine.Api/@coscine/model/pagination.d.ts +54 -0
  89. package/dist/types/Coscine.Api/@coscine/model/pid-request-dto.d.ts +42 -0
  90. package/dist/types/Coscine.Api/@coscine/model/pid-type.d.ts +21 -0
  91. package/dist/types/Coscine.Api/@coscine/model/pid-validation-dto-response.d.ts +43 -0
  92. package/dist/types/Coscine.Api/@coscine/model/pid-validation-dto.d.ts +31 -0
  93. package/dist/types/Coscine.Api/@coscine/model/project-admin-dto-ienumerable-paged-response.d.ts +50 -0
  94. package/dist/types/Coscine.Api/@coscine/model/project-admin-dto.d.ts +152 -0
  95. package/dist/types/Coscine.Api/@coscine/model/project-dto-paged-response.d.ts +50 -0
  96. package/dist/types/Coscine.Api/@coscine/model/project-dto-response.d.ts +43 -0
  97. package/dist/types/Coscine.Api/@coscine/model/project-dto.d.ts +131 -0
  98. package/dist/types/Coscine.Api/@coscine/model/project-for-creation-dto.d.ts +93 -0
  99. package/dist/types/Coscine.Api/@coscine/model/project-for-update-dto.d.ts +93 -0
  100. package/dist/types/Coscine.Api/@coscine/model/project-invitation-dto-paged-response.d.ts +50 -0
  101. package/dist/types/Coscine.Api/@coscine/model/project-invitation-dto-response.d.ts +43 -0
  102. package/dist/types/Coscine.Api/@coscine/model/project-invitation-dto.d.ts +57 -0
  103. package/dist/types/Coscine.Api/@coscine/model/project-invitation-for-project-manipulation-dto.d.ts +30 -0
  104. package/dist/types/Coscine.Api/@coscine/model/project-invitation-resolve-dto.d.ts +24 -0
  105. package/dist/types/Coscine.Api/@coscine/model/project-minimal-dto.d.ts +24 -0
  106. package/dist/types/Coscine.Api/@coscine/model/project-quota-dto-paged-response.d.ts +50 -0
  107. package/dist/types/Coscine.Api/@coscine/model/project-quota-dto-response.d.ts +43 -0
  108. package/dist/types/Coscine.Api/@coscine/model/project-quota-dto.d.ts +63 -0
  109. package/dist/types/Coscine.Api/@coscine/model/project-quota-for-update-dto.d.ts +31 -0
  110. package/dist/types/Coscine.Api/@coscine/model/project-resource-minimal-dto.d.ts +30 -0
  111. package/dist/types/Coscine.Api/@coscine/model/project-role-dto-paged-response.d.ts +50 -0
  112. package/dist/types/Coscine.Api/@coscine/model/project-role-dto-response.d.ts +43 -0
  113. package/dist/types/Coscine.Api/@coscine/model/project-role-dto.d.ts +45 -0
  114. package/dist/types/Coscine.Api/@coscine/model/project-role-for-project-creation-dto.d.ts +30 -0
  115. package/dist/types/Coscine.Api/@coscine/model/project-role-for-project-manipulation-dto.d.ts +24 -0
  116. package/dist/types/Coscine.Api/@coscine/model/project-role-minimal-dto.d.ts +36 -0
  117. package/dist/types/Coscine.Api/@coscine/model/public-user-dto-ienumerable-response.d.ts +43 -0
  118. package/dist/types/Coscine.Api/@coscine/model/public-user-dto.d.ts +55 -0
  119. package/dist/types/Coscine.Api/@coscine/model/quota-dto.d.ts +31 -0
  120. package/dist/types/Coscine.Api/@coscine/model/quota-for-manipulation-dto.d.ts +31 -0
  121. package/dist/types/Coscine.Api/@coscine/model/quota-unit.d.ts +25 -0
  122. package/dist/types/Coscine.Api/@coscine/model/rdf-definition-dto-response.d.ts +43 -0
  123. package/dist/types/Coscine.Api/@coscine/model/rdf-definition-dto.d.ts +30 -0
  124. package/dist/types/Coscine.Api/@coscine/model/rdf-definition-for-manipulation-dto.d.ts +31 -0
  125. package/dist/types/Coscine.Api/@coscine/model/rdf-format.d.ts +21 -0
  126. package/dist/types/Coscine.Api/@coscine/model/rds-options-dto.d.ts +31 -0
  127. package/dist/types/Coscine.Api/@coscine/model/rds-resource-type-options-for-manipulation-dto.d.ts +25 -0
  128. package/dist/types/Coscine.Api/@coscine/model/rds-s3-options-dto.d.ts +61 -0
  129. package/dist/types/Coscine.Api/@coscine/model/rds-s3-resource-type-options-for-manipulation-dto.d.ts +25 -0
  130. package/dist/types/Coscine.Api/@coscine/model/rds-s3-worm-options-dto.d.ts +61 -0
  131. package/dist/types/Coscine.Api/@coscine/model/rds-s3-worm-resource-type-options-for-manipulation-dto.d.ts +25 -0
  132. package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto-ienumerable-paged-response.d.ts +50 -0
  133. package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto.d.ts +137 -0
  134. package/dist/types/Coscine.Api/@coscine/model/resource-content-page-columns-dto.d.ts +24 -0
  135. package/dist/types/Coscine.Api/@coscine/model/resource-content-page-dto.d.ts +38 -0
  136. package/dist/types/Coscine.Api/@coscine/model/resource-content-page-entries-view-dto.d.ts +25 -0
  137. package/dist/types/Coscine.Api/@coscine/model/resource-content-page-metadata-view-dto.d.ts +30 -0
  138. package/dist/types/Coscine.Api/@coscine/model/resource-creation-page-dto.d.ts +24 -0
  139. package/dist/types/Coscine.Api/@coscine/model/resource-dto-paged-response.d.ts +50 -0
  140. package/dist/types/Coscine.Api/@coscine/model/resource-dto-response.d.ts +43 -0
  141. package/dist/types/Coscine.Api/@coscine/model/resource-dto.d.ts +124 -0
  142. package/dist/types/Coscine.Api/@coscine/model/resource-for-creation-dto.d.ts +100 -0
  143. package/dist/types/Coscine.Api/@coscine/model/resource-for-update-dto.d.ts +93 -0
  144. package/dist/types/Coscine.Api/@coscine/model/resource-minimal-dto.d.ts +24 -0
  145. package/dist/types/Coscine.Api/@coscine/model/resource-quota-dto-response.d.ts +43 -0
  146. package/dist/types/Coscine.Api/@coscine/model/resource-quota-dto.d.ts +44 -0
  147. package/dist/types/Coscine.Api/@coscine/model/resource-type-dto.d.ts +43 -0
  148. package/dist/types/Coscine.Api/@coscine/model/resource-type-information-dto-ienumerable-response.d.ts +43 -0
  149. package/dist/types/Coscine.Api/@coscine/model/resource-type-information-dto-response.d.ts +43 -0
  150. package/dist/types/Coscine.Api/@coscine/model/resource-type-information-dto.d.ts +135 -0
  151. package/dist/types/Coscine.Api/@coscine/model/resource-type-minimal-dto.d.ts +30 -0
  152. package/dist/types/Coscine.Api/@coscine/model/resource-type-options-dto.d.ts +52 -0
  153. package/dist/types/Coscine.Api/@coscine/model/resource-type-options-for-creation-dto.d.ts +52 -0
  154. package/dist/types/Coscine.Api/@coscine/model/resource-type-options-for-update-dto.d.ts +52 -0
  155. package/dist/types/Coscine.Api/@coscine/model/resource-type-status.d.ts +21 -0
  156. package/dist/types/Coscine.Api/@coscine/model/role-dto-paged-response.d.ts +50 -0
  157. package/dist/types/Coscine.Api/@coscine/model/role-dto-response.d.ts +43 -0
  158. package/dist/types/Coscine.Api/@coscine/model/role-dto.d.ts +36 -0
  159. package/dist/types/Coscine.Api/@coscine/model/role-minimal-dto.d.ts +24 -0
  160. package/dist/types/Coscine.Api/@coscine/model/search-category-type.d.ts +23 -0
  161. package/dist/types/Coscine.Api/@coscine/model/search-category.d.ts +30 -0
  162. package/dist/types/Coscine.Api/@coscine/model/search-result-dto-paged-search-response.d.ts +57 -0
  163. package/dist/types/Coscine.Api/@coscine/model/search-result-dto.d.ts +37 -0
  164. package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto-response.d.ts +43 -0
  165. package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto.d.ts +30 -0
  166. package/dist/types/Coscine.Api/@coscine/model/title-dto-ienumerable-response.d.ts +43 -0
  167. package/dist/types/Coscine.Api/@coscine/model/title-dto-paged-response.d.ts +50 -0
  168. package/dist/types/Coscine.Api/@coscine/model/title-dto-response.d.ts +43 -0
  169. package/dist/types/Coscine.Api/@coscine/model/title-dto.d.ts +30 -0
  170. package/dist/types/Coscine.Api/@coscine/model/title-for-user-manipulation-dto.d.ts +24 -0
  171. package/dist/types/Coscine.Api/@coscine/model/tree-data-type.d.ts +21 -0
  172. package/dist/types/Coscine.Api/@coscine/model/user-dto-ienumerable-paged-response.d.ts +50 -0
  173. package/dist/types/Coscine.Api/@coscine/model/user-dto-response.d.ts +43 -0
  174. package/dist/types/Coscine.Api/@coscine/model/user-dto.d.ts +97 -0
  175. package/dist/types/Coscine.Api/@coscine/model/user-email-dto.d.ts +36 -0
  176. package/dist/types/Coscine.Api/@coscine/model/user-for-update-dto.d.ts +69 -0
  177. package/dist/types/Coscine.Api/@coscine/model/user-institute-dto.d.ts +42 -0
  178. package/dist/types/Coscine.Api/@coscine/model/user-merge-dto-response.d.ts +43 -0
  179. package/dist/types/Coscine.Api/@coscine/model/user-merge-dto.d.ts +24 -0
  180. package/dist/types/Coscine.Api/@coscine/model/user-minimal-dto.d.ts +24 -0
  181. package/dist/types/Coscine.Api/@coscine/model/user-organization-dto.d.ts +42 -0
  182. package/dist/types/Coscine.Api/@coscine/model/user-terms-of-service-accept-dto.d.ts +24 -0
  183. package/dist/types/Coscine.Api/@coscine/model/visibility-dto-paged-response.d.ts +50 -0
  184. package/dist/types/Coscine.Api/@coscine/model/visibility-dto-response.d.ts +43 -0
  185. package/dist/types/Coscine.Api/@coscine/model/visibility-dto.d.ts +30 -0
  186. package/dist/types/Coscine.Api/@coscine/model/visibility-for-project-manipulation-dto.d.ts +24 -0
  187. package/dist/types/Coscine.Api/@coscine/model/visibility-for-resource-manipulation-dto.d.ts +24 -0
  188. package/dist/types/Coscine.Api/@coscine/model/vocabulary-dto-paged-response.d.ts +50 -0
  189. package/dist/types/Coscine.Api/@coscine/model/vocabulary-dto.d.ts +42 -0
  190. package/dist/types/Coscine.Api/@coscine/model/vocabulary-instance-dto-paged-response.d.ts +50 -0
  191. package/dist/types/Coscine.Api/@coscine/model/vocabulary-instance-dto-response.d.ts +43 -0
  192. package/dist/types/Coscine.Api/@coscine/model/vocabulary-instance-dto.d.ts +54 -0
  193. package/dist/types/Coscine.Api/api.d.ts +39 -9655
  194. package/dist/types/Coscine.Api/base.d.ts +66 -55
  195. package/dist/types/Coscine.Api/common.d.ts +65 -65
  196. package/dist/types/Coscine.Api/configuration.d.ts +91 -83
  197. package/dist/types/Coscine.Api/index.d.ts +14 -13
  198. package/dist/types/Coscine.Api.STS/@coscine/api/account-api.d.ts +99 -0
  199. package/dist/types/Coscine.Api.STS/@coscine/api/home-api.d.ts +69 -0
  200. package/dist/types/Coscine.Api.STS/@coscine/api/merge-api.d.ts +124 -0
  201. package/dist/types/Coscine.Api.STS/@coscine/api/orci-dapi.d.ts +140 -0
  202. package/dist/types/Coscine.Api.STS/@coscine/api/shibboleth-api.d.ts +148 -0
  203. package/dist/types/Coscine.Api.STS/@coscine/model/entity-id.d.ts +24 -0
  204. package/dist/types/Coscine.Api.STS/@coscine/model/index.d.ts +2 -0
  205. package/dist/types/Coscine.Api.STS/@coscine/model/login-urls.d.ts +31 -0
  206. package/dist/types/Coscine.Api.STS/api.d.ts +16 -465
  207. package/dist/types/Coscine.Api.STS/base.d.ts +66 -55
  208. package/dist/types/Coscine.Api.STS/common.d.ts +65 -65
  209. package/dist/types/Coscine.Api.STS/configuration.d.ts +91 -83
  210. package/dist/types/Coscine.Api.STS/index.d.ts +14 -13
  211. package/dist/types/apis.d.ts +187 -179
  212. package/dist/types/axios-basic.d.ts +2 -2
  213. package/dist/types/index.d.ts +369 -353
  214. package/package.json +33 -93
  215. package/dist/index.js.map +0 -1
  216. package/dist/index.umd.js +0 -9676
  217. package/dist/index.umd.js.map +0 -1
  218. package/dist/lib/Coscine.Api/api.js +0 -8904
  219. package/dist/lib/Coscine.Api/api.js.map +0 -1
  220. package/dist/lib/Coscine.Api/base.js +0 -65
  221. package/dist/lib/Coscine.Api/base.js.map +0 -1
  222. package/dist/lib/Coscine.Api/common.js +0 -153
  223. package/dist/lib/Coscine.Api/common.js.map +0 -1
  224. package/dist/lib/Coscine.Api/configuration.js +0 -43
  225. package/dist/lib/Coscine.Api/configuration.js.map +0 -1
  226. package/dist/lib/Coscine.Api/index.js +0 -32
  227. package/dist/lib/Coscine.Api/index.js.map +0 -1
  228. package/dist/lib/Coscine.Api.STS/api.js +0 -802
  229. package/dist/lib/Coscine.Api.STS/api.js.map +0 -1
  230. package/dist/lib/Coscine.Api.STS/base.js +0 -65
  231. package/dist/lib/Coscine.Api.STS/base.js.map +0 -1
  232. package/dist/lib/Coscine.Api.STS/common.js +0 -153
  233. package/dist/lib/Coscine.Api.STS/common.js.map +0 -1
  234. package/dist/lib/Coscine.Api.STS/configuration.js +0 -43
  235. package/dist/lib/Coscine.Api.STS/configuration.js.map +0 -1
  236. package/dist/lib/Coscine.Api.STS/index.js +0 -32
  237. package/dist/lib/Coscine.Api.STS/index.js.map +0 -1
  238. package/dist/lib/apis.js +0 -95
  239. package/dist/lib/apis.js.map +0 -1
  240. package/dist/lib/axios-basic.js +0 -46
  241. package/dist/lib/axios-basic.js.map +0 -1
  242. package/dist/lib/index.js +0 -43
  243. package/dist/lib/index.js.map +0 -1
@@ -0,0 +1,179 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../../configuration';
13
+ import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
+ import { RequestArgs, BaseAPI } from '../../base';
15
+ import { VisibilityDtoPagedResponse } from '../../@coscine/model';
16
+ import { VisibilityDtoResponse } from '../../@coscine/model';
17
+ /**
18
+ * VisibilityApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const VisibilityApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ *
24
+ * @summary Responds with the HTTP methods allowed for the endpoint.
25
+ * @param {*} [options] Override http request option.
26
+ * @throws {RequiredError}
27
+ */
28
+ apiV2VisibilitiesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
29
+ /**
30
+ *
31
+ * @summary Retrieves all visibilities.
32
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
33
+ * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
34
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ getVisibilities: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
+ /**
40
+ *
41
+ * @summary Retrieves a visibility by ID.
42
+ * @param {string} visibilityId The ID of the visibility.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ getVisibility: (visibilityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
+ };
48
+ /**
49
+ * VisibilityApi - functional programming interface
50
+ * @export
51
+ */
52
+ export declare const VisibilityApiFp: (configuration?: Configuration) => {
53
+ /**
54
+ *
55
+ * @summary Responds with the HTTP methods allowed for the endpoint.
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ apiV2VisibilitiesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
60
+ /**
61
+ *
62
+ * @summary Retrieves all visibilities.
63
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
64
+ * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
65
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ getVisibilities(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VisibilityDtoPagedResponse>>;
70
+ /**
71
+ *
72
+ * @summary Retrieves a visibility by ID.
73
+ * @param {string} visibilityId The ID of the visibility.
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ getVisibility(visibilityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VisibilityDtoResponse>>;
78
+ };
79
+ /**
80
+ * VisibilityApi - factory interface
81
+ * @export
82
+ */
83
+ export declare const VisibilityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
84
+ /**
85
+ *
86
+ * @summary Responds with the HTTP methods allowed for the endpoint.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ apiV2VisibilitiesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
91
+ /**
92
+ *
93
+ * @summary Retrieves all visibilities.
94
+ * @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters.
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ getVisibilities(requestParameters?: VisibilityApiGetVisibilitiesRequest, options?: AxiosRequestConfig): AxiosPromise<VisibilityDtoPagedResponse>;
99
+ /**
100
+ *
101
+ * @summary Retrieves a visibility by ID.
102
+ * @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters.
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ getVisibility(requestParameters: VisibilityApiGetVisibilityRequest, options?: AxiosRequestConfig): AxiosPromise<VisibilityDtoResponse>;
107
+ };
108
+ /**
109
+ * Request parameters for getVisibilities operation in VisibilityApi.
110
+ * @export
111
+ * @interface VisibilityApiGetVisibilitiesRequest
112
+ */
113
+ export interface VisibilityApiGetVisibilitiesRequest {
114
+ /**
115
+ * The desired page number. Should be greater than or equal to 1. Default is 1.
116
+ * @type {number}
117
+ * @memberof VisibilityApiGetVisibilities
118
+ */
119
+ readonly pageNumber?: number;
120
+ /**
121
+ * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
122
+ * @type {number}
123
+ * @memberof VisibilityApiGetVisibilities
124
+ */
125
+ readonly pageSize?: number;
126
+ /**
127
+ * Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
128
+ * @type {string}
129
+ * @memberof VisibilityApiGetVisibilities
130
+ */
131
+ readonly orderBy?: string;
132
+ }
133
+ /**
134
+ * Request parameters for getVisibility operation in VisibilityApi.
135
+ * @export
136
+ * @interface VisibilityApiGetVisibilityRequest
137
+ */
138
+ export interface VisibilityApiGetVisibilityRequest {
139
+ /**
140
+ * The ID of the visibility.
141
+ * @type {string}
142
+ * @memberof VisibilityApiGetVisibility
143
+ */
144
+ readonly visibilityId: string;
145
+ }
146
+ /**
147
+ * VisibilityApi - object-oriented interface
148
+ * @export
149
+ * @class VisibilityApi
150
+ * @extends {BaseAPI}
151
+ */
152
+ export declare class VisibilityApi extends BaseAPI {
153
+ /**
154
+ *
155
+ * @summary Responds with the HTTP methods allowed for the endpoint.
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ * @memberof VisibilityApi
159
+ */
160
+ apiV2VisibilitiesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
161
+ /**
162
+ *
163
+ * @summary Retrieves all visibilities.
164
+ * @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters.
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ * @memberof VisibilityApi
168
+ */
169
+ getVisibilities(requestParameters?: VisibilityApiGetVisibilitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VisibilityDtoPagedResponse, any>>;
170
+ /**
171
+ *
172
+ * @summary Retrieves a visibility by ID.
173
+ * @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters.
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ * @memberof VisibilityApi
177
+ */
178
+ getVisibility(requestParameters: VisibilityApiGetVisibilityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VisibilityDtoResponse, any>>;
179
+ }
@@ -0,0 +1,291 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../../configuration';
13
+ import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
+ import { RequestArgs, BaseAPI } from '../../base';
15
+ import { AcceptedLanguage } from '../../@coscine/model';
16
+ import { VocabularyDtoPagedResponse } from '../../@coscine/model';
17
+ import { VocabularyInstanceDtoPagedResponse } from '../../@coscine/model';
18
+ import { VocabularyInstanceDtoResponse } from '../../@coscine/model';
19
+ /**
20
+ * VocabularyApi - axios parameter creator
21
+ * @export
22
+ */
23
+ export declare const VocabularyApiAxiosParamCreator: (configuration?: Configuration) => {
24
+ /**
25
+ *
26
+ * @summary Responds with the HTTP methods allowed for the endpoint.
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ apiV2VocabulariesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ /**
32
+ *
33
+ * @summary Retrieves top-level instances from vocabularies.
34
+ * @param {string} [searchTerm] Gets or sets the search term used to filter vocabularies.
35
+ * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested.
36
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
37
+ * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
38
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getVocabularies: (searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ * Could be a top-level instance, or an intermediate-level instance from a vocabulary.
45
+ * @summary Retrieves a single instance from a vocabulary.
46
+ * @param {string} instance The URI of the vocabulary instance to retrieve.
47
+ * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the instance data.
48
+ * @param {*} [options] Override http request option.
49
+ * @throws {RequiredError}
50
+ */
51
+ getVocabularyInstance: (instance: string, acceptLanguage?: AcceptedLanguage, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
+ /**
53
+ *
54
+ * @summary Retrieves vocabulary instances.
55
+ * @param {string} _class Gets or sets the URI class, which is a required field.
56
+ * @param {string} [searchTerm] Gets or sets the search term used to filter vocabulary instances.
57
+ * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabulary instances are requested.
58
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;150&#x60;.
59
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
60
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
61
+ * @param {*} [options] Override http request option.
62
+ * @throws {RequiredError}
63
+ */
64
+ getVocabularyInstances: (_class: string, searchTerm?: string, language?: AcceptedLanguage, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ };
66
+ /**
67
+ * VocabularyApi - functional programming interface
68
+ * @export
69
+ */
70
+ export declare const VocabularyApiFp: (configuration?: Configuration) => {
71
+ /**
72
+ *
73
+ * @summary Responds with the HTTP methods allowed for the endpoint.
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ apiV2VocabulariesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
78
+ /**
79
+ *
80
+ * @summary Retrieves top-level instances from vocabularies.
81
+ * @param {string} [searchTerm] Gets or sets the search term used to filter vocabularies.
82
+ * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested.
83
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
84
+ * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
85
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ getVocabularies(searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VocabularyDtoPagedResponse>>;
90
+ /**
91
+ * Could be a top-level instance, or an intermediate-level instance from a vocabulary.
92
+ * @summary Retrieves a single instance from a vocabulary.
93
+ * @param {string} instance The URI of the vocabulary instance to retrieve.
94
+ * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the instance data.
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ getVocabularyInstance(instance: string, acceptLanguage?: AcceptedLanguage, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VocabularyInstanceDtoResponse>>;
99
+ /**
100
+ *
101
+ * @summary Retrieves vocabulary instances.
102
+ * @param {string} _class Gets or sets the URI class, which is a required field.
103
+ * @param {string} [searchTerm] Gets or sets the search term used to filter vocabulary instances.
104
+ * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabulary instances are requested.
105
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;150&#x60;.
106
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
107
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ getVocabularyInstances(_class: string, searchTerm?: string, language?: AcceptedLanguage, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VocabularyInstanceDtoPagedResponse>>;
112
+ };
113
+ /**
114
+ * VocabularyApi - factory interface
115
+ * @export
116
+ */
117
+ export declare const VocabularyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
118
+ /**
119
+ *
120
+ * @summary Responds with the HTTP methods allowed for the endpoint.
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ */
124
+ apiV2VocabulariesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
125
+ /**
126
+ *
127
+ * @summary Retrieves top-level instances from vocabularies.
128
+ * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters.
129
+ * @param {*} [options] Override http request option.
130
+ * @throws {RequiredError}
131
+ */
132
+ getVocabularies(requestParameters?: VocabularyApiGetVocabulariesRequest, options?: AxiosRequestConfig): AxiosPromise<VocabularyDtoPagedResponse>;
133
+ /**
134
+ * Could be a top-level instance, or an intermediate-level instance from a vocabulary.
135
+ * @summary Retrieves a single instance from a vocabulary.
136
+ * @param {VocabularyApiGetVocabularyInstanceRequest} requestParameters Request parameters.
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ */
140
+ getVocabularyInstance(requestParameters: VocabularyApiGetVocabularyInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<VocabularyInstanceDtoResponse>;
141
+ /**
142
+ *
143
+ * @summary Retrieves vocabulary instances.
144
+ * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters.
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getVocabularyInstances(requestParameters: VocabularyApiGetVocabularyInstancesRequest, options?: AxiosRequestConfig): AxiosPromise<VocabularyInstanceDtoPagedResponse>;
149
+ };
150
+ /**
151
+ * Request parameters for getVocabularies operation in VocabularyApi.
152
+ * @export
153
+ * @interface VocabularyApiGetVocabulariesRequest
154
+ */
155
+ export interface VocabularyApiGetVocabulariesRequest {
156
+ /**
157
+ * Gets or sets the search term used to filter vocabularies.
158
+ * @type {string}
159
+ * @memberof VocabularyApiGetVocabularies
160
+ */
161
+ readonly searchTerm?: string;
162
+ /**
163
+ * Gets or sets the language for which the vocabularies are requested.
164
+ * @type {AcceptedLanguage}
165
+ * @memberof VocabularyApiGetVocabularies
166
+ */
167
+ readonly language?: AcceptedLanguage;
168
+ /**
169
+ * The desired page number. Should be greater than or equal to 1. Default is 1.
170
+ * @type {number}
171
+ * @memberof VocabularyApiGetVocabularies
172
+ */
173
+ readonly pageNumber?: number;
174
+ /**
175
+ * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
176
+ * @type {number}
177
+ * @memberof VocabularyApiGetVocabularies
178
+ */
179
+ readonly pageSize?: number;
180
+ /**
181
+ * Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
182
+ * @type {string}
183
+ * @memberof VocabularyApiGetVocabularies
184
+ */
185
+ readonly orderBy?: string;
186
+ }
187
+ /**
188
+ * Request parameters for getVocabularyInstance operation in VocabularyApi.
189
+ * @export
190
+ * @interface VocabularyApiGetVocabularyInstanceRequest
191
+ */
192
+ export interface VocabularyApiGetVocabularyInstanceRequest {
193
+ /**
194
+ * The URI of the vocabulary instance to retrieve.
195
+ * @type {string}
196
+ * @memberof VocabularyApiGetVocabularyInstance
197
+ */
198
+ readonly instance: string;
199
+ /**
200
+ * The preferred language for the instance data.
201
+ * @type {AcceptedLanguage}
202
+ * @memberof VocabularyApiGetVocabularyInstance
203
+ */
204
+ readonly acceptLanguage?: AcceptedLanguage;
205
+ }
206
+ /**
207
+ * Request parameters for getVocabularyInstances operation in VocabularyApi.
208
+ * @export
209
+ * @interface VocabularyApiGetVocabularyInstancesRequest
210
+ */
211
+ export interface VocabularyApiGetVocabularyInstancesRequest {
212
+ /**
213
+ * Gets or sets the URI class, which is a required field.
214
+ * @type {string}
215
+ * @memberof VocabularyApiGetVocabularyInstances
216
+ */
217
+ readonly _class: string;
218
+ /**
219
+ * Gets or sets the search term used to filter vocabulary instances.
220
+ * @type {string}
221
+ * @memberof VocabularyApiGetVocabularyInstances
222
+ */
223
+ readonly searchTerm?: string;
224
+ /**
225
+ * Gets or sets the language for which the vocabulary instances are requested.
226
+ * @type {AcceptedLanguage}
227
+ * @memberof VocabularyApiGetVocabularyInstances
228
+ */
229
+ readonly language?: AcceptedLanguage;
230
+ /**
231
+ * Number of items per page. The maximum number of items per page is &#x60;150&#x60;.
232
+ * @type {number}
233
+ * @memberof VocabularyApiGetVocabularyInstances
234
+ */
235
+ readonly pageSize?: number;
236
+ /**
237
+ * The desired page number. Should be greater than or equal to 1. Default is 1.
238
+ * @type {number}
239
+ * @memberof VocabularyApiGetVocabularyInstances
240
+ */
241
+ readonly pageNumber?: number;
242
+ /**
243
+ * Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
244
+ * @type {string}
245
+ * @memberof VocabularyApiGetVocabularyInstances
246
+ */
247
+ readonly orderBy?: string;
248
+ }
249
+ /**
250
+ * VocabularyApi - object-oriented interface
251
+ * @export
252
+ * @class VocabularyApi
253
+ * @extends {BaseAPI}
254
+ */
255
+ export declare class VocabularyApi extends BaseAPI {
256
+ /**
257
+ *
258
+ * @summary Responds with the HTTP methods allowed for the endpoint.
259
+ * @param {*} [options] Override http request option.
260
+ * @throws {RequiredError}
261
+ * @memberof VocabularyApi
262
+ */
263
+ apiV2VocabulariesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
264
+ /**
265
+ *
266
+ * @summary Retrieves top-level instances from vocabularies.
267
+ * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters.
268
+ * @param {*} [options] Override http request option.
269
+ * @throws {RequiredError}
270
+ * @memberof VocabularyApi
271
+ */
272
+ getVocabularies(requestParameters?: VocabularyApiGetVocabulariesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyDtoPagedResponse, any>>;
273
+ /**
274
+ * Could be a top-level instance, or an intermediate-level instance from a vocabulary.
275
+ * @summary Retrieves a single instance from a vocabulary.
276
+ * @param {VocabularyApiGetVocabularyInstanceRequest} requestParameters Request parameters.
277
+ * @param {*} [options] Override http request option.
278
+ * @throws {RequiredError}
279
+ * @memberof VocabularyApi
280
+ */
281
+ getVocabularyInstance(requestParameters: VocabularyApiGetVocabularyInstanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyInstanceDtoResponse, any>>;
282
+ /**
283
+ *
284
+ * @summary Retrieves vocabulary instances.
285
+ * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters.
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ * @memberof VocabularyApi
289
+ */
290
+ getVocabularyInstances(requestParameters: VocabularyApiGetVocabularyInstancesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyInstanceDtoPagedResponse, any>>;
291
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Accepted languages by the API.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const AcceptedLanguage: {
18
+ readonly De: "de";
19
+ readonly En: "en";
20
+ };
21
+ export type AcceptedLanguage = typeof AcceptedLanguage[keyof typeof AcceptedLanguage];
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ApiTokenDto } from './api-token-dto';
13
+ import { Pagination } from './pagination';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface ApiTokenDtoPagedResponse
18
+ */
19
+ export interface ApiTokenDtoPagedResponse {
20
+ /**
21
+ *
22
+ * @type {Array<ApiTokenDto>}
23
+ * @memberof ApiTokenDtoPagedResponse
24
+ */
25
+ 'data'?: Array<ApiTokenDto> | null;
26
+ /**
27
+ *
28
+ * @type {boolean}
29
+ * @memberof ApiTokenDtoPagedResponse
30
+ */
31
+ 'isSuccess'?: boolean;
32
+ /**
33
+ *
34
+ * @type {number}
35
+ * @memberof ApiTokenDtoPagedResponse
36
+ */
37
+ 'statusCode'?: number | null;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof ApiTokenDtoPagedResponse
42
+ */
43
+ 'traceId'?: string | null;
44
+ /**
45
+ *
46
+ * @type {Pagination}
47
+ * @memberof ApiTokenDtoPagedResponse
48
+ */
49
+ 'pagination'?: Pagination;
50
+ }
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ApiTokenDto } from './api-token-dto';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ApiTokenDtoResponse
17
+ */
18
+ export interface ApiTokenDtoResponse {
19
+ /**
20
+ *
21
+ * @type {ApiTokenDto}
22
+ * @memberof ApiTokenDtoResponse
23
+ */
24
+ 'data'?: ApiTokenDto;
25
+ /**
26
+ *
27
+ * @type {boolean}
28
+ * @memberof ApiTokenDtoResponse
29
+ */
30
+ 'isSuccess'?: boolean;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof ApiTokenDtoResponse
35
+ */
36
+ 'statusCode'?: number | null;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof ApiTokenDtoResponse
41
+ */
42
+ 'traceId'?: string | null;
43
+ }
@@ -0,0 +1,55 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { UserMinimalDto } from './user-minimal-dto';
13
+ /**
14
+ * Represents an API token used for authentication.
15
+ * @export
16
+ * @interface ApiTokenDto
17
+ */
18
+ export interface ApiTokenDto {
19
+ /**
20
+ * The unique identifier of the API token.
21
+ * @type {string}
22
+ * @memberof ApiTokenDto
23
+ */
24
+ 'id'?: string;
25
+ /**
26
+ * The name associated with the API token.
27
+ * @type {string}
28
+ * @memberof ApiTokenDto
29
+ */
30
+ 'name'?: string;
31
+ /**
32
+ * The date when the API token was created.
33
+ * @type {string}
34
+ * @memberof ApiTokenDto
35
+ */
36
+ 'creationDate'?: string;
37
+ /**
38
+ * The expiry date of the API token.
39
+ * @type {string}
40
+ * @memberof ApiTokenDto
41
+ */
42
+ 'expiryDate'?: string;
43
+ /**
44
+ * The actual token used for authentication.
45
+ * @type {string}
46
+ * @memberof ApiTokenDto
47
+ */
48
+ 'token'?: string | null;
49
+ /**
50
+ *
51
+ * @type {UserMinimalDto}
52
+ * @memberof ApiTokenDto
53
+ */
54
+ 'owner'?: UserMinimalDto;
55
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Coscine Web API
3
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@itc.rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Data transfer object (DTO) representing the creation of an API token.
14
+ * @export
15
+ * @interface ApiTokenForCreationDto
16
+ */
17
+ export interface ApiTokenForCreationDto {
18
+ /**
19
+ * Gets or sets the name of the API token.
20
+ * @type {string}
21
+ * @memberof ApiTokenForCreationDto
22
+ */
23
+ 'name': string;
24
+ /**
25
+ * Gets or sets the expiration duration of the token in days.
26
+ * @type {number}
27
+ * @memberof ApiTokenForCreationDto
28
+ */
29
+ 'expiresInDays': number;
30
+ }