@globus/sdk 6.3.1 → 6.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -4
- package/dist/cjs/core/authorization/index.js +1 -1
- package/dist/cjs/core/authorization/index.js.map +1 -1
- package/dist/cjs/core/info/index.js +1 -1
- package/dist/cjs/core/info/index.js.map +1 -1
- package/dist/cjs/index.js +143 -59
- package/dist/cjs/index.js.map +4 -4
- package/dist/cjs/services/globus-connect-server/client.js +1 -1
- package/dist/cjs/services/globus-connect-server/client.js.map +1 -1
- package/dist/esm/core/info/version.d.ts +1 -1
- package/dist/esm/core/info/version.js +1 -1
- package/dist/esm/open-api/types/compute.d.ts +372 -394
- package/dist/esm/open-api/types/compute.d.ts.map +1 -1
- package/dist/esm/open-api/types/flows.d.ts +1009 -194
- package/dist/esm/open-api/types/flows.d.ts.map +1 -1
- package/dist/esm/open-api/types/search.d.ts +157 -10
- package/dist/esm/open-api/types/search.d.ts.map +1 -1
- package/dist/esm/open-api/types/transfer.d.ts +8 -6
- package/dist/esm/open-api/types/transfer.d.ts.map +1 -1
- package/dist/esm/package.json +1 -1
- package/dist/esm/services/compute/service/endpoints.d.ts +19 -15
- package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
- package/dist/esm/services/flows/config.d.ts +2 -0
- package/dist/esm/services/flows/config.d.ts.map +1 -1
- package/dist/esm/services/flows/config.js +2 -0
- package/dist/esm/services/flows/config.js.map +1 -1
- package/dist/esm/services/flows/index.d.ts +1 -0
- package/dist/esm/services/flows/index.d.ts.map +1 -1
- package/dist/esm/services/flows/index.js +1 -0
- package/dist/esm/services/flows/index.js.map +1 -1
- package/dist/esm/services/flows/service/flows.d.ts +1 -0
- package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
- package/dist/esm/services/flows/service/runs.d.ts +4 -0
- package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
- package/dist/esm/services/flows/service/web-inputs.d.ts +63 -0
- package/dist/esm/services/flows/service/web-inputs.d.ts.map +1 -0
- package/dist/esm/services/flows/service/web-inputs.js +54 -0
- package/dist/esm/services/flows/service/web-inputs.js.map +1 -0
- package/dist/esm/services/search/service/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/index.d.ts +1 -0
- package/dist/esm/services/transfer/index.d.ts.map +1 -1
- package/dist/esm/services/transfer/index.js.map +1 -1
- package/dist/esm/services/transfer/service/stream-access-point.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/tunnel.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/tunnel.js +26 -6
- package/dist/esm/services/transfer/service/tunnel.js.map +1 -1
- package/dist/esm/services/transfer/service/v2/bookmarks.d.ts.map +1 -1
- package/dist/umd/globus.production.js +2 -2
- package/dist/umd/globus.production.js.map +4 -4
- package/package.json +2 -2
|
@@ -7,7 +7,7 @@ export interface paths {
|
|
|
7
7
|
cookie?: never;
|
|
8
8
|
};
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* List Flows
|
|
11
11
|
* @description Query the Flows service for a listing of Flows available to a user
|
|
12
12
|
* according to the permissions (role) they have on the Flow.
|
|
13
13
|
*/
|
|
@@ -179,8 +179,8 @@ export interface paths {
|
|
|
179
179
|
};
|
|
180
180
|
put?: never;
|
|
181
181
|
/**
|
|
182
|
-
*
|
|
183
|
-
* @description
|
|
182
|
+
* Create a Flow
|
|
183
|
+
* @description Create a Flow and its schema.
|
|
184
184
|
*/
|
|
185
185
|
post: {
|
|
186
186
|
parameters: {
|
|
@@ -256,10 +256,7 @@ export interface paths {
|
|
|
256
256
|
};
|
|
257
257
|
};
|
|
258
258
|
responses: {
|
|
259
|
-
/**
|
|
260
|
-
* @description The Flow definition was successfully deployed onto the Flows
|
|
261
|
-
* service.
|
|
262
|
-
*/
|
|
259
|
+
/** @description The Flow was successfully created. */
|
|
263
260
|
201: {
|
|
264
261
|
headers: {
|
|
265
262
|
[name: string]: unknown;
|
|
@@ -268,14 +265,14 @@ export interface paths {
|
|
|
268
265
|
"application/json": components["schemas"]["FlowResponse"];
|
|
269
266
|
};
|
|
270
267
|
};
|
|
271
|
-
/** @description The requestor attempted to
|
|
268
|
+
/** @description The requestor attempted to create a malformed Flow. */
|
|
272
269
|
400: {
|
|
273
270
|
headers: {
|
|
274
271
|
[name: string]: unknown;
|
|
275
272
|
};
|
|
276
273
|
content?: never;
|
|
277
274
|
};
|
|
278
|
-
/** @description The requestor is not authorized to
|
|
275
|
+
/** @description The requestor is not authorized to create a Flow. */
|
|
279
276
|
403: {
|
|
280
277
|
headers: {
|
|
281
278
|
[name: string]: unknown;
|
|
@@ -300,7 +297,7 @@ export interface paths {
|
|
|
300
297
|
get?: never;
|
|
301
298
|
put?: never;
|
|
302
299
|
/**
|
|
303
|
-
* Validate a
|
|
300
|
+
* Validate a Flow
|
|
304
301
|
* @description Validate a flow definition and its schema.
|
|
305
302
|
*/
|
|
306
303
|
post: {
|
|
@@ -378,8 +375,8 @@ export interface paths {
|
|
|
378
375
|
cookie?: never;
|
|
379
376
|
};
|
|
380
377
|
/**
|
|
381
|
-
*
|
|
382
|
-
* @description Get
|
|
378
|
+
* Get a Flow by ID
|
|
379
|
+
* @description Get an existing Flow.
|
|
383
380
|
*/
|
|
384
381
|
get: {
|
|
385
382
|
parameters: {
|
|
@@ -429,7 +426,7 @@ export interface paths {
|
|
|
429
426
|
};
|
|
430
427
|
/**
|
|
431
428
|
* Update a Flow
|
|
432
|
-
* @description Update
|
|
429
|
+
* @description Update an existing Flow.
|
|
433
430
|
*/
|
|
434
431
|
put: {
|
|
435
432
|
parameters: {
|
|
@@ -505,10 +502,7 @@ export interface paths {
|
|
|
505
502
|
};
|
|
506
503
|
};
|
|
507
504
|
responses: {
|
|
508
|
-
/**
|
|
509
|
-
* @description The requestor has successfully authenticated and updated the target
|
|
510
|
-
* Flow definition.
|
|
511
|
-
*/
|
|
505
|
+
/** @description The Flow was successfully updated. */
|
|
512
506
|
200: {
|
|
513
507
|
headers: {
|
|
514
508
|
[name: string]: unknown;
|
|
@@ -517,31 +511,22 @@ export interface paths {
|
|
|
517
511
|
"application/json": components["schemas"]["FlowResponse"];
|
|
518
512
|
};
|
|
519
513
|
};
|
|
520
|
-
/**
|
|
521
|
-
|
|
522
|
-
* malformed update.
|
|
523
|
-
*/
|
|
524
|
-
400: {
|
|
514
|
+
/** @description The requestor does not have access to update the Flow. */
|
|
515
|
+
403: {
|
|
525
516
|
headers: {
|
|
526
517
|
[name: string]: unknown;
|
|
527
518
|
};
|
|
528
519
|
content?: never;
|
|
529
520
|
};
|
|
530
|
-
/**
|
|
531
|
-
|
|
532
|
-
* access.
|
|
533
|
-
*/
|
|
534
|
-
403: {
|
|
521
|
+
/** @description The specified Flow does not exist. */
|
|
522
|
+
404: {
|
|
535
523
|
headers: {
|
|
536
524
|
[name: string]: unknown;
|
|
537
525
|
};
|
|
538
526
|
content?: never;
|
|
539
527
|
};
|
|
540
|
-
/**
|
|
541
|
-
|
|
542
|
-
* requestor did not have permissions to update a Flow.
|
|
543
|
-
*/
|
|
544
|
-
404: {
|
|
528
|
+
/** @description The Flow update failed due to a malformed request. */
|
|
529
|
+
422: {
|
|
545
530
|
headers: {
|
|
546
531
|
[name: string]: unknown;
|
|
547
532
|
};
|
|
@@ -551,8 +536,8 @@ export interface paths {
|
|
|
551
536
|
};
|
|
552
537
|
post?: never;
|
|
553
538
|
/**
|
|
554
|
-
*
|
|
555
|
-
* @description
|
|
539
|
+
* Delete a Flow
|
|
540
|
+
* @description Delete an existing Flow.
|
|
556
541
|
*/
|
|
557
542
|
delete: {
|
|
558
543
|
parameters: {
|
|
@@ -566,10 +551,7 @@ export interface paths {
|
|
|
566
551
|
};
|
|
567
552
|
requestBody?: never;
|
|
568
553
|
responses: {
|
|
569
|
-
/**
|
|
570
|
-
* @description The requestor has successfully removed the Flow from the Flows
|
|
571
|
-
* service.
|
|
572
|
-
*/
|
|
554
|
+
/** @description The Flow was successfully deleted. */
|
|
573
555
|
200: {
|
|
574
556
|
headers: {
|
|
575
557
|
[name: string]: unknown;
|
|
@@ -578,10 +560,7 @@ export interface paths {
|
|
|
578
560
|
"application/json": components["schemas"]["FlowResponse"];
|
|
579
561
|
};
|
|
580
562
|
};
|
|
581
|
-
/**
|
|
582
|
-
* @description The requestor attempted to modify a Flow for which they did not have
|
|
583
|
-
* access.
|
|
584
|
-
*/
|
|
563
|
+
/** @description The requestor does not have access to delete the Flow. */
|
|
585
564
|
403: {
|
|
586
565
|
headers: {
|
|
587
566
|
[name: string]: unknown;
|
|
@@ -589,8 +568,8 @@ export interface paths {
|
|
|
589
568
|
content?: never;
|
|
590
569
|
};
|
|
591
570
|
/**
|
|
592
|
-
* @description The
|
|
593
|
-
* requestor
|
|
571
|
+
* @description The specified Flow does not exist,
|
|
572
|
+
* or the requestor does not have permissions to delete the Flow.
|
|
594
573
|
*/
|
|
595
574
|
404: {
|
|
596
575
|
headers: {
|
|
@@ -644,7 +623,7 @@ export interface paths {
|
|
|
644
623
|
};
|
|
645
624
|
};
|
|
646
625
|
responses: {
|
|
647
|
-
/** @description The
|
|
626
|
+
/** @description The Flow was successfully started. */
|
|
648
627
|
201: {
|
|
649
628
|
headers: {
|
|
650
629
|
[name: string]: unknown;
|
|
@@ -726,7 +705,7 @@ export interface paths {
|
|
|
726
705
|
get?: never;
|
|
727
706
|
put?: never;
|
|
728
707
|
/**
|
|
729
|
-
* Validate a
|
|
708
|
+
* Validate a Run
|
|
730
709
|
* @description Validate that a run input body will pass the target flow's input schema validation (if any),
|
|
731
710
|
* that run metadata will meet the Flows service's metadata constraints,
|
|
732
711
|
* and that known scope requirements are met by the user's or client's Globus Auth token.
|
|
@@ -1335,7 +1314,7 @@ export interface paths {
|
|
|
1335
1314
|
cookie?: never;
|
|
1336
1315
|
};
|
|
1337
1316
|
/**
|
|
1338
|
-
*
|
|
1317
|
+
* List a Flow's Runs
|
|
1339
1318
|
* @description Retrieve a listing of Runs launched from a particular Flow. If hitting
|
|
1340
1319
|
* the *\/actions endpoint, the response will list the Runs under a
|
|
1341
1320
|
* "actions" key. If hitting the *\/runs endpoint, the response will list
|
|
@@ -1534,7 +1513,7 @@ export interface paths {
|
|
|
1534
1513
|
cookie?: never;
|
|
1535
1514
|
};
|
|
1536
1515
|
/**
|
|
1537
|
-
* List
|
|
1516
|
+
* List Runs
|
|
1538
1517
|
* @description Retrieve a listing of Actions/Runs launched across all Flows. If hitting
|
|
1539
1518
|
* the *\/actions endpoint, the response will list the Runs under a
|
|
1540
1519
|
* "actions" key. If hitting the *\/runs endpoint, the response will list
|
|
@@ -1798,7 +1777,7 @@ export interface paths {
|
|
|
1798
1777
|
};
|
|
1799
1778
|
};
|
|
1800
1779
|
/**
|
|
1801
|
-
* Update a Run
|
|
1780
|
+
* Update a Run
|
|
1802
1781
|
* @description Modify a Run's metadata.
|
|
1803
1782
|
*
|
|
1804
1783
|
* By default only the Run initiator is able to modify a Run's metadata.
|
|
@@ -1954,7 +1933,7 @@ export interface paths {
|
|
|
1954
1933
|
};
|
|
1955
1934
|
get?: never;
|
|
1956
1935
|
put?: never;
|
|
1957
|
-
/** Update metadata for multiple Runs
|
|
1936
|
+
/** Update metadata for multiple Runs */
|
|
1958
1937
|
post: {
|
|
1959
1938
|
parameters: {
|
|
1960
1939
|
query?: never;
|
|
@@ -2117,163 +2096,730 @@ export interface paths {
|
|
|
2117
2096
|
};
|
|
2118
2097
|
};
|
|
2119
2098
|
put?: never;
|
|
2120
|
-
|
|
2099
|
+
/**
|
|
2100
|
+
* Create a Registered API
|
|
2101
|
+
* @description Create a new Registered API.
|
|
2102
|
+
*/
|
|
2103
|
+
post: {
|
|
2104
|
+
parameters: {
|
|
2105
|
+
query?: never;
|
|
2106
|
+
header?: never;
|
|
2107
|
+
path?: never;
|
|
2108
|
+
cookie?: never;
|
|
2109
|
+
};
|
|
2110
|
+
requestBody: {
|
|
2111
|
+
content: {
|
|
2112
|
+
"application/json": {
|
|
2113
|
+
/**
|
|
2114
|
+
* @description A non-unique, human-friendly name used for displaying the
|
|
2115
|
+
* Registered API to end users.
|
|
2116
|
+
*/
|
|
2117
|
+
name: string;
|
|
2118
|
+
/** @description A detailed description of the Registered API for end user display. */
|
|
2119
|
+
description?: string;
|
|
2120
|
+
/** @description The OpenAPI specification and configuration for the registered API. */
|
|
2121
|
+
target: {
|
|
2122
|
+
/** @enum {string} */
|
|
2123
|
+
type: "openapi";
|
|
2124
|
+
openapi_version: string;
|
|
2125
|
+
destination: {
|
|
2126
|
+
/** @enum {string} */
|
|
2127
|
+
method: "get" | "head" | "post" | "put" | "delete" | "connect" | "options" | "trace" | "patch";
|
|
2128
|
+
/** Format: uri */
|
|
2129
|
+
url: string;
|
|
2130
|
+
};
|
|
2131
|
+
specification: {
|
|
2132
|
+
[key: string]: unknown;
|
|
2133
|
+
};
|
|
2134
|
+
components?: {
|
|
2135
|
+
[key: string]: unknown;
|
|
2136
|
+
};
|
|
2137
|
+
};
|
|
2138
|
+
/** @description Access control roles for the Registered API. */
|
|
2139
|
+
roles?: {
|
|
2140
|
+
/**
|
|
2141
|
+
* @description The set of Principal URN values of users and/or groups who own
|
|
2142
|
+
* the Registered API.
|
|
2143
|
+
*/
|
|
2144
|
+
owners?: components["schemas"]["PrincipalURN"][];
|
|
2145
|
+
/**
|
|
2146
|
+
* @description The set of Principal URN values of users and/or groups who may
|
|
2147
|
+
* perform administrative operations on the Registered API.
|
|
2148
|
+
*/
|
|
2149
|
+
administrators?: components["schemas"]["PrincipalURN"][];
|
|
2150
|
+
/**
|
|
2151
|
+
* @description The set of Principal URN values of users and/or groups who may
|
|
2152
|
+
* view the Registered API.
|
|
2153
|
+
*/
|
|
2154
|
+
viewers?: components["schemas"]["PrincipalURN"][];
|
|
2155
|
+
};
|
|
2156
|
+
/**
|
|
2157
|
+
* Format: uuid
|
|
2158
|
+
* @description A subscription to associate with this Registered API.
|
|
2159
|
+
*/
|
|
2160
|
+
subscription_id: string;
|
|
2161
|
+
};
|
|
2162
|
+
};
|
|
2163
|
+
};
|
|
2164
|
+
responses: {
|
|
2165
|
+
/** @description The Registered API was successfully created. */
|
|
2166
|
+
201: {
|
|
2167
|
+
headers: {
|
|
2168
|
+
[name: string]: unknown;
|
|
2169
|
+
};
|
|
2170
|
+
content: {
|
|
2171
|
+
"application/json": components["schemas"]["RegisteredApi"];
|
|
2172
|
+
};
|
|
2173
|
+
};
|
|
2174
|
+
/** @description The requestor attempted to create a malformed Registered API. */
|
|
2175
|
+
400: {
|
|
2176
|
+
headers: {
|
|
2177
|
+
[name: string]: unknown;
|
|
2178
|
+
};
|
|
2179
|
+
content?: never;
|
|
2180
|
+
};
|
|
2181
|
+
/** @description The requestor is not authorized to create a Registered API. */
|
|
2182
|
+
403: {
|
|
2183
|
+
headers: {
|
|
2184
|
+
[name: string]: unknown;
|
|
2185
|
+
};
|
|
2186
|
+
content?: never;
|
|
2187
|
+
};
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2121
2190
|
delete?: never;
|
|
2122
2191
|
options?: never;
|
|
2123
2192
|
head?: never;
|
|
2124
2193
|
patch?: never;
|
|
2125
2194
|
trace?: never;
|
|
2126
2195
|
};
|
|
2127
|
-
}
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
*
|
|
2135
|
-
* If this parameter is used when updating a flow,
|
|
2136
|
-
* runs that are currently executing will continue to use the definition
|
|
2137
|
-
* that they were initially started with.
|
|
2138
|
-
*/
|
|
2139
|
-
FlowDefinition: {
|
|
2140
|
-
Comment?: string;
|
|
2141
|
-
StartAt: string;
|
|
2142
|
-
States: {
|
|
2143
|
-
[key: string]: components["schemas"]["Pass"] | components["schemas"]["Action"] | components["schemas"]["Wait"] | components["schemas"]["Choice"] | components["schemas"]["ExpressionEval"] | components["schemas"]["Fail"];
|
|
2196
|
+
"/registered_apis/{registered_api_id}": {
|
|
2197
|
+
parameters: {
|
|
2198
|
+
query?: never;
|
|
2199
|
+
header?: never;
|
|
2200
|
+
path: {
|
|
2201
|
+
/** @description The unique identifier for the Registered API. */
|
|
2202
|
+
registered_api_id: string;
|
|
2144
2203
|
};
|
|
2145
|
-
|
|
2146
|
-
FlowRun: {
|
|
2147
|
-
/** @description The ID for a particular Flow invocation. Analogous to a run_id. */
|
|
2148
|
-
action_id: string;
|
|
2149
|
-
/** @description The ID for a particular Flow invocation. Analogous to an action_id. */
|
|
2150
|
-
run_id: string;
|
|
2151
|
-
/** @description The Flow to which this Run belongs. */
|
|
2152
|
-
flow_id: string;
|
|
2153
|
-
/**
|
|
2154
|
-
* Format: date-time
|
|
2155
|
-
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2156
|
-
* which the last update to this Run's Flow occurred.
|
|
2157
|
-
*/
|
|
2158
|
-
flow_last_updated: string;
|
|
2159
|
-
/**
|
|
2160
|
-
* Format: date-time
|
|
2161
|
-
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2162
|
-
* which this Run started.
|
|
2163
|
-
*/
|
|
2164
|
-
start_time: string;
|
|
2165
|
-
/**
|
|
2166
|
-
* Format: date-time
|
|
2167
|
-
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2168
|
-
* which this Run reached a completed status.
|
|
2169
|
-
*/
|
|
2170
|
-
completion_time: string;
|
|
2171
|
-
label: components["schemas"]["Label"];
|
|
2172
|
-
/**
|
|
2173
|
-
* @description The current state of the Run.
|
|
2174
|
-
* @enum {string}
|
|
2175
|
-
*/
|
|
2176
|
-
status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
|
|
2177
|
-
display_status?: string;
|
|
2178
|
-
/**
|
|
2179
|
-
* @description Details about the run execution. This is null for runs of High Assurance
|
|
2180
|
-
* flows when listing runs.
|
|
2181
|
-
*/
|
|
2182
|
-
details: Record<string, unknown> | null;
|
|
2183
|
-
run_owner: components["schemas"]["PrincipalURN"];
|
|
2184
|
-
run_monitors?: components["schemas"]["RunMonitors"];
|
|
2185
|
-
run_managers?: components["schemas"]["RunManagers"];
|
|
2186
|
-
/**
|
|
2187
|
-
* @deprecated
|
|
2188
|
-
* @description The role the requesting user has on the Run.
|
|
2189
|
-
* @enum {string}
|
|
2190
|
-
*/
|
|
2191
|
-
user_role: "run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager";
|
|
2192
|
-
/** @description The list of all roles the requesting user has on the Run. */
|
|
2193
|
-
user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
|
|
2194
|
-
tags: components["schemas"]["Tags"];
|
|
2195
|
-
};
|
|
2196
|
-
ValidateRun: {
|
|
2197
|
-
/**
|
|
2198
|
-
* @description A message indicating the validation was successful
|
|
2199
|
-
* @example success
|
|
2200
|
-
*/
|
|
2201
|
-
message: string;
|
|
2202
|
-
};
|
|
2203
|
-
GetRunDefinitionResponse: {
|
|
2204
|
-
/** @description The Flow used to start the Run. */
|
|
2205
|
-
flow_id: string;
|
|
2206
|
-
/** @description The definition of the Flow at the time the Run was started. */
|
|
2207
|
-
definition: Record<string, unknown>;
|
|
2208
|
-
/** @description The input schema of the Flow at the time the Run was started. */
|
|
2209
|
-
input_schema: Record<string, unknown>;
|
|
2210
|
-
};
|
|
2211
|
-
FlowEmbed: {
|
|
2212
|
-
/** @description The unique identifier for the Flow. */
|
|
2213
|
-
id: string;
|
|
2214
|
-
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2215
|
-
/**
|
|
2216
|
-
* Format: date-time
|
|
2217
|
-
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2218
|
-
* which the Flow was created.
|
|
2219
|
-
*/
|
|
2220
|
-
created_at: string;
|
|
2221
|
-
/**
|
|
2222
|
-
* Format: date-time
|
|
2223
|
-
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2224
|
-
* which the Flow was last updated.
|
|
2225
|
-
*/
|
|
2226
|
-
updated_at?: string;
|
|
2227
|
-
/**
|
|
2228
|
-
* Format: date-time
|
|
2229
|
-
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2230
|
-
* which the Flow was deleted (not present if the Flow has not been deleted).
|
|
2231
|
-
*/
|
|
2232
|
-
deleted_at?: string;
|
|
2233
|
-
/** @description A non-unique, human-friendly name used for displaying the Flow to end users. */
|
|
2234
|
-
title: string;
|
|
2235
|
-
/** @description A concise summary of the Flow's purpose. */
|
|
2236
|
-
subtitle?: string;
|
|
2237
|
-
/** @description A detailed description of the Flow for end user display. */
|
|
2238
|
-
description?: string;
|
|
2239
|
-
/**
|
|
2240
|
-
* @description A set of terms used to categorize the Flow which may be used in
|
|
2241
|
-
* query and discovery operations.
|
|
2242
|
-
*/
|
|
2243
|
-
keywords?: string[];
|
|
2244
|
-
};
|
|
2245
|
-
FlowRunWithFlowEmbed: components["schemas"]["FlowRun"] & {
|
|
2246
|
-
flow_description?: components["schemas"]["FlowEmbed"];
|
|
2247
|
-
};
|
|
2248
|
-
RunUpdate: {
|
|
2249
|
-
label?: components["schemas"]["Label"];
|
|
2250
|
-
run_monitors?: components["schemas"]["RunMonitors"];
|
|
2251
|
-
run_managers?: components["schemas"]["RunManagers"];
|
|
2252
|
-
tags?: components["schemas"]["Tags"];
|
|
2204
|
+
cookie?: never;
|
|
2253
2205
|
};
|
|
2254
2206
|
/**
|
|
2255
|
-
*
|
|
2256
|
-
* @description
|
|
2207
|
+
* Get Registered API
|
|
2208
|
+
* @description Retrieve details of a specific Registered API by its ID.
|
|
2257
2209
|
*/
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2210
|
+
get: {
|
|
2211
|
+
parameters: {
|
|
2212
|
+
query?: never;
|
|
2213
|
+
header?: never;
|
|
2214
|
+
path: {
|
|
2215
|
+
/** @description The unique identifier for the Registered API. */
|
|
2216
|
+
registered_api_id: string;
|
|
2217
|
+
};
|
|
2218
|
+
cookie?: never;
|
|
2219
|
+
};
|
|
2220
|
+
requestBody?: never;
|
|
2221
|
+
responses: {
|
|
2222
|
+
/** @description Successfully retrieved the Registered API details. */
|
|
2223
|
+
200: {
|
|
2224
|
+
headers: {
|
|
2225
|
+
[name: string]: unknown;
|
|
2226
|
+
};
|
|
2227
|
+
content: {
|
|
2228
|
+
"application/json": components["schemas"]["RegisteredApi"];
|
|
2229
|
+
};
|
|
2230
|
+
};
|
|
2231
|
+
/**
|
|
2232
|
+
* @description The requestor presented a token with insufficient scopes or lacks
|
|
2233
|
+
* permission to view this Registered API.
|
|
2234
|
+
*/
|
|
2235
|
+
403: {
|
|
2236
|
+
headers: {
|
|
2237
|
+
[name: string]: unknown;
|
|
2238
|
+
};
|
|
2239
|
+
content?: never;
|
|
2240
|
+
};
|
|
2241
|
+
/** @description No Registered API exists with the specified ID. */
|
|
2242
|
+
404: {
|
|
2243
|
+
headers: {
|
|
2244
|
+
[name: string]: unknown;
|
|
2245
|
+
};
|
|
2246
|
+
content?: never;
|
|
2247
|
+
};
|
|
2248
|
+
};
|
|
2266
2249
|
};
|
|
2250
|
+
put?: never;
|
|
2251
|
+
post?: never;
|
|
2267
2252
|
/**
|
|
2268
|
-
*
|
|
2269
|
-
* @description
|
|
2270
|
-
* If the flow defines an input schema, the input body will be validated against the input schema.
|
|
2271
|
-
* If there is no input schema, no validation will be performed.
|
|
2253
|
+
* Remove a Registered API
|
|
2254
|
+
* @description Remove a Registered API from the Flows service.
|
|
2272
2255
|
*/
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2256
|
+
delete: {
|
|
2257
|
+
parameters: {
|
|
2258
|
+
query?: never;
|
|
2259
|
+
header?: never;
|
|
2260
|
+
path: {
|
|
2261
|
+
/** @description The unique identifier for the Registered API. */
|
|
2262
|
+
registered_api_id: string;
|
|
2263
|
+
};
|
|
2264
|
+
cookie?: never;
|
|
2265
|
+
};
|
|
2266
|
+
requestBody?: never;
|
|
2267
|
+
responses: {
|
|
2268
|
+
/**
|
|
2269
|
+
* @description The requestor has successfully removed the Registered API from the
|
|
2270
|
+
* Flows service.
|
|
2271
|
+
*/
|
|
2272
|
+
200: {
|
|
2273
|
+
headers: {
|
|
2274
|
+
[name: string]: unknown;
|
|
2275
|
+
};
|
|
2276
|
+
content: {
|
|
2277
|
+
"application/json": components["schemas"]["RegisteredApi"];
|
|
2278
|
+
};
|
|
2279
|
+
};
|
|
2280
|
+
/**
|
|
2281
|
+
* @description The requestor attempted to delete a Registered API for which they
|
|
2282
|
+
* did not have access.
|
|
2283
|
+
*/
|
|
2284
|
+
403: {
|
|
2285
|
+
headers: {
|
|
2286
|
+
[name: string]: unknown;
|
|
2287
|
+
};
|
|
2288
|
+
content?: never;
|
|
2289
|
+
};
|
|
2290
|
+
/**
|
|
2291
|
+
* @description The requestor attempted to delete a non-existent Registered API,
|
|
2292
|
+
* or the requestor did not have permissions to delete it.
|
|
2293
|
+
*/
|
|
2294
|
+
404: {
|
|
2295
|
+
headers: {
|
|
2296
|
+
[name: string]: unknown;
|
|
2297
|
+
};
|
|
2298
|
+
content?: never;
|
|
2299
|
+
};
|
|
2300
|
+
};
|
|
2301
|
+
};
|
|
2302
|
+
options?: never;
|
|
2303
|
+
head?: never;
|
|
2304
|
+
/**
|
|
2305
|
+
* Update a Registered API
|
|
2306
|
+
* @description Modify a previously created Registered API. Only specified fields will be updated.
|
|
2307
|
+
*/
|
|
2308
|
+
patch: {
|
|
2309
|
+
parameters: {
|
|
2310
|
+
query?: never;
|
|
2311
|
+
header?: never;
|
|
2312
|
+
path: {
|
|
2313
|
+
/** @description The unique identifier for the Registered API. */
|
|
2314
|
+
registered_api_id: string;
|
|
2315
|
+
};
|
|
2316
|
+
cookie?: never;
|
|
2317
|
+
};
|
|
2318
|
+
requestBody: {
|
|
2319
|
+
content: {
|
|
2320
|
+
"application/json": {
|
|
2321
|
+
/**
|
|
2322
|
+
* @description A non-unique, human-friendly name used for displaying the
|
|
2323
|
+
* Registered API to end users.
|
|
2324
|
+
*/
|
|
2325
|
+
name?: string;
|
|
2326
|
+
/** @description A detailed description of the Registered API for end user display. */
|
|
2327
|
+
description?: string;
|
|
2328
|
+
/** @description The OpenAPI specification and configuration for the registered API. */
|
|
2329
|
+
target?: {
|
|
2330
|
+
/** @enum {string} */
|
|
2331
|
+
type?: "openapi";
|
|
2332
|
+
openapi_version?: string;
|
|
2333
|
+
destination?: {
|
|
2334
|
+
/** @enum {string} */
|
|
2335
|
+
method?: "get" | "head" | "post" | "put" | "delete" | "connect" | "options" | "trace" | "patch";
|
|
2336
|
+
/** Format: uri */
|
|
2337
|
+
url?: string;
|
|
2338
|
+
};
|
|
2339
|
+
specification?: {
|
|
2340
|
+
[key: string]: unknown;
|
|
2341
|
+
};
|
|
2342
|
+
components?: {
|
|
2343
|
+
[key: string]: unknown;
|
|
2344
|
+
};
|
|
2345
|
+
};
|
|
2346
|
+
/** @description Access control roles for the Registered API. */
|
|
2347
|
+
roles?: {
|
|
2348
|
+
/**
|
|
2349
|
+
* @description The set of Principal URN values of users and/or groups who own
|
|
2350
|
+
* the Registered API.
|
|
2351
|
+
*/
|
|
2352
|
+
owners?: components["schemas"]["PrincipalURN"][];
|
|
2353
|
+
/**
|
|
2354
|
+
* @description The set of Principal URN values of users and/or groups who may
|
|
2355
|
+
* perform administrative operations on the Registered API.
|
|
2356
|
+
*/
|
|
2357
|
+
administrators?: components["schemas"]["PrincipalURN"][];
|
|
2358
|
+
/**
|
|
2359
|
+
* @description The set of Principal URN values of users and/or groups who may
|
|
2360
|
+
* view the Registered API.
|
|
2361
|
+
*/
|
|
2362
|
+
viewers?: components["schemas"]["PrincipalURN"][];
|
|
2363
|
+
};
|
|
2364
|
+
/**
|
|
2365
|
+
* Format: uuid
|
|
2366
|
+
* @description A subscription to associate with this Registered API.
|
|
2367
|
+
*/
|
|
2368
|
+
subscription_id?: string;
|
|
2369
|
+
};
|
|
2370
|
+
};
|
|
2371
|
+
};
|
|
2372
|
+
responses: {
|
|
2373
|
+
/**
|
|
2374
|
+
* @description The requestor has successfully authenticated and updated the target
|
|
2375
|
+
* Registered API.
|
|
2376
|
+
*/
|
|
2377
|
+
200: {
|
|
2378
|
+
headers: {
|
|
2379
|
+
[name: string]: unknown;
|
|
2380
|
+
};
|
|
2381
|
+
content: {
|
|
2382
|
+
"application/json": components["schemas"]["RegisteredApi"];
|
|
2383
|
+
};
|
|
2384
|
+
};
|
|
2385
|
+
/**
|
|
2386
|
+
* @description The Registered API update failed due to an attempt to perform a
|
|
2387
|
+
* malformed update.
|
|
2388
|
+
*/
|
|
2389
|
+
400: {
|
|
2390
|
+
headers: {
|
|
2391
|
+
[name: string]: unknown;
|
|
2392
|
+
};
|
|
2393
|
+
content?: never;
|
|
2394
|
+
};
|
|
2395
|
+
/**
|
|
2396
|
+
* @description The requestor attempted to update a Registered API for which they
|
|
2397
|
+
* did not have access.
|
|
2398
|
+
*/
|
|
2399
|
+
403: {
|
|
2400
|
+
headers: {
|
|
2401
|
+
[name: string]: unknown;
|
|
2402
|
+
};
|
|
2403
|
+
content?: never;
|
|
2404
|
+
};
|
|
2405
|
+
/**
|
|
2406
|
+
* @description The requestor attempted to update a non-existent Registered API,
|
|
2407
|
+
* or the requestor did not have permissions to update it.
|
|
2408
|
+
*/
|
|
2409
|
+
404: {
|
|
2410
|
+
headers: {
|
|
2411
|
+
[name: string]: unknown;
|
|
2412
|
+
};
|
|
2413
|
+
content?: never;
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
};
|
|
2417
|
+
trace?: never;
|
|
2418
|
+
};
|
|
2419
|
+
"/web_inputs": {
|
|
2420
|
+
parameters: {
|
|
2421
|
+
query?: never;
|
|
2422
|
+
header?: never;
|
|
2423
|
+
path?: never;
|
|
2424
|
+
cookie?: never;
|
|
2425
|
+
};
|
|
2426
|
+
/**
|
|
2427
|
+
* List Web Inputs
|
|
2428
|
+
* @description Retrieve a listing of Web Inputs available to a user based on their viewer or respondent role on each Web Input.
|
|
2429
|
+
*/
|
|
2430
|
+
get: {
|
|
2431
|
+
parameters: {
|
|
2432
|
+
query?: {
|
|
2433
|
+
/** @description An opaque token used to iterate through pages of returned Web Inputs. If provided, all other query arguments will be ignored. The marker encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial marker has been received. */
|
|
2434
|
+
marker?: string;
|
|
2435
|
+
/** @description The number of results to return in a single paged response. */
|
|
2436
|
+
per_page?: number;
|
|
2437
|
+
/** @description Return Web Inputs for which the user has one of the supplied roles. If multiple roles are specified (comma-separated), the user will have at least one of the specified roles on each Web Input returned. If not provided, Web Inputs for which the caller has either "viewer" or "respondent" role will be returned. */
|
|
2438
|
+
filter_roles?: ("viewer" | "respondent")[];
|
|
2439
|
+
/** @description Return Web Inputs that are in one of the supplied states. If multiple states are specified (comma-separated), Web Inputs in any of those states will be returned. If not provided, only "open" Web Inputs will be returned. */
|
|
2440
|
+
filter_states?: ("open" | "closed")[];
|
|
2441
|
+
/** @description Return only Web Inputs associated with the specified Flow IDs. Multiple IDs can be specified (comma-separated), up to a maximum of 10. */
|
|
2442
|
+
filter_flow_ids?: string[];
|
|
2443
|
+
/** @description Return only Web Inputs associated with the specified Run IDs. Multiple IDs can be specified (comma-separated), up to a maximum of 10. */
|
|
2444
|
+
filter_run_ids?: string[];
|
|
2445
|
+
/**
|
|
2446
|
+
* @description Ordering criteria to apply to the list of Web Inputs.
|
|
2447
|
+
*
|
|
2448
|
+
* This field is a comma-separated list of sort criteria,
|
|
2449
|
+
* and follows this syntax:
|
|
2450
|
+
*
|
|
2451
|
+
* ```
|
|
2452
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2453
|
+
* ```
|
|
2454
|
+
*
|
|
2455
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2456
|
+
*
|
|
2457
|
+
* ```
|
|
2458
|
+
* FIELD ORDERING
|
|
2459
|
+
* ```
|
|
2460
|
+
*
|
|
2461
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2462
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2463
|
+
*
|
|
2464
|
+
* When additional comma-separated criteria are added,
|
|
2465
|
+
* the first criterion will be used to sort the data;
|
|
2466
|
+
* subsequent criteria will be applied for ties.
|
|
2467
|
+
*
|
|
2468
|
+
* Supported fields are:
|
|
2469
|
+
*
|
|
2470
|
+
* - `created_timestamp`
|
|
2471
|
+
* - `edited_timestamp`
|
|
2472
|
+
* - `closed_timestamp`
|
|
2473
|
+
*
|
|
2474
|
+
* Supported orderings are:
|
|
2475
|
+
*
|
|
2476
|
+
* - `ASC`
|
|
2477
|
+
* - `DESC`
|
|
2478
|
+
*/
|
|
2479
|
+
orderby?: components["parameters"]["list_web_inputs_orderby"];
|
|
2480
|
+
};
|
|
2481
|
+
header?: never;
|
|
2482
|
+
path?: never;
|
|
2483
|
+
cookie?: never;
|
|
2484
|
+
};
|
|
2485
|
+
requestBody?: never;
|
|
2486
|
+
responses: {
|
|
2487
|
+
/** @description The requestor has successfully authenticated and queried the Flows service for the Web Inputs available for them. */
|
|
2488
|
+
200: {
|
|
2489
|
+
headers: {
|
|
2490
|
+
[name: string]: unknown;
|
|
2491
|
+
};
|
|
2492
|
+
content: {
|
|
2493
|
+
"application/json": {
|
|
2494
|
+
web_input_summaries: components["schemas"]["WebInputSummary"][];
|
|
2495
|
+
/** @description An opaque pagination token for iterating through returned Web Inputs. Null if there are no more pages. */
|
|
2496
|
+
marker?: string | null;
|
|
2497
|
+
};
|
|
2498
|
+
};
|
|
2499
|
+
};
|
|
2500
|
+
/** @description There was an issue parsing the query parameters. */
|
|
2501
|
+
400: {
|
|
2502
|
+
headers: {
|
|
2503
|
+
[name: string]: unknown;
|
|
2504
|
+
};
|
|
2505
|
+
content?: never;
|
|
2506
|
+
};
|
|
2507
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
2508
|
+
403: {
|
|
2509
|
+
headers: {
|
|
2510
|
+
[name: string]: unknown;
|
|
2511
|
+
};
|
|
2512
|
+
content?: never;
|
|
2513
|
+
};
|
|
2514
|
+
/** @description The request's query parameters did not pass validation. */
|
|
2515
|
+
422: {
|
|
2516
|
+
headers: {
|
|
2517
|
+
[name: string]: unknown;
|
|
2518
|
+
};
|
|
2519
|
+
content?: never;
|
|
2520
|
+
};
|
|
2521
|
+
};
|
|
2522
|
+
};
|
|
2523
|
+
put?: never;
|
|
2524
|
+
post?: never;
|
|
2525
|
+
delete?: never;
|
|
2526
|
+
options?: never;
|
|
2527
|
+
head?: never;
|
|
2528
|
+
patch?: never;
|
|
2529
|
+
trace?: never;
|
|
2530
|
+
};
|
|
2531
|
+
"/web_inputs/{web_input_id}": {
|
|
2532
|
+
parameters: {
|
|
2533
|
+
query?: never;
|
|
2534
|
+
header?: never;
|
|
2535
|
+
path?: never;
|
|
2536
|
+
cookie?: never;
|
|
2537
|
+
};
|
|
2538
|
+
/** @description Get a Web Input by ID */
|
|
2539
|
+
get: {
|
|
2540
|
+
parameters: {
|
|
2541
|
+
query?: never;
|
|
2542
|
+
header?: never;
|
|
2543
|
+
path: {
|
|
2544
|
+
web_input_id: string;
|
|
2545
|
+
};
|
|
2546
|
+
cookie?: never;
|
|
2547
|
+
};
|
|
2548
|
+
requestBody?: never;
|
|
2549
|
+
responses: {
|
|
2550
|
+
/** @description Information about the Web Input */
|
|
2551
|
+
200: {
|
|
2552
|
+
headers: {
|
|
2553
|
+
[name: string]: unknown;
|
|
2554
|
+
};
|
|
2555
|
+
content: {
|
|
2556
|
+
"application/json": components["schemas"]["WebInputResponse"];
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
2561
|
+
put?: never;
|
|
2562
|
+
post?: never;
|
|
2563
|
+
delete?: never;
|
|
2564
|
+
options?: never;
|
|
2565
|
+
head?: never;
|
|
2566
|
+
patch?: never;
|
|
2567
|
+
trace?: never;
|
|
2568
|
+
};
|
|
2569
|
+
"/web_inputs/{web_input_id}/respond": {
|
|
2570
|
+
parameters: {
|
|
2571
|
+
query?: never;
|
|
2572
|
+
header?: never;
|
|
2573
|
+
path?: never;
|
|
2574
|
+
cookie?: never;
|
|
2575
|
+
};
|
|
2576
|
+
get?: never;
|
|
2577
|
+
put?: never;
|
|
2578
|
+
/**
|
|
2579
|
+
* Respond to a Web Input
|
|
2580
|
+
* @description Submit a response to a Web Input. The caller must have the respondent role on the Web Input and satisfy any authentication policy on the associated flow.
|
|
2581
|
+
*/
|
|
2582
|
+
post: {
|
|
2583
|
+
parameters: {
|
|
2584
|
+
query?: never;
|
|
2585
|
+
header?: never;
|
|
2586
|
+
path: {
|
|
2587
|
+
/** @description The unique identifier of the Web Input to respond to. */
|
|
2588
|
+
web_input_id: string;
|
|
2589
|
+
};
|
|
2590
|
+
cookie?: never;
|
|
2591
|
+
};
|
|
2592
|
+
requestBody: {
|
|
2593
|
+
content: {
|
|
2594
|
+
"application/json": {
|
|
2595
|
+
response: {
|
|
2596
|
+
/** @description The response value submitted by the user. */
|
|
2597
|
+
value: unknown;
|
|
2598
|
+
};
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
};
|
|
2602
|
+
responses: {
|
|
2603
|
+
/** @description The response was successfully submitted. */
|
|
2604
|
+
200: {
|
|
2605
|
+
headers: {
|
|
2606
|
+
[name: string]: unknown;
|
|
2607
|
+
};
|
|
2608
|
+
content: {
|
|
2609
|
+
"application/json": {
|
|
2610
|
+
/** @enum {string} */
|
|
2611
|
+
status?: "ok";
|
|
2612
|
+
};
|
|
2613
|
+
};
|
|
2614
|
+
};
|
|
2615
|
+
/**
|
|
2616
|
+
* @description The requestor does not have the respondent role on the Web Input,
|
|
2617
|
+
* or the requestor does not satisfy the flow's authentication policy.
|
|
2618
|
+
* When the user has the respondent role but fails the authentication
|
|
2619
|
+
* policy, the response includes a web_input_summary alongside a GARE.
|
|
2620
|
+
*/
|
|
2621
|
+
403: {
|
|
2622
|
+
headers: {
|
|
2623
|
+
[name: string]: unknown;
|
|
2624
|
+
};
|
|
2625
|
+
content: {
|
|
2626
|
+
"application/json": {
|
|
2627
|
+
error: {
|
|
2628
|
+
code: string;
|
|
2629
|
+
detail: string;
|
|
2630
|
+
};
|
|
2631
|
+
} | {
|
|
2632
|
+
web_input_summary?: components["schemas"]["WebInputSummary"];
|
|
2633
|
+
code?: string;
|
|
2634
|
+
authorization_parameters?: Record<string, unknown>;
|
|
2635
|
+
error?: {
|
|
2636
|
+
code?: string;
|
|
2637
|
+
detail?: string;
|
|
2638
|
+
};
|
|
2639
|
+
};
|
|
2640
|
+
};
|
|
2641
|
+
};
|
|
2642
|
+
/** @description The Web Input does not exist. */
|
|
2643
|
+
404: {
|
|
2644
|
+
headers: {
|
|
2645
|
+
[name: string]: unknown;
|
|
2646
|
+
};
|
|
2647
|
+
content?: never;
|
|
2648
|
+
};
|
|
2649
|
+
/** @description The Web Input is already closed. */
|
|
2650
|
+
409: {
|
|
2651
|
+
headers: {
|
|
2652
|
+
[name: string]: unknown;
|
|
2653
|
+
};
|
|
2654
|
+
content?: never;
|
|
2655
|
+
};
|
|
2656
|
+
/** @description The request body did not pass validation. */
|
|
2657
|
+
422: {
|
|
2658
|
+
headers: {
|
|
2659
|
+
[name: string]: unknown;
|
|
2660
|
+
};
|
|
2661
|
+
content?: never;
|
|
2662
|
+
};
|
|
2663
|
+
};
|
|
2664
|
+
};
|
|
2665
|
+
delete?: never;
|
|
2666
|
+
options?: never;
|
|
2667
|
+
head?: never;
|
|
2668
|
+
patch?: never;
|
|
2669
|
+
trace?: never;
|
|
2670
|
+
};
|
|
2671
|
+
}
|
|
2672
|
+
export type webhooks = Record<string, never>;
|
|
2673
|
+
export interface components {
|
|
2674
|
+
schemas: {
|
|
2675
|
+
/**
|
|
2676
|
+
* The flow definition
|
|
2677
|
+
* @description The flow definition.
|
|
2678
|
+
*
|
|
2679
|
+
* If this parameter is used when updating a flow,
|
|
2680
|
+
* runs that are currently executing will continue to use the definition
|
|
2681
|
+
* that they were initially started with.
|
|
2682
|
+
*/
|
|
2683
|
+
FlowDefinition: {
|
|
2684
|
+
Comment?: string;
|
|
2685
|
+
StartAt: string;
|
|
2686
|
+
States: {
|
|
2687
|
+
[key: string]: components["schemas"]["Pass"] | components["schemas"]["Action"] | components["schemas"]["Wait"] | components["schemas"]["Choice"] | components["schemas"]["ExpressionEval"] | components["schemas"]["Fail"];
|
|
2688
|
+
};
|
|
2689
|
+
};
|
|
2690
|
+
FlowRun: {
|
|
2691
|
+
/** @description The ID for a particular Flow invocation. Analogous to a run_id. */
|
|
2692
|
+
action_id: string;
|
|
2693
|
+
/** @description The ID for a particular Flow invocation. Analogous to an action_id. */
|
|
2694
|
+
run_id: string;
|
|
2695
|
+
/** @description The Flow to which this Run belongs. */
|
|
2696
|
+
flow_id: string;
|
|
2697
|
+
/**
|
|
2698
|
+
* Format: date-time
|
|
2699
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2700
|
+
* which the last update to this Run's Flow occurred.
|
|
2701
|
+
*/
|
|
2702
|
+
flow_last_updated: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* Format: date-time
|
|
2705
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2706
|
+
* which this Run started.
|
|
2707
|
+
*/
|
|
2708
|
+
start_time: string;
|
|
2709
|
+
/**
|
|
2710
|
+
* Format: date-time
|
|
2711
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2712
|
+
* which this Run reached a completed status.
|
|
2713
|
+
*/
|
|
2714
|
+
completion_time: string;
|
|
2715
|
+
label: components["schemas"]["Label"];
|
|
2716
|
+
/**
|
|
2717
|
+
* @description The current state of the Run.
|
|
2718
|
+
* @enum {string}
|
|
2719
|
+
*/
|
|
2720
|
+
status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
|
|
2721
|
+
display_status?: string;
|
|
2722
|
+
/**
|
|
2723
|
+
* @description Details about the run execution. This is null for runs of High Assurance
|
|
2724
|
+
* flows when listing runs.
|
|
2725
|
+
*/
|
|
2726
|
+
details: Record<string, unknown> | null;
|
|
2727
|
+
run_owner: components["schemas"]["PrincipalURN"];
|
|
2728
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
2729
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
2730
|
+
/**
|
|
2731
|
+
* @deprecated
|
|
2732
|
+
* @description The role the requesting user has on the Run.
|
|
2733
|
+
* @enum {string}
|
|
2734
|
+
*/
|
|
2735
|
+
user_role: "run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager";
|
|
2736
|
+
/** @description The list of all roles the requesting user has on the Run. */
|
|
2737
|
+
user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
|
|
2738
|
+
tags: components["schemas"]["Tags"];
|
|
2739
|
+
/** @description The ID of the Web Input from which the Run is currently awaiting input. This field is present, but null, if the Run is not awaiting input. */
|
|
2740
|
+
blocking_web_input_id: string | null;
|
|
2741
|
+
};
|
|
2742
|
+
ValidateRun: {
|
|
2743
|
+
/**
|
|
2744
|
+
* @description A message indicating the validation was successful
|
|
2745
|
+
* @example success
|
|
2746
|
+
*/
|
|
2747
|
+
message: string;
|
|
2748
|
+
};
|
|
2749
|
+
GetRunDefinitionResponse: {
|
|
2750
|
+
/** @description The Flow used to start the Run. */
|
|
2751
|
+
flow_id: string;
|
|
2752
|
+
/** @description The definition of the Flow at the time the Run was started. */
|
|
2753
|
+
definition: Record<string, unknown>;
|
|
2754
|
+
/** @description The input schema of the Flow at the time the Run was started. */
|
|
2755
|
+
input_schema: Record<string, unknown>;
|
|
2756
|
+
};
|
|
2757
|
+
FlowEmbed: {
|
|
2758
|
+
/** @description The unique identifier for the Flow. */
|
|
2759
|
+
id: string;
|
|
2760
|
+
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2761
|
+
/**
|
|
2762
|
+
* Format: date-time
|
|
2763
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2764
|
+
* which the Flow was created.
|
|
2765
|
+
*/
|
|
2766
|
+
created_at: string;
|
|
2767
|
+
/**
|
|
2768
|
+
* Format: date-time
|
|
2769
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2770
|
+
* which the Flow was last updated.
|
|
2771
|
+
*/
|
|
2772
|
+
updated_at?: string;
|
|
2773
|
+
/**
|
|
2774
|
+
* Format: date-time
|
|
2775
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2776
|
+
* which the Flow was deleted (not present if the Flow has not been deleted).
|
|
2777
|
+
*/
|
|
2778
|
+
deleted_at?: string;
|
|
2779
|
+
/** @description A non-unique, human-friendly name used for displaying the Flow to end users. */
|
|
2780
|
+
title: string;
|
|
2781
|
+
/** @description A concise summary of the Flow's purpose. */
|
|
2782
|
+
subtitle?: string;
|
|
2783
|
+
/** @description A detailed description of the Flow for end user display. */
|
|
2784
|
+
description?: string;
|
|
2785
|
+
/**
|
|
2786
|
+
* @description A set of terms used to categorize the Flow which may be used in
|
|
2787
|
+
* query and discovery operations.
|
|
2788
|
+
*/
|
|
2789
|
+
keywords?: string[];
|
|
2790
|
+
};
|
|
2791
|
+
FlowRunWithFlowEmbed: components["schemas"]["FlowRun"] & {
|
|
2792
|
+
flow_description?: components["schemas"]["FlowEmbed"];
|
|
2793
|
+
};
|
|
2794
|
+
RunUpdate: {
|
|
2795
|
+
label?: components["schemas"]["Label"];
|
|
2796
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
2797
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
2798
|
+
tags?: components["schemas"]["Tags"];
|
|
2799
|
+
};
|
|
2800
|
+
/**
|
|
2801
|
+
* Activity notification policy
|
|
2802
|
+
* @description The email notification policy for the run.
|
|
2803
|
+
*/
|
|
2804
|
+
ActivityNotificationPolicy: {
|
|
2805
|
+
/**
|
|
2806
|
+
* @description The set of statuses on which to notify the run's owner by email.
|
|
2807
|
+
* @default [
|
|
2808
|
+
* "INACTIVE"
|
|
2809
|
+
* ]
|
|
2810
|
+
*/
|
|
2811
|
+
status: ("INACTIVE" | "FAILED" | "SUCCEEDED")[];
|
|
2812
|
+
};
|
|
2813
|
+
/**
|
|
2814
|
+
* Input body
|
|
2815
|
+
* @description The input body that will be passed into the flow when it starts.
|
|
2816
|
+
* If the flow defines an input schema, the input body will be validated against the input schema.
|
|
2817
|
+
* If there is no input schema, no validation will be performed.
|
|
2818
|
+
*/
|
|
2819
|
+
InputBody: {
|
|
2820
|
+
[key: string]: unknown;
|
|
2821
|
+
};
|
|
2822
|
+
/**
|
|
2277
2823
|
* Label
|
|
2278
2824
|
* @description A short, human-readable description of the run.
|
|
2279
2825
|
* @example Generate a report for experiment xDA202-batch-3
|
|
@@ -2626,6 +3172,240 @@ export interface components {
|
|
|
2626
3172
|
*/
|
|
2627
3173
|
updated_timestamp: string;
|
|
2628
3174
|
};
|
|
3175
|
+
/**
|
|
3176
|
+
* Format: date-time
|
|
3177
|
+
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was closed. Null if the Web Input is still open.
|
|
3178
|
+
*/
|
|
3179
|
+
_WebInputClosedTimestamp: string | null;
|
|
3180
|
+
_WebInputContext: components["schemas"]["_WebInputTableContext"] | components["schemas"]["_WebInputTextContext"];
|
|
3181
|
+
/**
|
|
3182
|
+
* @description Information that helps respondents understand what they're responding to.
|
|
3183
|
+
* For example, "What file transfer am I approving or denying?"
|
|
3184
|
+
*/
|
|
3185
|
+
_WebInputTableContext: {
|
|
3186
|
+
/**
|
|
3187
|
+
* @description A title for the Web Input.
|
|
3188
|
+
* This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.
|
|
3189
|
+
*/
|
|
3190
|
+
title: string;
|
|
3191
|
+
/**
|
|
3192
|
+
* @description The value "table" indicating that clients should present data as a table. (enum property replaced by openapi-typescript)
|
|
3193
|
+
* @enum {string}
|
|
3194
|
+
*/
|
|
3195
|
+
presentation_style: "table";
|
|
3196
|
+
rows: {
|
|
3197
|
+
field: string;
|
|
3198
|
+
value: string;
|
|
3199
|
+
}[];
|
|
3200
|
+
};
|
|
3201
|
+
/**
|
|
3202
|
+
* @description Information that helps respondents understand what they're responding to.
|
|
3203
|
+
* For example, "What file transfer am I approving or denying?"
|
|
3204
|
+
*/
|
|
3205
|
+
_WebInputTextContext: {
|
|
3206
|
+
/**
|
|
3207
|
+
* @description A title for the Web Input.
|
|
3208
|
+
* This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.
|
|
3209
|
+
*/
|
|
3210
|
+
title: string;
|
|
3211
|
+
/**
|
|
3212
|
+
* @description The value "text" indicating that clients should present data as a block of text. (enum property replaced by openapi-typescript)
|
|
3213
|
+
* @enum {string}
|
|
3214
|
+
*/
|
|
3215
|
+
presentation_style: "text";
|
|
3216
|
+
text: string;
|
|
3217
|
+
};
|
|
3218
|
+
/** @description The Globus Auth identity that created the Web Input. Creators are not implicitly granted "view" access to the Web Input. */
|
|
3219
|
+
_WebInputCreatorUrn: string;
|
|
3220
|
+
/**
|
|
3221
|
+
* Format: date-time
|
|
3222
|
+
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was created.
|
|
3223
|
+
*/
|
|
3224
|
+
_WebInputCreatedTimestamp: string;
|
|
3225
|
+
/**
|
|
3226
|
+
* Format: date-time
|
|
3227
|
+
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was last edited.
|
|
3228
|
+
*/
|
|
3229
|
+
_WebInputEditedTimestamp: string;
|
|
3230
|
+
/** @description Info about the Flow associated with the Web Input. */
|
|
3231
|
+
_WebInputFlowInfo: {
|
|
3232
|
+
/**
|
|
3233
|
+
* Format: uuid
|
|
3234
|
+
* @description The unique identifier for the associated Flow.
|
|
3235
|
+
*/
|
|
3236
|
+
id: string;
|
|
3237
|
+
/** @description The title of the associated Flow. */
|
|
3238
|
+
title: string;
|
|
3239
|
+
};
|
|
3240
|
+
/**
|
|
3241
|
+
* Format: uuid
|
|
3242
|
+
* @description The unique identifier for the Web Input.
|
|
3243
|
+
*/
|
|
3244
|
+
_WebInputId: string;
|
|
3245
|
+
/** @description The input schema used to validate all responses to the Web Input. */
|
|
3246
|
+
_WebInputInputSchema: Record<string, unknown>;
|
|
3247
|
+
/**
|
|
3248
|
+
* @description The type of Web Input.
|
|
3249
|
+
* @enum {string}
|
|
3250
|
+
*/
|
|
3251
|
+
_WebInputInputType: "selection";
|
|
3252
|
+
/** @description The individual options associated with Web Input. This field is only present when the input type is "selection". */
|
|
3253
|
+
_WebInputOptions: {
|
|
3254
|
+
/**
|
|
3255
|
+
* Format: uuid
|
|
3256
|
+
* @description A UUID that identifies the option. If a respondent selects this option (like "Approve" or "Deny"), this is the value that should be submitted back to the Flows service.
|
|
3257
|
+
*/
|
|
3258
|
+
option_id: string;
|
|
3259
|
+
/** @description Text that is associated with the option. For example, this may be the word "Approve" or "Deny", and is probably displayed prominently on a button or other UI element that respondents can click on. */
|
|
3260
|
+
label: string;
|
|
3261
|
+
/** @description Additional context to clarify the option for respondents. For example, this may be text "Allow file egress from the protected collection." */
|
|
3262
|
+
description: string;
|
|
3263
|
+
}[];
|
|
3264
|
+
/** @description The Globus Auth identities and groups that have been assigned roles/permissions to the Web Input. */
|
|
3265
|
+
_WebInputRoles: {
|
|
3266
|
+
/** @description Identities and groups that are allowed to view all of the Web Input's information. */
|
|
3267
|
+
viewer_urns: string[];
|
|
3268
|
+
/** @description Identities and groups that are allowed to submit responses to the Web Input. Respondents are also allowed to view information about the Web Input. */
|
|
3269
|
+
respondent_urns: string[];
|
|
3270
|
+
};
|
|
3271
|
+
/** @description Info about the Run associated with the Web Input. */
|
|
3272
|
+
_WebInputRunInfo: {
|
|
3273
|
+
/**
|
|
3274
|
+
* Format: uuid
|
|
3275
|
+
* @description The unique identifier for the associated Run.
|
|
3276
|
+
*/
|
|
3277
|
+
id: string;
|
|
3278
|
+
/** @description An optional label for the associated Run. */
|
|
3279
|
+
label: string | null;
|
|
3280
|
+
};
|
|
3281
|
+
/**
|
|
3282
|
+
* @description The current status of the Web Input. "open" indicates the Web Input is awaiting a response; "closed" indicates it has been completed.
|
|
3283
|
+
* @enum {string}
|
|
3284
|
+
*/
|
|
3285
|
+
_WebInputStatus: "open" | "closed";
|
|
3286
|
+
/** @description A human-readable title for the Web Input. */
|
|
3287
|
+
_WebInputTitle: string;
|
|
3288
|
+
/** @description The roles the current user has on this Web Input. */
|
|
3289
|
+
_WebInputUserRoles: ("viewer" | "respondent")[];
|
|
3290
|
+
WebInputResponse: {
|
|
3291
|
+
id: components["schemas"]["_WebInputId"];
|
|
3292
|
+
status: components["schemas"]["_WebInputStatus"];
|
|
3293
|
+
user_roles: components["schemas"]["_WebInputUserRoles"];
|
|
3294
|
+
input_type: components["schemas"]["_WebInputInputType"];
|
|
3295
|
+
input_schema: components["schemas"]["_WebInputInputSchema"];
|
|
3296
|
+
context: components["schemas"]["_WebInputContext"];
|
|
3297
|
+
flow: components["schemas"]["_WebInputFlowInfo"];
|
|
3298
|
+
run: components["schemas"]["_WebInputRunInfo"];
|
|
3299
|
+
roles: components["schemas"]["_WebInputRoles"];
|
|
3300
|
+
creator_urn: components["schemas"]["_WebInputCreatorUrn"];
|
|
3301
|
+
created_timestamp: components["schemas"]["_WebInputCreatedTimestamp"];
|
|
3302
|
+
edited_timestamp: components["schemas"]["_WebInputEditedTimestamp"];
|
|
3303
|
+
closed_timestamp: components["schemas"]["_WebInputClosedTimestamp"];
|
|
3304
|
+
options?: components["schemas"]["_WebInputOptions"];
|
|
3305
|
+
};
|
|
3306
|
+
WebInputSummary: {
|
|
3307
|
+
id: components["schemas"]["_WebInputId"];
|
|
3308
|
+
status: components["schemas"]["_WebInputStatus"];
|
|
3309
|
+
user_roles: components["schemas"]["_WebInputUserRoles"];
|
|
3310
|
+
input_type: components["schemas"]["_WebInputInputType"];
|
|
3311
|
+
title: components["schemas"]["_WebInputTitle"];
|
|
3312
|
+
flow: components["schemas"]["_WebInputFlowInfo"];
|
|
3313
|
+
run: components["schemas"]["_WebInputRunInfo"];
|
|
3314
|
+
created_timestamp: components["schemas"]["_WebInputCreatedTimestamp"];
|
|
3315
|
+
edited_timestamp: components["schemas"]["_WebInputEditedTimestamp"];
|
|
3316
|
+
closed_timestamp: components["schemas"]["_WebInputClosedTimestamp"];
|
|
3317
|
+
};
|
|
3318
|
+
RegisteredApi: components["schemas"]["RegisteredApiSummary"] & {
|
|
3319
|
+
/**
|
|
3320
|
+
* @description Access control roles for the Registered API, mapping role names to
|
|
3321
|
+
* lists of principal URNs.
|
|
3322
|
+
*/
|
|
3323
|
+
roles: {
|
|
3324
|
+
/** @description Principals with owner permissions on this Registered API. */
|
|
3325
|
+
owners?: components["schemas"]["PrincipalURN"][];
|
|
3326
|
+
/** @description Principals with administrator permissions on this Registered API. */
|
|
3327
|
+
administrators?: components["schemas"]["PrincipalURN"][];
|
|
3328
|
+
/** @description Principals with viewer permissions on this Registered API. */
|
|
3329
|
+
viewers?: components["schemas"]["PrincipalURN"][];
|
|
3330
|
+
};
|
|
3331
|
+
/** @description The OpenAPI specification and configuration for the registered API. */
|
|
3332
|
+
target: {
|
|
3333
|
+
/**
|
|
3334
|
+
* @description The type of API specification.
|
|
3335
|
+
* @enum {string}
|
|
3336
|
+
*/
|
|
3337
|
+
type: "openapi";
|
|
3338
|
+
/** @description The OpenAPI specification version (e.g., "3.1"). */
|
|
3339
|
+
openapi_version: string;
|
|
3340
|
+
/** @description The target endpoint for API calls. */
|
|
3341
|
+
destination: {
|
|
3342
|
+
/**
|
|
3343
|
+
* @description The HTTP method for the API call.
|
|
3344
|
+
* @enum {string}
|
|
3345
|
+
*/
|
|
3346
|
+
method: "get" | "post" | "put" | "patch" | "delete";
|
|
3347
|
+
/**
|
|
3348
|
+
* Format: uri
|
|
3349
|
+
* @description The URL template for the API endpoint.
|
|
3350
|
+
*/
|
|
3351
|
+
url: string;
|
|
3352
|
+
};
|
|
3353
|
+
/** @description The OpenAPI operation specification. */
|
|
3354
|
+
specification: {
|
|
3355
|
+
[key: string]: unknown;
|
|
3356
|
+
};
|
|
3357
|
+
/** @description OpenAPI components (schemas, etc.) referenced by the specification. */
|
|
3358
|
+
components?: {
|
|
3359
|
+
[key: string]: unknown;
|
|
3360
|
+
};
|
|
3361
|
+
};
|
|
3362
|
+
/**
|
|
3363
|
+
* @description Service-generated templates that map and transform the OpenAPI specification
|
|
3364
|
+
* (target) to simplified parameter structures for use in flow definitions.
|
|
3365
|
+
*/
|
|
3366
|
+
data_templates: {
|
|
3367
|
+
/**
|
|
3368
|
+
* @description Template defining how to map simplified flow parameters to the
|
|
3369
|
+
* OpenAPI request structure.
|
|
3370
|
+
*/
|
|
3371
|
+
request: {
|
|
3372
|
+
[key: string]: unknown;
|
|
3373
|
+
};
|
|
3374
|
+
/** @description Template defining how to map the API response back to flow state. */
|
|
3375
|
+
response: {
|
|
3376
|
+
[key: string]: unknown;
|
|
3377
|
+
};
|
|
3378
|
+
};
|
|
3379
|
+
/**
|
|
3380
|
+
* @description Service-generated JSON Schema defining the input state required for this
|
|
3381
|
+
* Registered API when used in a flow.
|
|
3382
|
+
*/
|
|
3383
|
+
state_input_schema: {
|
|
3384
|
+
[key: string]: unknown;
|
|
3385
|
+
};
|
|
3386
|
+
/**
|
|
3387
|
+
* @description The current status of the Registered API.
|
|
3388
|
+
* @enum {string}
|
|
3389
|
+
*/
|
|
3390
|
+
status: "ACTIVE" | "INACTIVE";
|
|
3391
|
+
/**
|
|
3392
|
+
* Format: uuid
|
|
3393
|
+
* @description The subscription ID associated with this Registered API.
|
|
3394
|
+
*/
|
|
3395
|
+
subscription_id: string | null;
|
|
3396
|
+
/**
|
|
3397
|
+
* Format: date-time
|
|
3398
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
3399
|
+
* which the Registered API was last edited.
|
|
3400
|
+
*/
|
|
3401
|
+
edited_timestamp?: string | null;
|
|
3402
|
+
/**
|
|
3403
|
+
* Format: date-time
|
|
3404
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
3405
|
+
* which the Registered API is scheduled for deletion.
|
|
3406
|
+
*/
|
|
3407
|
+
scheduled_deletion_timestamp?: string | null;
|
|
3408
|
+
};
|
|
2629
3409
|
BatchRunUpdateOperation: {
|
|
2630
3410
|
tags?: string[];
|
|
2631
3411
|
run_managers?: components["schemas"]["PrincipalURN"][];
|
|
@@ -2838,6 +3618,41 @@ export interface components {
|
|
|
2838
3618
|
* - `DESC`
|
|
2839
3619
|
*/
|
|
2840
3620
|
list_registered_apis_orderby: string[];
|
|
3621
|
+
/**
|
|
3622
|
+
* @description Ordering criteria to apply to the list of Web Inputs.
|
|
3623
|
+
*
|
|
3624
|
+
* This field is a comma-separated list of sort criteria,
|
|
3625
|
+
* and follows this syntax:
|
|
3626
|
+
*
|
|
3627
|
+
* ```
|
|
3628
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
3629
|
+
* ```
|
|
3630
|
+
*
|
|
3631
|
+
* and each individual `CRITERION` follows this syntax:
|
|
3632
|
+
*
|
|
3633
|
+
* ```
|
|
3634
|
+
* FIELD ORDERING
|
|
3635
|
+
* ```
|
|
3636
|
+
*
|
|
3637
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
3638
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
3639
|
+
*
|
|
3640
|
+
* When additional comma-separated criteria are added,
|
|
3641
|
+
* the first criterion will be used to sort the data;
|
|
3642
|
+
* subsequent criteria will be applied for ties.
|
|
3643
|
+
*
|
|
3644
|
+
* Supported fields are:
|
|
3645
|
+
*
|
|
3646
|
+
* - `created_timestamp`
|
|
3647
|
+
* - `edited_timestamp`
|
|
3648
|
+
* - `closed_timestamp`
|
|
3649
|
+
*
|
|
3650
|
+
* Supported orderings are:
|
|
3651
|
+
*
|
|
3652
|
+
* - `ASC`
|
|
3653
|
+
* - `DESC`
|
|
3654
|
+
*/
|
|
3655
|
+
list_web_inputs_orderby: string[];
|
|
2841
3656
|
};
|
|
2842
3657
|
requestBodies: never;
|
|
2843
3658
|
headers: never;
|