@globus/sdk 5.8.0 → 6.0.0-rc.10

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 (201) hide show
  1. package/README.md +8 -15
  2. package/dist/cjs/core/authorization/index.js +142 -18
  3. package/dist/cjs/core/authorization/index.js.map +3 -3
  4. package/dist/cjs/index.js +450 -148
  5. package/dist/cjs/index.js.map +4 -4
  6. package/dist/cjs/services/globus-connect-server/client.js +2 -2
  7. package/dist/cjs/services/globus-connect-server/client.js.map +3 -3
  8. package/dist/esm/apps/web.d.ts +1 -1
  9. package/dist/esm/apps/web.d.ts.map +1 -1
  10. package/dist/esm/core/authorization/AuthorizationManager.d.ts +14 -8
  11. package/dist/esm/core/authorization/AuthorizationManager.d.ts.map +1 -1
  12. package/dist/esm/core/authorization/AuthorizationManager.js +13 -5
  13. package/dist/esm/core/authorization/AuthorizationManager.js.map +1 -1
  14. package/dist/esm/core/authorization/PopupTransport.d.ts +25 -0
  15. package/dist/esm/core/authorization/PopupTransport.d.ts.map +1 -0
  16. package/dist/esm/core/authorization/PopupTransport.js +161 -0
  17. package/dist/esm/core/authorization/PopupTransport.js.map +1 -0
  18. package/dist/esm/core/authorization/RedirectTransport.d.ts +4 -10
  19. package/dist/esm/core/authorization/RedirectTransport.d.ts.map +1 -1
  20. package/dist/esm/core/authorization/RedirectTransport.js +6 -17
  21. package/dist/esm/core/authorization/RedirectTransport.js.map +1 -1
  22. package/dist/esm/core/authorization/TokenManager.js +1 -1
  23. package/dist/esm/core/authorization/TokenManager.js.map +1 -1
  24. package/dist/esm/core/authorization/pkce.d.ts +15 -0
  25. package/dist/esm/core/authorization/pkce.d.ts.map +1 -1
  26. package/dist/esm/core/authorization/pkce.js +18 -0
  27. package/dist/esm/core/authorization/pkce.js.map +1 -1
  28. package/dist/esm/core/global.d.ts +1 -1
  29. package/dist/esm/core/global.d.ts.map +1 -1
  30. package/dist/esm/core/global.js +3 -3
  31. package/dist/esm/core/global.js.map +1 -1
  32. package/dist/esm/index.d.ts +1 -1
  33. package/dist/esm/index.d.ts.map +1 -1
  34. package/dist/esm/index.js +1 -5
  35. package/dist/esm/index.js.map +1 -1
  36. package/dist/esm/open-api/types/compute.d.ts +3759 -0
  37. package/dist/esm/open-api/types/compute.d.ts.map +1 -0
  38. package/dist/esm/open-api/types/compute.js +2 -0
  39. package/dist/esm/open-api/types/compute.js.map +1 -0
  40. package/dist/esm/open-api/types/flows.d.ts +2540 -0
  41. package/dist/esm/open-api/types/flows.d.ts.map +1 -0
  42. package/dist/esm/open-api/types/flows.js +6 -0
  43. package/dist/esm/open-api/types/flows.js.map +1 -0
  44. package/dist/esm/open-api/types/gcs/v5.4.d.ts +12052 -0
  45. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -0
  46. package/dist/esm/open-api/types/gcs/v5.4.js +2 -0
  47. package/dist/esm/open-api/types/gcs/v5.4.js.map +1 -0
  48. package/dist/esm/open-api/types/groups.d.ts +2382 -0
  49. package/dist/esm/open-api/types/groups.d.ts.map +1 -0
  50. package/dist/esm/open-api/types/groups.js +2 -0
  51. package/dist/esm/open-api/types/groups.js.map +1 -0
  52. package/dist/esm/open-api/types/search.d.ts +2215 -0
  53. package/dist/esm/open-api/types/search.d.ts.map +1 -0
  54. package/dist/esm/open-api/types/search.js +2 -0
  55. package/dist/esm/open-api/types/search.js.map +1 -0
  56. package/dist/esm/open-api/types/timer.d.ts +942 -0
  57. package/dist/esm/open-api/types/timer.d.ts.map +1 -0
  58. package/dist/esm/open-api/types/timer.js +2 -0
  59. package/dist/esm/open-api/types/timer.js.map +1 -0
  60. package/dist/esm/open-api/types/timers.d.ts +942 -0
  61. package/dist/esm/open-api/types/timers.d.ts.map +1 -0
  62. package/dist/esm/open-api/types/timers.js +2 -0
  63. package/dist/esm/open-api/types/timers.js.map +1 -0
  64. package/dist/esm/package.json +1 -1
  65. package/dist/esm/services/auth/config.d.ts +1 -1
  66. package/dist/esm/services/auth/config.js +2 -2
  67. package/dist/esm/services/auth/config.js.map +1 -1
  68. package/dist/esm/services/auth/index.d.ts +1 -0
  69. package/dist/esm/services/auth/index.d.ts.map +1 -1
  70. package/dist/esm/services/auth/index.js.map +1 -1
  71. package/dist/esm/services/auth/utils.d.ts +1 -1
  72. package/dist/esm/services/auth/utils.d.ts.map +1 -1
  73. package/dist/esm/services/compute/index.d.ts +1 -0
  74. package/dist/esm/services/compute/index.d.ts.map +1 -1
  75. package/dist/esm/services/compute/index.js.map +1 -1
  76. package/dist/esm/services/compute/service/endpoints.d.ts +34 -5
  77. package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
  78. package/dist/esm/services/compute/service/endpoints.js +31 -0
  79. package/dist/esm/services/compute/service/endpoints.js.map +1 -1
  80. package/dist/esm/services/flows/index.d.ts +1 -0
  81. package/dist/esm/services/flows/index.d.ts.map +1 -1
  82. package/dist/esm/services/flows/index.js.map +1 -1
  83. package/dist/esm/services/flows/service/flows.d.ts +12 -77
  84. package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
  85. package/dist/esm/services/flows/service/flows.js.map +1 -1
  86. package/dist/esm/services/flows/service/runs.d.ts +13 -0
  87. package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
  88. package/dist/esm/services/flows/service/runs.js +11 -0
  89. package/dist/esm/services/flows/service/runs.js.map +1 -1
  90. package/dist/esm/services/globus-connect-server/client.d.ts +646 -261
  91. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  92. package/dist/esm/services/globus-connect-server/index.d.ts +1 -0
  93. package/dist/esm/services/globus-connect-server/index.d.ts.map +1 -1
  94. package/dist/esm/services/globus-connect-server/index.js.map +1 -1
  95. package/dist/esm/services/globus-connect-server/service/collections.d.ts +40 -40
  96. package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
  97. package/dist/esm/services/globus-connect-server/service/collections.js.map +1 -1
  98. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +35 -35
  99. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
  100. package/dist/esm/services/globus-connect-server/service/endpoint.js.map +1 -1
  101. package/dist/esm/services/globus-connect-server/service/nodes.d.ts +30 -30
  102. package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
  103. package/dist/esm/services/globus-connect-server/service/nodes.js.map +1 -1
  104. package/dist/esm/services/globus-connect-server/service/roles.d.ts +20 -20
  105. package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
  106. package/dist/esm/services/globus-connect-server/service/roles.js.map +1 -1
  107. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +31 -31
  108. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
  109. package/dist/esm/services/globus-connect-server/service/storage-gateways.js.map +1 -1
  110. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts +30 -30
  111. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
  112. package/dist/esm/services/globus-connect-server/service/user-credentials.js.map +1 -1
  113. package/dist/esm/services/globus-connect-server/service/versioning.d.ts +6 -6
  114. package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
  115. package/dist/esm/services/globus-connect-server/service/versioning.js.map +1 -1
  116. package/dist/esm/services/groups/index.d.ts +1 -0
  117. package/dist/esm/services/groups/index.d.ts.map +1 -1
  118. package/dist/esm/services/groups/index.js.map +1 -1
  119. package/dist/esm/services/groups/service/groups.d.ts +5 -5
  120. package/dist/esm/services/groups/service/groups.d.ts.map +1 -1
  121. package/dist/esm/services/groups/service/groups.js.map +1 -1
  122. package/dist/esm/services/groups/service/membership.d.ts +3 -3
  123. package/dist/esm/services/groups/service/membership.d.ts.map +1 -1
  124. package/dist/esm/services/groups/service/membership.js.map +1 -1
  125. package/dist/esm/services/groups/service/policies.d.ts +2 -2
  126. package/dist/esm/services/groups/service/policies.d.ts.map +1 -1
  127. package/dist/esm/services/groups/service/policies.js.map +1 -1
  128. package/dist/esm/services/search/index.d.ts +2 -0
  129. package/dist/esm/services/search/index.d.ts.map +1 -1
  130. package/dist/esm/services/search/index.js.map +1 -1
  131. package/dist/esm/services/shared.d.ts +1 -0
  132. package/dist/esm/services/shared.d.ts.map +1 -1
  133. package/dist/esm/services/shared.js.map +1 -1
  134. package/dist/esm/services/timer/index.d.ts +1 -0
  135. package/dist/esm/services/timer/index.d.ts.map +1 -1
  136. package/dist/esm/services/timer/index.js.map +1 -1
  137. package/dist/esm/services/timer/service/timer.d.ts +28 -2
  138. package/dist/esm/services/timer/service/timer.d.ts.map +1 -1
  139. package/dist/esm/services/timer/service/timer.js.map +1 -1
  140. package/dist/esm/services/timers/config.d.ts +4 -0
  141. package/dist/esm/services/timers/config.d.ts.map +1 -0
  142. package/dist/esm/services/timers/config.js +10 -0
  143. package/dist/esm/services/timers/config.js.map +1 -0
  144. package/dist/esm/services/timers/index.d.ts +16 -0
  145. package/dist/esm/services/timers/index.d.ts.map +1 -0
  146. package/dist/esm/services/timers/index.js +15 -0
  147. package/dist/esm/services/timers/index.js.map +1 -0
  148. package/dist/esm/services/timers/service/jobs/index.d.ts +62 -0
  149. package/dist/esm/services/timers/service/jobs/index.d.ts.map +1 -0
  150. package/dist/esm/services/timers/service/jobs/index.js +70 -0
  151. package/dist/esm/services/timers/service/jobs/index.js.map +1 -0
  152. package/dist/esm/services/timers/service/timer.d.ts +31 -0
  153. package/dist/esm/services/timers/service/timer.d.ts.map +1 -0
  154. package/dist/esm/services/timers/service/timer.js +12 -0
  155. package/dist/esm/services/timers/service/timer.js.map +1 -0
  156. package/dist/esm/services/transfer/index.d.ts +2 -0
  157. package/dist/esm/services/transfer/index.d.ts.map +1 -1
  158. package/dist/esm/services/transfer/index.js +1 -0
  159. package/dist/esm/services/transfer/index.js.map +1 -1
  160. package/dist/esm/services/transfer/service/access.d.ts +35 -12
  161. package/dist/esm/services/transfer/service/access.d.ts.map +1 -1
  162. package/dist/esm/services/transfer/service/access.js +5 -5
  163. package/dist/esm/services/transfer/service/access.js.map +1 -1
  164. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts +20 -6
  165. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts.map +1 -1
  166. package/dist/esm/services/transfer/service/collection-bookmarks.js.map +1 -1
  167. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +11 -9
  168. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
  169. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js.map +1 -1
  170. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts +28 -6
  171. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts.map +1 -1
  172. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js.map +1 -1
  173. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts +100 -22
  174. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts.map +1 -1
  175. package/dist/esm/services/transfer/service/endpoint-manager/task.js +1 -1
  176. package/dist/esm/services/transfer/service/endpoint-manager/task.js.map +1 -1
  177. package/dist/esm/services/transfer/service/endpoint-search.d.ts +19 -12
  178. package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
  179. package/dist/esm/services/transfer/service/endpoint-search.js +2 -11
  180. package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
  181. package/dist/esm/services/transfer/service/endpoint.d.ts +257 -9
  182. package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
  183. package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
  184. package/dist/esm/services/transfer/service/file-operations.d.ts +22 -6
  185. package/dist/esm/services/transfer/service/file-operations.d.ts.map +1 -1
  186. package/dist/esm/services/transfer/service/file-operations.js.map +1 -1
  187. package/dist/esm/services/transfer/service/roles.d.ts +75 -0
  188. package/dist/esm/services/transfer/service/roles.d.ts.map +1 -0
  189. package/dist/esm/services/transfer/service/roles.js +49 -0
  190. package/dist/esm/services/transfer/service/roles.js.map +1 -0
  191. package/dist/esm/services/transfer/service/task-submission.d.ts +84 -3
  192. package/dist/esm/services/transfer/service/task-submission.d.ts.map +1 -1
  193. package/dist/esm/services/transfer/service/task-submission.js.map +1 -1
  194. package/dist/esm/services/transfer/service/task.d.ts +162 -16
  195. package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
  196. package/dist/esm/services/transfer/service/task.js.map +1 -1
  197. package/dist/esm/services/transfer/types.d.ts +79 -343
  198. package/dist/esm/services/transfer/types.d.ts.map +1 -1
  199. package/dist/umd/globus.production.js +2 -2
  200. package/dist/umd/globus.production.js.map +4 -4
  201. package/package.json +10 -17
@@ -0,0 +1,2540 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export interface paths {
6
+ "/flows": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * Retrieve all Flows
15
+ * @description Query the Flows service for a listing of Flows available to a user
16
+ * according to the permissions (role) they have on the Flow.
17
+ *
18
+ */
19
+ get: {
20
+ parameters: {
21
+ query?: {
22
+ /** @description An opaque token used to iterate through pages of returned Flows.
23
+ * If provided, all other query arguments will be ignored.
24
+ * The marker encodes all state in a given query,
25
+ * therefore it's unnecessary to provide query arguments
26
+ * once an initial marker has been received.
27
+ * */
28
+ marker?: string;
29
+ /**
30
+ * @description The number of results to return in a single paged response.
31
+ *
32
+ * @example 50
33
+ */
34
+ per_page?: number;
35
+ /**
36
+ * @description The page of results to return.
37
+ * @example 2
38
+ */
39
+ page?: number;
40
+ /**
41
+ * @description Return Flows for which the user has the supplied role. The role the
42
+ * user has on the Flow dictates the operations they can perform. If
43
+ * multiple roles are specified, the user will have at least one of the
44
+ * specified roles on each Flow returned.
45
+ *
46
+ * @example flow_owner,flow_viewers
47
+ */
48
+ filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
49
+ /**
50
+ * @deprecated
51
+ * @description Return Flows for which the user has the provided role. The
52
+ * role the user has on the Flow dictates the operations they
53
+ * can perform. Roles are cumulative in the sense that
54
+ * having, for example, the "flow_starter" role also implies having
55
+ * the "flow_viewer" role. Thus, specifying "flow_starter" will also
56
+ * include all Flows for which the user has "flow_viewer" role as
57
+ * well. If not provided, only Flows for which the caller has
58
+ * "flow_owner" role will be returned.
59
+ *
60
+ * @example flow_starter
61
+ */
62
+ filter_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_manager" | "run_monitor";
63
+ /**
64
+ * @description Performs a case insensitive substring based search on the Flows'
65
+ * scope string fields. If multiple values are specified, each Flow
66
+ * returned is guaranteed to contain at least one of the strings in its
67
+ * scope strings.
68
+ *
69
+ * @example 0abc,100
70
+ */
71
+ filter_scope_string?: string[];
72
+ /**
73
+ * @description Performs a case insensitive substring based search on the Flows' title
74
+ * field. If multiple values are specified, each Flow returned
75
+ * is guaranteed to contain at least one of the strings in its title.
76
+ *
77
+ * @example hello,science
78
+ */
79
+ filter_title?: string[];
80
+ /**
81
+ * @description Performs a case insensitive substring based search on the Flows'
82
+ * subtitle field. If multiple values are specified, each Flow returned
83
+ * is guaranteed to contain at least one of the strings in its
84
+ * subtitle.
85
+ *
86
+ * @example hello,science
87
+ */
88
+ filter_subtitle?: string[];
89
+ /**
90
+ * @description Performs a case insensitive substring based search on the Flows'
91
+ * description field. If multiple values are specified, each Flow returned
92
+ * is guaranteed to contain at least one of the strings in its
93
+ * description.
94
+ *
95
+ * @example hello,science
96
+ */
97
+ filter_description?: string[];
98
+ /**
99
+ * @description Performs a case insensitive substring based search on the Flows'
100
+ * keywords field. If multiple values are specified, each Flow returned
101
+ * is guaranteed to contain at least one of the substrings as a
102
+ * keyword.
103
+ *
104
+ * @example hello,science
105
+ */
106
+ filter_keywords?: string[];
107
+ /**
108
+ * @description Given a one or more patterns, this filter searches against a
109
+ * pre-defined subset of fields for a match. If any of the fields match
110
+ * any of the patterns, the Flow is considered a match.
111
+ *
112
+ * The fields that are automatically searched in are:
113
+ * - title
114
+ * - subtitle
115
+ * - flow_owner
116
+ * - description
117
+ * - id
118
+ * - flow_administrators
119
+ *
120
+ * @example globus
121
+ */
122
+ filter_fulltext?: string[];
123
+ /**
124
+ * @description An ordering criteria to apply to the resulting Flows listing. The
125
+ * first value indicates the field to order on, and the second value
126
+ * indicates the sorting order. The first ordering criteria will be
127
+ * used to sort the data, subsequent ordering criteria will be applied
128
+ * for ties.
129
+ *
130
+ * Fields that support ordering are:
131
+ * - id
132
+ * - scope_string
133
+ * - flow_owner
134
+ * - flow_administrators
135
+ * - title
136
+ * - created_at
137
+ * - updated_at
138
+ *
139
+ * Supported orderings are:
140
+ * - ASC
141
+ * - DESC
142
+ *
143
+ * @default orderby=id ASC
144
+ * @example title ASC,id DESC
145
+ */
146
+ orderby?: string[];
147
+ };
148
+ header?: never;
149
+ path?: never;
150
+ cookie?: never;
151
+ };
152
+ requestBody?: never;
153
+ responses: {
154
+ /** @description The requestor has successfully authenticated and queried the Flow's
155
+ * service for the Flows available for them.
156
+ * */
157
+ 200: {
158
+ headers: {
159
+ [name: string]: unknown;
160
+ };
161
+ content: {
162
+ "application/json": {
163
+ flows?: components["schemas"]["FlowResponse"][];
164
+ /** @description The number of Flows returned. */
165
+ limit?: number;
166
+ /** @description An opaque pagination token for iterating through returned
167
+ * Flows.
168
+ * */
169
+ marker?: string;
170
+ has_next_page?: boolean;
171
+ };
172
+ };
173
+ };
174
+ /** @description There was an issue parsing the query parameters.
175
+ * */
176
+ 400: {
177
+ headers: {
178
+ [name: string]: unknown;
179
+ };
180
+ content?: never;
181
+ };
182
+ /** @description The requestor presented a token with insufficient scopes.
183
+ * */
184
+ 403: {
185
+ headers: {
186
+ [name: string]: unknown;
187
+ };
188
+ content?: never;
189
+ };
190
+ };
191
+ };
192
+ put?: never;
193
+ /**
194
+ * Deploy a Flow
195
+ * @description Deploy a Flow and its schema.
196
+ */
197
+ post: {
198
+ parameters: {
199
+ query?: never;
200
+ header?: never;
201
+ path?: never;
202
+ cookie?: never;
203
+ };
204
+ requestBody: {
205
+ content: {
206
+ "application/json": {
207
+ /** @description The Flow to deploy. */
208
+ definition: components["schemas"]["FlowDefinition"];
209
+ /** @description A non-unique, human-friendly name used for displaying the provider
210
+ * to end users.
211
+ * */
212
+ title?: string;
213
+ /** @description A concise summary of the provider’s purpose. */
214
+ subtitle?: string;
215
+ /** @description A detailed description of the provider for end user display. */
216
+ description?: string;
217
+ /** @description A set of terms used to categorize the provider which may be used in
218
+ * query and discovery operations. Maximum total length of all
219
+ * keywords is 1024 characters.
220
+ * */
221
+ keywords?: string[];
222
+ /**
223
+ * @description A set of Principal URN values, or the value "public" indicating the
224
+ * identity of users who can view the provider description via
225
+ * introspection or when indexed in any provider catalog service.
226
+ *
227
+ * @example [
228
+ * "public",
229
+ * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
230
+ * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
231
+ * ]
232
+ */
233
+ flow_viewers?: components["schemas"]["PrincipalURN_or_public"][];
234
+ /**
235
+ * @description A set of Principal URN values, or the value
236
+ * "all_authenticated_users" indicating the identity of users who can
237
+ * use the /run operation to initiate an action on the provider.
238
+ *
239
+ * @example [
240
+ * "all_authenticated_users",
241
+ * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
242
+ * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
243
+ * ]
244
+ */
245
+ flow_starters?: components["schemas"]["PrincipalURN_or_all_authenticated_users"][];
246
+ /**
247
+ * @description The set of Principal URN values of users who may perform
248
+ * administrative operations, including updating the description
249
+ * itself, on the flow.
250
+ *
251
+ * @example [
252
+ * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
253
+ * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
254
+ * ]
255
+ */
256
+ flow_administrators?: components["schemas"]["PrincipalURN"][];
257
+ /** @description A published JSON Schema which input to the Flow must conform
258
+ * to.
259
+ * */
260
+ input_schema?: Record<string, never>;
261
+ run_managers?: components["schemas"]["RunManagers"];
262
+ run_monitors?: components["schemas"]["RunMonitors"];
263
+ /**
264
+ * Format: uuid
265
+ * @description A subscription to associate with this flow.
266
+ *
267
+ * If no subscription is specified, the flow may be created
268
+ * but may have limits on how long or how much it can be used.
269
+ *
270
+ */
271
+ subscription_id?: string;
272
+ };
273
+ };
274
+ };
275
+ responses: {
276
+ /** @description The Flow definition was successfully deployed onto the Flows
277
+ * service.
278
+ * */
279
+ 201: {
280
+ headers: {
281
+ [name: string]: unknown;
282
+ };
283
+ content: {
284
+ "application/json": components["schemas"]["FlowResponse"];
285
+ };
286
+ };
287
+ /** @description The requestor attempted to deploy a malformed Flow.
288
+ * */
289
+ 400: {
290
+ headers: {
291
+ [name: string]: unknown;
292
+ };
293
+ content?: never;
294
+ };
295
+ /** @description The requestor is not authorized to deploy a Flow.
296
+ * */
297
+ 403: {
298
+ headers: {
299
+ [name: string]: unknown;
300
+ };
301
+ content?: never;
302
+ };
303
+ };
304
+ };
305
+ delete?: never;
306
+ options?: never;
307
+ head?: never;
308
+ patch?: never;
309
+ trace?: never;
310
+ };
311
+ "/flows/validate": {
312
+ parameters: {
313
+ query?: never;
314
+ header?: never;
315
+ path?: never;
316
+ cookie?: never;
317
+ };
318
+ get?: never;
319
+ put?: never;
320
+ /**
321
+ * Validate a flow
322
+ * @description Validate a flow definition and its schema.
323
+ */
324
+ post: {
325
+ parameters: {
326
+ query?: never;
327
+ header?: never;
328
+ path?: never;
329
+ cookie?: never;
330
+ };
331
+ requestBody: {
332
+ content: {
333
+ "application/json": {
334
+ /** @description The flow definition. */
335
+ definition: components["schemas"]["FlowDefinition"];
336
+ /** @description A JSON Schema describing valid input to the flow.
337
+ * */
338
+ input_schema?: Record<string, never>;
339
+ };
340
+ };
341
+ };
342
+ responses: {
343
+ /** @description The flow passed all validation checks.
344
+ * */
345
+ 200: {
346
+ headers: {
347
+ [name: string]: unknown;
348
+ };
349
+ content: {
350
+ "application/json": components["schemas"]["FlowValidationResponse"];
351
+ };
352
+ };
353
+ /** @description The requestor attempted to validate a malformed flow.
354
+ * */
355
+ 400: {
356
+ headers: {
357
+ [name: string]: unknown;
358
+ };
359
+ content?: never;
360
+ };
361
+ /** @description The requestor is not authorized to validate a flow.
362
+ * */
363
+ 403: {
364
+ headers: {
365
+ [name: string]: unknown;
366
+ };
367
+ content?: never;
368
+ };
369
+ /** @description A conflict was found in the flow definition or input schema.
370
+ * */
371
+ 409: {
372
+ headers: {
373
+ [name: string]: unknown;
374
+ };
375
+ content?: never;
376
+ };
377
+ /** @description The flow definition or input schema failed validation checks.
378
+ * */
379
+ 422: {
380
+ headers: {
381
+ [name: string]: unknown;
382
+ };
383
+ content: {
384
+ "application/json": components["schemas"]["FlowValidationErrorResponse"];
385
+ };
386
+ };
387
+ };
388
+ };
389
+ delete?: never;
390
+ options?: never;
391
+ head?: never;
392
+ patch?: never;
393
+ trace?: never;
394
+ };
395
+ "/flows/{flow_id}": {
396
+ parameters: {
397
+ query?: never;
398
+ header?: never;
399
+ path: {
400
+ /** @description The ID for the Flow whose definition is being looked up. */
401
+ flow_id: string;
402
+ };
403
+ cookie?: never;
404
+ };
405
+ /**
406
+ * Retrieve a Flow
407
+ * @description Get a previously deployed Flow.
408
+ */
409
+ get: {
410
+ parameters: {
411
+ query?: never;
412
+ header?: never;
413
+ path: {
414
+ /** @description The ID for the Flow whose definition is being looked up. */
415
+ flow_id: string;
416
+ };
417
+ cookie?: never;
418
+ };
419
+ requestBody?: never;
420
+ responses: {
421
+ /** @description The requestor has successfully authenticated and queried the Flow's
422
+ * service for a specific Flow definition.
423
+ * */
424
+ 200: {
425
+ headers: {
426
+ [name: string]: unknown;
427
+ };
428
+ content: {
429
+ "application/json": components["schemas"]["FlowResponse"];
430
+ };
431
+ };
432
+ /** @description The requestor attempted to retrieve a Flow definition for which they
433
+ * did not have access.
434
+ * */
435
+ 403: {
436
+ headers: {
437
+ [name: string]: unknown;
438
+ };
439
+ content?: never;
440
+ };
441
+ /** @description The requestor attempted to retrieve a non-existent Flow, or the
442
+ * requestor did not have permissions to view a Flow.
443
+ * */
444
+ 404: {
445
+ headers: {
446
+ [name: string]: unknown;
447
+ };
448
+ content?: never;
449
+ };
450
+ };
451
+ };
452
+ /**
453
+ * Update a Flow
454
+ * @description Update a previously deployed Flow.
455
+ */
456
+ put: {
457
+ parameters: {
458
+ query?: never;
459
+ header?: never;
460
+ path: {
461
+ /** @description The ID for the Flow whose definition is being looked up. */
462
+ flow_id: string;
463
+ };
464
+ cookie?: never;
465
+ };
466
+ requestBody: {
467
+ content: {
468
+ "application/json": {
469
+ /** @description A new flow definition that will replace the old one.
470
+ *
471
+ * Runs that are currently executing will continue to use the definition
472
+ * that they were initially started with.
473
+ * */
474
+ definition?: components["schemas"]["FlowDefinition"];
475
+ /** @description A JSON schema document.
476
+ *
477
+ * When starting the flow, input keys and values must conform to the schema.
478
+ * The Globus Web App uses the input schema to created a guided input page when starting the flow.
479
+ * */
480
+ input_schema?: Record<string, never>;
481
+ /** @description A non-unique, human-friendly name used for displaying the flow to end users.
482
+ * */
483
+ title?: string;
484
+ /** @description A short summary of the flow's purpose or functionality.
485
+ * */
486
+ subtitle?: string;
487
+ /** @description Arbitrary text to describe the Flow.
488
+ * */
489
+ description?: string;
490
+ /** @description If provided, the value must be the calling user's Globus Auth identity URN,
491
+ * and the user must be a flow administrator.
492
+ *
493
+ * It is not possible for non-administrators to take ownership of a flow.
494
+ * Also, it is currently not possible to assign ownership to another user.
495
+ * */
496
+ flow_owner?: string;
497
+ /** @description A list of Globus Auth identity and group URNs that may administer the flow.
498
+ *
499
+ * Flow administrators are able to see the full flow definition,
500
+ * including any parameters listed in a "__Private_Parameters" value.
501
+ * */
502
+ flow_administrators?: Record<string, never>[];
503
+ /** @description A list of Globus Auth identity and group URNs that may start the flow.
504
+ *
505
+ * It is possible to make a flow available for use to all authenticated users
506
+ * -- including those outside your organization or domain --
507
+ * by using the special value "all_authenticated_users".
508
+ *
509
+ * Parameters listed in "__Private_Parameters" values in the definition
510
+ * will be removed from the definition when it is viewed by a flow starter.
511
+ * */
512
+ flow_starters?: Record<string, never>[];
513
+ /** @description A list of Globus Auth identity and group URNs that may see the flow,
514
+ * including its definition and input schema.
515
+ *
516
+ * It is possible to make a flow available for viewing to all users
517
+ * -- including those outside your organization or domain --
518
+ * by using the special value "public".
519
+ *
520
+ * Parameters listed in "__Private_Parameters" values in the definition
521
+ * will be removed from the definition when it is viewed by a flow starter.
522
+ * */
523
+ flow_viewers?: Record<string, never>[];
524
+ /** @description A list of keywords that can be used for grouping or identifying flows.
525
+ * */
526
+ keywords?: Record<string, never>[];
527
+ run_managers?: components["schemas"]["RunManagers"];
528
+ run_monitors?: components["schemas"]["RunMonitors"];
529
+ subscription_id?: string & (unknown | "DEFAULT");
530
+ };
531
+ };
532
+ };
533
+ responses: {
534
+ /** @description The requestor has successfully authenticated and updated the target
535
+ * Flow definition.
536
+ * */
537
+ 200: {
538
+ headers: {
539
+ [name: string]: unknown;
540
+ };
541
+ content: {
542
+ "application/json": components["schemas"]["FlowResponse"];
543
+ };
544
+ };
545
+ /** @description The Flow definition update failed due to an attempt to perform a
546
+ * malformed update.
547
+ * */
548
+ 400: {
549
+ headers: {
550
+ [name: string]: unknown;
551
+ };
552
+ content?: never;
553
+ };
554
+ /** @description The requestor attempted to update a Flow for which they did not have
555
+ * access.
556
+ * */
557
+ 403: {
558
+ headers: {
559
+ [name: string]: unknown;
560
+ };
561
+ content?: never;
562
+ };
563
+ /** @description The requestor attempted to update a non-existent Flow, or the
564
+ * requestor did not have permissions to update a Flow.
565
+ * */
566
+ 404: {
567
+ headers: {
568
+ [name: string]: unknown;
569
+ };
570
+ content?: never;
571
+ };
572
+ };
573
+ };
574
+ post?: never;
575
+ /**
576
+ * Remove a Flow
577
+ * @description Remove a Flow from the Flow service.
578
+ */
579
+ delete: {
580
+ parameters: {
581
+ query?: never;
582
+ header?: never;
583
+ path: {
584
+ /** @description The ID for the Flow whose definition is being looked up. */
585
+ flow_id: string;
586
+ };
587
+ cookie?: never;
588
+ };
589
+ requestBody?: never;
590
+ responses: {
591
+ /** @description The requestor has successfully removed the Flow from the Flows
592
+ * service.
593
+ * */
594
+ 200: {
595
+ headers: {
596
+ [name: string]: unknown;
597
+ };
598
+ content: {
599
+ "application/json": components["schemas"]["FlowResponse"];
600
+ };
601
+ };
602
+ /** @description The requestor attempted to modify a Flow for which they did not have
603
+ * access.
604
+ * */
605
+ 403: {
606
+ headers: {
607
+ [name: string]: unknown;
608
+ };
609
+ content?: never;
610
+ };
611
+ /** @description The requestor attempted to remove a non-existent Flow, or the
612
+ * requestor did not have permissions to remove the Flow.
613
+ * */
614
+ 404: {
615
+ headers: {
616
+ [name: string]: unknown;
617
+ };
618
+ content?: never;
619
+ };
620
+ };
621
+ };
622
+ options?: never;
623
+ head?: never;
624
+ patch?: never;
625
+ trace?: never;
626
+ };
627
+ "/mine": {
628
+ parameters: {
629
+ query?: never;
630
+ header?: never;
631
+ path?: never;
632
+ cookie?: never;
633
+ };
634
+ /**
635
+ * Retrieve all Flows
636
+ * @deprecated
637
+ * @description Query the Flows service for a listing of Flows available to a user
638
+ * according to the permissions (role) they have on the Flow.
639
+ *
640
+ */
641
+ get: {
642
+ parameters: {
643
+ query?: {
644
+ /**
645
+ * @description Return Flow's for which the user has the supplied role. The role the
646
+ * user has on the Flow dictates the operations they can perform.
647
+ *
648
+ * @example flow_owner,flow_viewers
649
+ */
650
+ roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators")[];
651
+ };
652
+ header?: never;
653
+ path?: never;
654
+ cookie?: never;
655
+ };
656
+ requestBody?: never;
657
+ responses: {
658
+ /** @description The requestor has successfully authenticated and queried the Flow's
659
+ * service for the Flows available for them.
660
+ * */
661
+ 200: {
662
+ headers: {
663
+ [name: string]: unknown;
664
+ };
665
+ content: {
666
+ "application/json": {
667
+ flows?: components["schemas"]["FlowResponse"][];
668
+ /** @description The number of Flows returned. */
669
+ limit?: number;
670
+ /** @description An opaque pagination token for iterating through returned
671
+ * Flows.
672
+ * */
673
+ marker?: string;
674
+ has_next_page?: boolean;
675
+ };
676
+ };
677
+ };
678
+ /** @description There was an issue parsing the query parameters.
679
+ * */
680
+ 400: {
681
+ headers: {
682
+ [name: string]: unknown;
683
+ };
684
+ content?: never;
685
+ };
686
+ /** @description The requestor presented a token with insufficient scopes.
687
+ * */
688
+ 403: {
689
+ headers: {
690
+ [name: string]: unknown;
691
+ };
692
+ content?: never;
693
+ };
694
+ };
695
+ };
696
+ put?: never;
697
+ post?: never;
698
+ delete?: never;
699
+ options?: never;
700
+ head?: never;
701
+ patch?: never;
702
+ trace?: never;
703
+ };
704
+ "/flows/{flow_id}/run": {
705
+ parameters: {
706
+ query?: never;
707
+ header?: never;
708
+ path: {
709
+ /** @description The ID for the Flow to run. */
710
+ flow_id: string;
711
+ };
712
+ cookie?: never;
713
+ };
714
+ get?: never;
715
+ put?: never;
716
+ /**
717
+ * Start a Flow
718
+ * @description Start a particular Flow, which creates a Run.
719
+ */
720
+ post: {
721
+ parameters: {
722
+ query?: never;
723
+ header?: never;
724
+ path: {
725
+ /** @description The ID for the Flow to run. */
726
+ flow_id: string;
727
+ };
728
+ cookie?: never;
729
+ };
730
+ requestBody: {
731
+ content: {
732
+ "application/json": {
733
+ body: components["schemas"]["InputBody"];
734
+ run_monitors?: components["schemas"]["RunMonitors"];
735
+ run_managers?: components["schemas"]["RunManagers"];
736
+ label?: components["schemas"]["Label"];
737
+ tags?: components["schemas"]["Tags"];
738
+ activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
739
+ };
740
+ };
741
+ };
742
+ responses: {
743
+ /** @description The Run inputs were successfully validated during a dry-run. */
744
+ 200: {
745
+ headers: {
746
+ [name: string]: unknown;
747
+ };
748
+ content?: never;
749
+ };
750
+ /** @description The Run was successfully started. */
751
+ 201: {
752
+ headers: {
753
+ [name: string]: unknown;
754
+ };
755
+ content: {
756
+ "application/json": components["schemas"]["FlowRun"];
757
+ };
758
+ };
759
+ /** @description The Run's input failed validation against the Flow's input schema.
760
+ * */
761
+ 400: {
762
+ headers: {
763
+ [name: string]: unknown;
764
+ };
765
+ content?: never;
766
+ };
767
+ /** @description The requestor presented a token with insufficient scopes.
768
+ * */
769
+ 403: {
770
+ headers: {
771
+ [name: string]: unknown;
772
+ };
773
+ content?: never;
774
+ };
775
+ /** @description The requestor did not have access to run the provided Flow, or the
776
+ * Flow does not exist.
777
+ * */
778
+ 404: {
779
+ headers: {
780
+ [name: string]: unknown;
781
+ };
782
+ content?: never;
783
+ };
784
+ /** @description The input tags did not pass validation. */
785
+ 422: {
786
+ headers: {
787
+ [name: string]: unknown;
788
+ };
789
+ content?: never;
790
+ };
791
+ /** @description An upstream service has imposed rate limiting.
792
+ * The requestor may resubmit the API request.
793
+ * */
794
+ 429: {
795
+ headers: {
796
+ [name: string]: unknown;
797
+ };
798
+ content?: never;
799
+ };
800
+ /** @description An upstream service returned an uncorrectable error.
801
+ * The error may or may not occur if the API request is submitted again.
802
+ * It may be possible to resubmit the API request.
803
+ * */
804
+ 502: {
805
+ headers: {
806
+ [name: string]: unknown;
807
+ };
808
+ content?: never;
809
+ };
810
+ };
811
+ };
812
+ delete?: never;
813
+ options?: never;
814
+ head?: never;
815
+ patch?: never;
816
+ trace?: never;
817
+ };
818
+ "/flows/{flow_id}/validate_run": {
819
+ parameters: {
820
+ query?: never;
821
+ header?: never;
822
+ path?: never;
823
+ cookie?: never;
824
+ };
825
+ get?: never;
826
+ put?: never;
827
+ /**
828
+ * Validate a run
829
+ * @description Validate that a run input body will pass the target flow's input schema validation (if any),
830
+ * that run metadata will meet the Flows service's metadata constraints,
831
+ * and that known scope requirements are met by the user's or client's Globus Auth token.
832
+ *
833
+ * If validation passes, then it is likely that the flow can be started
834
+ * with the same inputs and Globus Auth token.
835
+ *
836
+ */
837
+ post: {
838
+ parameters: {
839
+ query?: never;
840
+ header?: never;
841
+ path?: never;
842
+ cookie?: never;
843
+ };
844
+ requestBody: {
845
+ content: {
846
+ "application/json": {
847
+ activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
848
+ body: components["schemas"]["InputBody"];
849
+ label?: components["schemas"]["Label"];
850
+ run_managers?: components["schemas"]["RunManagers"];
851
+ run_monitors?: components["schemas"]["RunMonitors"];
852
+ tags?: components["schemas"]["Tags"];
853
+ };
854
+ };
855
+ };
856
+ responses: {
857
+ /** @description The inputs and Globus Auth token passed validation.
858
+ *
859
+ * It is likely that the user or client will be able to start the flow
860
+ * using the same Globus Auth token and input values.
861
+ * */
862
+ 200: {
863
+ headers: {
864
+ [name: string]: unknown;
865
+ };
866
+ content: {
867
+ "application/json": components["schemas"]["ValidateRun"];
868
+ };
869
+ };
870
+ /** @description The input body failed validation against the flow's input schema.
871
+ * */
872
+ 400: {
873
+ headers: {
874
+ [name: string]: unknown;
875
+ };
876
+ content?: never;
877
+ };
878
+ /** @description The user or client is not allowed to run the flow,
879
+ * or the Globus Auth token is missing required scopes.
880
+ * */
881
+ 403: {
882
+ headers: {
883
+ [name: string]: unknown;
884
+ };
885
+ content?: never;
886
+ };
887
+ };
888
+ };
889
+ delete?: never;
890
+ options?: never;
891
+ head?: never;
892
+ patch?: never;
893
+ trace?: never;
894
+ };
895
+ "/flows/{flow_id}/start": {
896
+ parameters: {
897
+ query?: never;
898
+ header?: never;
899
+ path: {
900
+ /** @description The ID for the Flow to run. */
901
+ flow_id: string;
902
+ };
903
+ cookie?: never;
904
+ };
905
+ get?: never;
906
+ put?: never;
907
+ /**
908
+ * Start a Flow
909
+ * @deprecated
910
+ * @description Start a particular Flow, which creates a Run.
911
+ */
912
+ post: {
913
+ parameters: {
914
+ query?: never;
915
+ header?: never;
916
+ path: {
917
+ /** @description The ID for the Flow to run. */
918
+ flow_id: string;
919
+ };
920
+ cookie?: never;
921
+ };
922
+ requestBody: {
923
+ content: {
924
+ "application/json": {
925
+ body: components["schemas"]["InputBody"];
926
+ tags?: components["schemas"]["Tags"];
927
+ };
928
+ };
929
+ };
930
+ responses: {
931
+ /** @description The Run inputs were successfully validated during a dry-run. */
932
+ 200: {
933
+ headers: {
934
+ [name: string]: unknown;
935
+ };
936
+ content?: never;
937
+ };
938
+ /** @description The Run was successfully started. */
939
+ 201: {
940
+ headers: {
941
+ [name: string]: unknown;
942
+ };
943
+ content: {
944
+ "application/json": components["schemas"]["FlowRun"];
945
+ };
946
+ };
947
+ /** @description The Run's input failed validation against the Flow's input schema.
948
+ * */
949
+ 400: {
950
+ headers: {
951
+ [name: string]: unknown;
952
+ };
953
+ content?: never;
954
+ };
955
+ /** @description The requestor presented a token with insufficient scopes.
956
+ * */
957
+ 403: {
958
+ headers: {
959
+ [name: string]: unknown;
960
+ };
961
+ content?: never;
962
+ };
963
+ /** @description The requestor did not have access to run the provided Flow, or the
964
+ * Flow does not exist.
965
+ * */
966
+ 404: {
967
+ headers: {
968
+ [name: string]: unknown;
969
+ };
970
+ content?: never;
971
+ };
972
+ /** @description The input tags did not pass validation. */
973
+ 422: {
974
+ headers: {
975
+ [name: string]: unknown;
976
+ };
977
+ content?: never;
978
+ };
979
+ /** @description An upstream service has imposed rate limiting.
980
+ * The requestor may resubmit the API request.
981
+ * */
982
+ 429: {
983
+ headers: {
984
+ [name: string]: unknown;
985
+ };
986
+ content?: never;
987
+ };
988
+ /** @description An upstream service returned an uncorrectable error.
989
+ * The error may or may not occur if the API request is submitted again.
990
+ * It may be possible to resubmit the API request.
991
+ * */
992
+ 502: {
993
+ headers: {
994
+ [name: string]: unknown;
995
+ };
996
+ content?: never;
997
+ };
998
+ };
999
+ };
1000
+ delete?: never;
1001
+ options?: never;
1002
+ head?: never;
1003
+ patch?: never;
1004
+ trace?: never;
1005
+ };
1006
+ "/runs/{run_id}/release": {
1007
+ parameters: {
1008
+ query?: never;
1009
+ header?: never;
1010
+ path: {
1011
+ /** @description The ID for the Run whose data is being released. */
1012
+ run_id: string;
1013
+ };
1014
+ cookie?: never;
1015
+ };
1016
+ get?: never;
1017
+ put?: never;
1018
+ /**
1019
+ * Remove a Run
1020
+ * @description Remove the state for a particular invocation of a Flow.
1021
+ */
1022
+ post: {
1023
+ parameters: {
1024
+ query?: never;
1025
+ header?: never;
1026
+ path: {
1027
+ /** @description The ID for the Run whose data is being released. */
1028
+ run_id: string;
1029
+ };
1030
+ cookie?: never;
1031
+ };
1032
+ requestBody?: never;
1033
+ responses: {
1034
+ /** @description The request was successful. */
1035
+ 200: {
1036
+ headers: {
1037
+ [name: string]: unknown;
1038
+ };
1039
+ content: {
1040
+ "application/json": components["schemas"]["FlowRun"];
1041
+ };
1042
+ };
1043
+ /** @description The requestor is not authorized to access the run or flow,
1044
+ * or has not provided access tokens with sufficient privileges.
1045
+ * */
1046
+ 403: {
1047
+ headers: {
1048
+ [name: string]: unknown;
1049
+ };
1050
+ content?: never;
1051
+ };
1052
+ /** @description The requested Run or Flow was not found. Or, the requestor did not
1053
+ * have access to view the Run.
1054
+ * */
1055
+ 404: {
1056
+ headers: {
1057
+ [name: string]: unknown;
1058
+ };
1059
+ content?: never;
1060
+ };
1061
+ /** @description The requestor attempted to remove the state for a Run which had
1062
+ * not yet reached a completed status.
1063
+ * */
1064
+ 409: {
1065
+ headers: {
1066
+ [name: string]: unknown;
1067
+ };
1068
+ content?: never;
1069
+ };
1070
+ /** @description An upstream service rate-limited the request to release the Run.
1071
+ * The requestor may re-submit the request at a later time.
1072
+ * */
1073
+ 429: {
1074
+ headers: {
1075
+ [name: string]: unknown;
1076
+ };
1077
+ content?: never;
1078
+ };
1079
+ /** @description The run is in an unexpected state in the Flows service.
1080
+ * Please contact Globus support.
1081
+ * */
1082
+ 500: {
1083
+ headers: {
1084
+ [name: string]: unknown;
1085
+ };
1086
+ content?: never;
1087
+ };
1088
+ /** @description A request to an upstream service failed for an unknown reason.
1089
+ * The requestor can re-submit the request or contact Globus support.
1090
+ * */
1091
+ 502: {
1092
+ headers: {
1093
+ [name: string]: unknown;
1094
+ };
1095
+ content?: never;
1096
+ };
1097
+ };
1098
+ };
1099
+ delete?: never;
1100
+ options?: never;
1101
+ head?: never;
1102
+ patch?: never;
1103
+ trace?: never;
1104
+ };
1105
+ "/flows/{flow_id}/runs/{run_id}/resume": {
1106
+ parameters: {
1107
+ query?: never;
1108
+ header?: never;
1109
+ path: {
1110
+ /** @description The ID for the Flow which launched the Run. */
1111
+ flow_id: string;
1112
+ /** @description The ID for the Run whose data is being resumed. */
1113
+ run_id: string;
1114
+ };
1115
+ cookie?: never;
1116
+ };
1117
+ get?: never;
1118
+ put?: never;
1119
+ /**
1120
+ * Resume a Run
1121
+ * @description Attempt to resume a Run, particularly when it has reached a
1122
+ * status of INACTIVE. A Flow Run may reach an INACTIVE status
1123
+ * when an Action type state within the Flow returns its status
1124
+ * as INACTIVE. The resume operation on the Flow Run provides a
1125
+ * hint that the cause of the Action becoming INACTIVE may have
1126
+ * been cleared, and thus the resume operation on the Action
1127
+ * Provider should be invoked to allow the Action state to resume
1128
+ * and thus resume the Flow Run.
1129
+ *
1130
+ * In the particular case that an Action state is INACTIVE with a
1131
+ * code value of "ConsentRequired" it is further assumed that the
1132
+ * Bearer token provided in the Authorization header on the
1133
+ * resume operation now carries sufficient consents to continue
1134
+ * the INACTIVE Action. Thus, the Flow service will use the
1135
+ * Bearer token to generate new dependent tokens for running the
1136
+ * Action and use these tokens to request that the Action be
1137
+ * resumed at the Action Provider.
1138
+ *
1139
+ * Note again that in reasons other than "ConsentRequired" for a
1140
+ * Flow or Action to go INACTIVE, the resume operation is just a
1141
+ * hint. For example, when the code is "ActivationRequired,"
1142
+ * indicating that a Globus collection or endpoint needs to be
1143
+ * Activated by the user, performing that Activation out-of-band
1144
+ * from the Flow will allow the Flow to proceed even without the
1145
+ * resume operation as the Action is periodically polled for
1146
+ * progress. Performing the resume operation may simply cause a
1147
+ * poll to happen more quickly and thus allow the Action to
1148
+ * resume more quickly.
1149
+ *
1150
+ */
1151
+ post: {
1152
+ parameters: {
1153
+ query?: never;
1154
+ header?: never;
1155
+ path: {
1156
+ /** @description The ID for the Flow which launched the Run. */
1157
+ flow_id: string;
1158
+ /** @description The ID for the Run whose data is being resumed. */
1159
+ run_id: string;
1160
+ };
1161
+ cookie?: never;
1162
+ };
1163
+ requestBody?: never;
1164
+ responses: {
1165
+ /** @description The request was successful. */
1166
+ 200: {
1167
+ headers: {
1168
+ [name: string]: unknown;
1169
+ };
1170
+ content: {
1171
+ "application/json": components["schemas"]["FlowRun"];
1172
+ };
1173
+ };
1174
+ /** @description The requested Run or Flow was not found. Or, the requestor did not
1175
+ * have access to manage the Run.
1176
+ * */
1177
+ 404: {
1178
+ headers: {
1179
+ [name: string]: unknown;
1180
+ };
1181
+ content?: never;
1182
+ };
1183
+ };
1184
+ };
1185
+ delete?: never;
1186
+ options?: never;
1187
+ head?: never;
1188
+ patch?: never;
1189
+ trace?: never;
1190
+ };
1191
+ "/flows/{flow_id}/actions/{action_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1192
+ "/runs/{action_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1193
+ "/flows/{flow_id}/{run_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1194
+ "/runs/{run_id}/cancel": {
1195
+ parameters: {
1196
+ query?: never;
1197
+ header?: never;
1198
+ path: {
1199
+ /** @description The ID for the Run to cancel. */
1200
+ run_id: string;
1201
+ };
1202
+ cookie?: never;
1203
+ };
1204
+ get?: never;
1205
+ put?: never;
1206
+ /**
1207
+ * Cancel a Run
1208
+ * @description Cancel the execution for a particular Run of a Flow.
1209
+ */
1210
+ post: {
1211
+ parameters: {
1212
+ query?: never;
1213
+ header?: never;
1214
+ path: {
1215
+ /** @description The ID for the Run to cancel. */
1216
+ run_id: string;
1217
+ };
1218
+ cookie?: never;
1219
+ };
1220
+ requestBody?: never;
1221
+ responses: {
1222
+ /** @description The request was successfully received. */
1223
+ 202: {
1224
+ headers: {
1225
+ [name: string]: unknown;
1226
+ };
1227
+ content: {
1228
+ "application/json": components["schemas"]["FlowRun"];
1229
+ };
1230
+ };
1231
+ /** @description The requested Run or Flow was not found. Or, the requestor did not
1232
+ * have access to view the Run.
1233
+ * */
1234
+ 404: {
1235
+ headers: {
1236
+ [name: string]: unknown;
1237
+ };
1238
+ content?: never;
1239
+ };
1240
+ /** @description The service encountered an Upstream error when attempting to cancel
1241
+ * the Run.
1242
+ * */
1243
+ 502: {
1244
+ headers: {
1245
+ [name: string]: unknown;
1246
+ };
1247
+ content?: never;
1248
+ };
1249
+ };
1250
+ };
1251
+ delete?: never;
1252
+ options?: never;
1253
+ head?: never;
1254
+ patch?: never;
1255
+ trace?: never;
1256
+ };
1257
+ "/flows/{flow_id}/runs/{run_id}/log": {
1258
+ parameters: {
1259
+ query?: {
1260
+ /** @description An integer limit on the number of log records returned. */
1261
+ limit?: number;
1262
+ /** @description A flag to indicate if log records should be returned in reverse order.
1263
+ * */
1264
+ reverse_order?: boolean;
1265
+ /** @description A token used to iterate through pages of returned log records.
1266
+ * */
1267
+ pagination_token?: string;
1268
+ };
1269
+ header?: never;
1270
+ path: {
1271
+ /** @description The ID for the Flow which launched the Run. */
1272
+ flow_id: string;
1273
+ /** @description The ID for the Run whose log is getting pulled. */
1274
+ run_id: string;
1275
+ };
1276
+ cookie?: never;
1277
+ };
1278
+ /**
1279
+ * Get execution details on a Run
1280
+ * @description Retrieve detailed execution information for a particular Flow Run
1281
+ *
1282
+ */
1283
+ get: {
1284
+ parameters: {
1285
+ query?: {
1286
+ /** @description An integer limit on the number of log records returned. */
1287
+ limit?: number;
1288
+ /** @description A flag to indicate if log records should be returned in reverse order.
1289
+ * */
1290
+ reverse_order?: boolean;
1291
+ /** @description A token used to iterate through pages of returned log records.
1292
+ * */
1293
+ pagination_token?: string;
1294
+ };
1295
+ header?: never;
1296
+ path: {
1297
+ /** @description The ID for the Flow which launched the Run. */
1298
+ flow_id: string;
1299
+ /** @description The ID for the Run whose log is getting pulled. */
1300
+ run_id: string;
1301
+ };
1302
+ cookie?: never;
1303
+ };
1304
+ requestBody?: never;
1305
+ responses: {
1306
+ /** @description The request was successfully received. */
1307
+ 200: {
1308
+ headers: {
1309
+ [name: string]: unknown;
1310
+ };
1311
+ content: {
1312
+ "application/json": {
1313
+ /** @description The number of log states returned. */
1314
+ limit: number;
1315
+ /** @description An opaque pagination token for iterating through returned
1316
+ * records. If there are no more entries, this field will not
1317
+ * exist.
1318
+ * */
1319
+ marker?: string;
1320
+ has_next_page: boolean;
1321
+ entries: Record<string, never>[];
1322
+ };
1323
+ };
1324
+ };
1325
+ /** @description There was an issue parsing the query parameters.
1326
+ * */
1327
+ 400: {
1328
+ headers: {
1329
+ [name: string]: unknown;
1330
+ };
1331
+ content?: never;
1332
+ };
1333
+ /** @description The requested Action or Flow was not found. Or, the
1334
+ * requestor did not have access to view the Action.
1335
+ * */
1336
+ 404: {
1337
+ headers: {
1338
+ [name: string]: unknown;
1339
+ };
1340
+ content?: never;
1341
+ };
1342
+ };
1343
+ };
1344
+ put?: never;
1345
+ post?: never;
1346
+ delete?: never;
1347
+ options?: never;
1348
+ head?: never;
1349
+ patch?: never;
1350
+ trace?: never;
1351
+ };
1352
+ "/flows/{flow_id}/actions/{action_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
1353
+ "/runs/{action_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
1354
+ "/flows/{flow_id}/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
1355
+ "/flows/{flow_id}/runs": {
1356
+ parameters: {
1357
+ query?: never;
1358
+ header?: never;
1359
+ path: {
1360
+ /** @description The ID for the Flow which launched the Runs. */
1361
+ flow_id: string;
1362
+ };
1363
+ cookie?: never;
1364
+ };
1365
+ /**
1366
+ * Get a Flow's Runs
1367
+ * @description Retrieve a listing of Runs launched from a particular Flow. If hitting
1368
+ * the *\/actions endpoint, the response will list the Runs under a
1369
+ * "actions" key. If hitting the *\/runs endpoint, the response will list
1370
+ * the Runs under a "runs" key.
1371
+ *
1372
+ */
1373
+ get: {
1374
+ parameters: {
1375
+ query?: {
1376
+ /** @description An opaque token used to iterate through pages of returned Actions.
1377
+ * If provided, all other query arguments will be ignored.
1378
+ * The marker encodes all state in a given query,
1379
+ * therefore it's unnecessary to provide query arguments
1380
+ * once an initial marker has been received.
1381
+ * */
1382
+ marker?: string;
1383
+ /**
1384
+ * @deprecated
1385
+ * @description ("marker" is now the preferred name for this parameter.)
1386
+ * An opaque token used to iterate through pages of returned Actions. If
1387
+ * provided, all other query arguments will be ignored. The
1388
+ * pagination_token encodes all state in a given query, therefore it's
1389
+ * unnecessary to provide query arguments once an initial token has been
1390
+ * received.
1391
+ *
1392
+ */
1393
+ pagination_token?: string;
1394
+ /**
1395
+ * @description The number of results to return in a single paged response.
1396
+ *
1397
+ * @example 50
1398
+ */
1399
+ per_page?: number;
1400
+ /**
1401
+ * @description The page of results to return.
1402
+ * @example 2
1403
+ */
1404
+ page?: number;
1405
+ /**
1406
+ * @description Return Actions for which the user has the supplied role. The role the
1407
+ * user has on the Action dictates the operations they can perform.
1408
+ * If multiple roles are specified, the user will have at least one of
1409
+ * the specified roles on each Action returned.
1410
+ *
1411
+ * @example run_manager
1412
+ */
1413
+ filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
1414
+ /**
1415
+ * @deprecated
1416
+ * @description Return Actions for which the user has the provided
1417
+ * role. The role the user has on the Action dictates the
1418
+ * operations they can perform. Roles are cumulative in the
1419
+ * sense that having, for example, the "run_manager" role also
1420
+ * implies having the "run_monitor" role. Thus, specifying
1421
+ * manager will also include all Actions for which the user
1422
+ * has "run_monitor" role as well. If not provided, only Actions
1423
+ * for which the caller has "run_owner" role will be returned.
1424
+ *
1425
+ * @example run_manager
1426
+ */
1427
+ filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
1428
+ /**
1429
+ * @description Return Actions which are in the specified state. The state of the
1430
+ * Action dictates the operations which can performed on them. If
1431
+ * multiple statuses are specified, each Action returned will be in one
1432
+ * of the specified states. By default, Actions in any state will be
1433
+ * returned.
1434
+ *
1435
+ * @example FAILED,INACTIVE
1436
+ */
1437
+ filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
1438
+ /**
1439
+ * @description Performs a case insensitive string based search on the Actions'
1440
+ * label fields. If multiple values are specified, each Action returned
1441
+ * is guaranteed to contain at least one of the strings in its label.
1442
+ *
1443
+ * @example science,tests
1444
+ */
1445
+ filter_label?: string[];
1446
+ /**
1447
+ * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1448
+ * results to only those Actions whose completion time is within the
1449
+ * specified range. If one of the dates is omitted, it forms an open
1450
+ * range, so "dt," returns all records with date greater or equal to
1451
+ * dt, and ",dt" returns all records with dates less than dt. If there
1452
+ * is no comma, it is treated in the same way as "dt,". Results will
1453
+ * contain Actions which completed between the first date/time string
1454
+ * onwards, up to (but not including) the second date/time string.
1455
+ * Note that Actions which are still running will have null completion
1456
+ * times and thus cannot be filtered by this field.
1457
+ *
1458
+ * @example 2021-03-09T21:52:14,2021-03-09T21:53
1459
+ */
1460
+ filter_completion_time?: string;
1461
+ /**
1462
+ * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1463
+ * results to only those Actions which started running within the
1464
+ * specified range. If one of the dates is omitted, it forms an open
1465
+ * range, so "dt," returns all records with date greater or equal to
1466
+ * dt, and ",dt" returns all records with dates less than dt. If there
1467
+ * is no comma, it is treated in the same way as "dt,". Results will
1468
+ * contain Actions which began between the first date/time string
1469
+ * onwards, up to (but not including) the second date/time string.
1470
+ *
1471
+ * @example 2021-03-09T21:52:14,2021-03-09T21:53
1472
+ */
1473
+ filter_start_time?: string;
1474
+ /**
1475
+ * @description An ordering criteria to apply to the resulting Action listing. The
1476
+ * first value indicates the field to order on, and the second value
1477
+ * indicates the sorting order. The first ordering criteria will be
1478
+ * used to sort the data, subsequent ordering criteria will be applied
1479
+ * for ties.
1480
+ *
1481
+ * Fields that support ordering are:
1482
+ * - id
1483
+ * - start_time
1484
+ * - completion_time
1485
+ * - status
1486
+ * - label
1487
+ *
1488
+ * Supported orderings are:
1489
+ * - ASC
1490
+ * - DESC
1491
+ *
1492
+ * @default orderby=id ASC
1493
+ * @example start_time ASC,id DESC
1494
+ */
1495
+ orderby?: string[];
1496
+ };
1497
+ header?: never;
1498
+ path: {
1499
+ /** @description The ID for the Flow which launched the Runs. */
1500
+ flow_id: string;
1501
+ };
1502
+ cookie?: never;
1503
+ };
1504
+ requestBody?: never;
1505
+ responses: {
1506
+ /** @description The request was successfully received. */
1507
+ 200: {
1508
+ headers: {
1509
+ [name: string]: unknown;
1510
+ };
1511
+ content: {
1512
+ "application/json": {
1513
+ /** @description An opaque pagination token for iterating through returned
1514
+ * Actions. If there are no more entries, this field will not
1515
+ * exist.
1516
+ * */
1517
+ marker?: string;
1518
+ has_next_page: boolean;
1519
+ actions: components["schemas"]["FlowRun"][];
1520
+ };
1521
+ };
1522
+ };
1523
+ /** @description The requestor presented a token with insufficient scopes.
1524
+ * */
1525
+ 403: {
1526
+ headers: {
1527
+ [name: string]: unknown;
1528
+ };
1529
+ content?: never;
1530
+ };
1531
+ /** @description The Flow does not exist or the requestor did not have access to
1532
+ * enumerate the Flow's Actions.
1533
+ * */
1534
+ 404: {
1535
+ headers: {
1536
+ [name: string]: unknown;
1537
+ };
1538
+ content?: never;
1539
+ };
1540
+ };
1541
+ };
1542
+ put?: never;
1543
+ post?: never;
1544
+ delete?: never;
1545
+ options?: never;
1546
+ head?: never;
1547
+ patch?: never;
1548
+ trace?: never;
1549
+ };
1550
+ "/flows/{flow_id}/actions": paths["/flows/{flow_id}/runs"];
1551
+ "/runs": {
1552
+ parameters: {
1553
+ query?: never;
1554
+ header?: never;
1555
+ path?: never;
1556
+ cookie?: never;
1557
+ };
1558
+ /**
1559
+ * List all Runs
1560
+ * @description Retrieve a listing of Actions/Runs launched across all Flows. If hitting
1561
+ * the *\/actions endpoint, the response will list the Runs under a
1562
+ * "actions" key. If hitting the *\/runs endpoint, the response will list
1563
+ * the Runs under a "runs" key.
1564
+ *
1565
+ */
1566
+ get: {
1567
+ parameters: {
1568
+ query?: {
1569
+ /** @description An opaque token used to iterate through pages of returned Actions.
1570
+ * If provided, all other query arguments will be ignored.
1571
+ * The marker encodes all state in a given query,
1572
+ * therefore it's unnecessary to provide query arguments
1573
+ * once an initial marker has been received.
1574
+ * */
1575
+ marker?: string;
1576
+ /**
1577
+ * @deprecated
1578
+ * @description ("marker" is now the preferred name for this parameter.)
1579
+ * An opaque token used to iterate through pages of returned Actions. If
1580
+ * provided, all other query arguments will be ignored. The
1581
+ * pagination_token encodes all state in a given query, therefore it's
1582
+ * unnecessary to provide query arguments once an initial token has been
1583
+ * received.
1584
+ *
1585
+ */
1586
+ pagination_token?: string;
1587
+ /**
1588
+ * @description The number of results to return in a single paged response.
1589
+ *
1590
+ * @example 50
1591
+ */
1592
+ per_page?: number;
1593
+ /**
1594
+ * @description The page of results to return.
1595
+ * @example 2
1596
+ */
1597
+ page?: number;
1598
+ /**
1599
+ * @description Return Runs for which the user has the supplied role. The role the
1600
+ * user has on the Action dictates the operations they can perform.
1601
+ * If multiple roles are specified, the user will have at least one of
1602
+ * the specified roles on each Action returned.
1603
+ *
1604
+ * @example run_owner,run_managers
1605
+ */
1606
+ filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
1607
+ /**
1608
+ * @deprecated
1609
+ * @description Return Runs for which the user has the provided
1610
+ * role. The role the user has on the Runs dictates the
1611
+ * operations they can perform. Roles are cumulative in the
1612
+ * sense that having, for example, the "run_manager" role also
1613
+ * implies having the "run_monitor" role. Thus, specifying
1614
+ * manager will also include all Runs for which the user
1615
+ * has "run_monitor" role as well. If not provided, only Runs
1616
+ * for which the caller has "run_owner" role will be returned.
1617
+ *
1618
+ * @example run_manager
1619
+ */
1620
+ filter_role?: "run_monitor" | "run_manager" | "run_owner";
1621
+ /**
1622
+ * @description Return Actions which are in the specified state. The state of the
1623
+ * Action dictates the operations which can performed on them. If
1624
+ * multiple statuses are specified, each Action returned will be in one
1625
+ * of the specified states. By default, Actions in any state will be
1626
+ * returned.
1627
+ *
1628
+ * @example FAILED,INACTIVE
1629
+ */
1630
+ filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
1631
+ /**
1632
+ * @description Performs a case insensitive string based search on the Actions'
1633
+ * label fields. If multiple values are specified, each Action returned
1634
+ * is guaranteed to contain at least one of the strings in its label.
1635
+ *
1636
+ * @example science,tests
1637
+ */
1638
+ filter_label?: string[];
1639
+ /**
1640
+ * @description Performs a case insensitive string based search to filter for
1641
+ * Actions which have parent Flow's with a matching title(s). If
1642
+ * multiple values are specified, each Action returned will have a
1643
+ * parent Flow with a title matching at least one of the strings.
1644
+ *
1645
+ * @example globus,tests
1646
+ */
1647
+ filter_flow_title?: string[];
1648
+ /**
1649
+ * @description Performs an equality based search to filter for Runs which were
1650
+ * initiated from the specified Flow ID(s). If multiple values are
1651
+ * specified, each Run returned will have been initiated from at least
1652
+ * one of the specified Flow IDs.
1653
+ *
1654
+ * @example 6086d817-19d9-4f5b-9329-22ed12d4d3dd,71a70751-19a5-4d19-998e-0709c40321e9
1655
+ */
1656
+ filter_flow_id?: string[];
1657
+ /**
1658
+ * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1659
+ * results to only those Actions whose completion time is within the
1660
+ * specified range. If one of the dates is omitted, it forms an open
1661
+ * range, so "dt," returns all records with date greater or equal to
1662
+ * dt, and ",dt" returns all records with dates less than dt. If there
1663
+ * is no comma, it is treated in the same way as "dt,". Results will
1664
+ * contain Actions which completed between the first date/time string
1665
+ * onwards, up to (but not including) the second date/time string.
1666
+ * Note that Actions which are still running will have null completion
1667
+ * times and thus cannot be filtered by this field.
1668
+ *
1669
+ * @example 2021-03-09T21:52:14,2021-03-09T21:53
1670
+ */
1671
+ filter_completion_time?: string;
1672
+ /**
1673
+ * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1674
+ * results to only those Actions which started running within the
1675
+ * specified range. If one of the dates is omitted, it forms an open
1676
+ * range, so "dt," returns all records with date greater or equal to
1677
+ * dt, and ",dt" returns all records with dates less than dt. If there
1678
+ * is no comma, it is treated in the same way as "dt,". Results will
1679
+ * contain Actions which began between the first date/time string
1680
+ * onwards, up to (but not including) the second date/time string.
1681
+ *
1682
+ * @example 2021-03-09T21:52:14,2021-03-09T21:53
1683
+ */
1684
+ filter_start_time?: string;
1685
+ /**
1686
+ * @description An ordering criteria to apply to the resulting Action listing. The
1687
+ * first value indicates the field to order on, and the second value
1688
+ * indicates the sorting order. The first ordering criteria will be
1689
+ * used to sort the data, subsequent ordering criteria will be applied
1690
+ * for ties.
1691
+ *
1692
+ * Fields that support ordering are:
1693
+ * - id
1694
+ * - start_time
1695
+ * - completion_time
1696
+ * - status
1697
+ * - label
1698
+ * - run_owner
1699
+ * - flow_title
1700
+ *
1701
+ * Supported orderings are:
1702
+ * - ASC
1703
+ * - DESC
1704
+ *
1705
+ * @default orderby=start_time DESC
1706
+ * @example start_time ASC,id DESC
1707
+ */
1708
+ orderby?: string[];
1709
+ };
1710
+ header?: never;
1711
+ path?: never;
1712
+ cookie?: never;
1713
+ };
1714
+ requestBody?: never;
1715
+ responses: {
1716
+ /** @description The request was successfully received. */
1717
+ 200: {
1718
+ headers: {
1719
+ [name: string]: unknown;
1720
+ };
1721
+ content: {
1722
+ "application/json": {
1723
+ /** @description An opaque pagination token for iterating through returned
1724
+ * Actions. If there are no more entries, this field will not
1725
+ * exist.
1726
+ * */
1727
+ marker?: string;
1728
+ has_next_page: boolean;
1729
+ actions?: components["schemas"]["FlowRun"][];
1730
+ runs?: components["schemas"]["FlowRun"][];
1731
+ };
1732
+ };
1733
+ };
1734
+ /** @description The requestor presented a token with insufficient scopes.
1735
+ * */
1736
+ 403: {
1737
+ headers: {
1738
+ [name: string]: unknown;
1739
+ };
1740
+ content?: never;
1741
+ };
1742
+ /** @description The Flow does not exist or the requestor did not have access to
1743
+ * enumerate the Actions.
1744
+ * */
1745
+ 404: {
1746
+ headers: {
1747
+ [name: string]: unknown;
1748
+ };
1749
+ content?: never;
1750
+ };
1751
+ };
1752
+ };
1753
+ put?: never;
1754
+ post?: never;
1755
+ delete?: never;
1756
+ options?: never;
1757
+ head?: never;
1758
+ patch?: never;
1759
+ trace?: never;
1760
+ };
1761
+ "/runs/{run_id}": {
1762
+ parameters: {
1763
+ query?: never;
1764
+ header?: never;
1765
+ path: {
1766
+ /** @description The ID for the Run. */
1767
+ run_id: string;
1768
+ };
1769
+ cookie?: never;
1770
+ };
1771
+ /**
1772
+ * Get details about a run
1773
+ * @description Get details about a run.
1774
+ *
1775
+ */
1776
+ get: {
1777
+ parameters: {
1778
+ query?: {
1779
+ /**
1780
+ * @description If present and set to a true value,
1781
+ * metadata about the associated flow will be included.
1782
+ *
1783
+ * @example true
1784
+ */
1785
+ include_flow_description?: true | true | false | false;
1786
+ };
1787
+ header?: never;
1788
+ path: {
1789
+ /** @description The ID for the Run. */
1790
+ run_id: string;
1791
+ };
1792
+ cookie?: never;
1793
+ };
1794
+ requestBody?: never;
1795
+ responses: {
1796
+ /** @description The request was successfully received. */
1797
+ 200: {
1798
+ headers: {
1799
+ [name: string]: unknown;
1800
+ };
1801
+ content: {
1802
+ "application/json": components["schemas"]["FlowRunWithFlowEmbed"];
1803
+ };
1804
+ };
1805
+ /** @description The requestor presented a token with insufficient scopes.
1806
+ * */
1807
+ 403: {
1808
+ headers: {
1809
+ [name: string]: unknown;
1810
+ };
1811
+ content?: never;
1812
+ };
1813
+ /** @description The Run does not exist or the requestor did not have access to
1814
+ * view the Run's status.
1815
+ * */
1816
+ 404: {
1817
+ headers: {
1818
+ [name: string]: unknown;
1819
+ };
1820
+ content?: never;
1821
+ };
1822
+ };
1823
+ };
1824
+ /**
1825
+ * Update a Run's metadata
1826
+ * @description Modify a Run's metadata.
1827
+ *
1828
+ * By default only the Run initiator is able to modify a Run's metadata.
1829
+ * Note that delegating manage access to a principal will allow them
1830
+ * to further alter the principals with monitor and manage access.
1831
+ *
1832
+ */
1833
+ put: {
1834
+ parameters: {
1835
+ query?: never;
1836
+ header?: never;
1837
+ path: {
1838
+ /** @description The ID for the Run. */
1839
+ run_id: string;
1840
+ };
1841
+ cookie?: never;
1842
+ };
1843
+ requestBody: {
1844
+ content: {
1845
+ "application/json": components["schemas"]["RunUpdate"];
1846
+ };
1847
+ };
1848
+ responses: {
1849
+ /** @description The request was successfully received. */
1850
+ 200: {
1851
+ headers: {
1852
+ [name: string]: unknown;
1853
+ };
1854
+ content: {
1855
+ "application/json": components["schemas"]["FlowRun"];
1856
+ };
1857
+ };
1858
+ /** @description The requestor presented a token with insufficient scopes.
1859
+ * */
1860
+ 403: {
1861
+ headers: {
1862
+ [name: string]: unknown;
1863
+ };
1864
+ content?: never;
1865
+ };
1866
+ /** @description The Run does not exist or the requestor did not have access to
1867
+ * modify the Run.
1868
+ * */
1869
+ 404: {
1870
+ headers: {
1871
+ [name: string]: unknown;
1872
+ };
1873
+ content?: never;
1874
+ };
1875
+ /** @description The request's JSON body did not pass schema validation.
1876
+ * */
1877
+ 422: {
1878
+ headers: {
1879
+ [name: string]: unknown;
1880
+ };
1881
+ content?: never;
1882
+ };
1883
+ /** @description An upstream service has imposed rate limiting.
1884
+ * The requestor may resubmit the API request.
1885
+ * */
1886
+ 429: {
1887
+ headers: {
1888
+ [name: string]: unknown;
1889
+ };
1890
+ content?: never;
1891
+ };
1892
+ /** @description An unknown upstream service error occurred.
1893
+ * The problem may be resolved by re-submitting the API request.
1894
+ * */
1895
+ 502: {
1896
+ headers: {
1897
+ [name: string]: unknown;
1898
+ };
1899
+ content?: never;
1900
+ };
1901
+ };
1902
+ };
1903
+ post?: never;
1904
+ delete?: never;
1905
+ options?: never;
1906
+ head?: never;
1907
+ patch?: never;
1908
+ trace?: never;
1909
+ };
1910
+ "/runs/{run_id}/definition": {
1911
+ parameters: {
1912
+ query?: never;
1913
+ header?: never;
1914
+ path: {
1915
+ /** @description The UUID of the Run. */
1916
+ run_id: string;
1917
+ };
1918
+ cookie?: never;
1919
+ };
1920
+ /**
1921
+ * Get the Flow definition and input schema that were used to start a Run
1922
+ * @description Flow definitions and input schemas may be updated after a Run has been started.
1923
+ *
1924
+ * This route allows users to view the Flow definition and input schema
1925
+ * that were used to start a given Run.
1926
+ *
1927
+ */
1928
+ get: {
1929
+ parameters: {
1930
+ query?: never;
1931
+ header?: never;
1932
+ path: {
1933
+ /** @description The UUID of the Run. */
1934
+ run_id: string;
1935
+ };
1936
+ cookie?: never;
1937
+ };
1938
+ requestBody?: never;
1939
+ responses: {
1940
+ /** @description The request was successfully received. */
1941
+ 200: {
1942
+ headers: {
1943
+ [name: string]: unknown;
1944
+ };
1945
+ content: {
1946
+ "application/json": components["schemas"]["GetRunDefinitionResponse"];
1947
+ };
1948
+ };
1949
+ /** @description The requestor presented a token with insufficient scopes.
1950
+ * */
1951
+ 403: {
1952
+ headers: {
1953
+ [name: string]: unknown;
1954
+ };
1955
+ content?: never;
1956
+ };
1957
+ /** @description The Run does not exist or the requestor did not have access to view the Run.
1958
+ * */
1959
+ 404: {
1960
+ headers: {
1961
+ [name: string]: unknown;
1962
+ };
1963
+ content?: never;
1964
+ };
1965
+ };
1966
+ };
1967
+ put?: never;
1968
+ post?: never;
1969
+ delete?: never;
1970
+ options?: never;
1971
+ head?: never;
1972
+ patch?: never;
1973
+ trace?: never;
1974
+ };
1975
+ "/batch/runs": {
1976
+ parameters: {
1977
+ query?: never;
1978
+ header?: never;
1979
+ path?: never;
1980
+ cookie?: never;
1981
+ };
1982
+ get?: never;
1983
+ put?: never;
1984
+ /** Update metadata for multiple Runs. */
1985
+ post: {
1986
+ parameters: {
1987
+ query?: never;
1988
+ header?: never;
1989
+ path?: never;
1990
+ cookie?: never;
1991
+ };
1992
+ requestBody: {
1993
+ content: {
1994
+ "application/json": {
1995
+ filters: {
1996
+ run_ids: string[];
1997
+ };
1998
+ set?: components["schemas"]["BatchRunUpdateSetOperation"];
1999
+ add?: components["schemas"]["BatchRunUpdateOperation"];
2000
+ remove?: components["schemas"]["BatchRunUpdateOperation"];
2001
+ };
2002
+ };
2003
+ };
2004
+ responses: never;
2005
+ };
2006
+ delete?: never;
2007
+ options?: never;
2008
+ head?: never;
2009
+ patch?: never;
2010
+ trace?: never;
2011
+ };
2012
+ }
2013
+ export type webhooks = Record<string, never>;
2014
+ export interface components {
2015
+ schemas: {
2016
+ FlowDefinition: {
2017
+ Comment?: string;
2018
+ StartAt: string;
2019
+ States: {
2020
+ [key: string]: components["schemas"]["Pass"] | components["schemas"]["Action"] | components["schemas"]["Wait"] | components["schemas"]["Choice"] | components["schemas"]["ExpressionEval"] | components["schemas"]["Fail"];
2021
+ };
2022
+ };
2023
+ FlowRun: {
2024
+ /** @description The ID for a particular Flow invocation. Analogous to a run_id.
2025
+ * */
2026
+ action_id: string;
2027
+ /** @description The ID for a particular Flow invocation. Analogous to an action_id.
2028
+ * */
2029
+ run_id: string;
2030
+ /** @description The Flow to which this Run belongs.
2031
+ * */
2032
+ flow_id: string;
2033
+ /**
2034
+ * Format: date-time
2035
+ * @description A timezone-aware ISO8601 format string that represents the time at
2036
+ * which the last update to this Run's Flow occurred.
2037
+ *
2038
+ */
2039
+ flow_last_updated: string;
2040
+ /**
2041
+ * Format: date-time
2042
+ * @description A timezone-aware ISO8601 format string that represents the time at
2043
+ * which this Run started.
2044
+ *
2045
+ */
2046
+ start_time: string;
2047
+ /**
2048
+ * Format: date-time
2049
+ * @description A timezone-aware ISO8601 format string that represents the time at
2050
+ * which this Run reached a completed status.
2051
+ *
2052
+ */
2053
+ completion_time: string;
2054
+ label: components["schemas"]["Label"];
2055
+ /**
2056
+ * @description The current state of the Run.
2057
+ * @enum {string}
2058
+ */
2059
+ status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
2060
+ display_status?: string;
2061
+ details: Record<string, never>;
2062
+ run_owner: components["schemas"]["PrincipalURN"];
2063
+ run_monitors?: components["schemas"]["RunMonitors"];
2064
+ run_managers?: components["schemas"]["RunManagers"];
2065
+ /**
2066
+ * @description The role the requesting user has on the Run.
2067
+ *
2068
+ * @enum {string}
2069
+ */
2070
+ user_role: "run_monitor" | "run_manager" | "run_owner";
2071
+ tags: components["schemas"]["Tags"];
2072
+ };
2073
+ ValidateRun: {
2074
+ /**
2075
+ * @description A message indicating the validation was successful
2076
+ *
2077
+ * @example success
2078
+ */
2079
+ message: string;
2080
+ };
2081
+ GetRunDefinitionResponse: {
2082
+ /** @description The Flow used to start the Run.
2083
+ * */
2084
+ flow_id: string;
2085
+ /** @description The definition of the Flow at the time the Run was started.
2086
+ * */
2087
+ definition: Record<string, never>;
2088
+ /** @description The input schema of the Flow at the time the Run was started.
2089
+ * */
2090
+ input_schema: Record<string, never>;
2091
+ };
2092
+ FlowEmbed: {
2093
+ /** @description The unique identifier for the Flow. */
2094
+ id: string;
2095
+ /** @description The user with primary responsibility for the Flow. */
2096
+ flow_owner?: components["schemas"]["PrincipalURN"];
2097
+ /**
2098
+ * Format: date-time
2099
+ * @description A timezone-aware ISO8601 format string that represents the time at
2100
+ * which the Flow was created.
2101
+ *
2102
+ */
2103
+ created_at: string;
2104
+ /**
2105
+ * Format: date-time
2106
+ * @description A timezone-aware ISO8601 format string that represents the time at
2107
+ * which the Flow was last updated.
2108
+ *
2109
+ */
2110
+ updated_at?: string;
2111
+ /**
2112
+ * Format: date-time
2113
+ * @description A timezone-aware ISO8601 format string that represents the time at
2114
+ * which the Flow was deleted (not present if the Flow has not been deleted).
2115
+ *
2116
+ */
2117
+ deleted_at?: string;
2118
+ /** @description A non-unique, human-friendly name used for displaying the Flow to end users.
2119
+ * */
2120
+ title: string;
2121
+ /** @description A concise summary of the Flow's purpose. */
2122
+ subtitle?: string;
2123
+ /** @description A detailed description of the Flow for end user display. */
2124
+ description?: string;
2125
+ /** @description A set of terms used to categorize the Flow which may be used in
2126
+ * query and discovery operations.
2127
+ * */
2128
+ keywords?: string[];
2129
+ };
2130
+ FlowRunWithFlowEmbed: components["schemas"]["FlowRun"] & {
2131
+ flow_description?: components["schemas"]["FlowEmbed"];
2132
+ };
2133
+ RunUpdate: {
2134
+ label?: components["schemas"]["Label"];
2135
+ run_monitors?: components["schemas"]["RunMonitors"];
2136
+ run_managers?: components["schemas"]["RunManagers"];
2137
+ tags?: components["schemas"]["Tags"];
2138
+ };
2139
+ /**
2140
+ * Activity notification policy
2141
+ * @description The email notification policy for the run.
2142
+ */
2143
+ ActivityNotificationPolicy: {
2144
+ /**
2145
+ * @description The set of statuses on which to notify the run's owner by email.
2146
+ *
2147
+ * @default [
2148
+ * "INACTIVE"
2149
+ * ]
2150
+ */
2151
+ status: ("INACTIVE" | "FAILED" | "SUCCEEDED")[];
2152
+ };
2153
+ /**
2154
+ * Input body
2155
+ * @description The input body that will be passed into the flow when it starts.
2156
+ * If the flow defines an input schema, the input body will be validated against the input schema.
2157
+ * If there is no input schema, no validation will be performed.
2158
+ */
2159
+ InputBody: {
2160
+ [key: string]: unknown;
2161
+ };
2162
+ /**
2163
+ * Label
2164
+ * @description A short, human-readable description of the run.
2165
+ * @example Generate a report for experiment xDA202-batch-3
2166
+ */
2167
+ Label: string;
2168
+ /**
2169
+ * Run managers
2170
+ * @description A list of Globus Auth identity and group URNs that may manage runs of the flow.
2171
+ *
2172
+ * "Managing" operations include updating, canceling, and deleting the run.
2173
+ *
2174
+ * Only users with the "run_manager" role will be able to view this list.
2175
+ * Users with only the "run_monitor" role will see an empty list.
2176
+ *
2177
+ */
2178
+ RunManagers: components["schemas"]["PrincipalURN"][];
2179
+ /**
2180
+ * Run monitors
2181
+ * @description A list of Globus Auth identity and group URNs that may monitor runs of the flow.
2182
+ *
2183
+ * "Monitoring" operations include checking the run status and its logs.
2184
+ *
2185
+ * Only users with the "run_manager" role will be able to view this list.
2186
+ * Users with only the "run_monitor" role will see an empty list.
2187
+ *
2188
+ */
2189
+ RunMonitors: components["schemas"]["PrincipalURN"][];
2190
+ /**
2191
+ * Tags
2192
+ * @description A list of tags to associate with the run.
2193
+ *
2194
+ * Tags are normalized by stripping leading and trailing whitespace,
2195
+ * and by replacing all whitespace with a single space.
2196
+ *
2197
+ * When updating a run, existing tags will be overwritten.
2198
+ * This means that an empty array will delete all existing tags.
2199
+ *
2200
+ * @example [
2201
+ * "Experiment:xDA202",
2202
+ * "Site:Nautilus",
2203
+ * "Friday COB Report"
2204
+ * ]
2205
+ */
2206
+ Tags: string[];
2207
+ /**
2208
+ * @description A URN representation of an Identity in Globus either of a user from
2209
+ * Globus Auth or a group from Globus Groups.
2210
+ *
2211
+ * @example urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
2212
+ */
2213
+ PrincipalURN: string;
2214
+ JsonPathPattern: string;
2215
+ NextOrEnd: {
2216
+ Next?: string;
2217
+ End?: boolean;
2218
+ } & (unknown | unknown);
2219
+ Parameters: {
2220
+ Parameters?: components["schemas"]["JsonPathPattern"];
2221
+ };
2222
+ InputPath: {
2223
+ InputPath?: components["schemas"]["JsonPathPattern"];
2224
+ };
2225
+ ResultPath: {
2226
+ ResultPath?: components["schemas"]["JsonPathPattern"];
2227
+ };
2228
+ ParametersOrInputPathNotRequired: components["schemas"]["Parameters"] & components["schemas"]["InputPath"];
2229
+ ParametersOrInputPath: (components["schemas"]["Parameters"] & components["schemas"]["InputPath"]) & (unknown | unknown);
2230
+ Pass: {
2231
+ Type?: string;
2232
+ Comment?: unknown;
2233
+ Next?: unknown;
2234
+ End?: unknown;
2235
+ InputPath?: unknown;
2236
+ Parameters?: unknown;
2237
+ ResultPath?: unknown;
2238
+ } & components["schemas"]["NextOrEnd"] & components["schemas"]["ParametersOrInputPathNotRequired"] & components["schemas"]["ResultPath"];
2239
+ Catch: {
2240
+ Catch?: ({
2241
+ ErrorEquals: string[];
2242
+ Next: string;
2243
+ ResultPath?: unknown;
2244
+ } & components["schemas"]["ResultPath"])[];
2245
+ };
2246
+ Action: {
2247
+ /** Format: uri */
2248
+ ActionUrl: string;
2249
+ /** Format: uri */
2250
+ ActionScope?: string;
2251
+ RunAs?: string;
2252
+ /** @default false */
2253
+ ExceptionOnActionFailure: boolean;
2254
+ WaitTime?: number;
2255
+ Type: string;
2256
+ Comment?: unknown;
2257
+ Next?: unknown;
2258
+ End?: unknown;
2259
+ InputPath?: unknown;
2260
+ Parameters?: unknown;
2261
+ ResultPath?: unknown;
2262
+ Catch?: unknown;
2263
+ } & components["schemas"]["NextOrEnd"] & components["schemas"]["ParametersOrInputPath"] & components["schemas"]["ResultPath"] & components["schemas"]["Catch"];
2264
+ ExpressionEval: {
2265
+ Type?: string;
2266
+ Comment?: unknown;
2267
+ Parameters: unknown;
2268
+ ResultPath: unknown;
2269
+ Next: string;
2270
+ } & components["schemas"]["Parameters"] & components["schemas"]["ResultPath"];
2271
+ Wait: {
2272
+ Type?: string;
2273
+ Comment?: unknown;
2274
+ Next?: string;
2275
+ Seconds?: number;
2276
+ SecondsPath?: components["schemas"]["JsonPathPattern"];
2277
+ /** Format: date-time */
2278
+ Timestamp?: string;
2279
+ TimestampPath?: components["schemas"]["JsonPathPattern"];
2280
+ } & (unknown | unknown | unknown | unknown);
2281
+ ChoiceRule: {
2282
+ And?: components["schemas"]["ChoiceRule"][];
2283
+ Or?: components["schemas"]["ChoiceRule"][];
2284
+ Not?: components["schemas"]["ChoiceRule"];
2285
+ Variable?: string;
2286
+ StringEquals?: string;
2287
+ StringEqualsPath?: components["schemas"]["JsonPathPattern"];
2288
+ StringLessThan?: string;
2289
+ StringLessThanPath?: components["schemas"]["JsonPathPattern"];
2290
+ StringGreaterThan?: string;
2291
+ StringGreaterThanPath?: components["schemas"]["JsonPathPattern"];
2292
+ StringLessThanEquals?: string;
2293
+ StringLessThanEqualsPath?: components["schemas"]["JsonPathPattern"];
2294
+ StringGreaterThanEquals?: string;
2295
+ StringGreaterThanEqualsPath?: components["schemas"]["JsonPathPattern"];
2296
+ StringMatches?: string;
2297
+ NumericEquals?: number;
2298
+ NumericEqualsPath?: components["schemas"]["JsonPathPattern"];
2299
+ NumericLessThan?: number;
2300
+ NumericLessThanPath?: components["schemas"]["JsonPathPattern"];
2301
+ NumericGreaterThan?: number;
2302
+ NumericGreaterThanPath?: components["schemas"]["JsonPathPattern"];
2303
+ NumericLessThanEquals?: number;
2304
+ NumericLessThanEqualsPath?: components["schemas"]["JsonPathPattern"];
2305
+ NumericGreaterThanEquals?: number;
2306
+ NumericGreaterThanEqualsPath?: components["schemas"]["JsonPathPattern"];
2307
+ BooleanEquals?: boolean;
2308
+ BooleanEqualsPath?: components["schemas"]["JsonPathPattern"];
2309
+ /** Format: date-time */
2310
+ TimestampEquals?: string;
2311
+ TimestampEqualsPath?: components["schemas"]["JsonPathPattern"];
2312
+ /** Format: date-time */
2313
+ TimestampLessThan?: string;
2314
+ TimestampLessThanPath?: components["schemas"]["JsonPathPattern"];
2315
+ /** Format: date-time */
2316
+ TimestampGreaterThan?: string;
2317
+ TimestampGreaterThanPath?: components["schemas"]["JsonPathPattern"];
2318
+ /** Format: date-time */
2319
+ TimestampLessThanEquals?: string;
2320
+ TimestampLessThanEqualsPath?: components["schemas"]["JsonPathPattern"];
2321
+ /** Format: date-time */
2322
+ TimestampGreaterThanEquals?: string;
2323
+ TimestampGreaterThanEqualsPath?: components["schemas"]["JsonPathPattern"];
2324
+ IsNull?: boolean;
2325
+ IsPresent?: boolean;
2326
+ IsNumeric?: boolean;
2327
+ IsString?: boolean;
2328
+ IsBoolean?: boolean;
2329
+ IsTimestamp?: boolean;
2330
+ } & (unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown);
2331
+ Choice: {
2332
+ Type?: string;
2333
+ Comment?: string;
2334
+ Default?: string;
2335
+ Choices: ({
2336
+ Next?: string;
2337
+ } & components["schemas"]["ChoiceRule"])[];
2338
+ };
2339
+ Fail: {
2340
+ Type?: string;
2341
+ Comment?: string;
2342
+ Cause?: string;
2343
+ Error?: string;
2344
+ };
2345
+ FlowResponse: {
2346
+ /** @description The unique identifier for the Flow. */
2347
+ id?: string;
2348
+ /** @description The Flow to deploy. */
2349
+ definition?: components["schemas"]["FlowDefinition"];
2350
+ /** @description A JSON Schema compliant definition of the format of the `body` field
2351
+ * when requesting a Flow be run.
2352
+ * */
2353
+ input_schema?: Record<string, never>;
2354
+ /**
2355
+ * Format: uri
2356
+ * @description The scope of any bearer token to be used on authenticated accesses
2357
+ * to the Flow.
2358
+ *
2359
+ */
2360
+ globus_auth_scope?: string;
2361
+ /** @description A list of scopes according to RunAs values as defined in the Flow.
2362
+ * */
2363
+ globus_auth_scopes_by_RunAs?: string[];
2364
+ /**
2365
+ * @description The role the requesting user has on the Flow.
2366
+ *
2367
+ * @enum {string}
2368
+ */
2369
+ user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner";
2370
+ /**
2371
+ * @description A set of Principal URN values, or the value "public"
2372
+ * indicating the identity of users who can view the Flow
2373
+ * definition. Only calling users with the "administrator"
2374
+ * role will be provided this list. Otherwise, the value
2375
+ * will always be an empty list.
2376
+ *
2377
+ * @example [
2378
+ * "public",
2379
+ * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
2380
+ * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
2381
+ * ]
2382
+ */
2383
+ flow_viewers?: components["schemas"]["PrincipalURN_or_public"][];
2384
+ /**
2385
+ * @description A set of Principal URN values, or the value
2386
+ * "all_authenticated_users" indicating the identity of users
2387
+ * who can initiate a run of the Flow. Only calling users
2388
+ * with the "administrator" role will be provided this
2389
+ * list. Otherwise, the value will always be an empty list.
2390
+ *
2391
+ * @example [
2392
+ * "all_authenticated_users",
2393
+ * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
2394
+ * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
2395
+ * ]
2396
+ */
2397
+ flow_starters?: components["schemas"]["PrincipalURN_or_all_authenticated_users"][];
2398
+ /** @description The set of Principal URN values of users who may perform
2399
+ * administrative operations, including updating the
2400
+ * description itself. Only calling users with the
2401
+ * "administrator" role will be provided this
2402
+ * list. Otherwise, the value will always be an empty list.
2403
+ * */
2404
+ flow_administrators?: components["schemas"]["PrincipalURN"][];
2405
+ /** @description The user with primary responsibility for the Flow. */
2406
+ flow_owner?: components["schemas"]["PrincipalURN"];
2407
+ /**
2408
+ * Format: date-time
2409
+ * @description A timezone-aware ISO8601 format string that represents the time at
2410
+ * which the Flow was created.
2411
+ *
2412
+ */
2413
+ created_at?: string;
2414
+ /**
2415
+ * Format: date-time
2416
+ * @description A timezone-aware ISO8601 format string that represents the time at
2417
+ * which the Flow was last updated.
2418
+ *
2419
+ */
2420
+ updated_at?: string;
2421
+ synchronous?: boolean;
2422
+ /** @description True if the Flow supports the /log operation providing detailed
2423
+ * information on the intermediate states of a Flow invocation.
2424
+ * */
2425
+ log_supported?: boolean;
2426
+ types?: ("Action" | "Event")[];
2427
+ /** @enum {string} */
2428
+ api_version?: "1.0";
2429
+ /** @description A non-unique, human-friendly name used for displaying the Flow
2430
+ * to end users.
2431
+ * */
2432
+ title?: string;
2433
+ /** @description A concise summary of the Flow's purpose. */
2434
+ subtitle?: string;
2435
+ /** @description A detailed description of the Flow for end user display. */
2436
+ description?: string;
2437
+ /** @description A set of terms used to categorize the Flow which may be used in
2438
+ * query and discovery operations.
2439
+ * */
2440
+ keywords?: string[];
2441
+ /** @description The Flow's identity in Globus Auth. */
2442
+ principal_urn?: components["schemas"]["PrincipalURN"];
2443
+ /** @description The Flow's Globus Auth username. */
2444
+ globus_auth_username?: string;
2445
+ /**
2446
+ * Format: uri
2447
+ * @description The web-addressable location at which this Flow can be referenced
2448
+ * and run from.
2449
+ *
2450
+ */
2451
+ flow_url?: string;
2452
+ /**
2453
+ * Format: uuid
2454
+ * @description A subscription_id associated with this Flow. If no
2455
+ * subscription_id is present, the Flow may be
2456
+ * accepted, but may have limits on how long or how
2457
+ * much it can be used.
2458
+ *
2459
+ */
2460
+ subscription_id?: string;
2461
+ };
2462
+ FlowValidationResponse: {
2463
+ /** @description A mapping of RunAs values to the scopes required to run the flow
2464
+ * as that identity.
2465
+ * */
2466
+ scopes?: components["schemas"]["FlowScopes"];
2467
+ };
2468
+ FlowValidationErrorResponse: {
2469
+ /** @description A unique identifier for the validation error, used for debugging.
2470
+ * */
2471
+ debug_id: string;
2472
+ error: {
2473
+ /** @description A readable keyword describing the failure. */
2474
+ code: string;
2475
+ /** An array of failure objects, describing what failed. */
2476
+ detail: string | components["schemas"]["LocationErrorList"];
2477
+ /** @description A human-readable message providing more context about the failure. */
2478
+ message?: string;
2479
+ };
2480
+ };
2481
+ LocationErrorList: {
2482
+ /** The path of object keys that led to the validation failure. */
2483
+ loc: string[];
2484
+ /** A readable description of the validation failure. */
2485
+ msg: string;
2486
+ /** A readable failure category. */
2487
+ type: string;
2488
+ }[];
2489
+ FlowScopes: {
2490
+ [key: string]: string[];
2491
+ };
2492
+ BatchRunUpdateOperation: {
2493
+ tags?: string[];
2494
+ run_managers?: components["schemas"]["PrincipalURN"][];
2495
+ run_monitors?: components["schemas"]["PrincipalURN"][];
2496
+ };
2497
+ BatchRunUpdateSetOperation: {
2498
+ tags?: string[];
2499
+ run_managers?: components["schemas"]["PrincipalURN"][];
2500
+ run_monitors?: components["schemas"]["PrincipalURN"][];
2501
+ /** @enum {string} */
2502
+ status?: "cancel";
2503
+ };
2504
+ /** @description The requested operation was accepted.
2505
+ *
2506
+ * The operation may have been completed, or may be completed at a later time.
2507
+ * A follow-up API request may be needed to confirm the status of the operation.
2508
+ * */
2509
+ HTTP202Response: unknown;
2510
+ /** @description The requesting user is not authorized to make the requested changes. */
2511
+ HTTP403Response: unknown;
2512
+ /** @description The input document failed input validation in some way. */
2513
+ HTTP422Response: unknown;
2514
+ /**
2515
+ * @description A URN representation of an Identity in Globus either of a user from
2516
+ * Globus Auth or a group from Globus Groups or the special value
2517
+ * "public".
2518
+ *
2519
+ * @example urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035
2520
+ */
2521
+ PrincipalURN_or_public: string;
2522
+ /**
2523
+ * @description A URN representation of an Identity in Globus either of a user from
2524
+ * Globus Auth or a group from Globus Groups or the special value
2525
+ * "all_authenticated_users" indicating any user who presents valid
2526
+ * credentials (bearer token).
2527
+ *
2528
+ * @example all_authenticated_users
2529
+ */
2530
+ PrincipalURN_or_all_authenticated_users: string;
2531
+ };
2532
+ responses: never;
2533
+ parameters: never;
2534
+ requestBodies: never;
2535
+ headers: never;
2536
+ pathItems: never;
2537
+ }
2538
+ export type $defs = Record<string, never>;
2539
+ export type operations = Record<string, never>;
2540
+ //# sourceMappingURL=flows.d.ts.map