@globus/sdk 6.2.0-next.9.9c8bf24 → 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 +576 -162
  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 +740 -67
  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,25 +22,15 @@ export interface paths {
22
22
  * once an initial marker has been received.
23
23
  */
24
24
  marker?: string;
25
- /**
26
- * @description The number of results to return in a single paged response.
27
- * @example 50
28
- */
25
+ /** @description The number of results to return in a single paged response. */
29
26
  per_page?: number;
30
- /**
31
- * @description The page of results to return.
32
- * @example 2
33
- */
27
+ /** @description The page of results to return. */
34
28
  page?: number;
35
29
  /**
36
30
  * @description Return Flows for which the user has the supplied role. The role the
37
31
  * user has on the Flow dictates the operations they can perform. If
38
32
  * multiple roles are specified, the user will have at least one of the
39
33
  * specified roles on each Flow returned.
40
- * @example [
41
- * "flow_owner",
42
- * "flow_viewers"
43
- * ]
44
34
  */
45
35
  filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
46
36
  /**
@@ -53,7 +43,6 @@ export interface paths {
53
43
  * include all Flows for which the user has "flow_viewer" role as
54
44
  * well. If not provided, only Flows for which the caller has
55
45
  * "flow_owner" role will be returned.
56
- * @example flow_starter
57
46
  */
58
47
  filter_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_manager" | "run_monitor";
59
48
  /**
@@ -61,20 +50,12 @@ export interface paths {
61
50
  * scope string fields. If multiple values are specified, each Flow
62
51
  * returned is guaranteed to contain at least one of the strings in its
63
52
  * scope strings.
64
- * @example [
65
- * "0abc",
66
- * "100"
67
- * ]
68
53
  */
69
54
  filter_scope_string?: string[];
70
55
  /**
71
56
  * @description Performs a case insensitive substring based search on the Flows' title
72
57
  * field. If multiple values are specified, each Flow returned
73
58
  * is guaranteed to contain at least one of the strings in its title.
74
- * @example [
75
- * "hello",
76
- * "science"
77
- * ]
78
59
  */
79
60
  filter_title?: string[];
80
61
  /**
@@ -82,10 +63,6 @@ export interface paths {
82
63
  * subtitle field. If multiple values are specified, each Flow returned
83
64
  * is guaranteed to contain at least one of the strings in its
84
65
  * subtitle.
85
- * @example [
86
- * "hello",
87
- * "science"
88
- * ]
89
66
  */
90
67
  filter_subtitle?: string[];
91
68
  /**
@@ -93,10 +70,6 @@ export interface paths {
93
70
  * description field. If multiple values are specified, each Flow returned
94
71
  * is guaranteed to contain at least one of the strings in its
95
72
  * description.
96
- * @example [
97
- * "hello",
98
- * "science"
99
- * ]
100
73
  */
101
74
  filter_description?: string[];
102
75
  /**
@@ -104,10 +77,6 @@ export interface paths {
104
77
  * keywords field. If multiple values are specified, each Flow returned
105
78
  * is guaranteed to contain at least one of the substrings as a
106
79
  * keyword.
107
- * @example [
108
- * "hello",
109
- * "science"
110
- * ]
111
80
  */
112
81
  filter_keywords?: string[];
113
82
  /**
@@ -122,9 +91,6 @@ export interface paths {
122
91
  * - description
123
92
  * - id
124
93
  * - flow_administrators
125
- * @example [
126
- * "globus"
127
- * ]
128
94
  */
129
95
  filter_fulltext?: string[];
130
96
  /**
@@ -164,10 +130,6 @@ export interface paths {
164
130
  *
165
131
  * - `ASC`
166
132
  * - `DESC`
167
- * @example [
168
- * "title ASC",
169
- * "id DESC"
170
- * ]
171
133
  */
172
134
  orderby?: components["parameters"]["list_flows_orderby"];
173
135
  };
@@ -1025,7 +987,88 @@ export interface paths {
1025
987
  patch?: never;
1026
988
  trace?: never;
1027
989
  };
1028
- "/runs/{run_id}/resume": paths["/flows/{flow_id}/{run_id}/resume"];
990
+ "/runs/{run_id}/resume": {
991
+ parameters: {
992
+ query?: never;
993
+ header?: never;
994
+ path: {
995
+ /** @description The run ID */
996
+ run_id: components["parameters"]["run_id"];
997
+ };
998
+ cookie?: never;
999
+ };
1000
+ get?: never;
1001
+ put?: never;
1002
+ /**
1003
+ * Resume a Run
1004
+ * @description Attempt to resume a Run, particularly when it has reached a
1005
+ * status of INACTIVE. A Flow Run may reach an INACTIVE status
1006
+ * when an Action type state within the Flow returns its status
1007
+ * as INACTIVE. The resume operation on the Flow Run provides a
1008
+ * hint that the cause of the Action becoming INACTIVE may have
1009
+ * been cleared, and thus the resume operation on the Action
1010
+ * Provider should be invoked to allow the Action state to resume
1011
+ * and thus resume the Flow Run.
1012
+ *
1013
+ * In the particular case that an Action state is INACTIVE with a
1014
+ * code value of "ConsentRequired" it is further assumed that the
1015
+ * Bearer token provided in the Authorization header on the
1016
+ * resume operation now carries sufficient consents to continue
1017
+ * the INACTIVE Action. Thus, the Flow service will use the
1018
+ * Bearer token to generate new dependent tokens for running the
1019
+ * Action and use these tokens to request that the Action be
1020
+ * resumed at the Action Provider.
1021
+ *
1022
+ * Note again that in reasons other than "ConsentRequired" for a
1023
+ * Flow or Action to go INACTIVE, the resume operation is just a
1024
+ * hint. For example, when the code is "ActivationRequired,"
1025
+ * indicating that a Globus collection or endpoint needs to be
1026
+ * Activated by the user, performing that Activation out-of-band
1027
+ * from the Flow will allow the Flow to proceed even without the
1028
+ * resume operation as the Action is periodically polled for
1029
+ * progress. Performing the resume operation may simply cause a
1030
+ * poll to happen more quickly and thus allow the Action to
1031
+ * resume more quickly.
1032
+ */
1033
+ post: {
1034
+ parameters: {
1035
+ query?: never;
1036
+ header?: never;
1037
+ path: {
1038
+ /** @description The run ID */
1039
+ run_id: components["parameters"]["run_id"];
1040
+ };
1041
+ cookie?: never;
1042
+ };
1043
+ requestBody?: never;
1044
+ responses: {
1045
+ /** @description The request was successful. */
1046
+ 200: {
1047
+ headers: {
1048
+ [name: string]: unknown;
1049
+ };
1050
+ content: {
1051
+ "application/json": components["schemas"]["FlowRun"];
1052
+ };
1053
+ };
1054
+ /**
1055
+ * @description The requested Run or Flow was not found.
1056
+ * Or, the requestor did not have access to manage the Run.
1057
+ */
1058
+ 404: {
1059
+ headers: {
1060
+ [name: string]: unknown;
1061
+ };
1062
+ content?: never;
1063
+ };
1064
+ };
1065
+ };
1066
+ delete?: never;
1067
+ options?: never;
1068
+ head?: never;
1069
+ patch?: never;
1070
+ trace?: never;
1071
+ };
1029
1072
  "/runs/{run_id}/cancel": {
1030
1073
  parameters: {
1031
1074
  query?: never;
@@ -1098,7 +1141,13 @@ export interface paths {
1098
1141
  limit?: number;
1099
1142
  /** @description A flag to indicate if log records should be returned in reverse order. */
1100
1143
  reverse_order?: boolean;
1101
- /** @description A token used to iterate through pages of returned log records. */
1144
+ /** @description An opaque token used to iterate through pages of returned log records. */
1145
+ marker?: string;
1146
+ /**
1147
+ * @deprecated
1148
+ * @description A token used to iterate through pages of returned log records.
1149
+ * ("marker" is now the preferred name for this parameter.)
1150
+ */
1102
1151
  pagination_token?: string;
1103
1152
  };
1104
1153
  header?: never;
@@ -1121,7 +1170,13 @@ export interface paths {
1121
1170
  limit?: number;
1122
1171
  /** @description A flag to indicate if log records should be returned in reverse order. */
1123
1172
  reverse_order?: boolean;
1124
- /** @description A token used to iterate through pages of returned log records. */
1173
+ /** @description An opaque token used to iterate through pages of returned log records. */
1174
+ marker?: string;
1175
+ /**
1176
+ * @deprecated
1177
+ * @description A token used to iterate through pages of returned log records.
1178
+ * ("marker" is now the preferred name for this parameter.)
1179
+ */
1125
1180
  pagination_token?: string;
1126
1181
  };
1127
1182
  header?: never;
@@ -1182,7 +1237,93 @@ export interface paths {
1182
1237
  patch?: never;
1183
1238
  trace?: never;
1184
1239
  };
1185
- "/runs/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
1240
+ "/runs/{run_id}/log": {
1241
+ parameters: {
1242
+ query?: {
1243
+ /** @description An integer limit on the number of log records returned. */
1244
+ limit?: number;
1245
+ /** @description A flag to indicate if log records should be returned in reverse order. */
1246
+ reverse_order?: boolean;
1247
+ /** @description A token used to iterate through pages of returned log records. */
1248
+ pagination_token?: string;
1249
+ };
1250
+ header?: never;
1251
+ path: {
1252
+ /** @description The run ID */
1253
+ run_id: components["parameters"]["run_id"];
1254
+ };
1255
+ cookie?: never;
1256
+ };
1257
+ /**
1258
+ * Get execution details on a Run
1259
+ * @description Retrieve detailed execution information for a particular Flow Run
1260
+ */
1261
+ get: {
1262
+ parameters: {
1263
+ query?: {
1264
+ /** @description An integer limit on the number of log records returned. */
1265
+ limit?: number;
1266
+ /** @description A flag to indicate if log records should be returned in reverse order. */
1267
+ reverse_order?: boolean;
1268
+ /** @description A token used to iterate through pages of returned log records. */
1269
+ pagination_token?: string;
1270
+ };
1271
+ header?: never;
1272
+ path: {
1273
+ /** @description The run ID */
1274
+ run_id: components["parameters"]["run_id"];
1275
+ };
1276
+ cookie?: never;
1277
+ };
1278
+ requestBody?: never;
1279
+ responses: {
1280
+ /** @description The request was successfully received. */
1281
+ 200: {
1282
+ headers: {
1283
+ [name: string]: unknown;
1284
+ };
1285
+ content: {
1286
+ "application/json": {
1287
+ /** @description The number of log states returned. */
1288
+ limit: number;
1289
+ /**
1290
+ * @description An opaque pagination token for iterating through returned
1291
+ * records. If there are no more entries, this field will not
1292
+ * exist.
1293
+ */
1294
+ marker?: string;
1295
+ has_next_page: boolean;
1296
+ entries: Record<string, unknown>[];
1297
+ };
1298
+ };
1299
+ };
1300
+ /** @description There was an issue parsing the query parameters. */
1301
+ 400: {
1302
+ headers: {
1303
+ [name: string]: unknown;
1304
+ };
1305
+ content?: never;
1306
+ };
1307
+ /**
1308
+ * @description The requested Run or Flow was not found.
1309
+ * Or, the requestor did not have access to view the Run.
1310
+ */
1311
+ 404: {
1312
+ headers: {
1313
+ [name: string]: unknown;
1314
+ };
1315
+ content?: never;
1316
+ };
1317
+ };
1318
+ };
1319
+ put?: never;
1320
+ post?: never;
1321
+ delete?: never;
1322
+ options?: never;
1323
+ head?: never;
1324
+ patch?: never;
1325
+ trace?: never;
1326
+ };
1186
1327
  "/flows/{flow_id}/runs": {
1187
1328
  parameters: {
1188
1329
  query?: never;
@@ -1221,24 +1362,15 @@ export interface paths {
1221
1362
  * received.
1222
1363
  */
1223
1364
  pagination_token?: string;
1224
- /**
1225
- * @description The number of results to return in a single paged response.
1226
- * @example 50
1227
- */
1365
+ /** @description The number of results to return in a single paged response. */
1228
1366
  per_page?: number;
1229
- /**
1230
- * @description The page of results to return.
1231
- * @example 2
1232
- */
1367
+ /** @description The page of results to return. */
1233
1368
  page?: number;
1234
1369
  /**
1235
1370
  * @description Return Actions for which the user has the supplied role. The role the
1236
1371
  * user has on the Action dictates the operations they can perform.
1237
1372
  * If multiple roles are specified, the user will have at least one of
1238
1373
  * the specified roles on each Action returned.
1239
- * @example [
1240
- * "run_manager"
1241
- * ]
1242
1374
  */
1243
1375
  filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
1244
1376
  /**
@@ -1251,9 +1383,6 @@ export interface paths {
1251
1383
  * manager will also include all Actions for which the user
1252
1384
  * has "run_monitor" role as well. If not provided, only Actions
1253
1385
  * for which the caller has "run_owner" role will be returned.
1254
- * @example [
1255
- * "run_manager"
1256
- * ]
1257
1386
  */
1258
1387
  filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
1259
1388
  /**
@@ -1262,20 +1391,12 @@ export interface paths {
1262
1391
  * multiple statuses are specified, each Action returned will be in one
1263
1392
  * of the specified states. By default, Actions in any state will be
1264
1393
  * returned.
1265
- * @example [
1266
- * "FAILED",
1267
- * "INACTIVE"
1268
- * ]
1269
1394
  */
1270
1395
  filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
1271
1396
  /**
1272
1397
  * @description Performs a case insensitive string based search on the Actions'
1273
1398
  * label fields. If multiple values are specified, each Action returned
1274
1399
  * is guaranteed to contain at least one of the strings in its label.
1275
- * @example [
1276
- * "science",
1277
- * "tests"
1278
- * ]
1279
1400
  */
1280
1401
  filter_label?: string[];
1281
1402
  /**
@@ -1295,7 +1416,6 @@ export interface paths {
1295
1416
  *
1296
1417
  * Note that runs which are still executing will not have a completion time
1297
1418
  * and will be automatically excluded if this filter is applied.
1298
- * @example 2021-03-09T21:52:14,2021-03-09T21:53
1299
1419
  */
1300
1420
  filter_completion_time?: components["parameters"]["filter_completion_time"];
1301
1421
  /**
@@ -1312,7 +1432,6 @@ export interface paths {
1312
1432
  *
1313
1433
  * Results will contain runs which began between the first datetime
1314
1434
  * onwards, up to (but not including) the second datetime.
1315
- * @example 2021-03-09T21:52:14,2021-03-09T21:53
1316
1435
  */
1317
1436
  filter_start_time?: components["parameters"]["filter_start_time"];
1318
1437
  /**
@@ -1350,10 +1469,6 @@ export interface paths {
1350
1469
  *
1351
1470
  * - `ASC`
1352
1471
  * - `DESC`
1353
- * @example [
1354
- * "start_time ASC",
1355
- * "id DESC"
1356
- * ]
1357
1472
  */
1358
1473
  orderby?: components["parameters"]["list_runs_orderby"];
1359
1474
  };
@@ -1446,25 +1561,15 @@ export interface paths {
1446
1561
  * received.
1447
1562
  */
1448
1563
  pagination_token?: string;
1449
- /**
1450
- * @description The number of results to return in a single paged response.
1451
- * @example 50
1452
- */
1564
+ /** @description The number of results to return in a single paged response. */
1453
1565
  per_page?: number;
1454
- /**
1455
- * @description The page of results to return.
1456
- * @example 2
1457
- */
1566
+ /** @description The page of results to return. */
1458
1567
  page?: number;
1459
1568
  /**
1460
1569
  * @description Return Runs for which the user has the supplied role. The role the
1461
1570
  * user has on the Action dictates the operations they can perform.
1462
1571
  * If multiple roles are specified, the user will have at least one of
1463
1572
  * the specified roles on each Action returned.
1464
- * @example [
1465
- * "run_owner",
1466
- * "run_managers"
1467
- * ]
1468
1573
  */
1469
1574
  filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
1470
1575
  /**
@@ -1477,7 +1582,6 @@ export interface paths {
1477
1582
  * manager will also include all Runs for which the user
1478
1583
  * has "run_monitor" role as well. If not provided, only Runs
1479
1584
  * for which the caller has "run_owner" role will be returned.
1480
- * @example run_manager
1481
1585
  */
1482
1586
  filter_role?: "run_monitor" | "run_manager" | "run_owner";
1483
1587
  /**
@@ -1486,20 +1590,12 @@ export interface paths {
1486
1590
  * multiple statuses are specified, each Action returned will be in one
1487
1591
  * of the specified states. By default, Actions in any state will be
1488
1592
  * returned.
1489
- * @example [
1490
- * "FAILED",
1491
- * "INACTIVE"
1492
- * ]
1493
1593
  */
1494
1594
  filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
1495
1595
  /**
1496
1596
  * @description Performs a case insensitive string based search on the Actions'
1497
1597
  * label fields. If multiple values are specified, each Action returned
1498
1598
  * is guaranteed to contain at least one of the strings in its label.
1499
- * @example [
1500
- * "science",
1501
- * "tests"
1502
- * ]
1503
1599
  */
1504
1600
  filter_label?: string[];
1505
1601
  /**
@@ -1507,10 +1603,6 @@ export interface paths {
1507
1603
  * Actions which have parent Flow's with a matching title(s). If
1508
1604
  * multiple values are specified, each Action returned will have a
1509
1605
  * parent Flow with a title matching at least one of the strings.
1510
- * @example [
1511
- * "globus",
1512
- * "tests"
1513
- * ]
1514
1606
  */
1515
1607
  filter_flow_title?: string[];
1516
1608
  /**
@@ -1518,10 +1610,6 @@ export interface paths {
1518
1610
  * initiated from the specified Flow ID(s). If multiple values are
1519
1611
  * specified, each Run returned will have been initiated from at least
1520
1612
  * one of the specified Flow IDs.
1521
- * @example [
1522
- * "00000000-19d9-4f5b-9329-22ed12d4d3dd",
1523
- * "11111111-19a5-4d19-998e-0709c40321e9"
1524
- * ]
1525
1613
  */
1526
1614
  filter_flow_id?: string[];
1527
1615
  /**
@@ -1541,7 +1629,6 @@ export interface paths {
1541
1629
  *
1542
1630
  * Note that runs which are still executing will not have a completion time
1543
1631
  * and will be automatically excluded if this filter is applied.
1544
- * @example 2021-03-09T21:52:14,2021-03-09T21:53
1545
1632
  */
1546
1633
  filter_completion_time?: components["parameters"]["filter_completion_time"];
1547
1634
  /**
@@ -1558,7 +1645,6 @@ export interface paths {
1558
1645
  *
1559
1646
  * Results will contain runs which began between the first datetime
1560
1647
  * onwards, up to (but not including) the second datetime.
1561
- * @example 2021-03-09T21:52:14,2021-03-09T21:53
1562
1648
  */
1563
1649
  filter_start_time?: components["parameters"]["filter_start_time"];
1564
1650
  /**
@@ -1596,10 +1682,6 @@ export interface paths {
1596
1682
  *
1597
1683
  * - `ASC`
1598
1684
  * - `DESC`
1599
- * @example [
1600
- * "start_time ASC",
1601
- * "id DESC"
1602
- * ]
1603
1685
  */
1604
1686
  orderby?: components["parameters"]["list_runs_orderby"];
1605
1687
  };
@@ -1675,7 +1757,6 @@ export interface paths {
1675
1757
  /**
1676
1758
  * @description If present and set to a true value,
1677
1759
  * metadata about the associated flow will be included.
1678
- * @example true
1679
1760
  */
1680
1761
  include_flow_description?: true | true | false | false;
1681
1762
  };
@@ -1905,28 +1986,479 @@ export interface paths {
1905
1986
  patch?: never;
1906
1987
  trace?: never;
1907
1988
  };
1908
- }
1909
- export type webhooks = Record<string, never>;
1910
- export interface components {
1911
- schemas: {
1989
+ "/registered_apis": {
1990
+ parameters: {
1991
+ query?: never;
1992
+ header?: never;
1993
+ path?: never;
1994
+ cookie?: never;
1995
+ };
1912
1996
  /**
1913
- * The flow definition
1914
- * @description The flow definition.
1915
- *
1916
- * If this parameter is used when updating a flow,
1917
- * runs that are currently executing will continue to use the definition
1918
- * that they were initially started with.
1997
+ * List Registered APIs
1998
+ * @description Retrieve a listing of Registered APIs available to a user
1999
+ * according to the permissions (role) they have on the Registered API.
1919
2000
  */
1920
- FlowDefinition: {
1921
- Comment?: string;
1922
- StartAt: string;
1923
- States: {
1924
- [key: string]: components["schemas"]["Pass"] | components["schemas"]["Action"] | components["schemas"]["Wait"] | components["schemas"]["Choice"] | components["schemas"]["ExpressionEval"] | components["schemas"]["Fail"];
2001
+ get: {
2002
+ parameters: {
2003
+ query?: {
2004
+ /**
2005
+ * @description An opaque token used to iterate through pages of returned Registered APIs.
2006
+ * If provided, all other query arguments will be ignored.
2007
+ * The marker encodes all state in a given query,
2008
+ * therefore it's unnecessary to provide query arguments
2009
+ * once an initial marker has been received.
2010
+ */
2011
+ marker?: string;
2012
+ /** @description The number of results to return in a single paged response. */
2013
+ per_page?: number;
2014
+ /**
2015
+ * @description Return Registered APIs for which the user has one of the supplied roles.
2016
+ * The role the user has on the Registered API dictates the operations they
2017
+ * can perform. If multiple roles are specified (comma-separated), the user
2018
+ * will have at least one of the specified roles on each Registered API returned.
2019
+ * If not provided, only Registered APIs for which the caller has "owner"
2020
+ * role will be returned.
2021
+ */
2022
+ filter_roles?: ("owner" | "administrator" | "viewer")[];
2023
+ /**
2024
+ * @description Ordering criteria to apply to the list of Registered APIs.
2025
+ *
2026
+ * This field is a comma-separated list of sort criteria,
2027
+ * and follows this syntax:
2028
+ *
2029
+ * ```
2030
+ * CRITERION1[,CRITERION2[,...]]
2031
+ * ```
2032
+ *
2033
+ * and each individual `CRITERION` follows this syntax:
2034
+ *
2035
+ * ```
2036
+ * FIELD ORDERING
2037
+ * ```
2038
+ *
2039
+ * The first value, `FIELD`, indicates the field to sort by;
2040
+ * the second value, `ORDERING`, indicates the sorting order.
2041
+ *
2042
+ * When additional comma-separated criteria are added,
2043
+ * the first criterion will be used to sort the data;
2044
+ * subsequent criteria will be applied for ties.
2045
+ *
2046
+ * Supported fields are:
2047
+ *
2048
+ * - `id`
2049
+ * - `name`
2050
+ * - `created_timestamp`
2051
+ * - `updated_timestamp`
2052
+ *
2053
+ * Supported orderings are:
2054
+ *
2055
+ * - `ASC`
2056
+ * - `DESC`
2057
+ */
2058
+ orderby?: components["parameters"]["list_registered_apis_orderby"];
2059
+ };
2060
+ header?: never;
2061
+ path?: never;
2062
+ cookie?: never;
1925
2063
  };
1926
- };
1927
- FlowRun: {
1928
- /** @description The ID for a particular Flow invocation. Analogous to a run_id. */
1929
- action_id: string;
2064
+ requestBody?: never;
2065
+ responses: {
2066
+ /**
2067
+ * @description The requestor has successfully authenticated and queried the Flows
2068
+ * service for the Registered APIs available for them.
2069
+ */
2070
+ 200: {
2071
+ headers: {
2072
+ [name: string]: unknown;
2073
+ };
2074
+ content: {
2075
+ "application/json": {
2076
+ registered_apis: components["schemas"]["RegisteredApiSummary"][];
2077
+ /** @description The number of Registered APIs returned. */
2078
+ limit: number;
2079
+ /**
2080
+ * @description An opaque pagination token for iterating through returned
2081
+ * Registered APIs. Null if there are no more pages.
2082
+ */
2083
+ marker?: string | null;
2084
+ /** @description Whether there are more results available. */
2085
+ has_next_page: boolean;
2086
+ };
2087
+ };
2088
+ };
2089
+ /** @description There was an issue parsing the query parameters. */
2090
+ 400: {
2091
+ headers: {
2092
+ [name: string]: unknown;
2093
+ };
2094
+ content?: never;
2095
+ };
2096
+ /** @description The requestor presented a token with insufficient scopes. */
2097
+ 403: {
2098
+ headers: {
2099
+ [name: string]: unknown;
2100
+ };
2101
+ content?: never;
2102
+ };
2103
+ /** @description The requested resource was not found. */
2104
+ 404: {
2105
+ headers: {
2106
+ [name: string]: unknown;
2107
+ };
2108
+ content?: never;
2109
+ };
2110
+ /** @description The request's query parameters did not pass validation. */
2111
+ 422: {
2112
+ headers: {
2113
+ [name: string]: unknown;
2114
+ };
2115
+ content?: never;
2116
+ };
2117
+ };
2118
+ };
2119
+ put?: never;
2120
+ /**
2121
+ * Create a Registered API
2122
+ * @description Create a new Registered API.
2123
+ */
2124
+ post: {
2125
+ parameters: {
2126
+ query?: never;
2127
+ header?: never;
2128
+ path?: never;
2129
+ cookie?: never;
2130
+ };
2131
+ requestBody: {
2132
+ content: {
2133
+ "application/json": {
2134
+ /**
2135
+ * @description A non-unique, human-friendly name used for displaying the
2136
+ * Registered API to end users.
2137
+ */
2138
+ name: string;
2139
+ /** @description A detailed description of the Registered API for end user display. */
2140
+ description?: string;
2141
+ /** @description The OpenAPI specification and configuration for the registered API. */
2142
+ target: {
2143
+ /** @enum {string} */
2144
+ type: "openapi";
2145
+ openapi_version: string;
2146
+ destination: {
2147
+ /** @enum {string} */
2148
+ method: "get" | "head" | "post" | "put" | "delete" | "connect" | "options" | "trace" | "patch";
2149
+ /** Format: uri */
2150
+ url: string;
2151
+ };
2152
+ specification: {
2153
+ [key: string]: unknown;
2154
+ };
2155
+ components?: {
2156
+ [key: string]: unknown;
2157
+ };
2158
+ };
2159
+ /** @description Access control roles for the Registered API. */
2160
+ roles?: {
2161
+ /**
2162
+ * @description The set of Principal URN values of users and/or groups who own
2163
+ * the Registered API.
2164
+ */
2165
+ owners?: components["schemas"]["PrincipalURN"][];
2166
+ /**
2167
+ * @description The set of Principal URN values of users and/or groups who may
2168
+ * perform administrative operations on the Registered API.
2169
+ */
2170
+ administrators?: components["schemas"]["PrincipalURN"][];
2171
+ /**
2172
+ * @description The set of Principal URN values of users and/or groups who may
2173
+ * view the Registered API.
2174
+ */
2175
+ viewers?: components["schemas"]["PrincipalURN"][];
2176
+ };
2177
+ /**
2178
+ * Format: uuid
2179
+ * @description A subscription to associate with this Registered API.
2180
+ */
2181
+ subscription_id: string;
2182
+ };
2183
+ };
2184
+ };
2185
+ responses: {
2186
+ /** @description The Registered API was successfully created. */
2187
+ 201: {
2188
+ headers: {
2189
+ [name: string]: unknown;
2190
+ };
2191
+ content: {
2192
+ "application/json": components["schemas"]["RegisteredApi"];
2193
+ };
2194
+ };
2195
+ /** @description The requestor attempted to create a malformed Registered API. */
2196
+ 400: {
2197
+ headers: {
2198
+ [name: string]: unknown;
2199
+ };
2200
+ content?: never;
2201
+ };
2202
+ /** @description The requestor is not authorized to create a Registered API. */
2203
+ 403: {
2204
+ headers: {
2205
+ [name: string]: unknown;
2206
+ };
2207
+ content?: never;
2208
+ };
2209
+ };
2210
+ };
2211
+ delete?: never;
2212
+ options?: never;
2213
+ head?: never;
2214
+ patch?: never;
2215
+ trace?: never;
2216
+ };
2217
+ "/registered_apis/{registered_api_id}": {
2218
+ parameters: {
2219
+ query?: never;
2220
+ header?: never;
2221
+ path: {
2222
+ /** @description The unique identifier for the Registered API. */
2223
+ registered_api_id: string;
2224
+ };
2225
+ cookie?: never;
2226
+ };
2227
+ /**
2228
+ * Get Registered API
2229
+ * @description Retrieve details of a specific Registered API by its ID.
2230
+ */
2231
+ get: {
2232
+ parameters: {
2233
+ query?: never;
2234
+ header?: never;
2235
+ path: {
2236
+ /** @description The unique identifier for the Registered API. */
2237
+ registered_api_id: string;
2238
+ };
2239
+ cookie?: never;
2240
+ };
2241
+ requestBody?: never;
2242
+ responses: {
2243
+ /** @description Successfully retrieved the Registered API details. */
2244
+ 200: {
2245
+ headers: {
2246
+ [name: string]: unknown;
2247
+ };
2248
+ content: {
2249
+ "application/json": components["schemas"]["RegisteredApi"];
2250
+ };
2251
+ };
2252
+ /**
2253
+ * @description The requestor presented a token with insufficient scopes or lacks
2254
+ * permission to view this Registered API.
2255
+ */
2256
+ 403: {
2257
+ headers: {
2258
+ [name: string]: unknown;
2259
+ };
2260
+ content?: never;
2261
+ };
2262
+ /** @description No Registered API exists with the specified ID. */
2263
+ 404: {
2264
+ headers: {
2265
+ [name: string]: unknown;
2266
+ };
2267
+ content?: never;
2268
+ };
2269
+ };
2270
+ };
2271
+ put?: never;
2272
+ post?: never;
2273
+ /**
2274
+ * Remove a Registered API
2275
+ * @description Remove a Registered API from the Flows service.
2276
+ */
2277
+ delete: {
2278
+ parameters: {
2279
+ query?: never;
2280
+ header?: never;
2281
+ path: {
2282
+ /** @description The unique identifier for the Registered API. */
2283
+ registered_api_id: string;
2284
+ };
2285
+ cookie?: never;
2286
+ };
2287
+ requestBody?: never;
2288
+ responses: {
2289
+ /**
2290
+ * @description The requestor has successfully removed the Registered API from the
2291
+ * Flows service.
2292
+ */
2293
+ 200: {
2294
+ headers: {
2295
+ [name: string]: unknown;
2296
+ };
2297
+ content: {
2298
+ "application/json": components["schemas"]["RegisteredApi"];
2299
+ };
2300
+ };
2301
+ /**
2302
+ * @description The requestor attempted to delete a Registered API for which they
2303
+ * did not have access.
2304
+ */
2305
+ 403: {
2306
+ headers: {
2307
+ [name: string]: unknown;
2308
+ };
2309
+ content?: never;
2310
+ };
2311
+ /**
2312
+ * @description The requestor attempted to delete a non-existent Registered API,
2313
+ * or the requestor did not have permissions to delete it.
2314
+ */
2315
+ 404: {
2316
+ headers: {
2317
+ [name: string]: unknown;
2318
+ };
2319
+ content?: never;
2320
+ };
2321
+ };
2322
+ };
2323
+ options?: never;
2324
+ head?: never;
2325
+ /**
2326
+ * Update a Registered API
2327
+ * @description Modify a previously created Registered API. Only specified fields will be updated.
2328
+ */
2329
+ patch: {
2330
+ parameters: {
2331
+ query?: never;
2332
+ header?: never;
2333
+ path: {
2334
+ /** @description The unique identifier for the Registered API. */
2335
+ registered_api_id: string;
2336
+ };
2337
+ cookie?: never;
2338
+ };
2339
+ requestBody: {
2340
+ content: {
2341
+ "application/json": {
2342
+ /**
2343
+ * @description A non-unique, human-friendly name used for displaying the
2344
+ * Registered API to end users.
2345
+ */
2346
+ name?: string;
2347
+ /** @description A detailed description of the Registered API for end user display. */
2348
+ description?: string;
2349
+ /** @description The OpenAPI specification and configuration for the registered API. */
2350
+ target?: {
2351
+ /** @enum {string} */
2352
+ type?: "openapi";
2353
+ openapi_version?: string;
2354
+ destination?: {
2355
+ /** @enum {string} */
2356
+ method?: "get" | "head" | "post" | "put" | "delete" | "connect" | "options" | "trace" | "patch";
2357
+ /** Format: uri */
2358
+ url?: string;
2359
+ };
2360
+ specification?: {
2361
+ [key: string]: unknown;
2362
+ };
2363
+ components?: {
2364
+ [key: string]: unknown;
2365
+ };
2366
+ };
2367
+ /** @description Access control roles for the Registered API. */
2368
+ roles?: {
2369
+ /**
2370
+ * @description The set of Principal URN values of users and/or groups who own
2371
+ * the Registered API.
2372
+ */
2373
+ owners?: components["schemas"]["PrincipalURN"][];
2374
+ /**
2375
+ * @description The set of Principal URN values of users and/or groups who may
2376
+ * perform administrative operations on the Registered API.
2377
+ */
2378
+ administrators?: components["schemas"]["PrincipalURN"][];
2379
+ /**
2380
+ * @description The set of Principal URN values of users and/or groups who may
2381
+ * view the Registered API.
2382
+ */
2383
+ viewers?: components["schemas"]["PrincipalURN"][];
2384
+ };
2385
+ /**
2386
+ * Format: uuid
2387
+ * @description A subscription to associate with this Registered API.
2388
+ */
2389
+ subscription_id?: string;
2390
+ };
2391
+ };
2392
+ };
2393
+ responses: {
2394
+ /**
2395
+ * @description The requestor has successfully authenticated and updated the target
2396
+ * Registered API.
2397
+ */
2398
+ 200: {
2399
+ headers: {
2400
+ [name: string]: unknown;
2401
+ };
2402
+ content: {
2403
+ "application/json": components["schemas"]["RegisteredApi"];
2404
+ };
2405
+ };
2406
+ /**
2407
+ * @description The Registered API update failed due to an attempt to perform a
2408
+ * malformed update.
2409
+ */
2410
+ 400: {
2411
+ headers: {
2412
+ [name: string]: unknown;
2413
+ };
2414
+ content?: never;
2415
+ };
2416
+ /**
2417
+ * @description The requestor attempted to update a Registered API for which they
2418
+ * did not have access.
2419
+ */
2420
+ 403: {
2421
+ headers: {
2422
+ [name: string]: unknown;
2423
+ };
2424
+ content?: never;
2425
+ };
2426
+ /**
2427
+ * @description The requestor attempted to update a non-existent Registered API,
2428
+ * or the requestor did not have permissions to update it.
2429
+ */
2430
+ 404: {
2431
+ headers: {
2432
+ [name: string]: unknown;
2433
+ };
2434
+ content?: never;
2435
+ };
2436
+ };
2437
+ };
2438
+ trace?: never;
2439
+ };
2440
+ }
2441
+ export type webhooks = Record<string, never>;
2442
+ export interface components {
2443
+ schemas: {
2444
+ /**
2445
+ * The flow definition
2446
+ * @description The flow definition.
2447
+ *
2448
+ * If this parameter is used when updating a flow,
2449
+ * runs that are currently executing will continue to use the definition
2450
+ * that they were initially started with.
2451
+ */
2452
+ FlowDefinition: {
2453
+ Comment?: string;
2454
+ StartAt: string;
2455
+ States: {
2456
+ [key: string]: components["schemas"]["Pass"] | components["schemas"]["Action"] | components["schemas"]["Wait"] | components["schemas"]["Choice"] | components["schemas"]["ExpressionEval"] | components["schemas"]["Fail"];
2457
+ };
2458
+ };
2459
+ FlowRun: {
2460
+ /** @description The ID for a particular Flow invocation. Analogous to a run_id. */
2461
+ action_id: string;
1930
2462
  /** @description The ID for a particular Flow invocation. Analogous to an action_id. */
1931
2463
  run_id: string;
1932
2464
  /** @description The Flow to which this Run belongs. */
@@ -1965,10 +2497,13 @@ export interface components {
1965
2497
  run_monitors?: components["schemas"]["RunMonitors"];
1966
2498
  run_managers?: components["schemas"]["RunManagers"];
1967
2499
  /**
2500
+ * @deprecated
1968
2501
  * @description The role the requesting user has on the Run.
1969
2502
  * @enum {string}
1970
2503
  */
1971
- user_role: "run_monitor" | "run_manager" | "run_owner";
2504
+ user_role: "run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager";
2505
+ /** @description The list of all roles the requesting user has on the Run. */
2506
+ user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
1972
2507
  tags: components["schemas"]["Tags"];
1973
2508
  };
1974
2509
  ValidateRun: {
@@ -2251,10 +2786,13 @@ export interface components {
2251
2786
  /** @description A list of scopes according to RunAs values as defined in the Flow. */
2252
2787
  globus_auth_scopes_by_RunAs?: string[];
2253
2788
  /**
2789
+ * @deprecated
2254
2790
  * @description The role the requesting user has on the Flow.
2255
2791
  * @enum {string}
2256
2792
  */
2257
- user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner";
2793
+ user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_monitor" | "run_manager";
2794
+ /** @description The list of all roles the requesting user has on the Flow. */
2795
+ user_roles?: ("flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "flow_run_monitor" | "flow_run_manager")[];
2258
2796
  /**
2259
2797
  * @description A set of Principal URN values, or the value "public"
2260
2798
  * indicating the identity of users who can view the Flow
@@ -2375,6 +2913,123 @@ export interface components {
2375
2913
  FlowScopes: {
2376
2914
  [key: string]: string[];
2377
2915
  };
2916
+ RegisteredApiSummary: {
2917
+ /**
2918
+ * Format: uuid
2919
+ * @description The unique identifier for the Registered API.
2920
+ */
2921
+ id: string;
2922
+ /**
2923
+ * @description A non-unique, human-friendly name used for displaying the
2924
+ * Registered API to end users.
2925
+ */
2926
+ name: string;
2927
+ /** @description A detailed description of the Registered API. */
2928
+ description: string;
2929
+ /**
2930
+ * Format: date-time
2931
+ * @description A timezone-aware ISO8601 format string that represents the time at
2932
+ * which the Registered API was created.
2933
+ */
2934
+ created_timestamp: string;
2935
+ /**
2936
+ * Format: date-time
2937
+ * @description A timezone-aware ISO8601 format string that represents the time at
2938
+ * which the Registered API was last updated.
2939
+ */
2940
+ updated_timestamp: string;
2941
+ };
2942
+ RegisteredApi: components["schemas"]["RegisteredApiSummary"] & {
2943
+ /**
2944
+ * @description Access control roles for the Registered API, mapping role names to
2945
+ * lists of principal URNs.
2946
+ */
2947
+ roles: {
2948
+ /** @description Principals with owner permissions on this Registered API. */
2949
+ owners?: components["schemas"]["PrincipalURN"][];
2950
+ /** @description Principals with administrator permissions on this Registered API. */
2951
+ administrators?: components["schemas"]["PrincipalURN"][];
2952
+ /** @description Principals with viewer permissions on this Registered API. */
2953
+ viewers?: components["schemas"]["PrincipalURN"][];
2954
+ };
2955
+ /** @description The OpenAPI specification and configuration for the registered API. */
2956
+ target: {
2957
+ /**
2958
+ * @description The type of API specification.
2959
+ * @enum {string}
2960
+ */
2961
+ type: "openapi";
2962
+ /** @description The OpenAPI specification version (e.g., "3.1"). */
2963
+ openapi_version: string;
2964
+ /** @description The target endpoint for API calls. */
2965
+ destination: {
2966
+ /**
2967
+ * @description The HTTP method for the API call.
2968
+ * @enum {string}
2969
+ */
2970
+ method: "get" | "post" | "put" | "patch" | "delete";
2971
+ /**
2972
+ * Format: uri
2973
+ * @description The URL template for the API endpoint.
2974
+ */
2975
+ url: string;
2976
+ };
2977
+ /** @description The OpenAPI operation specification. */
2978
+ specification: {
2979
+ [key: string]: unknown;
2980
+ };
2981
+ /** @description OpenAPI components (schemas, etc.) referenced by the specification. */
2982
+ components?: {
2983
+ [key: string]: unknown;
2984
+ };
2985
+ };
2986
+ /**
2987
+ * @description Service-generated templates that map and transform the OpenAPI specification
2988
+ * (target) to simplified parameter structures for use in flow definitions.
2989
+ */
2990
+ data_templates: {
2991
+ /**
2992
+ * @description Template defining how to map simplified flow parameters to the
2993
+ * OpenAPI request structure.
2994
+ */
2995
+ request: {
2996
+ [key: string]: unknown;
2997
+ };
2998
+ /** @description Template defining how to map the API response back to flow state. */
2999
+ response: {
3000
+ [key: string]: unknown;
3001
+ };
3002
+ };
3003
+ /**
3004
+ * @description Service-generated JSON Schema defining the input state required for this
3005
+ * Registered API when used in a flow.
3006
+ */
3007
+ state_input_schema: {
3008
+ [key: string]: unknown;
3009
+ };
3010
+ /**
3011
+ * @description The current status of the Registered API.
3012
+ * @enum {string}
3013
+ */
3014
+ status: "ACTIVE" | "INACTIVE";
3015
+ /**
3016
+ * Format: uuid
3017
+ * @description The subscription ID associated with this Registered API.
3018
+ */
3019
+ subscription_id: string | null;
3020
+ /**
3021
+ * Format: date-time
3022
+ * @description A timezone-aware ISO8601 format string that represents the time at
3023
+ * which the Registered API was last edited.
3024
+ */
3025
+ edited_timestamp?: string | null;
3026
+ /**
3027
+ * Format: date-time
3028
+ * @description A timezone-aware ISO8601 format string that represents the time at
3029
+ * which the Registered API is scheduled for deletion.
3030
+ */
3031
+ scheduled_deletion_timestamp?: string | null;
3032
+ };
2378
3033
  BatchRunUpdateOperation: {
2379
3034
  tags?: string[];
2380
3035
  run_managers?: components["schemas"]["PrincipalURN"][];
@@ -2457,7 +3112,6 @@ export interface components {
2457
3112
  *
2458
3113
  * Note that runs which are still executing will not have a completion time
2459
3114
  * and will be automatically excluded if this filter is applied.
2460
- * @example 2021-03-09T21:52:14,2021-03-09T21:53
2461
3115
  */
2462
3116
  filter_completion_time: string;
2463
3117
  /**
@@ -2474,7 +3128,6 @@ export interface components {
2474
3128
  *
2475
3129
  * Results will contain runs which began between the first datetime
2476
3130
  * onwards, up to (but not including) the second datetime.
2477
- * @example 2021-03-09T21:52:14,2021-03-09T21:53
2478
3131
  */
2479
3132
  filter_start_time: string;
2480
3133
  /**
@@ -2514,10 +3167,6 @@ export interface components {
2514
3167
  *
2515
3168
  * - `ASC`
2516
3169
  * - `DESC`
2517
- * @example [
2518
- * "title ASC",
2519
- * "id DESC"
2520
- * ]
2521
3170
  */
2522
3171
  list_flows_orderby: string[];
2523
3172
  /**
@@ -2555,12 +3204,44 @@ export interface components {
2555
3204
  *
2556
3205
  * - `ASC`
2557
3206
  * - `DESC`
2558
- * @example [
2559
- * "start_time ASC",
2560
- * "id DESC"
2561
- * ]
2562
3207
  */
2563
3208
  list_runs_orderby: string[];
3209
+ /**
3210
+ * @description Ordering criteria to apply to the list of Registered APIs.
3211
+ *
3212
+ * This field is a comma-separated list of sort criteria,
3213
+ * and follows this syntax:
3214
+ *
3215
+ * ```
3216
+ * CRITERION1[,CRITERION2[,...]]
3217
+ * ```
3218
+ *
3219
+ * and each individual `CRITERION` follows this syntax:
3220
+ *
3221
+ * ```
3222
+ * FIELD ORDERING
3223
+ * ```
3224
+ *
3225
+ * The first value, `FIELD`, indicates the field to sort by;
3226
+ * the second value, `ORDERING`, indicates the sorting order.
3227
+ *
3228
+ * When additional comma-separated criteria are added,
3229
+ * the first criterion will be used to sort the data;
3230
+ * subsequent criteria will be applied for ties.
3231
+ *
3232
+ * Supported fields are:
3233
+ *
3234
+ * - `id`
3235
+ * - `name`
3236
+ * - `created_timestamp`
3237
+ * - `updated_timestamp`
3238
+ *
3239
+ * Supported orderings are:
3240
+ *
3241
+ * - `ASC`
3242
+ * - `DESC`
3243
+ */
3244
+ list_registered_apis_orderby: string[];
2564
3245
  };
2565
3246
  requestBodies: never;
2566
3247
  headers: never;