You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(Flows): Adds singular GET for web inputs type (#873)
This PR was auto-generated by the `scheduled--generate-types` GitHub
Action workflow.
### Continuous integration workflows were NOT run on the creation of
this pull request.
---
- [x] Update the title (scope) of this pull request to match the changes
made.
- [x] Close and reopen this pull request to trigger workflows.
Co-authored-by: github-actions <github-actions@github.com>
/** @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. */
* @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.
3199
+
*/
3200
+
_WebInputClosedTimestamp: string|null;
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
+
_WebInputContext: {
3157
3206
/**
3158
-
* Format: uuid
3159
-
* @description The unique identifier for the Web Input.
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.
3160
3209
*/
3161
-
id: string;
3210
+
title?: string;
3211
+
/** @description The suggested way by which the rows should be rendered for display. */
3212
+
presentation_style?: string;
3213
+
rows?: {
3214
+
field: string;
3215
+
value: string;
3216
+
}[];
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: {
3162
3232
/**
3163
-
* @description The current status of the Web Input. "open" indicates the Web Input is awaiting a response; "closed" indicates it has been completed.
3164
-
* @enum {string}
3233
+
* Format: uuid
3234
+
* @description The unique identifier for the associated Flow.
3165
3235
*/
3166
-
status: "open"|"closed";
3167
-
/** @description The roles the current user has on this Web Input. */
3168
-
user_roles: ("viewer"|"respondent")[];
3169
-
/** @description The type of Web Input (e.g., "selection", "form"). */
3170
-
input_type: string;
3171
-
/** @description A human-readable title for the Web Input. */
3236
+
id: string;
3237
+
/** @description The title of the associated Flow. */
3172
3238
title: string;
3173
-
flow: {
3174
-
/**
3175
-
* Format: uuid
3176
-
* @description The unique identifier for the associated Flow.
3177
-
*/
3178
-
id: string;
3179
-
/** @description The title of the associated Flow. */
3180
-
title: string;
3181
-
};
3182
-
run: {
3183
-
/**
3184
-
* Format: uuid
3185
-
* @description The unique identifier for the associated Run.
3186
-
*/
3187
-
id: string;
3188
-
/** @description An optional label for the associated Run. */
3189
-
label: string|null;
3190
-
};
3191
-
/**
3192
-
* Format: date-time
3193
-
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was created.
3194
-
*/
3195
-
created_timestamp: 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: {
3196
3254
/**
3197
-
* Format: date-time
3198
-
* @description A timezone-aware ISO8601 format string that represents the time at which the Web Input was last edited.
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.
3199
3257
*/
3200
-
edited_timestamp: string;
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: {
3201
3273
/**
3202
-
* Format: date-time
3203
-
* @descriptionA timezone-aware ISO8601 format string that represents the time at which the Web Input was closed. Null if the Web Input is still open.
3274
+
* Format: uuid
3275
+
* @descriptionThe unique identifier for the associated Run.
3204
3276
*/
3205
-
closed_timestamp: string|null;
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. */
0 commit comments