@globus/sdk 6.2.0 → 6.3.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 (255) hide show
  1. package/README.md +27 -5
  2. package/dist/cjs/core/authorization/index.js +314 -11
  3. package/dist/cjs/core/authorization/index.js.map +4 -4
  4. package/dist/cjs/core/info/index.js +1 -1
  5. package/dist/cjs/core/info/index.js.map +1 -1
  6. package/dist/cjs/index.js +1947 -235
  7. package/dist/cjs/index.js.map +4 -4
  8. package/dist/cjs/services/globus-connect-server/client.js +259 -10
  9. package/dist/cjs/services/globus-connect-server/client.js.map +4 -4
  10. package/dist/esm/core/info/version.d.ts +1 -1
  11. package/dist/esm/core/info/version.js +1 -1
  12. package/dist/esm/index.d.ts +0 -71
  13. package/dist/esm/index.d.ts.map +1 -1
  14. package/dist/esm/index.js +0 -71
  15. package/dist/esm/index.js.map +1 -1
  16. package/dist/esm/open-api/types/compute.d.ts +82 -88
  17. package/dist/esm/open-api/types/compute.d.ts.map +1 -1
  18. package/dist/esm/open-api/types/flows.d.ts +820 -139
  19. package/dist/esm/open-api/types/flows.d.ts.map +1 -1
  20. package/dist/esm/open-api/types/gcs/v5.4.d.ts +624 -7
  21. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
  22. package/dist/esm/open-api/types/groups.d.ts +6 -2
  23. package/dist/esm/open-api/types/groups.d.ts.map +1 -1
  24. package/dist/esm/open-api/types/search.d.ts +603 -163
  25. package/dist/esm/open-api/types/search.d.ts.map +1 -1
  26. package/dist/esm/open-api/types/timers.d.ts +13 -10
  27. package/dist/esm/open-api/types/timers.d.ts.map +1 -1
  28. package/dist/esm/open-api/types/transfer.d.ts +744 -69
  29. package/dist/esm/open-api/types/transfer.d.ts.map +1 -1
  30. package/dist/esm/package.json +1 -1
  31. package/dist/esm/services/auth/config.d.ts +1 -0
  32. package/dist/esm/services/auth/config.d.ts.map +1 -1
  33. package/dist/esm/services/auth/config.js +1 -0
  34. package/dist/esm/services/auth/config.js.map +1 -1
  35. package/dist/esm/services/auth/index.d.ts +2 -4
  36. package/dist/esm/services/auth/index.d.ts.map +1 -1
  37. package/dist/esm/services/auth/index.js +2 -12
  38. package/dist/esm/services/auth/index.js.map +1 -1
  39. package/dist/esm/services/auth/service/developers/clients/credentials.d.ts +69 -0
  40. package/dist/esm/services/auth/service/developers/clients/credentials.d.ts.map +1 -0
  41. package/dist/esm/services/auth/service/developers/clients/credentials.js +66 -0
  42. package/dist/esm/services/auth/service/developers/clients/credentials.js.map +1 -0
  43. package/dist/esm/services/auth/service/developers/clients/index.d.ts +137 -0
  44. package/dist/esm/services/auth/service/developers/clients/index.d.ts.map +1 -0
  45. package/dist/esm/services/auth/service/developers/clients/index.js +128 -0
  46. package/dist/esm/services/auth/service/developers/clients/index.js.map +1 -0
  47. package/dist/esm/services/auth/service/developers/clients/scopes.d.ts +38 -0
  48. package/dist/esm/services/auth/service/developers/clients/scopes.d.ts.map +1 -0
  49. package/dist/esm/services/auth/service/developers/clients/scopes.js +47 -0
  50. package/dist/esm/services/auth/service/developers/clients/scopes.js.map +1 -0
  51. package/dist/esm/services/auth/service/developers/index.d.ts +8 -0
  52. package/dist/esm/services/auth/service/developers/index.d.ts.map +1 -0
  53. package/dist/esm/services/auth/service/developers/index.js +5 -0
  54. package/dist/esm/services/auth/service/developers/index.js.map +1 -0
  55. package/dist/esm/services/auth/service/developers/policies.d.ts +95 -0
  56. package/dist/esm/services/auth/service/developers/policies.d.ts.map +1 -0
  57. package/dist/esm/services/auth/service/developers/policies.js +103 -0
  58. package/dist/esm/services/auth/service/developers/policies.js.map +1 -0
  59. package/dist/esm/services/auth/service/developers/projects.d.ts +114 -0
  60. package/dist/esm/services/auth/service/developers/projects.d.ts.map +1 -0
  61. package/dist/esm/services/auth/service/developers/projects.js +108 -0
  62. package/dist/esm/services/auth/service/developers/projects.js.map +1 -0
  63. package/dist/esm/services/auth/service/developers/scopes.d.ts +97 -0
  64. package/dist/esm/services/auth/service/developers/scopes.d.ts.map +1 -0
  65. package/dist/esm/services/auth/service/developers/scopes.js +81 -0
  66. package/dist/esm/services/auth/service/developers/scopes.js.map +1 -0
  67. package/dist/esm/services/auth/service/identities/consents.d.ts +15 -4
  68. package/dist/esm/services/auth/service/identities/consents.d.ts.map +1 -1
  69. package/dist/esm/services/auth/service/identities/consents.js +12 -1
  70. package/dist/esm/services/auth/service/identities/consents.js.map +1 -1
  71. package/dist/esm/services/auth/service/identities/index.d.ts +66 -5
  72. package/dist/esm/services/auth/service/identities/index.d.ts.map +1 -1
  73. package/dist/esm/services/auth/service/identities/index.js +18 -2
  74. package/dist/esm/services/auth/service/identities/index.js.map +1 -1
  75. package/dist/esm/services/auth/service/oauth2/token.d.ts +8 -8
  76. package/dist/esm/services/auth/service/oauth2/token.d.ts.map +1 -1
  77. package/dist/esm/services/auth/tokens.d.ts +5 -0
  78. package/dist/esm/services/auth/tokens.d.ts.map +1 -0
  79. package/dist/esm/services/auth/tokens.js +13 -0
  80. package/dist/esm/services/auth/tokens.js.map +1 -0
  81. package/dist/esm/services/compute/service/endpoints.d.ts +87 -16
  82. package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
  83. package/dist/esm/services/compute/service/endpoints.js +34 -0
  84. package/dist/esm/services/compute/service/endpoints.js.map +1 -1
  85. package/dist/esm/services/factory.d.ts +81 -0
  86. package/dist/esm/services/factory.d.ts.map +1 -0
  87. package/dist/esm/services/factory.js +78 -0
  88. package/dist/esm/services/factory.js.map +1 -0
  89. package/dist/esm/services/flows/service/flows.d.ts +194 -18
  90. package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
  91. package/dist/esm/services/flows/service/flows.js +47 -0
  92. package/dist/esm/services/flows/service/flows.js.map +1 -1
  93. package/dist/esm/services/flows/service/runs.d.ts +145 -24
  94. package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
  95. package/dist/esm/services/flows/service/runs.js +45 -0
  96. package/dist/esm/services/flows/service/runs.js.map +1 -1
  97. package/dist/esm/services/globus-connect-server/client.d.ts +2084 -0
  98. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  99. package/dist/esm/services/globus-connect-server/client.js +52 -0
  100. package/dist/esm/services/globus-connect-server/client.js.map +1 -1
  101. package/dist/esm/services/globus-connect-server/service/collections.d.ts +1019 -0
  102. package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
  103. package/dist/esm/services/globus-connect-server/service/collections.js +36 -0
  104. package/dist/esm/services/globus-connect-server/service/collections.js.map +1 -1
  105. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +282 -0
  106. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
  107. package/dist/esm/services/globus-connect-server/service/endpoint.js +33 -0
  108. package/dist/esm/services/globus-connect-server/service/endpoint.js.map +1 -1
  109. package/dist/esm/services/globus-connect-server/service/nodes.d.ts +240 -0
  110. package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
  111. package/dist/esm/services/globus-connect-server/service/nodes.js +28 -0
  112. package/dist/esm/services/globus-connect-server/service/nodes.js.map +1 -1
  113. package/dist/esm/services/globus-connect-server/service/roles.d.ts +137 -0
  114. package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
  115. package/dist/esm/services/globus-connect-server/service/roles.js +20 -0
  116. package/dist/esm/services/globus-connect-server/service/roles.js.map +1 -1
  117. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +287 -0
  118. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
  119. package/dist/esm/services/globus-connect-server/service/storage-gateways.js +28 -0
  120. package/dist/esm/services/globus-connect-server/service/storage-gateways.js.map +1 -1
  121. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts +205 -0
  122. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
  123. package/dist/esm/services/globus-connect-server/service/user-credentials.js +28 -0
  124. package/dist/esm/services/globus-connect-server/service/user-credentials.js.map +1 -1
  125. package/dist/esm/services/globus-connect-server/service/versioning.d.ts +35 -0
  126. package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
  127. package/dist/esm/services/globus-connect-server/service/versioning.js +6 -0
  128. package/dist/esm/services/globus-connect-server/service/versioning.js.map +1 -1
  129. package/dist/esm/services/groups/service/groups.d.ts +161 -15
  130. package/dist/esm/services/groups/service/groups.d.ts.map +1 -1
  131. package/dist/esm/services/groups/service/groups.js +39 -0
  132. package/dist/esm/services/groups/service/groups.js.map +1 -1
  133. package/dist/esm/services/groups/service/membership.d.ts +28 -5
  134. package/dist/esm/services/groups/service/membership.d.ts.map +1 -1
  135. package/dist/esm/services/groups/service/membership.js +13 -1
  136. package/dist/esm/services/groups/service/membership.js.map +1 -1
  137. package/dist/esm/services/groups/service/policies.d.ts +37 -9
  138. package/dist/esm/services/groups/service/policies.d.ts.map +1 -1
  139. package/dist/esm/services/groups/service/policies.js +18 -1
  140. package/dist/esm/services/groups/service/policies.js.map +1 -1
  141. package/dist/esm/services/search/config.d.ts.map +1 -1
  142. package/dist/esm/services/search/config.js.map +1 -1
  143. package/dist/esm/services/search/index.d.ts +1 -0
  144. package/dist/esm/services/search/index.d.ts.map +1 -1
  145. package/dist/esm/services/search/index.js +1 -0
  146. package/dist/esm/services/search/index.js.map +1 -1
  147. package/dist/esm/services/search/service/entry.d.ts +24 -4
  148. package/dist/esm/services/search/service/entry.d.ts.map +1 -1
  149. package/dist/esm/services/search/service/entry.js +18 -0
  150. package/dist/esm/services/search/service/entry.js.map +1 -1
  151. package/dist/esm/services/search/service/query.d.ts +106 -45
  152. package/dist/esm/services/search/service/query.d.ts.map +1 -1
  153. package/dist/esm/services/search/service/query.js +21 -0
  154. package/dist/esm/services/search/service/query.js.map +1 -1
  155. package/dist/esm/services/search/service/roles.d.ts +29 -13
  156. package/dist/esm/services/search/service/roles.d.ts.map +1 -1
  157. package/dist/esm/services/search/service/roles.js +24 -0
  158. package/dist/esm/services/search/service/roles.js.map +1 -1
  159. package/dist/esm/services/search/service/search-index.d.ts +43 -18
  160. package/dist/esm/services/search/service/search-index.d.ts.map +1 -1
  161. package/dist/esm/services/search/service/search-index.js +41 -0
  162. package/dist/esm/services/search/service/search-index.js.map +1 -1
  163. package/dist/esm/services/search/service/subject.d.ts +23 -4
  164. package/dist/esm/services/search/service/subject.d.ts.map +1 -1
  165. package/dist/esm/services/search/service/subject.js +18 -0
  166. package/dist/esm/services/search/service/subject.js.map +1 -1
  167. package/dist/esm/services/search/service/task.d.ts +69 -0
  168. package/dist/esm/services/search/service/task.d.ts.map +1 -0
  169. package/dist/esm/services/search/service/task.js +58 -0
  170. package/dist/esm/services/search/service/task.js.map +1 -0
  171. package/dist/esm/services/shared.d.ts +1 -2
  172. package/dist/esm/services/shared.d.ts.map +1 -1
  173. package/dist/esm/services/shared.js +1 -1
  174. package/dist/esm/services/shared.js.map +1 -1
  175. package/dist/esm/services/timers/service/jobs/index.d.ts +161 -20
  176. package/dist/esm/services/timers/service/jobs/index.d.ts.map +1 -1
  177. package/dist/esm/services/timers/service/jobs/index.js +46 -6
  178. package/dist/esm/services/timers/service/jobs/index.js.map +1 -1
  179. package/dist/esm/services/timers/service/timer.d.ts +15 -2
  180. package/dist/esm/services/timers/service/timer.d.ts.map +1 -1
  181. package/dist/esm/services/timers/service/timer.js +12 -0
  182. package/dist/esm/services/timers/service/timer.js.map +1 -1
  183. package/dist/esm/services/transfer/config.js +1 -1
  184. package/dist/esm/services/transfer/config.js.map +1 -1
  185. package/dist/esm/services/transfer/index.d.ts +8 -0
  186. package/dist/esm/services/transfer/index.d.ts.map +1 -1
  187. package/dist/esm/services/transfer/index.js +5 -1
  188. package/dist/esm/services/transfer/index.js.map +1 -1
  189. package/dist/esm/services/transfer/service/access.d.ts +69 -22
  190. package/dist/esm/services/transfer/service/access.d.ts.map +1 -1
  191. package/dist/esm/services/transfer/service/access.js +35 -0
  192. package/dist/esm/services/transfer/service/access.js.map +1 -1
  193. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts +53 -15
  194. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts.map +1 -1
  195. package/dist/esm/services/transfer/service/collection-bookmarks.js +35 -0
  196. package/dist/esm/services/transfer/service/collection-bookmarks.js.map +1 -1
  197. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +40 -12
  198. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
  199. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js +27 -0
  200. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js.map +1 -1
  201. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts +58 -15
  202. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts.map +1 -1
  203. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js +35 -0
  204. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js.map +1 -1
  205. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts +105 -27
  206. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts.map +1 -1
  207. package/dist/esm/services/transfer/service/endpoint-manager/task.js +61 -0
  208. package/dist/esm/services/transfer/service/endpoint-manager/task.js.map +1 -1
  209. package/dist/esm/services/transfer/service/endpoint-search.d.ts +10 -0
  210. package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
  211. package/dist/esm/services/transfer/service/endpoint-search.js +12 -0
  212. package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
  213. package/dist/esm/services/transfer/service/endpoint.d.ts +36 -12
  214. package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
  215. package/dist/esm/services/transfer/service/endpoint.js +38 -0
  216. package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
  217. package/dist/esm/services/transfer/service/file-operations.d.ts +73 -25
  218. package/dist/esm/services/transfer/service/file-operations.d.ts.map +1 -1
  219. package/dist/esm/services/transfer/service/file-operations.js +47 -0
  220. package/dist/esm/services/transfer/service/file-operations.js.map +1 -1
  221. package/dist/esm/services/transfer/service/roles.d.ts +51 -17
  222. package/dist/esm/services/transfer/service/roles.d.ts.map +1 -1
  223. package/dist/esm/services/transfer/service/roles.js +29 -0
  224. package/dist/esm/services/transfer/service/roles.js.map +1 -1
  225. package/dist/esm/services/transfer/service/stream-access-point.d.ts +27 -4
  226. package/dist/esm/services/transfer/service/stream-access-point.d.ts.map +1 -1
  227. package/dist/esm/services/transfer/service/stream-access-point.js +16 -0
  228. package/dist/esm/services/transfer/service/stream-access-point.js.map +1 -1
  229. package/dist/esm/services/transfer/service/task-submission.d.ts +22 -4
  230. package/dist/esm/services/transfer/service/task-submission.d.ts.map +1 -1
  231. package/dist/esm/services/transfer/service/task-submission.js +32 -0
  232. package/dist/esm/services/transfer/service/task-submission.js.map +1 -1
  233. package/dist/esm/services/transfer/service/task.d.ts +85 -33
  234. package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
  235. package/dist/esm/services/transfer/service/task.js +55 -0
  236. package/dist/esm/services/transfer/service/task.js.map +1 -1
  237. package/dist/esm/services/transfer/service/tunnel.d.ts +87 -23
  238. package/dist/esm/services/transfer/service/tunnel.d.ts.map +1 -1
  239. package/dist/esm/services/transfer/service/tunnel.js +55 -2
  240. package/dist/esm/services/transfer/service/tunnel.js.map +1 -1
  241. package/dist/esm/services/transfer/service/v2/bookmarks.d.ts +66 -0
  242. package/dist/esm/services/transfer/service/v2/bookmarks.d.ts.map +1 -0
  243. package/dist/esm/services/transfer/service/v2/bookmarks.js +33 -0
  244. package/dist/esm/services/transfer/service/v2/bookmarks.js.map +1 -0
  245. package/dist/esm/services/transfer/service/v2/index.d.ts +2 -0
  246. package/dist/esm/services/transfer/service/v2/index.d.ts.map +1 -0
  247. package/dist/esm/services/transfer/service/v2/index.js +2 -0
  248. package/dist/esm/services/transfer/service/v2/index.js.map +1 -0
  249. package/dist/esm/services/transfer/types.d.ts +3 -1
  250. package/dist/esm/services/transfer/types.d.ts.map +1 -1
  251. package/dist/esm/services/types.d.ts +3 -5
  252. package/dist/esm/services/types.d.ts.map +1 -1
  253. package/dist/umd/globus.production.js +2 -2
  254. package/dist/umd/globus.production.js.map +4 -4
  255. package/package.json +10 -8
@@ -22,6 +22,7 @@ export interface paths {
22
22
  /** @description Set to true to allow this operation to return data with visibility which does not include the current user. Only allowed for index admins and owners. */
23
23
  bypass_visible_to?: boolean;
24
24
  filter_principal_sets?: string[];
25
+ fields?: ("visible_to" | "principal_sets" | "content")[];
25
26
  offset?: number;
26
27
  };
27
28
  header?: never;
@@ -670,6 +671,204 @@ export interface paths {
670
671
  patch?: never;
671
672
  trace?: never;
672
673
  };
674
+ "/beta/insights/{collection_configuration_id}/ingest": {
675
+ parameters: {
676
+ query?: never;
677
+ header?: never;
678
+ path?: never;
679
+ cookie?: never;
680
+ };
681
+ get?: never;
682
+ put?: never;
683
+ /** [BETA] Insights Ingest */
684
+ post: {
685
+ parameters: {
686
+ query?: never;
687
+ header?: never;
688
+ path: {
689
+ collection_configuration_id: string;
690
+ };
691
+ cookie?: never;
692
+ };
693
+ requestBody?: {
694
+ content: {
695
+ "application/json": components["schemas"]["InsightsIngest"];
696
+ };
697
+ };
698
+ responses: {
699
+ 200: {
700
+ headers: {
701
+ [name: string]: unknown;
702
+ };
703
+ content: {
704
+ "application/json": components["schemas"]["InsightsIngestResponse"];
705
+ };
706
+ };
707
+ };
708
+ };
709
+ delete?: never;
710
+ options?: never;
711
+ head?: never;
712
+ patch?: never;
713
+ trace?: never;
714
+ };
715
+ "/beta/insights/collection_configuration/{collection_configuration_id}/scan_start": {
716
+ parameters: {
717
+ query?: never;
718
+ header?: never;
719
+ path?: never;
720
+ cookie?: never;
721
+ };
722
+ get?: never;
723
+ put?: never;
724
+ /** [BETA] Insights Ingest Scan Start */
725
+ post: {
726
+ parameters: {
727
+ query?: never;
728
+ header?: never;
729
+ path: {
730
+ collection_configuration_id: string;
731
+ };
732
+ cookie?: never;
733
+ };
734
+ requestBody?: {
735
+ content: {
736
+ "application/json": components["schemas"]["InsightsScanStartEvent"];
737
+ };
738
+ };
739
+ responses: {
740
+ 200: {
741
+ headers: {
742
+ [name: string]: unknown;
743
+ };
744
+ content: {
745
+ "application/json": components["schemas"]["InsightsScanStartResponse"];
746
+ };
747
+ };
748
+ };
749
+ };
750
+ delete?: never;
751
+ options?: never;
752
+ head?: never;
753
+ patch?: never;
754
+ trace?: never;
755
+ };
756
+ "/beta/insights/collection_configuration/{collection_configuration_id}/scan/{scan_id}": {
757
+ parameters: {
758
+ query?: never;
759
+ header?: never;
760
+ path?: never;
761
+ cookie?: never;
762
+ };
763
+ get?: never;
764
+ put?: never;
765
+ /** [BETA] Insights Ingest Scan Stop */
766
+ post: {
767
+ parameters: {
768
+ query?: never;
769
+ header?: never;
770
+ path: {
771
+ collection_configuration_id: string;
772
+ scan_id: string;
773
+ };
774
+ cookie?: never;
775
+ };
776
+ requestBody?: {
777
+ content: {
778
+ "application/json": components["schemas"]["InsightsScanStopEvent"];
779
+ };
780
+ };
781
+ responses: {
782
+ 200: {
783
+ headers: {
784
+ [name: string]: unknown;
785
+ };
786
+ content: {
787
+ "application/json": components["schemas"]["InsightsScanStopResponse"];
788
+ };
789
+ };
790
+ };
791
+ };
792
+ delete?: never;
793
+ options?: never;
794
+ head?: never;
795
+ patch?: never;
796
+ trace?: never;
797
+ };
798
+ "/beta/insights/catalog/{catalog_id}": {
799
+ parameters: {
800
+ query?: never;
801
+ header?: never;
802
+ path?: never;
803
+ cookie?: never;
804
+ };
805
+ /** [BETA] Lookup an Insights Catalog */
806
+ get: {
807
+ parameters: {
808
+ query?: never;
809
+ header?: never;
810
+ path: {
811
+ catalog_id: string;
812
+ };
813
+ cookie?: never;
814
+ };
815
+ requestBody?: never;
816
+ responses: {
817
+ 200: {
818
+ headers: {
819
+ [name: string]: unknown;
820
+ };
821
+ content: {
822
+ "application/json": components["schemas"]["InsightsCatalog"];
823
+ };
824
+ };
825
+ };
826
+ };
827
+ put?: never;
828
+ post?: never;
829
+ delete?: never;
830
+ options?: never;
831
+ head?: never;
832
+ patch?: never;
833
+ trace?: never;
834
+ };
835
+ "/beta/insights/catalog": {
836
+ parameters: {
837
+ query?: never;
838
+ header?: never;
839
+ path?: never;
840
+ cookie?: never;
841
+ };
842
+ /** [BETA] List Insights Catalogs */
843
+ get: {
844
+ parameters: {
845
+ query?: {
846
+ filter_collection_ids?: string[];
847
+ };
848
+ header?: never;
849
+ path?: never;
850
+ cookie?: never;
851
+ };
852
+ requestBody?: never;
853
+ responses: {
854
+ 200: {
855
+ headers: {
856
+ [name: string]: unknown;
857
+ };
858
+ content: {
859
+ "application/json": components["schemas"]["InsightsCatalogList"];
860
+ };
861
+ };
862
+ };
863
+ };
864
+ put?: never;
865
+ post?: never;
866
+ delete?: never;
867
+ options?: never;
868
+ head?: never;
869
+ patch?: never;
870
+ trace?: never;
871
+ };
673
872
  "/v1/index/{index_id}/role_list": {
674
873
  parameters: {
675
874
  query?: never;
@@ -1100,58 +1299,121 @@ export type webhooks = Record<string, never>;
1100
1299
  export interface components {
1101
1300
  schemas: {
1102
1301
  ResultEntry: {
1302
+ entry_id: string | null;
1303
+ matched_principal_sets: string[];
1103
1304
  content?: {
1104
1305
  [key: string]: unknown;
1105
1306
  };
1106
- entry_id?: string;
1107
- matched_principal_sets?: string[];
1307
+ /**
1308
+ * @example [
1309
+ * "public"
1310
+ * ]
1311
+ * @example [
1312
+ * "all_authenticated_users"
1313
+ * ]
1314
+ */
1315
+ visible_to?: string[];
1316
+ principal_sets?: string[];
1108
1317
  };
1109
1318
  GMetaResult: {
1110
- /** @default 2019-08-27 */
1111
- readonly "@version": unknown;
1112
- subject?: string;
1113
- entries?: components["schemas"]["ResultEntry"][];
1319
+ /**
1320
+ * @default 2017-09-01
1321
+ * @constant
1322
+ */
1323
+ readonly "@version": "2017-09-01";
1324
+ subject: string;
1325
+ entries: components["schemas"]["ResultEntry"][];
1114
1326
  };
1115
1327
  ApproximateMetricFacetResult: {
1116
- /** @default 2017-09-01 */
1117
- readonly "@version": unknown;
1118
- readonly name?: string;
1119
- approximate_value?: number;
1328
+ /**
1329
+ * @default 2017-09-01
1330
+ * @constant
1331
+ */
1332
+ readonly "@version": "2017-09-01";
1333
+ readonly name: string;
1334
+ approximate_value: number;
1120
1335
  };
1121
1336
  MetricFacetResult: {
1122
- /** @default 2017-09-01 */
1123
- readonly "@version": unknown;
1124
- readonly name?: string;
1125
- value?: number;
1337
+ /**
1338
+ * @default 2017-09-01
1339
+ * @constant
1340
+ */
1341
+ readonly "@version": "2017-09-01";
1342
+ readonly name: string;
1343
+ value: number;
1126
1344
  };
1127
- GBucket: {
1128
- /** @default 2017-09-01 */
1129
- readonly "@version": unknown;
1130
- value?: unknown;
1131
- count?: number;
1345
+ GBucketStr: {
1346
+ /**
1347
+ * @default 2017-09-01
1348
+ * @constant
1349
+ */
1350
+ readonly "@version": "2017-09-01";
1351
+ count: number;
1352
+ value: string;
1353
+ };
1354
+ GBucketInt: {
1355
+ /**
1356
+ * @default 2017-09-01
1357
+ * @constant
1358
+ */
1359
+ readonly "@version": "2017-09-01";
1360
+ count: number;
1361
+ value: number;
1362
+ };
1363
+ GBucketFloat: {
1364
+ /**
1365
+ * @default 2017-09-01
1366
+ * @constant
1367
+ */
1368
+ readonly "@version": "2017-09-01";
1369
+ count: number;
1370
+ value: number;
1371
+ };
1372
+ RangeBounds: {
1373
+ from: unknown;
1374
+ to: unknown;
1132
1375
  };
1376
+ GBucketRange: {
1377
+ /**
1378
+ * @default 2017-09-01
1379
+ * @constant
1380
+ */
1381
+ readonly "@version": "2017-09-01";
1382
+ count: number;
1383
+ value: components["schemas"]["RangeBounds"];
1384
+ };
1385
+ GBucket: components["schemas"]["GBucketStr"] | components["schemas"]["GBucketInt"] | components["schemas"]["GBucketFloat"] | components["schemas"]["GBucketRange"];
1133
1386
  BucketFacetResult: {
1134
- /** @default 2017-09-01 */
1135
- readonly "@version": unknown;
1136
- readonly name?: string;
1137
- buckets?: components["schemas"]["GBucket"][];
1387
+ /**
1388
+ * @default 2017-09-01
1389
+ * @constant
1390
+ */
1391
+ readonly "@version": "2017-09-01";
1392
+ readonly name: string;
1393
+ buckets: components["schemas"]["GBucket"][];
1138
1394
  };
1139
1395
  GFacetResult: components["schemas"]["ApproximateMetricFacetResult"] | components["schemas"]["MetricFacetResult"] | components["schemas"]["BucketFacetResult"];
1140
1396
  GSearchResult: {
1141
- total?: number;
1397
+ total: number;
1142
1398
  /** @description The length of the 'gmeta' array. */
1143
- count?: number;
1144
- gmeta?: components["schemas"]["GMetaResult"][];
1399
+ count: number;
1400
+ gmeta: components["schemas"]["GMetaResult"][];
1145
1401
  /** @description True if another page of results is available with pagination. */
1146
- has_next_page?: boolean;
1147
- /** @default 2017-09-01 */
1148
- readonly "@version": unknown;
1149
- offset?: number;
1402
+ has_next_page: boolean;
1403
+ /**
1404
+ * @default 2017-09-01
1405
+ * @constant
1406
+ */
1407
+ readonly "@version": "2017-09-01";
1408
+ offset: number;
1150
1409
  facet_results?: components["schemas"]["GFacetResult"][];
1151
1410
  };
1152
1411
  TermsFacet: {
1153
- /** @default 2017-09-01 */
1154
- "@version": unknown;
1412
+ /**
1413
+ * @default 2017-09-01
1414
+ * @constant
1415
+ */
1416
+ "@version": "2017-09-01";
1155
1417
  /**
1156
1418
  * @description The field to which the facet refers.
1157
1419
  * Any dots (`.`) must be escaped with a preceding backslash (`\`) character.
@@ -1173,8 +1435,11 @@ export interface components {
1173
1435
  size: number;
1174
1436
  };
1175
1437
  MetricFacet: {
1176
- /** @default 2017-09-01 */
1177
- "@version": unknown;
1438
+ /**
1439
+ * @default 2017-09-01
1440
+ * @constant
1441
+ */
1442
+ "@version": "2017-09-01";
1178
1443
  /**
1179
1444
  * @description The field to which the facet refers.
1180
1445
  * Any dots (`.`) must be escaped with a preceding backslash (`\`) character.
@@ -1195,12 +1460,15 @@ export interface components {
1195
1460
  missing?: number;
1196
1461
  };
1197
1462
  DateHistogramRange: {
1198
- low?: unknown;
1199
- high?: unknown;
1463
+ low: unknown;
1464
+ high: unknown;
1200
1465
  };
1201
1466
  DateHistogramFacet: {
1202
- /** @default 2017-09-01 */
1203
- "@version": unknown;
1467
+ /**
1468
+ * @default 2017-09-01
1469
+ * @constant
1470
+ */
1471
+ "@version": "2017-09-01";
1204
1472
  /**
1205
1473
  * @description The field to which the facet refers.
1206
1474
  * Any dots (`.`) must be escaped with a preceding backslash (`\`) character.
@@ -1227,8 +1495,11 @@ export interface components {
1227
1495
  high: number;
1228
1496
  };
1229
1497
  NumericHistogramFacet: {
1230
- /** @default 2017-09-01 */
1231
- "@version": unknown;
1498
+ /**
1499
+ * @default 2017-09-01
1500
+ * @constant
1501
+ */
1502
+ "@version": "2017-09-01";
1232
1503
  /**
1233
1504
  * @description The field to which the facet refers.
1234
1505
  * Any dots (`.`) must be escaped with a preceding backslash (`\`) character.
@@ -1251,8 +1522,11 @@ export interface components {
1251
1522
  };
1252
1523
  GFacet: components["schemas"]["TermsFacet"] | components["schemas"]["MetricFacet"] | components["schemas"]["MetricFacet"] | components["schemas"]["DateHistogramFacet"] | components["schemas"]["NumericHistogramFacet"];
1253
1524
  GFilterMatchAll: {
1254
- /** @default 2017-09-01 */
1255
- "@version": unknown;
1525
+ /**
1526
+ * @default 2017-09-01
1527
+ * @constant
1528
+ */
1529
+ "@version": "2017-09-01";
1256
1530
  /**
1257
1531
  * @description discriminator enum property added by openapi-typescript
1258
1532
  * @enum {string}
@@ -1272,8 +1546,11 @@ export interface components {
1272
1546
  values: unknown[];
1273
1547
  };
1274
1548
  GFilterMatchAny: {
1275
- /** @default 2017-09-01 */
1276
- "@version": unknown;
1549
+ /**
1550
+ * @default 2017-09-01
1551
+ * @constant
1552
+ */
1553
+ "@version": "2017-09-01";
1277
1554
  /**
1278
1555
  * @description discriminator enum property added by openapi-typescript
1279
1556
  * @enum {string}
@@ -1301,8 +1578,11 @@ export interface components {
1301
1578
  lt?: unknown;
1302
1579
  };
1303
1580
  GFilterRange: {
1304
- /** @default 2017-09-01 */
1305
- "@version": unknown;
1581
+ /**
1582
+ * @default 2017-09-01
1583
+ * @constant
1584
+ */
1585
+ "@version": "2017-09-01";
1306
1586
  /**
1307
1587
  * @description discriminator enum property added by openapi-typescript
1308
1588
  * @enum {string}
@@ -1326,8 +1606,11 @@ export interface components {
1326
1606
  lon: number;
1327
1607
  };
1328
1608
  GFilterBoundingBox: {
1329
- /** @default 2017-09-01 */
1330
- "@version": unknown;
1609
+ /**
1610
+ * @default 2017-09-01
1611
+ * @constant
1612
+ */
1613
+ "@version": "2017-09-01";
1331
1614
  /**
1332
1615
  * @description discriminator enum property added by openapi-typescript
1333
1616
  * @enum {string}
@@ -1377,8 +1660,11 @@ export interface components {
1377
1660
  };
1378
1661
  GeoShape: components["schemas"]["GeoPolygon"];
1379
1662
  GFilterGeoShape: {
1380
- /** @default 2017-09-01 */
1381
- "@version": unknown;
1663
+ /**
1664
+ * @default 2017-09-01
1665
+ * @constant
1666
+ */
1667
+ "@version": "2017-09-01";
1382
1668
  /**
1383
1669
  * @description discriminator enum property added by openapi-typescript
1384
1670
  * @enum {string}
@@ -1407,8 +1693,11 @@ export interface components {
1407
1693
  relation: "intersects" | "within";
1408
1694
  };
1409
1695
  GFilterExists: {
1410
- /** @default 2017-09-01 */
1411
- "@version": unknown;
1696
+ /**
1697
+ * @default 2017-09-01
1698
+ * @constant
1699
+ */
1700
+ "@version": "2017-09-01";
1412
1701
  /**
1413
1702
  * @description discriminator enum property added by openapi-typescript
1414
1703
  * @enum {string}
@@ -1427,8 +1716,11 @@ export interface components {
1427
1716
  field_name: string;
1428
1717
  };
1429
1718
  GFilterLike: {
1430
- /** @default 2017-09-01 */
1431
- "@version": unknown;
1719
+ /**
1720
+ * @default 2017-09-01
1721
+ * @constant
1722
+ */
1723
+ "@version": "2017-09-01";
1432
1724
  /**
1433
1725
  * @description discriminator enum property added by openapi-typescript
1434
1726
  * @enum {string}
@@ -1452,8 +1744,11 @@ export interface components {
1452
1744
  value: string;
1453
1745
  };
1454
1746
  GFilterMatchAllNested: {
1455
- /** @default 2017-09-01 */
1456
- "@version": unknown;
1747
+ /**
1748
+ * @default 2017-09-01
1749
+ * @constant
1750
+ */
1751
+ "@version": "2017-09-01";
1457
1752
  /**
1458
1753
  * @description discriminator enum property added by openapi-typescript
1459
1754
  * @enum {string}
@@ -1464,8 +1759,11 @@ export interface components {
1464
1759
  values: unknown[];
1465
1760
  };
1466
1761
  GFilterMatchAnyNested: {
1467
- /** @default 2017-09-01 */
1468
- "@version": unknown;
1762
+ /**
1763
+ * @default 2017-09-01
1764
+ * @constant
1765
+ */
1766
+ "@version": "2017-09-01";
1469
1767
  /**
1470
1768
  * @description discriminator enum property added by openapi-typescript
1471
1769
  * @enum {string}
@@ -1476,8 +1774,11 @@ export interface components {
1476
1774
  values: unknown[];
1477
1775
  };
1478
1776
  GFilterRangeNested: {
1479
- /** @default 2017-09-01 */
1480
- "@version": unknown;
1777
+ /**
1778
+ * @default 2017-09-01
1779
+ * @constant
1780
+ */
1781
+ "@version": "2017-09-01";
1481
1782
  /**
1482
1783
  * @description discriminator enum property added by openapi-typescript
1483
1784
  * @enum {string}
@@ -1488,8 +1789,11 @@ export interface components {
1488
1789
  values: components["schemas"]["RangeFilterValue"][];
1489
1790
  };
1490
1791
  GFilterBoundingBoxNested: {
1491
- /** @default 2017-09-01 */
1492
- "@version": unknown;
1792
+ /**
1793
+ * @default 2017-09-01
1794
+ * @constant
1795
+ */
1796
+ "@version": "2017-09-01";
1493
1797
  /**
1494
1798
  * @description discriminator enum property added by openapi-typescript
1495
1799
  * @enum {string}
@@ -1521,8 +1825,11 @@ export interface components {
1521
1825
  bottom_right: components["schemas"]["Coordinate"];
1522
1826
  };
1523
1827
  GFilterGeoShapeNested: {
1524
- /** @default 2017-09-01 */
1525
- "@version": unknown;
1828
+ /**
1829
+ * @default 2017-09-01
1830
+ * @constant
1831
+ */
1832
+ "@version": "2017-09-01";
1526
1833
  /**
1527
1834
  * @description discriminator enum property added by openapi-typescript
1528
1835
  * @enum {string}
@@ -1542,8 +1849,11 @@ export interface components {
1542
1849
  relation: "intersects" | "within";
1543
1850
  };
1544
1851
  GFilterExistsNested: {
1545
- /** @default 2017-09-01 */
1546
- "@version": unknown;
1852
+ /**
1853
+ * @default 2017-09-01
1854
+ * @constant
1855
+ */
1856
+ "@version": "2017-09-01";
1547
1857
  /**
1548
1858
  * @description discriminator enum property added by openapi-typescript
1549
1859
  * @enum {string}
@@ -1553,8 +1863,11 @@ export interface components {
1553
1863
  field_name: string;
1554
1864
  };
1555
1865
  GFilterLikeNested: {
1556
- /** @default 2017-09-01 */
1557
- "@version": unknown;
1866
+ /**
1867
+ * @default 2017-09-01
1868
+ * @constant
1869
+ */
1870
+ "@version": "2017-09-01";
1558
1871
  /**
1559
1872
  * @description discriminator enum property added by openapi-typescript
1560
1873
  * @enum {string}
@@ -1569,8 +1882,11 @@ export interface components {
1569
1882
  value: string;
1570
1883
  };
1571
1884
  GFilterNotNested: {
1572
- /** @default 2017-09-01 */
1573
- "@version": unknown;
1885
+ /**
1886
+ * @default 2017-09-01
1887
+ * @constant
1888
+ */
1889
+ "@version": "2017-09-01";
1574
1890
  /**
1575
1891
  * @description discriminator enum property added by openapi-typescript
1576
1892
  * @enum {string}
@@ -1579,8 +1895,11 @@ export interface components {
1579
1895
  filter: components["schemas"]["GFilterNested"];
1580
1896
  };
1581
1897
  GFilterOrNested: {
1582
- /** @default 2017-09-01 */
1583
- "@version": unknown;
1898
+ /**
1899
+ * @default 2017-09-01
1900
+ * @constant
1901
+ */
1902
+ "@version": "2017-09-01";
1584
1903
  /**
1585
1904
  * @description discriminator enum property added by openapi-typescript
1586
1905
  * @enum {string}
@@ -1589,8 +1908,11 @@ export interface components {
1589
1908
  filters: components["schemas"]["GFilterNested"][];
1590
1909
  };
1591
1910
  GFilterAndNested: {
1592
- /** @default 2017-09-01 */
1593
- "@version": unknown;
1911
+ /**
1912
+ * @default 2017-09-01
1913
+ * @constant
1914
+ */
1915
+ "@version": "2017-09-01";
1594
1916
  /**
1595
1917
  * @description discriminator enum property added by openapi-typescript
1596
1918
  * @enum {string}
@@ -1600,8 +1922,11 @@ export interface components {
1600
1922
  };
1601
1923
  GFilterNested: components["schemas"]["GFilterMatchAllNested"] | components["schemas"]["GFilterMatchAnyNested"] | components["schemas"]["GFilterRangeNested"] | components["schemas"]["GFilterBoundingBoxNested"] | components["schemas"]["GFilterGeoShapeNested"] | components["schemas"]["GFilterExistsNested"] | components["schemas"]["GFilterLikeNested"] | components["schemas"]["GFilterNotNested"] | components["schemas"]["GFilterOrNested"] | components["schemas"]["GFilterAndNested"];
1602
1924
  GFilterNot: {
1603
- /** @default 2017-09-01 */
1604
- "@version": unknown;
1925
+ /**
1926
+ * @default 2017-09-01
1927
+ * @constant
1928
+ */
1929
+ "@version": "2017-09-01";
1605
1930
  /**
1606
1931
  * @description discriminator enum property added by openapi-typescript
1607
1932
  * @enum {string}
@@ -1619,8 +1944,11 @@ export interface components {
1619
1944
  filter: components["schemas"]["GFilterNested"];
1620
1945
  };
1621
1946
  GFilterOr: {
1622
- /** @default 2017-09-01 */
1623
- "@version": unknown;
1947
+ /**
1948
+ * @default 2017-09-01
1949
+ * @constant
1950
+ */
1951
+ "@version": "2017-09-01";
1624
1952
  /**
1625
1953
  * @description discriminator enum property added by openapi-typescript
1626
1954
  * @enum {string}
@@ -1638,8 +1966,11 @@ export interface components {
1638
1966
  filters: components["schemas"]["GFilterNested"][];
1639
1967
  };
1640
1968
  GFilterAnd: {
1641
- /** @default 2017-09-01 */
1642
- "@version": unknown;
1969
+ /**
1970
+ * @default 2017-09-01
1971
+ * @constant
1972
+ */
1973
+ "@version": "2017-09-01";
1643
1974
  /**
1644
1975
  * @description discriminator enum property added by openapi-typescript
1645
1976
  * @enum {string}
@@ -1658,15 +1989,21 @@ export interface components {
1658
1989
  };
1659
1990
  GFilter: components["schemas"]["GFilterMatchAll"] | components["schemas"]["GFilterMatchAny"] | components["schemas"]["GFilterRange"] | components["schemas"]["GFilterBoundingBox"] | components["schemas"]["GFilterGeoShape"] | components["schemas"]["GFilterExists"] | components["schemas"]["GFilterLike"] | components["schemas"]["GFilterNot"] | components["schemas"]["GFilterOr"] | components["schemas"]["GFilterAnd"];
1660
1991
  GBoost: {
1661
- /** @default 2017-09-01 */
1662
- "@version": unknown;
1992
+ /**
1993
+ * @default 2017-09-01
1994
+ * @constant
1995
+ */
1996
+ "@version": "2017-09-01";
1663
1997
  /** @example my_field_name */
1664
1998
  field_name: string;
1665
1999
  factor: number;
1666
2000
  };
1667
2001
  GSort: {
1668
- /** @default 2017-09-01 */
1669
- "@version": unknown;
2002
+ /**
2003
+ * @default 2017-09-01
2004
+ * @constant
2005
+ */
2006
+ "@version": "2017-09-01";
1670
2007
  /** @example my_field_name */
1671
2008
  field_name: string;
1672
2009
  /**
@@ -1906,8 +2243,8 @@ export interface components {
1906
2243
  additional_filters?: components["schemas"]["GFilterV1"][];
1907
2244
  };
1908
2245
  DateHistogramRangeV1: {
1909
- low?: unknown;
1910
- high?: unknown;
2246
+ low: unknown;
2247
+ high: unknown;
1911
2248
  };
1912
2249
  DateHistogramFacetV1: {
1913
2250
  /**
@@ -1989,7 +2326,18 @@ export interface components {
1989
2326
  mode: "advanced_query_string";
1990
2327
  default_operator: string;
1991
2328
  };
1992
- QSettings: components["schemas"]["SimpleQSettings"] | components["schemas"]["AdvancedQSettings"];
2329
+ TextMatchQSettings: {
2330
+ /**
2331
+ * @description discriminator enum property added by openapi-typescript
2332
+ * @enum {string}
2333
+ */
2334
+ mode: "text_match";
2335
+ /** @default and */
2336
+ default_operator: string;
2337
+ /** @default 1 */
2338
+ fuzziness: number;
2339
+ };
2340
+ QSettings: components["schemas"]["SimpleQSettings"] | components["schemas"]["AdvancedQSettings"] | components["schemas"]["TextMatchQSettings"];
1993
2341
  GSearchRequestBodyV1: {
1994
2342
  q?: string;
1995
2343
  /** @default 10 */
@@ -2006,6 +2354,12 @@ export interface components {
2006
2354
  * @enum {string}
2007
2355
  */
2008
2356
  "@version": "query#1.0.0";
2357
+ /**
2358
+ * @default [
2359
+ * "content"
2360
+ * ]
2361
+ */
2362
+ fields: ("visible_to" | "principal_sets" | "content")[];
2009
2363
  offset?: number;
2010
2364
  facets?: components["schemas"]["GFacetV1"][];
2011
2365
  filters?: components["schemas"]["GFilterV1"][];
@@ -2053,20 +2407,29 @@ export interface components {
2053
2407
  "@version": "scroll#1.0.0";
2054
2408
  filters?: components["schemas"]["GFilterV1"][];
2055
2409
  q_settings?: components["schemas"]["QSettings"];
2410
+ /**
2411
+ * @default [
2412
+ * "content"
2413
+ * ]
2414
+ */
2415
+ fields: ("visible_to" | "principal_sets" | "content")[];
2056
2416
  };
2057
2417
  GScrollRequest: components["schemas"]["GScrollRequest2017"] | components["schemas"]["GScrollRequestV1"];
2058
2418
  GScrollResponse: {
2059
- total?: number;
2419
+ total: number;
2060
2420
  /** @description The length of the 'gmeta' array. */
2061
- count?: number;
2062
- gmeta?: components["schemas"]["GMetaResult"][];
2421
+ count: number;
2422
+ gmeta: components["schemas"]["GMetaResult"][];
2063
2423
  /** @description True if another page of results is available with pagination. */
2064
- has_next_page?: boolean;
2065
- marker?: unknown;
2424
+ has_next_page: boolean;
2425
+ marker: unknown;
2066
2426
  };
2067
2427
  GMetaEntry: {
2068
- /** @default 2017-09-01 */
2069
- "@version": unknown;
2428
+ /**
2429
+ * @default 2017-09-01
2430
+ * @constant
2431
+ */
2432
+ "@version": "2017-09-01";
2070
2433
  subject: string;
2071
2434
  /** @default null */
2072
2435
  id: string | null;
@@ -2079,8 +2442,11 @@ export interface components {
2079
2442
  };
2080
2443
  };
2081
2444
  GIngestEntry: {
2082
- /** @default 2017-09-01 */
2083
- "@version": unknown;
2445
+ /**
2446
+ * @default 2017-09-01
2447
+ * @constant
2448
+ */
2449
+ "@version": "2017-09-01";
2084
2450
  /**
2085
2451
  * @description discriminator enum property added by openapi-typescript
2086
2452
  * @enum {string}
@@ -2104,13 +2470,19 @@ export interface components {
2104
2470
  ingest_data: components["schemas"]["GMetaEntry"];
2105
2471
  };
2106
2472
  GMetaList: {
2107
- /** @default 2017-09-01 */
2108
- "@version": unknown;
2473
+ /**
2474
+ * @default 2017-09-01
2475
+ * @constant
2476
+ */
2477
+ "@version": "2017-09-01";
2109
2478
  gmeta: components["schemas"]["GMetaEntry"][];
2110
2479
  };
2111
2480
  GIngestList: {
2112
- /** @default 2017-09-01 */
2113
- "@version": unknown;
2481
+ /**
2482
+ * @default 2017-09-01
2483
+ * @constant
2484
+ */
2485
+ "@version": "2017-09-01";
2114
2486
  /**
2115
2487
  * @description discriminator enum property added by openapi-typescript
2116
2488
  * @enum {string}
@@ -2136,58 +2508,61 @@ export interface components {
2136
2508
  GIngest: components["schemas"]["GIngestEntry"] | components["schemas"]["GIngestList"];
2137
2509
  TaskSubmitResponse: {
2138
2510
  /** @description Always true for successful task submission. */
2139
- acknowledged?: boolean;
2511
+ acknowledged: boolean;
2140
2512
  /**
2141
2513
  * Format: uuid
2142
2514
  * @description The ID of the task which was just created.
2143
2515
  */
2144
- task_id?: string;
2516
+ task_id: string;
2145
2517
  };
2146
2518
  Task: {
2147
2519
  /** Format: uuid */
2148
- task_id?: string;
2520
+ task_id: string;
2149
2521
  /** @enum {string} */
2150
- state?: "PENDING" | "PROGRESS" | "SUCCESS" | "FAILED" | "CREATING";
2151
- state_description?: string;
2152
- task_type?: string;
2522
+ state: "PENDING" | "PROGRESS" | "SUCCESS" | "FAILED" | "CREATING";
2523
+ state_description: string;
2524
+ task_type: string;
2153
2525
  /** Format: uuid */
2154
- index_id?: string;
2526
+ index_id: string;
2155
2527
  /** Format: date */
2156
- creation_date?: string;
2157
- message?: string;
2528
+ creation_date: string;
2529
+ message: string;
2158
2530
  additional_details?: unknown;
2159
2531
  /** Format: date */
2160
- completion_date?: string | null;
2532
+ completion_date: string | null;
2161
2533
  };
2162
2534
  TaskList: {
2163
2535
  /** Format: uuid */
2164
- index_id?: string;
2165
- tasks?: components["schemas"]["Task"][];
2536
+ index_id: string;
2537
+ tasks: components["schemas"]["Task"][];
2166
2538
  };
2167
2539
  IndexWithPermissions: {
2168
- /** @default 2017-09-01 */
2169
- readonly "@version": unknown;
2170
- display_name?: string;
2171
- description?: string;
2540
+ /**
2541
+ * @default 2017-09-01
2542
+ * @constant
2543
+ */
2544
+ readonly "@version": "2017-09-01";
2545
+ display_name: string;
2546
+ description: string;
2172
2547
  /** Format: uuid */
2173
- id?: string;
2174
- max_size_in_mb?: number;
2175
- size_in_mb?: number;
2176
- num_subjects?: number;
2177
- num_entries?: number;
2548
+ id: string;
2549
+ max_size_in_mb: number;
2550
+ size_in_mb: number;
2551
+ num_subjects: number;
2552
+ num_entries: number;
2178
2553
  /** Format: date */
2179
- creation_date?: string;
2554
+ creation_date: string;
2180
2555
  /** Format: date */
2181
- content_last_modified_date?: string | null;
2556
+ content_last_modified_date: string | null;
2182
2557
  entry_schema?: {
2183
2558
  [key: string]: unknown;
2184
2559
  };
2185
2560
  /** Format: uuid */
2186
- subscription_id?: string;
2187
- is_trial?: boolean;
2188
- status?: string;
2561
+ subscription_id: string;
2562
+ is_trial: boolean;
2563
+ status: string;
2189
2564
  /** @description The 'available' field indicates whether or not an index is available to serve queries and process tasks. It is `true` for active indices, but `false` when an index is being deleted or Globus Search is unable to access the index data. */
2190
- available?: boolean;
2565
+ available: boolean;
2191
2566
  permissions?: ("owner" | "admin" | "writer")[];
2192
2567
  };
2193
2568
  IndexUpdate: {
@@ -2203,38 +2578,41 @@ export interface components {
2203
2578
  description: string | null;
2204
2579
  };
2205
2580
  IndexInfo: {
2206
- /** @default 2017-09-01 */
2207
- readonly "@version": unknown;
2208
- display_name?: string;
2209
- description?: string;
2581
+ /**
2582
+ * @default 2017-09-01
2583
+ * @constant
2584
+ */
2585
+ readonly "@version": "2017-09-01";
2586
+ display_name: string;
2587
+ description: string;
2210
2588
  /** Format: uuid */
2211
- id?: string;
2212
- max_size_in_mb?: number;
2213
- size_in_mb?: number;
2214
- num_subjects?: number;
2215
- num_entries?: number;
2589
+ id: string;
2590
+ max_size_in_mb: number;
2591
+ size_in_mb: number;
2592
+ num_subjects: number;
2593
+ num_entries: number;
2216
2594
  /** Format: date */
2217
- creation_date?: string;
2595
+ creation_date: string;
2218
2596
  /** Format: date */
2219
- content_last_modified_date?: string | null;
2597
+ content_last_modified_date: string | null;
2220
2598
  entry_schema?: {
2221
2599
  [key: string]: unknown;
2222
2600
  };
2223
2601
  /** Format: uuid */
2224
- subscription_id?: string;
2225
- is_trial?: boolean;
2226
- status?: string;
2602
+ subscription_id: string;
2603
+ is_trial: boolean;
2604
+ status: string;
2227
2605
  /** @description The 'available' field indicates whether or not an index is available to serve queries and process tasks. It is `true` for active indices, but `false` when an index is being deleted or Globus Search is unable to access the index data. */
2228
- available?: boolean;
2606
+ available: boolean;
2229
2607
  };
2230
2608
  IndexDeleteResponse: {
2231
2609
  /** @description Always true for successful index deletion. */
2232
- acknowledged?: boolean;
2610
+ acknowledged: boolean;
2233
2611
  /**
2234
2612
  * Format: uuid
2235
2613
  * @description The ID of the index which was marked for deletion.
2236
2614
  */
2237
- index_id?: string;
2615
+ index_id: string;
2238
2616
  };
2239
2617
  IndexListWPermissions: {
2240
2618
  index_list?: components["schemas"]["IndexWithPermissions"][];
@@ -2247,48 +2625,107 @@ export interface components {
2247
2625
  };
2248
2626
  IndexReopenResponse: {
2249
2627
  /** @description Always true for successful index reopen. */
2250
- acknowledged?: boolean;
2628
+ acknowledged: boolean;
2251
2629
  /**
2252
2630
  * Format: uuid
2253
2631
  * @description The ID of the index which was reopened.
2254
2632
  */
2255
- index_id?: string;
2633
+ index_id: string;
2634
+ };
2635
+ Attributes: {
2636
+ /** @enum {string} */
2637
+ object_type: "file" | "dir";
2638
+ path: string;
2639
+ inode: number;
2640
+ size_bytes: number;
2641
+ uid: number;
2642
+ gid: number;
2643
+ mode_str: string;
2644
+ /** Format: date-time */
2645
+ atime: string;
2646
+ /** Format: date-time */
2647
+ ctime: string;
2648
+ /** Format: date-time */
2649
+ mtime: string;
2650
+ };
2651
+ InsightsFileScanEvent: {
2652
+ /** Format: date-time */
2653
+ scan_observed_timestamp: string;
2654
+ attributes: components["schemas"]["Attributes"];
2655
+ };
2656
+ InsightsIngest: {
2657
+ events?: components["schemas"]["InsightsFileScanEvent"][];
2658
+ };
2659
+ InsightsIngestResponse: {
2660
+ /** @description Always true for successful ingest submission. */
2661
+ acknowledged: boolean;
2662
+ };
2663
+ InsightsScanStartEvent: {
2664
+ /** @enum {string} */
2665
+ scan_type: "full" | "discovery";
2666
+ scope: string;
2667
+ };
2668
+ InsightsScanStartResponse: {
2669
+ scan_id: string;
2670
+ };
2671
+ InsightsScanStopEvent: {
2672
+ /** @enum {string} */
2673
+ status: "succeeded" | "failed" | "terminated";
2674
+ };
2675
+ InsightsScanStopResponse: {
2676
+ /** @description Always true for successful scan stop requests. */
2677
+ acknowledged: boolean;
2678
+ };
2679
+ InsightsCatalog: {
2680
+ id: string;
2681
+ display_name: string;
2682
+ collection_id: string;
2683
+ subscription_id: string;
2684
+ file_datamart_id: string | null;
2685
+ aggregation_datamart_id: string | null;
2686
+ visible_to_group_id: string | null;
2687
+ status: string;
2688
+ /** Format: date */
2689
+ created_timestamp: string;
2690
+ };
2691
+ InsightsCatalogList: {
2692
+ catalogs?: components["schemas"]["InsightsCatalog"][];
2256
2693
  };
2257
2694
  Role: {
2258
2695
  /** @description The ID of the role. */
2259
- id?: string;
2696
+ id: string;
2260
2697
  /**
2261
2698
  * @description The name of the role. This implies some set of permissions.
2262
2699
  * @enum {string}
2263
2700
  */
2264
- role_name?: "owner" | "admin" | "writer";
2701
+ role_name: "owner" | "admin" | "writer";
2265
2702
  /** Format: uuid */
2266
- index_id?: string;
2703
+ index_id: string;
2267
2704
  /** @description The principal URN for the entity which has this role. */
2268
- principal?: string;
2705
+ principal: string;
2269
2706
  /**
2270
2707
  * @description The type of principal encoded by the URN.
2271
2708
  * @enum {string}
2272
2709
  */
2273
- principal_type?: "identity" | "group";
2710
+ principal_type: "identity" | "group";
2274
2711
  /** Format: date */
2275
- creation_date?: string;
2712
+ creation_date: string;
2276
2713
  };
2277
2714
  RoleList: {
2278
- role_list?: components["schemas"]["Role"][];
2715
+ role_list: components["schemas"]["Role"][];
2279
2716
  };
2280
2717
  RoleCreate: {
2281
2718
  /**
2282
2719
  * @description The name of the role. This implies some set of permissions.
2283
2720
  * @enum {string}
2284
2721
  */
2285
- role_name?: "owner" | "admin" | "writer";
2722
+ role_name: "owner" | "admin" | "writer";
2286
2723
  /** @description The principal URN for the entity which has this role. */
2287
- principal?: string;
2724
+ principal: string;
2288
2725
  };
2289
2726
  DeletedRole: {
2290
- deleted?: components["schemas"]["Role"];
2291
- success?: boolean;
2727
+ deleted: components["schemas"]["Role"];
2728
+ success: boolean;
2292
2729
  };
2293
2730
  DeleteBySubjectRequest: {
2294
2731
  subjects: string[];
@@ -2306,8 +2743,11 @@ export interface components {
2306
2743
  };
2307
2744
  DeleteByQuery: components["schemas"]["GSearchRequestBody2017"] | components["schemas"]["DeleteByQueryV1"];
2308
2745
  UGFieldMappings: {
2309
- /** @default 2017-09-01 */
2310
- readonly "@version": unknown;
2746
+ /**
2747
+ * @default 2017-09-01
2748
+ * @constant
2749
+ */
2750
+ readonly "@version": "2017-09-01";
2311
2751
  /**
2312
2752
  * @description A mapping from full field names to their types.
2313
2753
  * @example {
@@ -2315,17 +2755,17 @@ export interface components {
2315
2755
  * "bar.baz": "text"
2316
2756
  * }
2317
2757
  */
2318
- mappings?: {
2758
+ mappings: {
2319
2759
  [key: string]: unknown;
2320
2760
  };
2321
2761
  };
2322
2762
  FieldBudget: {
2323
2763
  /** @description The size of the budget for the index. */
2324
- budget?: number;
2764
+ budget: number;
2325
2765
  /** @description The amount of the budget which has been used (i.e., budget - remaining). */
2326
- used?: number;
2766
+ used: number;
2327
2767
  /** @description The amount of the budget remaining (i.e., budget - used). */
2328
- remaining?: number;
2768
+ remaining: number;
2329
2769
  };
2330
2770
  };
2331
2771
  responses: never;