@globus/sdk 6.1.0 → 6.2.0-canary.113.06d76db

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 (245) 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 +2062 -269
  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/open-api/types/compute.d.ts +421 -159
  13. package/dist/esm/open-api/types/compute.d.ts.map +1 -1
  14. package/dist/esm/open-api/types/flows.d.ts +605 -380
  15. package/dist/esm/open-api/types/flows.d.ts.map +1 -1
  16. package/dist/esm/open-api/types/gcs/v5.4.d.ts +3251 -2374
  17. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
  18. package/dist/esm/open-api/types/search.d.ts +580 -145
  19. package/dist/esm/open-api/types/search.d.ts.map +1 -1
  20. package/dist/esm/open-api/types/timers.d.ts +25 -16
  21. package/dist/esm/open-api/types/timers.d.ts.map +1 -1
  22. package/dist/esm/open-api/types/transfer.d.ts +807 -0
  23. package/dist/esm/open-api/types/transfer.d.ts.map +1 -0
  24. package/dist/esm/open-api/types/transfer.js +2 -0
  25. package/dist/esm/open-api/types/transfer.js.map +1 -0
  26. package/dist/esm/package.json +1 -1
  27. package/dist/esm/services/auth/config.d.ts +1 -0
  28. package/dist/esm/services/auth/config.d.ts.map +1 -1
  29. package/dist/esm/services/auth/config.js +1 -0
  30. package/dist/esm/services/auth/config.js.map +1 -1
  31. package/dist/esm/services/auth/index.d.ts +2 -4
  32. package/dist/esm/services/auth/index.d.ts.map +1 -1
  33. package/dist/esm/services/auth/index.js +2 -12
  34. package/dist/esm/services/auth/index.js.map +1 -1
  35. package/dist/esm/services/auth/service/developers/clients/credentials.d.ts +69 -0
  36. package/dist/esm/services/auth/service/developers/clients/credentials.d.ts.map +1 -0
  37. package/dist/esm/services/auth/service/developers/clients/credentials.js +66 -0
  38. package/dist/esm/services/auth/service/developers/clients/credentials.js.map +1 -0
  39. package/dist/esm/services/auth/service/developers/clients/index.d.ts +137 -0
  40. package/dist/esm/services/auth/service/developers/clients/index.d.ts.map +1 -0
  41. package/dist/esm/services/auth/service/developers/clients/index.js +128 -0
  42. package/dist/esm/services/auth/service/developers/clients/index.js.map +1 -0
  43. package/dist/esm/services/auth/service/developers/clients/scopes.d.ts +38 -0
  44. package/dist/esm/services/auth/service/developers/clients/scopes.d.ts.map +1 -0
  45. package/dist/esm/services/auth/service/developers/clients/scopes.js +47 -0
  46. package/dist/esm/services/auth/service/developers/clients/scopes.js.map +1 -0
  47. package/dist/esm/services/auth/service/developers/index.d.ts +8 -0
  48. package/dist/esm/services/auth/service/developers/index.d.ts.map +1 -0
  49. package/dist/esm/services/auth/service/developers/index.js +5 -0
  50. package/dist/esm/services/auth/service/developers/index.js.map +1 -0
  51. package/dist/esm/services/auth/service/developers/policies.d.ts +95 -0
  52. package/dist/esm/services/auth/service/developers/policies.d.ts.map +1 -0
  53. package/dist/esm/services/auth/service/developers/policies.js +103 -0
  54. package/dist/esm/services/auth/service/developers/policies.js.map +1 -0
  55. package/dist/esm/services/auth/service/developers/projects.d.ts +114 -0
  56. package/dist/esm/services/auth/service/developers/projects.d.ts.map +1 -0
  57. package/dist/esm/services/auth/service/developers/projects.js +108 -0
  58. package/dist/esm/services/auth/service/developers/projects.js.map +1 -0
  59. package/dist/esm/services/auth/service/developers/scopes.d.ts +97 -0
  60. package/dist/esm/services/auth/service/developers/scopes.d.ts.map +1 -0
  61. package/dist/esm/services/auth/service/developers/scopes.js +81 -0
  62. package/dist/esm/services/auth/service/developers/scopes.js.map +1 -0
  63. package/dist/esm/services/auth/service/identities/consents.d.ts +15 -4
  64. package/dist/esm/services/auth/service/identities/consents.d.ts.map +1 -1
  65. package/dist/esm/services/auth/service/identities/consents.js +12 -1
  66. package/dist/esm/services/auth/service/identities/consents.js.map +1 -1
  67. package/dist/esm/services/auth/service/identities/index.d.ts +66 -5
  68. package/dist/esm/services/auth/service/identities/index.d.ts.map +1 -1
  69. package/dist/esm/services/auth/service/identities/index.js +18 -2
  70. package/dist/esm/services/auth/service/identities/index.js.map +1 -1
  71. package/dist/esm/services/auth/service/oauth2/token.d.ts +8 -8
  72. package/dist/esm/services/auth/service/oauth2/token.d.ts.map +1 -1
  73. package/dist/esm/services/auth/tokens.d.ts +5 -0
  74. package/dist/esm/services/auth/tokens.d.ts.map +1 -0
  75. package/dist/esm/services/auth/tokens.js +13 -0
  76. package/dist/esm/services/auth/tokens.js.map +1 -0
  77. package/dist/esm/services/compute/index.d.ts +1 -1
  78. package/dist/esm/services/compute/index.js +1 -1
  79. package/dist/esm/services/compute/service/endpoints.d.ts +87 -16
  80. package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
  81. package/dist/esm/services/compute/service/endpoints.js +34 -0
  82. package/dist/esm/services/compute/service/endpoints.js.map +1 -1
  83. package/dist/esm/services/factory.d.ts +81 -0
  84. package/dist/esm/services/factory.d.ts.map +1 -0
  85. package/dist/esm/services/factory.js +78 -0
  86. package/dist/esm/services/factory.js.map +1 -0
  87. package/dist/esm/services/flows/service/flows.d.ts +194 -18
  88. package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
  89. package/dist/esm/services/flows/service/flows.js +47 -0
  90. package/dist/esm/services/flows/service/flows.js.map +1 -1
  91. package/dist/esm/services/flows/service/runs.d.ts +145 -24
  92. package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
  93. package/dist/esm/services/flows/service/runs.js +45 -0
  94. package/dist/esm/services/flows/service/runs.js.map +1 -1
  95. package/dist/esm/services/globus-connect-server/client.d.ts +2088 -4
  96. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  97. package/dist/esm/services/globus-connect-server/client.js +52 -0
  98. package/dist/esm/services/globus-connect-server/client.js.map +1 -1
  99. package/dist/esm/services/globus-connect-server/service/collections.d.ts +1019 -0
  100. package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
  101. package/dist/esm/services/globus-connect-server/service/collections.js +36 -0
  102. package/dist/esm/services/globus-connect-server/service/collections.js.map +1 -1
  103. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +282 -0
  104. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
  105. package/dist/esm/services/globus-connect-server/service/endpoint.js +33 -0
  106. package/dist/esm/services/globus-connect-server/service/endpoint.js.map +1 -1
  107. package/dist/esm/services/globus-connect-server/service/nodes.d.ts +240 -0
  108. package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
  109. package/dist/esm/services/globus-connect-server/service/nodes.js +28 -0
  110. package/dist/esm/services/globus-connect-server/service/nodes.js.map +1 -1
  111. package/dist/esm/services/globus-connect-server/service/roles.d.ts +137 -0
  112. package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
  113. package/dist/esm/services/globus-connect-server/service/roles.js +20 -0
  114. package/dist/esm/services/globus-connect-server/service/roles.js.map +1 -1
  115. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +287 -0
  116. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
  117. package/dist/esm/services/globus-connect-server/service/storage-gateways.js +28 -0
  118. package/dist/esm/services/globus-connect-server/service/storage-gateways.js.map +1 -1
  119. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts +205 -0
  120. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
  121. package/dist/esm/services/globus-connect-server/service/user-credentials.js +28 -0
  122. package/dist/esm/services/globus-connect-server/service/user-credentials.js.map +1 -1
  123. package/dist/esm/services/globus-connect-server/service/versioning.d.ts +35 -0
  124. package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
  125. package/dist/esm/services/globus-connect-server/service/versioning.js +6 -0
  126. package/dist/esm/services/globus-connect-server/service/versioning.js.map +1 -1
  127. package/dist/esm/services/groups/service/groups.d.ts +161 -15
  128. package/dist/esm/services/groups/service/groups.d.ts.map +1 -1
  129. package/dist/esm/services/groups/service/groups.js +39 -0
  130. package/dist/esm/services/groups/service/groups.js.map +1 -1
  131. package/dist/esm/services/groups/service/membership.d.ts +28 -5
  132. package/dist/esm/services/groups/service/membership.d.ts.map +1 -1
  133. package/dist/esm/services/groups/service/membership.js +13 -1
  134. package/dist/esm/services/groups/service/membership.js.map +1 -1
  135. package/dist/esm/services/groups/service/policies.d.ts +37 -9
  136. package/dist/esm/services/groups/service/policies.d.ts.map +1 -1
  137. package/dist/esm/services/groups/service/policies.js +18 -1
  138. package/dist/esm/services/groups/service/policies.js.map +1 -1
  139. package/dist/esm/services/search/config.d.ts.map +1 -1
  140. package/dist/esm/services/search/config.js.map +1 -1
  141. package/dist/esm/services/search/index.d.ts +1 -0
  142. package/dist/esm/services/search/index.d.ts.map +1 -1
  143. package/dist/esm/services/search/index.js +1 -0
  144. package/dist/esm/services/search/index.js.map +1 -1
  145. package/dist/esm/services/search/service/entry.d.ts +24 -4
  146. package/dist/esm/services/search/service/entry.d.ts.map +1 -1
  147. package/dist/esm/services/search/service/entry.js +18 -0
  148. package/dist/esm/services/search/service/entry.js.map +1 -1
  149. package/dist/esm/services/search/service/query.d.ts +107 -49
  150. package/dist/esm/services/search/service/query.d.ts.map +1 -1
  151. package/dist/esm/services/search/service/query.js +21 -0
  152. package/dist/esm/services/search/service/query.js.map +1 -1
  153. package/dist/esm/services/search/service/roles.d.ts +29 -13
  154. package/dist/esm/services/search/service/roles.d.ts.map +1 -1
  155. package/dist/esm/services/search/service/roles.js +24 -0
  156. package/dist/esm/services/search/service/roles.js.map +1 -1
  157. package/dist/esm/services/search/service/search-index.d.ts +43 -18
  158. package/dist/esm/services/search/service/search-index.d.ts.map +1 -1
  159. package/dist/esm/services/search/service/search-index.js +41 -0
  160. package/dist/esm/services/search/service/search-index.js.map +1 -1
  161. package/dist/esm/services/search/service/subject.d.ts +23 -4
  162. package/dist/esm/services/search/service/subject.d.ts.map +1 -1
  163. package/dist/esm/services/search/service/subject.js +18 -0
  164. package/dist/esm/services/search/service/subject.js.map +1 -1
  165. package/dist/esm/services/search/service/task.d.ts +69 -0
  166. package/dist/esm/services/search/service/task.d.ts.map +1 -0
  167. package/dist/esm/services/search/service/task.js +58 -0
  168. package/dist/esm/services/search/service/task.js.map +1 -0
  169. package/dist/esm/services/shared.d.ts +1 -2
  170. package/dist/esm/services/shared.d.ts.map +1 -1
  171. package/dist/esm/services/shared.js +1 -1
  172. package/dist/esm/services/shared.js.map +1 -1
  173. package/dist/esm/services/timers/service/jobs/index.d.ts +161 -20
  174. package/dist/esm/services/timers/service/jobs/index.d.ts.map +1 -1
  175. package/dist/esm/services/timers/service/jobs/index.js +46 -6
  176. package/dist/esm/services/timers/service/jobs/index.js.map +1 -1
  177. package/dist/esm/services/timers/service/timer.d.ts +15 -2
  178. package/dist/esm/services/timers/service/timer.d.ts.map +1 -1
  179. package/dist/esm/services/timers/service/timer.js +12 -0
  180. package/dist/esm/services/timers/service/timer.js.map +1 -1
  181. package/dist/esm/services/transfer/config.js +1 -1
  182. package/dist/esm/services/transfer/config.js.map +1 -1
  183. package/dist/esm/services/transfer/index.d.ts +9 -0
  184. package/dist/esm/services/transfer/index.d.ts.map +1 -1
  185. package/dist/esm/services/transfer/index.js +6 -1
  186. package/dist/esm/services/transfer/index.js.map +1 -1
  187. package/dist/esm/services/transfer/service/access.d.ts +69 -22
  188. package/dist/esm/services/transfer/service/access.d.ts.map +1 -1
  189. package/dist/esm/services/transfer/service/access.js +35 -0
  190. package/dist/esm/services/transfer/service/access.js.map +1 -1
  191. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts +53 -15
  192. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts.map +1 -1
  193. package/dist/esm/services/transfer/service/collection-bookmarks.js +35 -0
  194. package/dist/esm/services/transfer/service/collection-bookmarks.js.map +1 -1
  195. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +40 -12
  196. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
  197. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js +27 -0
  198. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js.map +1 -1
  199. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts +58 -15
  200. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts.map +1 -1
  201. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js +35 -0
  202. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js.map +1 -1
  203. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts +105 -27
  204. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts.map +1 -1
  205. package/dist/esm/services/transfer/service/endpoint-manager/task.js +61 -0
  206. package/dist/esm/services/transfer/service/endpoint-manager/task.js.map +1 -1
  207. package/dist/esm/services/transfer/service/endpoint-search.d.ts +15 -3
  208. package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
  209. package/dist/esm/services/transfer/service/endpoint-search.js +12 -0
  210. package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
  211. package/dist/esm/services/transfer/service/endpoint.d.ts +36 -12
  212. package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
  213. package/dist/esm/services/transfer/service/endpoint.js +38 -0
  214. package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
  215. package/dist/esm/services/transfer/service/file-operations.d.ts +73 -25
  216. package/dist/esm/services/transfer/service/file-operations.d.ts.map +1 -1
  217. package/dist/esm/services/transfer/service/file-operations.js +47 -0
  218. package/dist/esm/services/transfer/service/file-operations.js.map +1 -1
  219. package/dist/esm/services/transfer/service/roles.d.ts +51 -17
  220. package/dist/esm/services/transfer/service/roles.d.ts.map +1 -1
  221. package/dist/esm/services/transfer/service/roles.js +29 -0
  222. package/dist/esm/services/transfer/service/roles.js.map +1 -1
  223. package/dist/esm/services/transfer/service/stream-access-point.d.ts +46 -0
  224. package/dist/esm/services/transfer/service/stream-access-point.d.ts.map +1 -0
  225. package/dist/esm/services/transfer/service/stream-access-point.js +42 -0
  226. package/dist/esm/services/transfer/service/stream-access-point.js.map +1 -0
  227. package/dist/esm/services/transfer/service/task-submission.d.ts +22 -4
  228. package/dist/esm/services/transfer/service/task-submission.d.ts.map +1 -1
  229. package/dist/esm/services/transfer/service/task-submission.js +32 -0
  230. package/dist/esm/services/transfer/service/task-submission.js.map +1 -1
  231. package/dist/esm/services/transfer/service/task.d.ts +85 -33
  232. package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
  233. package/dist/esm/services/transfer/service/task.js +55 -0
  234. package/dist/esm/services/transfer/service/task.js.map +1 -1
  235. package/dist/esm/services/transfer/service/tunnel.d.ts +140 -0
  236. package/dist/esm/services/transfer/service/tunnel.d.ts.map +1 -0
  237. package/dist/esm/services/transfer/service/tunnel.js +133 -0
  238. package/dist/esm/services/transfer/service/tunnel.js.map +1 -0
  239. package/dist/esm/services/transfer/types.d.ts +3 -1
  240. package/dist/esm/services/transfer/types.d.ts.map +1 -1
  241. package/dist/esm/services/types.d.ts +3 -5
  242. package/dist/esm/services/types.d.ts.map +1 -1
  243. package/dist/umd/globus.production.js +2 -2
  244. package/dist/umd/globus.production.js.map +4 -4
  245. package/package.json +7 -5
@@ -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;
@@ -32,15 +33,15 @@ export interface paths {
32
33
  };
33
34
  requestBody?: never;
34
35
  responses: {
35
- /** @description
36
- * A Search Result document.
36
+ /**
37
+ * @description A Search Result document.
37
38
  *
38
39
  * The offset, count, total, and has_next_page fields are computed based on the
39
40
  * number of results which were matched and which results were returned by the
40
41
  * search.
41
42
  * As long as `has_next_page` is True, you can add the count of results to the offset
42
43
  * of a prior query to fetch another page of results.
43
- * */
44
+ */
44
45
  200: {
45
46
  headers: {
46
47
  [name: string]: unknown;
@@ -75,15 +76,15 @@ export interface paths {
75
76
  };
76
77
  };
77
78
  responses: {
78
- /** @description
79
- * A Search Result document.
79
+ /**
80
+ * @description A Search Result document.
80
81
  *
81
82
  * The offset, count, total, and has_next_page fields are computed based on the
82
83
  * number of results which were matched and which results were returned by the
83
84
  * search.
84
85
  * As long as `has_next_page` is True, you can add the count of results to the offset
85
86
  * of a prior query to fetch another page of results.
86
- * */
87
+ */
87
88
  200: {
88
89
  headers: {
89
90
  [name: string]: unknown;
@@ -131,15 +132,15 @@ export interface paths {
131
132
  };
132
133
  };
133
134
  responses: {
134
- /** @description
135
- * A Scroll Result document.
135
+ /**
136
+ * @description A Scroll Result document.
136
137
  *
137
138
  * This is nearly identical to a Search Result, but includes the `marker` parameter.
138
139
  * `marker` is an opaque token which can be used on subsequent requests for pagination.
139
140
  *
140
141
  * NOTE: In rare cases, `has_next_page` may be True until an empty page of results is
141
142
  * reached.
142
- * */
143
+ */
143
144
  200: {
144
145
  headers: {
145
146
  [name: string]: unknown;
@@ -495,7 +496,38 @@ export interface paths {
495
496
  };
496
497
  options?: never;
497
498
  head?: never;
498
- patch?: never;
499
+ /**
500
+ * Index Update Metadata
501
+ * @description Update an index's display_name and description. Only index owners and admins
502
+ * can update an index's metadata. Only indexes with the open status can be updated.
503
+ *
504
+ * Returns the updated index metadata in the response.
505
+ */
506
+ patch: {
507
+ parameters: {
508
+ query?: never;
509
+ header?: never;
510
+ path: {
511
+ index_id: string;
512
+ };
513
+ cookie?: never;
514
+ };
515
+ requestBody?: {
516
+ content: {
517
+ "application/json": components["schemas"]["IndexUpdate"];
518
+ };
519
+ };
520
+ responses: {
521
+ 200: {
522
+ headers: {
523
+ [name: string]: unknown;
524
+ };
525
+ content: {
526
+ "application/json": components["schemas"]["IndexInfo"];
527
+ };
528
+ };
529
+ };
530
+ };
499
531
  trace?: never;
500
532
  };
501
533
  "/v1/index_list": {
@@ -639,6 +671,288 @@ export interface paths {
639
671
  patch?: never;
640
672
  trace?: never;
641
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"]["LighthouseIngest"];
696
+ };
697
+ };
698
+ responses: {
699
+ 200: {
700
+ headers: {
701
+ [name: string]: unknown;
702
+ };
703
+ content: {
704
+ "application/json": components["schemas"]["LighthouseIngestResponse"];
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"]["LighthouseScanStartEvent"];
737
+ };
738
+ };
739
+ responses: {
740
+ 200: {
741
+ headers: {
742
+ [name: string]: unknown;
743
+ };
744
+ content: {
745
+ "application/json": components["schemas"]["LighthouseScanStartResponse"];
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"]["LighthouseScanStopEvent"];
779
+ };
780
+ };
781
+ responses: {
782
+ 200: {
783
+ headers: {
784
+ [name: string]: unknown;
785
+ };
786
+ content: {
787
+ "application/json": components["schemas"]["LighthouseScanStopResponse"];
788
+ };
789
+ };
790
+ };
791
+ };
792
+ delete?: never;
793
+ options?: never;
794
+ head?: never;
795
+ patch?: never;
796
+ trace?: never;
797
+ };
798
+ "/beta/lighthouse/{collection_configuration_id}/ingest": {
799
+ parameters: {
800
+ query?: never;
801
+ header?: never;
802
+ path?: never;
803
+ cookie?: never;
804
+ };
805
+ get?: never;
806
+ put?: never;
807
+ post: {
808
+ parameters: {
809
+ query?: never;
810
+ header?: never;
811
+ path: {
812
+ collection_configuration_id: string;
813
+ };
814
+ cookie?: never;
815
+ };
816
+ requestBody?: {
817
+ content: {
818
+ "application/json": components["schemas"]["LighthouseIngest"];
819
+ };
820
+ };
821
+ responses: {
822
+ 200: {
823
+ headers: {
824
+ [name: string]: unknown;
825
+ };
826
+ content: {
827
+ "application/json": components["schemas"]["LighthouseIngestResponse"];
828
+ };
829
+ };
830
+ };
831
+ };
832
+ delete?: never;
833
+ options?: never;
834
+ head?: never;
835
+ patch?: never;
836
+ trace?: never;
837
+ };
838
+ "/beta/lighthouse/collection_configuration/{collection_configuration_id}/scan_start": {
839
+ parameters: {
840
+ query?: never;
841
+ header?: never;
842
+ path?: never;
843
+ cookie?: never;
844
+ };
845
+ get?: never;
846
+ put?: never;
847
+ post: {
848
+ parameters: {
849
+ query?: never;
850
+ header?: never;
851
+ path: {
852
+ collection_configuration_id: string;
853
+ };
854
+ cookie?: never;
855
+ };
856
+ requestBody?: {
857
+ content: {
858
+ "application/json": components["schemas"]["LighthouseScanStartEvent"];
859
+ };
860
+ };
861
+ responses: {
862
+ 200: {
863
+ headers: {
864
+ [name: string]: unknown;
865
+ };
866
+ content: {
867
+ "application/json": components["schemas"]["LighthouseScanStartResponse"];
868
+ };
869
+ };
870
+ };
871
+ };
872
+ delete?: never;
873
+ options?: never;
874
+ head?: never;
875
+ patch?: never;
876
+ trace?: never;
877
+ };
878
+ "/beta/lighthouse/collection_configuration/{collection_configuration_id}/scan/{scan_id}": {
879
+ parameters: {
880
+ query?: never;
881
+ header?: never;
882
+ path?: never;
883
+ cookie?: never;
884
+ };
885
+ get?: never;
886
+ put?: never;
887
+ post: {
888
+ parameters: {
889
+ query?: never;
890
+ header?: never;
891
+ path: {
892
+ collection_configuration_id: string;
893
+ scan_id: string;
894
+ };
895
+ cookie?: never;
896
+ };
897
+ requestBody?: {
898
+ content: {
899
+ "application/json": components["schemas"]["LighthouseScanStopEvent"];
900
+ };
901
+ };
902
+ responses: {
903
+ 200: {
904
+ headers: {
905
+ [name: string]: unknown;
906
+ };
907
+ content: {
908
+ "application/json": components["schemas"]["LighthouseScanStopResponse"];
909
+ };
910
+ };
911
+ };
912
+ };
913
+ delete?: never;
914
+ options?: never;
915
+ head?: never;
916
+ patch?: never;
917
+ trace?: never;
918
+ };
919
+ "/beta/insights/catalog/{catalog_id}": {
920
+ parameters: {
921
+ query?: never;
922
+ header?: never;
923
+ path?: never;
924
+ cookie?: never;
925
+ };
926
+ /** [BETA] Lookup an Insights Catalog */
927
+ get: {
928
+ parameters: {
929
+ query?: never;
930
+ header?: never;
931
+ path: {
932
+ catalog_id: string;
933
+ };
934
+ cookie?: never;
935
+ };
936
+ requestBody?: never;
937
+ responses: {
938
+ 200: {
939
+ headers: {
940
+ [name: string]: unknown;
941
+ };
942
+ content: {
943
+ "application/json": components["schemas"]["InsightsCatalog"];
944
+ };
945
+ };
946
+ };
947
+ };
948
+ put?: never;
949
+ post?: never;
950
+ delete?: never;
951
+ options?: never;
952
+ head?: never;
953
+ patch?: never;
954
+ trace?: never;
955
+ };
642
956
  "/v1/index/{index_id}/role_list": {
643
957
  parameters: {
644
958
  query?: never;
@@ -1069,53 +1383,86 @@ export type webhooks = Record<string, never>;
1069
1383
  export interface components {
1070
1384
  schemas: {
1071
1385
  ResultEntry: {
1386
+ entry_id: string | null;
1387
+ matched_principal_sets: string[];
1072
1388
  content?: {
1073
1389
  [key: string]: unknown;
1074
1390
  };
1075
- entry_id?: string;
1076
- matched_principal_sets?: string[];
1391
+ /**
1392
+ * @example [
1393
+ * "public"
1394
+ * ]
1395
+ * @example [
1396
+ * "all_authenticated_users"
1397
+ * ]
1398
+ */
1399
+ visible_to?: string[];
1400
+ principal_sets?: string[];
1077
1401
  };
1078
1402
  GMetaResult: {
1079
- /** @default 2019-08-27 */
1403
+ /** @default 2017-09-01 */
1080
1404
  readonly "@version": unknown;
1081
- subject?: string;
1082
- entries?: components["schemas"]["ResultEntry"][];
1405
+ subject: string;
1406
+ entries: components["schemas"]["ResultEntry"][];
1083
1407
  };
1084
1408
  ApproximateMetricFacetResult: {
1085
1409
  /** @default 2017-09-01 */
1086
1410
  readonly "@version": unknown;
1087
- readonly name?: string;
1088
- approximate_value?: number;
1411
+ readonly name: string;
1412
+ approximate_value: number;
1089
1413
  };
1090
1414
  MetricFacetResult: {
1091
1415
  /** @default 2017-09-01 */
1092
1416
  readonly "@version": unknown;
1093
- readonly name?: string;
1094
- value?: number;
1417
+ readonly name: string;
1418
+ value: number;
1419
+ };
1420
+ GBucketStr: {
1421
+ /** @default 2017-09-01 */
1422
+ readonly "@version": unknown;
1423
+ count: number;
1424
+ value: string;
1425
+ };
1426
+ GBucketInt: {
1427
+ /** @default 2017-09-01 */
1428
+ readonly "@version": unknown;
1429
+ count: number;
1430
+ value: number;
1431
+ };
1432
+ GBucketFloat: {
1433
+ /** @default 2017-09-01 */
1434
+ readonly "@version": unknown;
1435
+ count: number;
1436
+ value: number;
1437
+ };
1438
+ RangeBounds: {
1439
+ from: unknown;
1440
+ to: unknown;
1095
1441
  };
1096
- GBucket: {
1442
+ GBucketRange: {
1097
1443
  /** @default 2017-09-01 */
1098
1444
  readonly "@version": unknown;
1099
- value?: unknown;
1100
- count?: number;
1445
+ count: number;
1446
+ value: components["schemas"]["RangeBounds"];
1101
1447
  };
1448
+ GBucket: components["schemas"]["GBucketStr"] | components["schemas"]["GBucketInt"] | components["schemas"]["GBucketFloat"] | components["schemas"]["GBucketRange"];
1102
1449
  BucketFacetResult: {
1103
1450
  /** @default 2017-09-01 */
1104
1451
  readonly "@version": unknown;
1105
- readonly name?: string;
1106
- buckets?: components["schemas"]["GBucket"][];
1452
+ readonly name: string;
1453
+ buckets: components["schemas"]["GBucket"][];
1107
1454
  };
1108
1455
  GFacetResult: components["schemas"]["ApproximateMetricFacetResult"] | components["schemas"]["MetricFacetResult"] | components["schemas"]["BucketFacetResult"];
1109
1456
  GSearchResult: {
1110
- total?: number;
1457
+ total: number;
1111
1458
  /** @description The length of the 'gmeta' array. */
1112
- count?: number;
1113
- gmeta?: components["schemas"]["GMetaResult"][];
1459
+ count: number;
1460
+ gmeta: components["schemas"]["GMetaResult"][];
1114
1461
  /** @description True if another page of results is available with pagination. */
1115
- has_next_page?: boolean;
1462
+ has_next_page: boolean;
1116
1463
  /** @default 2017-09-01 */
1117
1464
  readonly "@version": unknown;
1118
- offset?: number;
1465
+ offset: number;
1119
1466
  facet_results?: components["schemas"]["GFacetResult"][];
1120
1467
  };
1121
1468
  TermsFacet: {
@@ -1127,9 +1474,11 @@ export interface components {
1127
1474
  * @example my_field_name
1128
1475
  */
1129
1476
  field_name: string;
1130
- /** @description A name for this facet which is referenced in the results.
1477
+ /**
1478
+ * @description A name for this facet which is referenced in the results.
1131
1479
  *
1132
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
1480
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
1481
+ */
1133
1482
  name?: string;
1134
1483
  /**
1135
1484
  * @description discriminator enum property added by openapi-typescript
@@ -1148,9 +1497,11 @@ export interface components {
1148
1497
  * @example my_field_name
1149
1498
  */
1150
1499
  field_name: string;
1151
- /** @description A name for this facet which is referenced in the results.
1500
+ /**
1501
+ * @description A name for this facet which is referenced in the results.
1152
1502
  *
1153
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
1503
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
1504
+ */
1154
1505
  name?: string;
1155
1506
  /**
1156
1507
  * @description discriminator enum property added by openapi-typescript
@@ -1160,8 +1511,8 @@ export interface components {
1160
1511
  missing?: number;
1161
1512
  };
1162
1513
  DateHistogramRange: {
1163
- low?: unknown;
1164
- high?: unknown;
1514
+ low: unknown;
1515
+ high: unknown;
1165
1516
  };
1166
1517
  DateHistogramFacet: {
1167
1518
  /** @default 2017-09-01 */
@@ -1172,9 +1523,11 @@ export interface components {
1172
1523
  * @example my_field_name
1173
1524
  */
1174
1525
  field_name: string;
1175
- /** @description A name for this facet which is referenced in the results.
1526
+ /**
1527
+ * @description A name for this facet which is referenced in the results.
1176
1528
  *
1177
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
1529
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
1530
+ */
1178
1531
  name?: string;
1179
1532
  /**
1180
1533
  * @description discriminator enum property added by openapi-typescript
@@ -1198,9 +1551,11 @@ export interface components {
1198
1551
  * @example my_field_name
1199
1552
  */
1200
1553
  field_name: string;
1201
- /** @description A name for this facet which is referenced in the results.
1554
+ /**
1555
+ * @description A name for this facet which is referenced in the results.
1202
1556
  *
1203
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
1557
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
1558
+ */
1204
1559
  name?: string;
1205
1560
  /**
1206
1561
  * @description discriminator enum property added by openapi-typescript
@@ -1225,7 +1580,6 @@ export interface components {
1225
1580
  * query results.
1226
1581
  *
1227
1582
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1228
- *
1229
1583
  * @default false
1230
1584
  */
1231
1585
  post_filter: boolean;
@@ -1247,7 +1601,6 @@ export interface components {
1247
1601
  * query results.
1248
1602
  *
1249
1603
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1250
- *
1251
1604
  * @default true
1252
1605
  */
1253
1606
  post_filter: boolean;
@@ -1277,7 +1630,6 @@ export interface components {
1277
1630
  * query results.
1278
1631
  *
1279
1632
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1280
- *
1281
1633
  * @default true
1282
1634
  */
1283
1635
  post_filter: boolean;
@@ -1303,7 +1655,6 @@ export interface components {
1303
1655
  * query results.
1304
1656
  *
1305
1657
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1306
- *
1307
1658
  * @default true
1308
1659
  */
1309
1660
  post_filter: boolean;
@@ -1314,7 +1665,6 @@ export interface components {
1314
1665
  * and `lon`, for latitude and longitude. The values must be floats, positive or negative,
1315
1666
  * within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
1316
1667
  * [-180.0, 180.0] for longitude.
1317
- *
1318
1668
  * @example {
1319
1669
  * "lat": 40.9,
1320
1670
  * "lon": 87.5
@@ -1326,7 +1676,6 @@ export interface components {
1326
1676
  * and `lon`, for latitude and longitude. The values must be floats, positive or negative,
1327
1677
  * within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
1328
1678
  * [-180.0, 180.0] for longitude.
1329
- *
1330
1679
  * @example {
1331
1680
  * "lat": 40.9,
1332
1681
  * "lon": 87.5
@@ -1357,7 +1706,6 @@ export interface components {
1357
1706
  * query results.
1358
1707
  *
1359
1708
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1360
- *
1361
1709
  * @default true
1362
1710
  */
1363
1711
  post_filter: boolean;
@@ -1369,7 +1717,6 @@ export interface components {
1369
1717
  *
1370
1718
  * 'intersects': (default) Return documents whose shape intersects the query shape.
1371
1719
  * 'within': Return documents whose shape is fully within the query shape.
1372
- *
1373
1720
  * @default intersects
1374
1721
  * @enum {string}
1375
1722
  */
@@ -1389,7 +1736,6 @@ export interface components {
1389
1736
  * query results.
1390
1737
  *
1391
1738
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1392
- *
1393
1739
  * @default true
1394
1740
  */
1395
1741
  post_filter: boolean;
@@ -1410,7 +1756,6 @@ export interface components {
1410
1756
  * query results.
1411
1757
  *
1412
1758
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1413
- *
1414
1759
  * @default true
1415
1760
  */
1416
1761
  post_filter: boolean;
@@ -1473,7 +1818,6 @@ export interface components {
1473
1818
  * and `lon`, for latitude and longitude. The values must be floats, positive or negative,
1474
1819
  * within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
1475
1820
  * [-180.0, 180.0] for longitude.
1476
- *
1477
1821
  * @example {
1478
1822
  * "lat": 40.9,
1479
1823
  * "lon": 87.5
@@ -1485,7 +1829,6 @@ export interface components {
1485
1829
  * and `lon`, for latitude and longitude. The values must be floats, positive or negative,
1486
1830
  * within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
1487
1831
  * [-180.0, 180.0] for longitude.
1488
- *
1489
1832
  * @example {
1490
1833
  * "lat": 40.9,
1491
1834
  * "lon": 87.5
@@ -1509,7 +1852,6 @@ export interface components {
1509
1852
  *
1510
1853
  * 'intersects': (default) Return documents whose shape intersects the query shape.
1511
1854
  * 'within': Return documents whose shape is fully within the query shape.
1512
- *
1513
1855
  * @default intersects
1514
1856
  * @enum {string}
1515
1857
  */
@@ -1587,7 +1929,6 @@ export interface components {
1587
1929
  * query results.
1588
1930
  *
1589
1931
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1590
- *
1591
1932
  * @default true
1592
1933
  */
1593
1934
  post_filter: boolean;
@@ -1607,7 +1948,6 @@ export interface components {
1607
1948
  * query results.
1608
1949
  *
1609
1950
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1610
- *
1611
1951
  * @default true
1612
1952
  */
1613
1953
  post_filter: boolean;
@@ -1627,7 +1967,6 @@ export interface components {
1627
1967
  * query results.
1628
1968
  *
1629
1969
  * Defaults to True for all filters except `match_all`, where it defaults to False.
1630
- *
1631
1970
  * @default true
1632
1971
  */
1633
1972
  post_filter: boolean;
@@ -1725,7 +2064,6 @@ export interface components {
1725
2064
  * and `lon`, for latitude and longitude. The values must be floats, positive or negative,
1726
2065
  * within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
1727
2066
  * [-180.0, 180.0] for longitude.
1728
- *
1729
2067
  * @example {
1730
2068
  * "lat": 40.9,
1731
2069
  * "lon": 87.5
@@ -1737,7 +2075,6 @@ export interface components {
1737
2075
  * and `lon`, for latitude and longitude. The values must be floats, positive or negative,
1738
2076
  * within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
1739
2077
  * [-180.0, 180.0] for longitude.
1740
- *
1741
2078
  * @example {
1742
2079
  * "lat": 40.9,
1743
2080
  * "lon": 87.5
@@ -1768,7 +2105,6 @@ export interface components {
1768
2105
  *
1769
2106
  * 'intersects': (default) Return documents whose shape intersects the query shape.
1770
2107
  * 'within': Return documents whose shape is fully within the query shape.
1771
- *
1772
2108
  * @default intersects
1773
2109
  * @enum {string}
1774
2110
  */
@@ -1829,9 +2165,11 @@ export interface components {
1829
2165
  * @example my_field_name
1830
2166
  */
1831
2167
  field_name: string;
1832
- /** @description A name for this facet which is referenced in the results.
2168
+ /**
2169
+ * @description A name for this facet which is referenced in the results.
1833
2170
  *
1834
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
2171
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
2172
+ */
1835
2173
  name?: string;
1836
2174
  /**
1837
2175
  * @description discriminator enum property added by openapi-typescript
@@ -1849,9 +2187,11 @@ export interface components {
1849
2187
  * @example my_field_name
1850
2188
  */
1851
2189
  field_name: string;
1852
- /** @description A name for this facet which is referenced in the results.
2190
+ /**
2191
+ * @description A name for this facet which is referenced in the results.
1853
2192
  *
1854
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
2193
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
2194
+ */
1855
2195
  name?: string;
1856
2196
  /**
1857
2197
  * @description discriminator enum property added by openapi-typescript
@@ -1868,9 +2208,11 @@ export interface components {
1868
2208
  * @example my_field_name
1869
2209
  */
1870
2210
  field_name: string;
1871
- /** @description A name for this facet which is referenced in the results.
2211
+ /**
2212
+ * @description A name for this facet which is referenced in the results.
1872
2213
  *
1873
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
2214
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
2215
+ */
1874
2216
  name?: string;
1875
2217
  /**
1876
2218
  * @description discriminator enum property added by openapi-typescript
@@ -1880,8 +2222,8 @@ export interface components {
1880
2222
  additional_filters?: components["schemas"]["GFilterV1"][];
1881
2223
  };
1882
2224
  DateHistogramRangeV1: {
1883
- low?: unknown;
1884
- high?: unknown;
2225
+ low: unknown;
2226
+ high: unknown;
1885
2227
  };
1886
2228
  DateHistogramFacetV1: {
1887
2229
  /**
@@ -1890,9 +2232,11 @@ export interface components {
1890
2232
  * @example my_field_name
1891
2233
  */
1892
2234
  field_name: string;
1893
- /** @description A name for this facet which is referenced in the results.
2235
+ /**
2236
+ * @description A name for this facet which is referenced in the results.
1894
2237
  *
1895
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
2238
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
2239
+ */
1896
2240
  name?: string;
1897
2241
  /**
1898
2242
  * @description discriminator enum property added by openapi-typescript
@@ -1915,9 +2259,11 @@ export interface components {
1915
2259
  * @example my_field_name
1916
2260
  */
1917
2261
  field_name: string;
1918
- /** @description A name for this facet which is referenced in the results.
2262
+ /**
2263
+ * @description A name for this facet which is referenced in the results.
1919
2264
  *
1920
- * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
2265
+ * If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
2266
+ */
1921
2267
  name?: string;
1922
2268
  /**
1923
2269
  * @description discriminator enum property added by openapi-typescript
@@ -1959,7 +2305,18 @@ export interface components {
1959
2305
  mode: "advanced_query_string";
1960
2306
  default_operator: string;
1961
2307
  };
1962
- QSettings: components["schemas"]["SimpleQSettings"] | components["schemas"]["AdvancedQSettings"];
2308
+ TextMatchQSettings: {
2309
+ /**
2310
+ * @description discriminator enum property added by openapi-typescript
2311
+ * @enum {string}
2312
+ */
2313
+ mode: "text_match";
2314
+ /** @default and */
2315
+ default_operator: string;
2316
+ /** @default 1 */
2317
+ fuzziness: number;
2318
+ };
2319
+ QSettings: components["schemas"]["SimpleQSettings"] | components["schemas"]["AdvancedQSettings"] | components["schemas"]["TextMatchQSettings"];
1963
2320
  GSearchRequestBodyV1: {
1964
2321
  q?: string;
1965
2322
  /** @default 10 */
@@ -1976,6 +2333,12 @@ export interface components {
1976
2333
  * @enum {string}
1977
2334
  */
1978
2335
  "@version": "query#1.0.0";
2336
+ /**
2337
+ * @default [
2338
+ * "content"
2339
+ * ]
2340
+ */
2341
+ fields: ("visible_to" | "principal_sets" | "content")[];
1979
2342
  offset?: number;
1980
2343
  facets?: components["schemas"]["GFacetV1"][];
1981
2344
  filters?: components["schemas"]["GFilterV1"][];
@@ -2023,16 +2386,22 @@ export interface components {
2023
2386
  "@version": "scroll#1.0.0";
2024
2387
  filters?: components["schemas"]["GFilterV1"][];
2025
2388
  q_settings?: components["schemas"]["QSettings"];
2389
+ /**
2390
+ * @default [
2391
+ * "content"
2392
+ * ]
2393
+ */
2394
+ fields: ("visible_to" | "principal_sets" | "content")[];
2026
2395
  };
2027
2396
  GScrollRequest: components["schemas"]["GScrollRequest2017"] | components["schemas"]["GScrollRequestV1"];
2028
2397
  GScrollResponse: {
2029
- total?: number;
2398
+ total: number;
2030
2399
  /** @description The length of the 'gmeta' array. */
2031
- count?: number;
2032
- gmeta?: components["schemas"]["GMetaResult"][];
2400
+ count: number;
2401
+ gmeta: components["schemas"]["GMetaResult"][];
2033
2402
  /** @description True if another page of results is available with pagination. */
2034
- has_next_page?: boolean;
2035
- marker?: unknown;
2403
+ has_next_page: boolean;
2404
+ marker: unknown;
2036
2405
  };
2037
2406
  GMetaEntry: {
2038
2407
  /** @default 2017-09-01 */
@@ -2063,7 +2432,6 @@ export interface components {
2063
2432
  * backslash.
2064
2433
  *
2065
2434
  * Currently, only geo datatypes are supported.
2066
- *
2067
2435
  * @example {
2068
2436
  * "location.center": "geo_point",
2069
2437
  * "location.boundary": "geo_shape"
@@ -2094,7 +2462,6 @@ export interface components {
2094
2462
  * backslash.
2095
2463
  *
2096
2464
  * Currently, only geo datatypes are supported.
2097
- *
2098
2465
  * @example {
2099
2466
  * "location.center": "geo_point",
2100
2467
  * "location.boundary": "geo_shape"
@@ -2108,68 +2475,105 @@ export interface components {
2108
2475
  GIngest: components["schemas"]["GIngestEntry"] | components["schemas"]["GIngestList"];
2109
2476
  TaskSubmitResponse: {
2110
2477
  /** @description Always true for successful task submission. */
2111
- acknowledged?: boolean;
2478
+ acknowledged: boolean;
2112
2479
  /**
2113
2480
  * Format: uuid
2114
2481
  * @description The ID of the task which was just created.
2115
2482
  */
2116
- task_id?: string;
2483
+ task_id: string;
2117
2484
  };
2118
2485
  Task: {
2119
2486
  /** Format: uuid */
2120
- task_id?: string;
2487
+ task_id: string;
2121
2488
  /** @enum {string} */
2122
- state?: "PENDING" | "PROGRESS" | "SUCCESS" | "FAILED" | "CREATING";
2123
- state_description?: string;
2124
- task_type?: string;
2489
+ state: "PENDING" | "PROGRESS" | "SUCCESS" | "FAILED" | "CREATING";
2490
+ state_description: string;
2491
+ task_type: string;
2125
2492
  /** Format: uuid */
2126
- index_id?: string;
2493
+ index_id: string;
2127
2494
  /** Format: date */
2128
- creation_date?: string;
2129
- message?: string;
2495
+ creation_date: string;
2496
+ message: string;
2130
2497
  additional_details?: unknown;
2131
2498
  /** Format: date */
2132
- completion_date?: string | null;
2499
+ completion_date: string | null;
2133
2500
  };
2134
2501
  TaskList: {
2135
2502
  /** Format: uuid */
2136
- index_id?: string;
2137
- tasks?: components["schemas"]["Task"][];
2503
+ index_id: string;
2504
+ tasks: components["schemas"]["Task"][];
2138
2505
  };
2139
2506
  IndexWithPermissions: {
2140
2507
  /** @default 2017-09-01 */
2141
2508
  readonly "@version": unknown;
2142
- display_name?: string;
2143
- description?: string;
2509
+ display_name: string;
2510
+ description: string;
2144
2511
  /** Format: uuid */
2145
- id?: string;
2146
- max_size_in_mb?: number;
2147
- size_in_mb?: number;
2148
- num_subjects?: number;
2149
- num_entries?: number;
2512
+ id: string;
2513
+ max_size_in_mb: number;
2514
+ size_in_mb: number;
2515
+ num_subjects: number;
2516
+ num_entries: number;
2150
2517
  /** Format: date */
2151
- creation_date?: string;
2518
+ creation_date: string;
2152
2519
  /** Format: date */
2153
- content_last_modified_date?: string | null;
2520
+ content_last_modified_date: string | null;
2154
2521
  entry_schema?: {
2155
2522
  [key: string]: unknown;
2156
2523
  };
2157
2524
  /** Format: uuid */
2158
- subscription_id?: string;
2159
- is_trial?: boolean;
2160
- status?: string;
2525
+ subscription_id: string;
2526
+ is_trial: boolean;
2527
+ status: string;
2161
2528
  /** @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. */
2162
- available?: boolean;
2529
+ available: boolean;
2163
2530
  permissions?: ("owner" | "admin" | "writer")[];
2164
2531
  };
2532
+ IndexUpdate: {
2533
+ /**
2534
+ * @description The name of the index
2535
+ * @default null
2536
+ */
2537
+ display_name: string | null;
2538
+ /**
2539
+ * @description A description of the index
2540
+ * @default null
2541
+ */
2542
+ description: string | null;
2543
+ };
2544
+ IndexInfo: {
2545
+ /** @default 2017-09-01 */
2546
+ readonly "@version": unknown;
2547
+ display_name: string;
2548
+ description: string;
2549
+ /** Format: uuid */
2550
+ id: string;
2551
+ max_size_in_mb: number;
2552
+ size_in_mb: number;
2553
+ num_subjects: number;
2554
+ num_entries: number;
2555
+ /** Format: date */
2556
+ creation_date: string;
2557
+ /** Format: date */
2558
+ content_last_modified_date: string | null;
2559
+ entry_schema?: {
2560
+ [key: string]: unknown;
2561
+ };
2562
+ /** Format: uuid */
2563
+ subscription_id: string;
2564
+ is_trial: boolean;
2565
+ status: string;
2566
+ /** @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. */
2567
+ available: boolean;
2568
+ };
2165
2569
  IndexDeleteResponse: {
2166
2570
  /** @description Always true for successful index deletion. */
2167
- acknowledged?: boolean;
2571
+ acknowledged: boolean;
2168
2572
  /**
2169
2573
  * Format: uuid
2170
2574
  * @description The ID of the index which was marked for deletion.
2171
2575
  */
2172
- index_id?: string;
2576
+ index_id: string;
2173
2577
  };
2174
2578
  IndexListWPermissions: {
2175
2579
  index_list?: components["schemas"]["IndexWithPermissions"][];
@@ -2180,62 +2584,93 @@ export interface components {
2180
2584
  /** @description A description of the index */
2181
2585
  description: string;
2182
2586
  };
2183
- IndexInfo: {
2184
- /** @default 2017-09-01 */
2185
- readonly "@version": unknown;
2186
- display_name?: string;
2187
- description?: string;
2188
- /** Format: uuid */
2189
- id?: string;
2190
- max_size_in_mb?: number;
2191
- size_in_mb?: number;
2192
- num_subjects?: number;
2193
- num_entries?: number;
2194
- /** Format: date */
2195
- creation_date?: string;
2196
- /** Format: date */
2197
- content_last_modified_date?: string | null;
2198
- entry_schema?: {
2199
- [key: string]: unknown;
2200
- };
2201
- /** Format: uuid */
2202
- subscription_id?: string;
2203
- is_trial?: boolean;
2204
- status?: string;
2205
- /** @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. */
2206
- available?: boolean;
2207
- };
2208
2587
  IndexReopenResponse: {
2209
2588
  /** @description Always true for successful index reopen. */
2210
- acknowledged?: boolean;
2589
+ acknowledged: boolean;
2211
2590
  /**
2212
2591
  * Format: uuid
2213
2592
  * @description The ID of the index which was reopened.
2214
2593
  */
2215
- index_id?: string;
2594
+ index_id: string;
2595
+ };
2596
+ Attributes: {
2597
+ /** @enum {string} */
2598
+ object_type: "file" | "dir";
2599
+ path: string;
2600
+ inode: number;
2601
+ size_bytes: number;
2602
+ uid: number;
2603
+ gid: number;
2604
+ mode_str: string;
2605
+ /** Format: date-time */
2606
+ atime: string;
2607
+ /** Format: date-time */
2608
+ ctime: string;
2609
+ /** Format: date-time */
2610
+ mtime: string;
2611
+ };
2612
+ LighthouseFileScanEvent: {
2613
+ /** Format: date-time */
2614
+ scan_observed_timestamp: string;
2615
+ attributes: components["schemas"]["Attributes"];
2616
+ };
2617
+ LighthouseIngest: {
2618
+ events?: components["schemas"]["LighthouseFileScanEvent"][];
2619
+ };
2620
+ LighthouseIngestResponse: {
2621
+ /** @description Always true for successful ingest submission. */
2622
+ acknowledged: boolean;
2623
+ };
2624
+ LighthouseScanStartEvent: {
2625
+ /** @enum {string} */
2626
+ scan_type: "full" | "discovery";
2627
+ scope: string;
2628
+ };
2629
+ LighthouseScanStartResponse: {
2630
+ scan_id: string;
2631
+ };
2632
+ LighthouseScanStopEvent: {
2633
+ /** @enum {string} */
2634
+ status: "succeeded" | "failed" | "terminated";
2635
+ };
2636
+ LighthouseScanStopResponse: {
2637
+ /** @description Always true for successful scan stop requests. */
2638
+ acknowledged: boolean;
2639
+ };
2640
+ InsightsCatalog: {
2641
+ id: string;
2642
+ display_name: string;
2643
+ collection_id: string;
2644
+ subscription_id: string;
2645
+ file_datamart_id: string | null;
2646
+ aggregation_datamart_id: string | null;
2647
+ visible_to_group_id: string | null;
2648
+ status: string;
2649
+ /** Format: date */
2650
+ created_timestamp: string;
2216
2651
  };
2217
2652
  Role: {
2218
2653
  /** @description The ID of the role. */
2219
- id?: string;
2654
+ id: string;
2220
2655
  /**
2221
2656
  * @description The name of the role. This implies some set of permissions.
2222
2657
  * @enum {string}
2223
2658
  */
2224
- role_name?: "owner" | "admin" | "writer";
2659
+ role_name: "owner" | "admin" | "writer";
2225
2660
  /** Format: uuid */
2226
- index_id?: string;
2661
+ index_id: string;
2227
2662
  /** @description The principal URN for the entity which has this role. */
2228
- principal?: string;
2663
+ principal: string;
2229
2664
  /**
2230
2665
  * @description The type of principal encoded by the URN.
2231
2666
  * @enum {string}
2232
2667
  */
2233
- principal_type?: "identity" | "group";
2668
+ principal_type: "identity" | "group";
2234
2669
  /** Format: date */
2235
- creation_date?: string;
2670
+ creation_date: string;
2236
2671
  };
2237
2672
  RoleList: {
2238
- role_list?: components["schemas"]["Role"][];
2673
+ role_list: components["schemas"]["Role"][];
2239
2674
  };
2240
2675
  RoleCreate: {
2241
2676
  /**
@@ -2247,8 +2682,8 @@ export interface components {
2247
2682
  principal?: string;
2248
2683
  };
2249
2684
  DeletedRole: {
2250
- deleted?: components["schemas"]["Role"];
2251
- success?: boolean;
2685
+ deleted: components["schemas"]["Role"];
2686
+ success: boolean;
2252
2687
  };
2253
2688
  DeleteBySubjectRequest: {
2254
2689
  subjects: string[];
@@ -2275,17 +2710,17 @@ export interface components {
2275
2710
  * "bar.baz": "text"
2276
2711
  * }
2277
2712
  */
2278
- mappings?: {
2713
+ mappings: {
2279
2714
  [key: string]: unknown;
2280
2715
  };
2281
2716
  };
2282
2717
  FieldBudget: {
2283
2718
  /** @description The size of the budget for the index. */
2284
- budget?: number;
2719
+ budget: number;
2285
2720
  /** @description The amount of the budget which has been used (i.e., budget - remaining). */
2286
- used?: number;
2721
+ used: number;
2287
2722
  /** @description The amount of the budget remaining (i.e., budget - used). */
2288
- remaining?: number;
2723
+ remaining: number;
2289
2724
  };
2290
2725
  };
2291
2726
  responses: never;