@reqquest/ui 1.0.0 → 1.1.0

package/dist/typed-client/schema.graphql

@@ -1,8 +1,13 @@
 type Access {
   """
-  Current user may create a new app request, either for themselves or on behalf of another user.
+  Current user may create a new app request on behalf of another user and should be shown the Create App Request button on the reviewer dashboard or main app request list.
   """
-  createAppRequest: Boolean!
+  createAppRequestOther: Boolean!
+
+  """
+  Current user may create a new app request for themselves and should be shown the Create App Request button.
+  """
+  createAppRequestSelf: Boolean!
 
   """
   Current user is permitted to create new periods in the period management UI.
@@ -14,6 +19,9 @@ type Access {
   """
   createRole: Boolean!
 
+  """The current user, if any."""
+  user: AccessUser
+
   """Current user is permitted to view the app request list."""
   viewAppRequestList: Boolean!
 
@@ -35,6 +43,25 @@ type AccessControl {
   name: String!
 }
 
+type AccessControlGroup {
+  """
+  A list of all possible controls for this controlGroup. Use this to populate the control dropdown when creating a grant.
+  """
+  controls: [AccessControl!]!
+
+  """
+  A longer explanation of the control group for display in the role management interface.
+  """
+  description: String
+  name: String!
+  tags: [AccessTagCategory!]!
+
+  """
+  A slightly longer version of the control group's name, for display in the role management interface.
+  """
+  title: String!
+}
+
 type AccessGrantTag {
   category: String!
   categoryLabel: String!
@@ -50,7 +77,7 @@ type AccessRole {
   """
   description: String
   grants: [AccessRoleGrant!]!
-  groups: [String!]!
+  groups: [AccessRoleGroup!]!
   id: ID!
   name: String!
   scope: String
@@ -66,13 +93,13 @@ input AccessRoleFilter {
 type AccessRoleGrant {
   actions: AccessRoleGrantActions!
 
-  "\n    If true, this grant allows the action specified by the selected controls. If false, it removes\n    the controls.\n\n    Removing a control only happens within the context of a single role. If another role grants the\n    same control, the action is allowed. This is more of an exception system than a denial\n    system. So you can do something like add the \"view\" control to the \"movie\" subject type in one\n    grant, and then in a second grant in the same role, remove it from \"The Princess Bride\". Now you\n    have a role that grants \"view\" on all movies _except_ The Princess Bride. If the user has another role\n    that grants \"view\" on The Princess Bride (or on all movies), they can view it based on that other role.\n  "
+  "\n    If true, this grant allows the action specified by the selected controls. If false, it removes\n    the controls.\n\n    Removing a control only happens within the context of a single role. If another role grants the\n    same control, the action is allowed. This is more of an exception system than a denial\n    system. So you can do something like add the \"view\" control to the \"movie\" control group in one\n    grant, and then in a second grant in the same role, remove it from \"The Princess Bride\". Now you\n    have a role that grants \"view\" on all movies _except_ The Princess Bride. If the user has another role\n    that grants \"view\" on The Princess Bride (or on all movies), they can view it based on that other role.\n  "
   allow: Boolean!
+
+  """The group this control belongs to. e.g. Reviewer - Review Phase"""
+  controlGroup: AccessControlGroup!
   controls: [String!]!
   id: ID!
-
-  """The type of subject this grant applies to, e.g. "movie"."""
-  subjectType: AccessSubjectType!
   tags: [AccessGrantTag!]!
 }
 
@@ -83,12 +110,12 @@ type AccessRoleGrantActions {
 
 input AccessRoleGrantCreate {
   allow: Boolean!
+  controlGroup: String
 
   """
-  A list of controls that are allowed or denied by this grant. Each subjectType has a list of available controls, available under Query.subjectTypes.
+  A list of controls that are allowed or denied by this grant. Each controlGroup has a list of available controls, available under Query.controlGroups.
   """
   controls: [String!]
-  subjectType: String
 
   """
   A list of tags to restrict a grant. For instance, if this is added to a grant on PromptAnswer-update, each tag refers to a subset of App Requests.
@@ -98,12 +125,12 @@ input AccessRoleGrantCreate {
 
 input AccessRoleGrantUpdate {
   allow: Boolean!
+  controlGroup: String
 
   """
-  A list of controls that are allowed or denied by this grant. Each subjectType has a list of available controls, available under Query.subjectTypes.
+  A list of controls that are allowed or denied by this grant. Each controlGroup has a list of available controls, available under Query.controlGroups.
   """
   controls: [String!]
-  subjectType: String
 
   """
   A list of tags to restrict a grant. For instance, if this is added to a grant on PromptAnswer-update, each tag refers to a subset of App Requests.
@@ -111,6 +138,25 @@ input AccessRoleGrantUpdate {
   tags: [AccessTagInput!]
 }
 
+type AccessRoleGroup {
+  """The date the group was added to a role."""
+  dateAdded: DateTime!
+  dateCreated: DateTime!
+
+  """The name of the group. This should be unique even among all roleIds."""
+  groupName: String!
+  managers: [AccessRoleGroupManager!]!
+  roleId: ID!
+}
+
+type AccessRoleGroupManager {
+  """The date the group was added to a role."""
+  email: String
+
+  """The date the group was added to a role."""
+  fullname: String!
+}
+
 input AccessRoleInput {
   """
   A description of the role. This is not used for anything, but can be useful for admins to understand what the role is trying to do.
@@ -135,25 +181,6 @@ type AccessRoleValidatedResponse {
   success: Boolean!
 }
 
-type AccessSubjectType {
-  """
-  A list of all possible controls for this subjectType. Use this to populate the control dropdown when creating a grant.
-  """
-  controls: [AccessControl!]!
-
-  """
-  A longer explanation of the subject type for display in the role management interface.
-  """
-  description: String
-  name: String!
-  tags: [AccessTagCategory!]!
-
-  """
-  A slightly longer version of the subject type's name, for display in the role management interface.
-  """
-  title: String!
-}
-
 type AccessTag {
   label: String!
   value: String!
@@ -190,15 +217,36 @@ type AccessUser {
   A JSON object containing any information about the user that the implementing application wants to store. Could be useful for constructing personalized UI.
   """
   otherInfo: JsonData
-  roles: AccessRole!
+  roles: [AccessRole!]!
+
+  """
+  True as long as the lookupUser.byLogins function still returns this user. False otherwise. Likely this user has been deactivated.
+  """
+  stillValid: Boolean!
+}
+
+"""
+A category and tag pair for an internal and external user related attributes. For example, [{ category: "institutionalRole", tags: ["STAFF", "STUDENT"] }, { category: "lastLogin", tags: ["2025-09-01T10:20:04"] }]
+"""
+input AccessUserCategoryInput {
+  category: ID!
+  tags: [ID!]!
 }
 
 input AccessUserFilter {
   logins: [ID!]
 
+  """
+  One to Many categories Filter, like a institutional role people may belong to.
+  """
+  otherCategoriesByLabel: [AccessUserCategoryInput!]
+
   """Filter by identifiers aside from username, like an Employee ID."""
   otherIdentifiers: [String!]
   otherIdentifiersByLabel: [AccessUserIdentifierInput!]
+
+  """Filter users by associated Application Roles"""
+  roles: [String!]
   search: String
 
   """If true, only return the user that is currently logged in."""
@@ -239,6 +287,7 @@ type AppRequest {
     Filters to apply to the activity log. This can be used to filter by action type, date range, etc.
     """
     filters: AppRequestActivityFilters
+    paged: Pagination
   ): [AppRequestActivity!]!
   applicant: AccessUser!
   applications: [Application!]!
@@ -247,6 +296,7 @@ type AppRequest {
   Date that this request was considered closed and no longer editable. If active or re-opened, will be null. If closed again, will be the second closure date.
   """
   closedAt: DateTime
+  complete: Boolean!
   createdAt: DateTime!
 
   """
@@ -258,6 +308,11 @@ type AppRequest {
     """
     schemaVersion: String
   ): JsonData!
+
+  """
+  The version of the data for this app request. This is incremented every time the data is updated. If you provide it with your update requests, the API will perform an optimistic concurrency check and fail the update if someone else has updated the data in the meantime.
+  """
+  dataVersion: Int!
   id: ID!
 
   """
@@ -270,6 +325,16 @@ type AppRequest {
     for: AppRequestIndexDestination
   ): [AppRequestIndexCategory!]!
 
+  """
+  Notes attached to this app request. Notes are internal only and only visible to reviewers. They are not visible to applicants.
+  """
+  notes(filter: AppRequestNoteFilters): [Note!]!
+
+  """
+  Notes attached to other app requests from this same applicant. Useful for providing context information from previous applications.
+  """
+  otherNotes(filter: AppRequestNoteFilters): [Note!]!
+
   """The period this appRequest is associated with."""
   period: Period!
 
@@ -287,6 +352,11 @@ type AppRequest {
 }
 
 type AppRequestActions {
+  """
+  User may finalize the acceptance or denial of the offer. Sends the app request to non-blocking workflow (or completion).
+  """
+  acceptOffer: Boolean!
+
   """
   User may cancel this app request as the owner. Separate from closing as a reviewer/admin.
   """
@@ -297,8 +367,15 @@ type AppRequestActions {
   """
   close: Boolean!
 
-  """User may make an offer on this app request."""
-  offer: Boolean!
+  """
+  User may complete the app request. All non-blocking workflow must be complete.
+  """
+  completeRequest: Boolean!
+
+  """
+  User may complete the review app request. Sends the app request to the acceptance phase, or if there is no acceptance phase, to the non-blocking workflow or completion.
+  """
+  completeReview: Boolean!
 
   """
   User may reopen this app request, whether as the owner or as a reviewer/admin.
@@ -306,7 +383,20 @@ type AppRequestActions {
   reopen: Boolean!
 
   """User may return this app request to the applicant phase."""
-  return: Boolean!
+  returnToApplicant: Boolean!
+
+  """User may return to the non-blocking workflow phase from completion."""
+  returnToNonBlocking: Boolean!
+
+  """
+  User may return the app request to the acceptance phase from non-blocking workflow or completion.
+  """
+  returnToOffer: Boolean!
+
+  """
+  User may return the app request to the review phase from non-blocking workflow or completion. This does not cover reclaiming an offer - see reverseOffer for that. It also does not cover returning from completion to acceptance - see returnToOffer for that.
+  """
+  returnToReview: Boolean!
 
   """Whether the user can view this app request as a reviewer."""
   review: Boolean!
@@ -373,7 +463,9 @@ input AppRequestActivityFilters {
   """
   impersonatedUsers: [ID!]
 
-  """Return activities that were performed by one of the given logins."""
+  """
+  Return activities that were performed by one of the given logins. Also returns activities that were performed while one of the given logins was impersonating someone else.
+  """
   users: [ID!]
 }
 
@@ -382,15 +474,55 @@ input AppRequestFilter {
   true -> only return appRequests that are closed. false -> only return appRequests that are open. null -> return all appRequests.
   """
   closed: Boolean
+
+  """
+  Only return appRequests that were closed after this date. Open appRequests will be filtered out.
+  """
+  closedAfter: DateTime
+
+  """
+  Only return appRequests that were closed before this date. Open appRequests will be filtered out.
+  """
+  closedBefore: DateTime
+
+  """Only return appRequests that were created after this date."""
+  createdAfter: DateTime
+
+  """Only return appRequests that were created before this date."""
+  createdBefore: DateTime
   ids: [ID!]
 
+  """Only return appRequests that match one of the given indexes."""
+  indexes: [AppRequestIndexFilter!]
+
   """Only return appRequests that are owned by one the given logins."""
   logins: [ID!]
 
   """Only return appRequests that are owned by the current user."""
   own: Boolean
   periodIds: [ID!]
+
+  """
+  Search for appRequests that match this search term. This will do a prefix search across all fields that are indexed.
+  """
+  search: String
   status: [AppRequestStatus!]
+
+  """
+  Only return appRequests that were submitted after this date. App Requests that have not been submitted will be filtered out.
+  """
+  submittedAfter: DateTime
+
+  """
+  Only return appRequests that were submitted before this date. App Requests that have not been submitted will be filtered out.
+  """
+  submittedBefore: DateTime
+
+  """Only return appRequests that were updated after this date."""
+  updatedAfter: DateTime
+
+  """Only return appRequests that were updated before this date."""
+  updatedBefore: DateTime
 }
 
 """
@@ -443,6 +575,24 @@ enum AppRequestIndexDestination {
   REVIEWER_DASHBOARD
 }
 
+input AppRequestIndexFilter {
+  category: String!
+  tags: [String!]!
+}
+
+input AppRequestNoteFilters {
+  """Filter notes to those attached to the specified application requests."""
+  appRequestIds: [ID!]
+
+  """
+  Filter notes to those attached to application requests from the specified applicants (by login name).
+  """
+  applicants: [String!]
+
+  """Filter to the specified note IDs."""
+  ids: [ID!]
+}
+
 "\n    The status of an appRequest. This status is computed based on the \"dbStatus\" recorded in\n    the database and the status of each application.\n  "
 enum AppRequestStatus {
   """
@@ -461,7 +611,7 @@ enum AppRequestStatus {
   APPROVAL
 
   """
-  Applicant has submitted, at least one application is in an approved state, and no applications are pending.
+  Results have been released to the applicant, there is no acceptance phase, and at least one application was found eligible.
   """
   APPROVED
 
@@ -474,10 +624,14 @@ enum AppRequestStatus {
   Applicant has not yet submitted but ALL applications have been disqualified. Applicant may continue editing prompts until the App Request is closed.
   """
   DISQUALIFIED
+
+  """
+  Applicant has responded to the offer, but did not accept an offer on any application.
+  """
   NOT_ACCEPTED
 
   """
-  Applicant has submitted, and ALL applications have been disqualified, no applications are pending.
+  Results have been released to the applicant, there is no acceptance phase, and all applications were found ineligible.
   """
   NOT_APPROVED
 
@@ -486,11 +640,21 @@ enum AppRequestStatus {
   """
   PREAPPROVAL
 
+  """
+  Applicant has been offered, satisfied all acceptance requirements and is ready to accept. This status is unreachable if the period has no ACCEPTANCE requirements.
+  """
+  READY_TO_ACCEPT
+
   """
   Applicant has completed all prompts and is ready to submit. At least one application is eligible to proceed.
   """
   READY_TO_SUBMIT
 
+  """
+  All applications have been reviewed and any blocking workflow stages have been completed. The application is ready for results to be released to the applicant.
+  """
+  REVIEW_COMPLETE
+
   """Applicant has begun the process and has not yet submitted."""
   STARTED
 
@@ -507,8 +671,31 @@ type Application {
   actions: ApplicationActions!
   id: ID!
 
+  """
+  The phase in which this application became ineligible for benefits. Useful for reporting / filtering. Null if the application is not (yet) ineligible.
+  """
+  ineligiblePhase: IneligiblePhases
+
   """The navigation title of the program this application is for."""
   navTitle: String!
+
+  """
+  The next workflow stage for this application that would be active after activating the advanceWorkflow mutation. Null if the application or current user is not allowed to advance.
+  """
+  nextWorkflowStage: PeriodWorkflowStage
+
+  """
+  The phase of the application. This is usually a computed field, not stored in the database.
+  """
+  phase: ApplicationPhase!
+
+  """
+  The previous workflow stage for this application that would be active after activating the reverseWorkflow mutation. Null if the application or current user is not allowed to reverse.
+  """
+  previousWorkflowStage: PeriodWorkflowStage
+
+  """The program key this application corresponds to."""
+  programKey: String!
   requirements: [ApplicationRequirement!]!
   status: ApplicationStatus!
 
@@ -519,12 +706,92 @@ type Application {
 
   """The title of the program this application is for."""
   title: String!
+
+  """
+  If the program has workflow, it may be divided into multiple stages of audit, each with their own requirements/prompts. This indicates which stage we are currently evaluating, or null if we are not in the workflow phase. An application with no workflow defined will never be in the workflow phase. Starts at 1.
+  """
+  workflowStage: PeriodWorkflowStage
+
+  """
+  All workflow stages defined for the program/period of this application, in evaluation order.
+  """
+  workflowStages: [PeriodWorkflowStage!]!
 }
 
 type ApplicationActions {
+  advanceWorkflow: Boolean!
+  reverseWorkflow: Boolean!
   viewAsReviewer: Boolean!
 }
 
+"\n    The phase of the application. This is usually a computed field, not stored in the database. The phase\n    is computed based on the status of the appRequest and of the requirements for the program.\n  "
+enum ApplicationPhase {
+  """
+  The application has been reviewed and an offer has been made to the applicant. The applicant must accept the offer.
+  """
+  ACCEPTANCE
+
+  """
+  The applicant has submitted the application and any PREAPPROVAL requirements are passing. The application is under review.
+  """
+  APPROVAL
+
+  """
+  The application has been reviewed. If there was a workflow, it is complete. If there was an acceptance phase, the offer was accepted or rejected.
+  """
+  COMPLETE
+
+  """
+  The applicant has submitted the application, but there are automated prompts that need to be filled in before the application will appear on a reviewer's dashboard.
+  """
+  PREAPPROVAL
+
+  """
+  The appRequest has not finished pre-qual yet. The application doesn't properly exist yet.
+  """
+  PREQUAL
+
+  """
+  The applicant is filling out their portion of prompts and has not yet finished.
+  """
+  QUALIFICATION
+
+  """
+  No application requirements are PENDING. The application is ready for the first workflow stage, but a reviewer must manually advance the phase. This phase will be automatically skipped if there are no workflow stages configured/enabled.
+  """
+  READY_FOR_WORKFLOW
+
+  """
+  An offer has been made to the applicant. The acceptance requirements are no longer pending, the application is ready to be finalized.
+  """
+  READY_TO_ACCEPT
+
+  """
+  All non-blocking workflow stages are complete. The application is ready to be finalized.
+  """
+  READY_TO_COMPLETE
+
+  """
+  The applicant has filled out their portion of the prompts but has not yet submitted for review.
+  """
+  READY_TO_SUBMIT
+
+  """
+  The application has been reviewed and any blocking workflow stages have been completed. The application is ready for results (whether eligible or not) to be released to the applicant. A reviewer must manually advanced the phase, and will do so for the whole appRequest, not one application at a time. So the application will sit in this state until all applications are REVIEW_COMPLETE. If there is no acceptance phase (because there are no acceptance requirements), or if the application is not eligible, the makeOffer prompt will move the phase to WORKFLOW_NONBLOCKING or COMPLETE.
+  """
+  REVIEW_COMPLETE
+
+  """
+  The application review has been completed and now there is a workflow process to audit the review BEFORE marking the application status as eligible or ineligible. It should remain pending until the blocking workflow stages have been completed. Workflow stages that evaluate to INELIGIBLE will also make the application status INELIGIBLE. Prompts from the applicant and review phases are locked.
+  """
+  WORKFLOW_BLOCKING
+
+  """
+  The application has been offered and accepted and now there is a workflow process to audit the review AFTER marking the application status as eligible or ineligible. Requirements from non-blocking workflow states cannot affect the application status, but the application will not proceed to the complete phase until all workflow stages are non-PENDING.
+  """
+  WORKFLOW_NONBLOCKING
+}
+
 """
 The specific instance of a requirement on a particular application. Stores the status of the requirement, e.g. being satisfied or not.
 """
@@ -553,11 +820,6 @@ type ApplicationRequirement {
   navTitle: String!
   prompts: [RequirementPrompt!]!
 
-  """
-  When true, means that the requirement has not been made moot by an earlier requirement failing. It may still need to be hidden from navigation based on evaluatedInEarlierApplication.
-  """
-  reachable: Boolean!
-
   """
   The smart title for this requirement in the app request's period. For instance, might be "Applicant must have GPA over 3.4" instead of the regular title "Applicant must meet GPA requirement". Will fall back to the regular title for any requirement that does not provide a smart title.
   """
@@ -580,76 +842,82 @@ type ApplicationRequirement {
   The type of requirement. This determines when the requirement is evaluated and who can see the requirement.
   """
   type: RequirementType!
-}
 
-"\n    The status of an application. This is usually a computed field, not stored in the database. The status\n    is computed based on the status of the appRequest and of the requirements for the program. If\n    the appRequest is CLOSED, the status should permanently match the ApplicationStatusDB instead of being\n    computed. If the appRequest is CANCELLED, all applications should be CANCELLED as well.\n  "
-enum ApplicationStatus {
   """
-  The application has been approved and an offer has been submitted for applicant acceptance. This status is only possible for programs with at least one ACCEPTANCE requirement.
+  The stage of the workflow for this requirement. Null if not part of a workflow stage
   """
-  ACCEPTANCE
+  workflowStage: PeriodWorkflowStage
+}
 
+"\n    The status of an application. This is usually a computed field, not stored in the database. The status\n    is computed based on the status of the appRequest and of the requirements for the program. If\n    the appRequest is CLOSED or CANCELLED, this status will remain frozen wherever it was before the\n    closure / cancellation.\n  "
+enum ApplicationStatus {
   """
-  The application's benefit has been accepted by the applicant. This status is only possible for programs with at least one ACCEPTANCE requirement.
+  An offer was made to the applicant and all ACCEPTANCE requirements are met (the applicant accepted the offer).
   """
   ACCEPTED
 
   """
-  The application has been submitted, has passed preapproval, and is awaiting approval.
+  All application requirements up to and including WORKFLOW_BLOCKING requirements are resolving as MET (or NOT_APPLICABLE or WARNING). If there is an acceptance phase, the acceptance is still pending.
   """
-  APPROVAL
+  ELIGIBLE
 
-  """The application has been approved."""
-  APPROVED
-
-  "\n      The appRequest (and thus the application inside it) has been cancelled by the applicant. In\n      some cases, individual programs may have a requirement that the applicant agrees that they\n      desire to apply. In that case the appRequest status is not CANCELLED, and neither is the application\n      status. It will actually be FAILED_PREQUAL or FAILED_QUALIFICATION, and the statusReason of the\n      requirement will explain that the applicant did not wish to pursue the application.\n    "
-  CANCELLED
+  """
+  At least one application requirement up to and including WORKFLOW_BLOCKING requirements is not met. The review cannot proceed, but the first or current stage of the workflow should still continue.
+  """
+  INELIGIBLE
 
   """
-  The applicant is ineligible for the program according to the pre-qual requirements. The application/program should no longer be visible in the UI for this appRequest.
+  The application status has not yet been determined. Further prompts must be answered.
   """
-  FAILED_PREQUAL
+  PENDING
 
   """
-  The applicant is ineligible for the program according to the qualification requirements. The application/program should remain visible in the UI and any applicable statusReason from the associated requirements should be displayed.
+  An offer was made to the applicant and at least one ACCEPTANCE requirement is not met (the applicant rejected the offer).
   """
-  FAILED_QUALIFICATION
+  REJECTED
+}
 
+type Category {
   """
-  The application's benefit was rejected by the applicant. This status is only possible for programs with at least one ACCEPTANCE requirement.
+  This is indexed name of the category. Categories are indexed to allow for quick filtering of a list of items. e.g. institutionalRoles
   """
-  NOT_ACCEPTED
+  category: String!
 
-  """The application has not been approved."""
-  NOT_APPROVED
+  """Displayed Label of the category. e.g. Institutional Roles"""
+  label: String
 
-  """The application has been submitted and is awaiting preapproval."""
-  PREAPPROVAL
+  """
+  IDs are the unique values that may be used to group an items. Multiple IDs may be assigned to an item. i.e. ["Staff", "Faculty", "Student"]
+  """
+  tags: [CategoryTag!]!
 
   """
-  The appRequest has not finished pre-qualification yet. This application does not quite exist yet and probably should not appear in the UI.
+  Set this to true should be available as a filter in the User list view.
   """
-  PREQUAL
+  useInFilters: Boolean
 
   """
-  The application has been pre-qualified and is awaiting further input from the applicant.
+  Set this to true should be displayed as a column in the User list view.
   """
-  QUALIFICATION
+  useInList: Boolean
+}
 
+type CategoryTag {
   """
-  All requirements have been evaluated as MET or NOT_APPLICABLE. The application is ready to be submitted.
+  Displayed Label of the tag in the UI Filter. This value should be unique enough to be distinguishable between other tags within a category type.
   """
-  READY_TO_SUBMIT
+  label: String
 
   """
-  The appRequest (and thus the application inside it) was withdrawn after being submitted. If it is re-opened, it will re-open in submitted state.
+  This is the indexed name of the tagged instance within a category type and is what is stored/searched for in the database.
   """
-  WITHDRAWN
+  tag: String!
 }
 
 type Configuration {
   actions: ConfigurationAccess!
   data: JsonData!
+  fetchedData: JsonData
 
   """The key being configured. Could be a requirement or prompt key."""
   key: String!
@@ -719,24 +987,108 @@ type IndexValue {
   value: String!
 }
 
+enum IneligiblePhases {
+  """The application became ineligible in the acceptance phase."""
+  ACCEPTANCE
+
+  """The application became ineligible in the approval phase."""
+  APPROVAL
+
+  """The application became ineligible in the pre-approval phase."""
+  PREAPPROVAL
+
+  """The application became ineligible in the pre-qualification phase."""
+  PREQUAL
+
+  """The application became ineligible in the qualification phase."""
+  QUALIFICATION
+
+  """The application became ineligible during blocking workflow."""
+  WORKFLOW
+}
+
 """Unstructured JSON data."""
 scalar JsonData
 
 type Mutation {
+  """
+  This is for the applicant to accept or reject the offer that was made based on their app request. The difference between accept and reject is determined by the status of the acceptance requirements. They will still "accept offer" after they answer that they do not want the offer. If there is non-blocking workflow on any applications, the first one in each will begin. Applications without non-blocking workflow will be advanced to the COMPLETE phase. If all applications are complete, the app request will be closed.
+  """
+  acceptOffer(appRequestId: ID!): ValidatedAppRequestResponse!
+
   """Add a note to the app request."""
   addNote(
+    """The content of the note. HTML is expected."""
     content: String!
+  ): ValidatedAppRequestResponse!
+
+  """
+  Moves the application to the next workflow stage. If phase is READY_FOR_WORKFLOW, moves to the first or next blocking workflow stage. If on the last blocking workflow, moves to REVIEW_COMPLETE. If on the last non-blocking workflow, moves the application to COMPLETE. If all applications are COMPLETE, automatically triggers the app request close mutation.
+  """
+  advanceWorkflow(applicationId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Cancel or withdraw the app request, depending on its current phase. This is only available if the app request is in a cancellable state.
+  """
+  cancelAppRequest(
+    appRequestId: ID!
 
     """
-    If true, the note will be marked as internal and only visible to reviewers.
+    If the user is currently viewing some of the app request details, include the dataVersion here to make the cancellation fail when the app request has been updated by another user.
     """
-    internal: Boolean!
+    dataVersion: Int
   ): ValidatedAppRequestResponse!
 
-  """Make an offer on the app request."""
-  offerAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
+  """
+  Close the app request. Generally this is always available and will freeze the request/applications in their current phase/status.
+  """
+  closeAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Complete the app request. This is generally only available if request is in non-blocking workflow and all applications are complete.
+  """
+  completeRequest(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Make an offer on the app request. If all applications are ineligible, or if there are no acceptance requirements, the applications will advance to the non-blocking workflow, or absent that, be marked complete.
+  """
+  completeReview(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """Create a new app request."""
+  createAppRequest(login: String!, periodId: ID!, validateOnly: Boolean): ValidatedAppRequestResponse!
+  createPeriod(copyPeriodId: String, period: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
+  deletePeriod(periodId: ID!): ValidatedResponse!
+  markPeriodReviewed(periodId: ID!, validateOnly: Boolean): ValidatedPeriodResponse!
+
+  """
+  Reopen the app request. This is only available if the app request is in a state that allows reopening.
+  """
+  reopenAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Return the app request to the applicant phase. This is only available if the app request is in a state that allows returning.
+  """
+  returnToApplicant(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """If request is complete, undo and return to non-blocking workflow."""
+  returnToNonBlocking(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Return the app request to the acceptance phase from non-blocking workflow or completion.
+  """
+  returnToOffer(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Return the app request to the review phase from acceptance, non-blocking workflow, or completion.
+  """
+  returnToReview(appRequestId: ID!): ValidatedAppRequestResponse!
+
+  """
+  Moves the application back to the previous workflow stage. If on the first blocking workflow stage, moves back to APPROVAL. If on the first non-blocking workflow, throws an error.
+  """
+  reverseWorkflow(applicationId: ID!): ValidatedAppRequestResponse!
   roleAddGrant(grant: AccessRoleGrantCreate!, roleId: ID!, validateOnly: Boolean): AccessRoleValidatedResponse!
-  roleCreate(role: AccessRoleInput!, validateOnly: Boolean): AccessRoleValidatedResponse!
+  roleCreate(copyRoleId: ID, role: AccessRoleInput!, validateOnly: Boolean): AccessRoleValidatedResponse!
   roleDelete(roleId: ID!): ValidatedResponse!
   roleDeleteGrant(grantId: ID!): AccessRoleValidatedResponse!
   roleUpdate(role: AccessRoleInput!, roleId: ID!, validateOnly: Boolean): AccessRoleValidatedResponse!
@@ -744,11 +1096,21 @@ type Mutation {
 
   """Submit the app request."""
   submitAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
-  updateConfiguration(data: JsonData!, key: String!, periodId: String!, validateOnly: Boolean): ValidatedConfigurationResponse!
-  updatePeriod(id: String!, update: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
+  updateConfiguration(data: JsonData!, key: String!, periodId: ID!, validateOnly: Boolean): ValidatedConfigurationResponse!
+  updatePeriod(periodId: ID!, update: PeriodUpdate!, validateOnly: Boolean): ValidatedPeriodResponse!
+  updatePeriodRequirement(disabled: Boolean!, periodId: String!, requirementKey: String!): ValidatedResponse!
 
   """Update the data for a prompt in this app request."""
-  updatePrompt(data: JsonData!, promptId: ID!, validateOnly: Boolean): ValidatedAppRequestResponse!
+  updatePrompt(
+    data: JsonData!
+
+    """
+    The data version of the app request at the time this prompt was loaded. If provided, the API will perform an optimistic concurrency check and fail the update if someone else has updated the data in the meantime.
+    """
+    dataVersion: Int
+    promptId: ID!
+    validateOnly: Boolean
+  ): ValidatedAppRequestResponse!
 }
 
 type MutationMessage {
@@ -781,6 +1143,68 @@ enum MutationMessageType {
   warning
 }
 
+"""
+An internal note attached to an application request. Notes are always written by reviewers and never visible to applicants. "Messages" are for reviewers and applicants communicating with one another.
+"""
+type Note {
+  actions: NoteActions!
+
+  """The app request this note is attached to."""
+  appRequest: AppRequest!
+
+  """The author of the note."""
+  author: AccessUser!
+
+  """The content of the note in HTML."""
+  content: String!
+  createdAt: DateTime!
+  id: ID!
+}
+
+"""Actions that can be performed on a note."""
+type NoteActions {
+  update: Boolean!
+}
+
+input Pagination {
+  """The page number to retrieve. If not provided, will default to 1."""
+  page: Int
+  perPage: Int
+}
+
+type PaginationInfoWithTotalItems {
+  """
+  List of indexed category data related to items within a page. Often used for filtering items.
+  """
+  categories: [Category!]
+
+  """
+  The current page number, starting at 1. This is always provided - if pagination was not requested, will return 1.
+  """
+  currentPage: Float!
+
+  """
+  Indicates whether requesting the next page would provide more results. Especially useful for models that cannot provide total item count for practical reasons. Note that over time, more results can appear and make this answer wrong, so in some circumstances it makes sense to request another page anyway.
+  """
+  hasNextPage: Boolean!
+
+  """
+  The number of items per page. Null if pagination was not requested/forced because results per page is unlimited.
+  """
+  perPage: Float
+
+  """
+  If possible, the total number of results will be provided. The API may return null if calculating the total is impractical. If pagination was not requested/forced, will equal the result count.
+  """
+  totalItems: Float
+}
+
+type PaginationResponse {
+  accessUsers: PaginationInfoWithTotalItems
+  appRequests: PaginationInfoWithTotalItems
+  appRequestsActivity: PaginationInfoWithTotalItems
+}
+
 type Period {
   actions: PeriodActions!
 
@@ -811,11 +1235,17 @@ type Period {
   programs: [PeriodProgram!]!
   prompts: [PeriodPrompt!]!
   requirements: [PeriodProgramRequirement!]!
+
+  """
+  Whether this period's configurations have been reviewed by an administrator. Newly created periods must be reviewed before they will accept new app requests, even if the open date has passed.
+  """
+  reviewed: Boolean!
 }
 
 type PeriodActions {
+  createAppRequest: Boolean!
+  delete: Boolean!
   update: Boolean!
-  view: Boolean!
 }
 
 input PeriodFilters {
@@ -839,6 +1269,9 @@ input PeriodFilters {
   """Return periods that have any of these IDs."""
   ids: [ID!]
 
+  """Return periods that have any of these names."""
+  names: [String!]
+
   """true -> open periods. false -> closed periods. null -> all periods."""
   openNow: Boolean
 
@@ -858,7 +1291,6 @@ type PeriodProgram {
   Whether the program is enabled in this period. This is set by the system administrator.
   """
   enabled: Boolean!
-  group: PeriodProgramActions!
   key: ID!
   navTitle: String!
   period: Period!
@@ -940,33 +1372,29 @@ input PeriodUpdate {
   openDate: DateTime!
 }
 
-type Program {
-  key: ID!
-  navTitle: String!
-  title: String!
-}
-
-input ProgramFilters {
-  keys: [String!]
-}
-
-type ProgramGroup {
-  key: ID!
-
+type PeriodWorkflowStage {
   """
-  A human readable title for the program group in the navigation. You may want it to be shorter than the full title. If not provided, the title will be used.
+  Whether this stage is blocking. If true, the application cannot be completed and shown to the applicant until all requirements in this stage are satisfied.
   """
-  navTitle: String!
-  programs(filter: ProgramFilters): [Program!]!
+  blocking: Boolean!
 
   """
-  A human readable title for the program group. This will be shown to users.
+  Globally unique key for this workflow stage. Use lowercase snake_case, alphanumeric and underscore only.
   """
+  key: String!
+
+  """A human readable title for the workflow stage."""
+  title: String!
+}
+
+type Program {
+  key: ID!
+  navTitle: String!
   title: String!
 }
 
-input ProgramGroupFilter {
-  keys: [ID!]
+input ProgramFilters {
+  keys: [String!]
 }
 
 """
@@ -978,11 +1406,6 @@ enum PromptVisibility {
   """
   APPLICATION_DUPE
 
-  """
-  The prompt is intended to be filled in by an automation, but is otherwise available to be answered. It may or may not be visible in various UIs but it is not editable in any of them.
-  """
-  AUTOMATION
-
   """
   This RequirementPrompt is available to be answered. It is the first appearance of this prompt in the App Request. It should be visible in both the applicant and reviewer UI.
   """
@@ -1002,7 +1425,7 @@ enum PromptVisibility {
 type Query {
   "\n    This is the global access object. Each field represents a global permission\n    like the ability to view the role management interface.\n  "
   access: Access!
-  accessUsers(filter: AccessUserFilter): [AccessUser!]!
+  accessUsers(filter: AccessUserFilter, paged: Pagination): [AccessUser!]!
   appRequestIndexes(
     categories: [String!]
 
@@ -1011,9 +1434,14 @@ type Query {
     """
     for: AppRequestIndexDestination
   ): [IndexCategory!]!
-  appRequests(filter: AppRequestFilter): [AppRequest!]!
+  appRequests(filter: AppRequestFilter, paged: Pagination): [AppRequest!]!
+
+  """
+  This is where you get information about the authorization system. Each grant will be associated with one of these controlGroups, one or more controls in the group, and an optional set of tags. The tags are used to limit the scope of the grant.
+  """
+  controlGroups: [AccessControlGroup!]!
+  pageInfo: PaginationResponse!
   periods(filter: PeriodFilters): [Period!]!
-  programGroups(filter: ProgramGroupFilter): [ProgramGroup!]!
   programs(filter: ProgramFilters): [Program!]!
   roles(filter: AccessRoleFilter): [AccessRole!]!
 
@@ -1021,11 +1449,6 @@ type Query {
   A list of all possible scopes. Scopes are used to limit users when they are accessing the system through an alternate UI or login method. For instance, if you generate an authentication token to give to a third party, it may have a scope identifying that third party and limiting their access even though they are acting as you. Roles must match the token scope in order to apply permissions.
   """
   scopes: [String!]!
-
-  """
-  This is where you get information about the authorization system. Each grant will be associated with one of these subjectTypes and optionally a list of subject instances. The grant will also have a set of controls, and each control will have an optional set of tags. The tags are used to limit the scope of the grant.
-  """
-  subjectTypes: [AccessSubjectType!]!
 }
 
 """
@@ -1035,17 +1458,14 @@ type RequirementPrompt {
   """Actions that the user can take on this prompt."""
   actions: RequirementPromptActions!
 
-  """Whether the prompt has been answered on this request."""
+  """
+  Whether the prompt has been answered on this request. Note that the answer may be marked invalidated, which means that even though it has been answered, the current answer can't be used and the user needs to answer it again.
+  """
   answered: Boolean!
 
   """The configuration data for this prompt in the app request's period."""
   configurationData: JsonData!
 
-  """
-  All the configuration data that could be relevant for this prompt. This includes its own config, and also the config data for any requirements and programs that are related to it.
-  """
-  configurationRelatedData: JsonData!
-
   """
   The data that has been gathered from the user in response to this prompt. The schema is controlled by the question's implementation.
   """
@@ -1062,7 +1482,7 @@ type RequirementPrompt {
   description: String
 
   """
-  Any data that the API needs to provide to the UI to display the prompt properly. For instance, if the prompt text is in the database and able to be modified by admins, the UI can't hardcode the prompt text and needs it from the API. Could also be used to pull reference information from an external system, e.g. a student's course schedule, for display in the prompt dialog.
+  Any data that the API needs to provide to the UI to build the prompt form properly. For instance, it could pull reference information from an external system, e.g. a student's course schedule, for display in the prompt dialog. Null if the user is not currently allowed to update the prompt.
   """
   fetchedData(
     """
@@ -1070,18 +1490,33 @@ type RequirementPrompt {
     """
     schemaVersion: String
   ): JsonData
+
+  """
+  Extra configuration data that is relevant for this prompt. This configuration is explicitly gathered from related requirements and prompts by the gatherConfig function in the prompt definition.
+  """
+  gatheredConfigData: JsonData!
   id: ID!
 
   """
-  When true, this prompt has been invalidated by the answer to another prompt. The `answered` field should remain false until the user specifically answers this prompt again, regardless of the output of the definition's `complete` method.
+  When true, this prompt has been invalidated by the answer to another prompt. The `answered` field will remain true so be sure to check this field as well when determining whether the prompt is complete.
   """
   invalidated: Boolean!
 
+  """
+  If the prompt has been invalidated, this may contain a reason why. It should be displayed to the user.
+  """
+  invalidatedReason: String
+
   """
   A human and machine readable identifier for the prompt. Will be used to match prompt data with UI and API code that handles it.
   """
   key: String!
 
+  """
+  This prompt's requirement follows a requirement that has already marked the application as ineligible. The prompt still has visibility of AVAILABLE OR REQUEST_DUPE OR APPLICATION_DUPE as normal, but should probably be shown to the user as disabled or not shown at all.
+  """
+  moot: Boolean!
+
   """
   A human readable title for the prompt in the navigation. You probably want it to be shorter than the full title. If not provided, the title will be used.
   """
@@ -1170,6 +1605,11 @@ enum RequirementType {
   A requirement that should have a non-pending status before an application may be submitted for review. Programs with a DISQUALIFYING requirement of type APPLICATION should be visible to the submitter but visually distinct as disabled/ineligible.
   """
   QUALIFICATION
+
+  """
+  This requirement belongs to a workflow stage. It should only be included in a workflow stage and should not appear in the standard requirementKeys array of a program.
+  """
+  WORKFLOW
 }
 
 type RoleActions {
@@ -1178,7 +1618,7 @@ type RoleActions {
 }
 
 type ValidatedAppRequestResponse {
-  appRequest: AppRequest!
+  appRequest: AppRequest
   messages: [MutationMessage!]!
 
   """