@reqquest/ui 1.9.1 → 1.11.0

package/dist/typed-client/schema.d.ts

@@ -275,8 +275,12 @@ export type AppRequestStatus = 'ACCEPTANCE' | 'ACCEPTED' | 'APPROVAL' | 'APPROVE
 /** An application represents the applicant applying to a specific program. Each appRequest has multiple applications - one per program defined in the system. Some applications are mutually exclusive and/or will be eliminated early based on PREQUAL requirements, but they all technically exist in the data model - there is no concept of picking one application over another, just two applications where one dies and the other survives. */
 export interface Application {
     actions: ApplicationActions;
+    /** A brief description, written for applicants, of the program this application is for. */
+    applicantDescription: (Scalars['String'] | null);
     /** True when at least one reachable prompt on this application has been invalidated and must be re-answered. Status is still computed from the answers on file, so pair status displays with this flag to indicate that a correction is outstanding. */
     awaitingCorrection: Scalars['Boolean'];
+    /** A prose summary of the applicant-side requirements of the program this application is for. Intended to be shown alongside statusReason when the application becomes ineligible before submission, since an applicant disqualified early may never have seen the program's prompts and the statusReason alone lacks context. */
+    eligibilityDescription: (Scalars['String'] | null);
     id: Scalars['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 | null);
@@ -291,6 +295,12 @@ export interface Application {
     /** The program key this application corresponds to. */
     programKey: Scalars['String'];
     requirements: ApplicationRequirement[];
+    /** The reason the application was rescinded */
+    rescindedReason: (Scalars['String'] | null);
+    /** The application rescinded status */
+    rescindedStatus: (ApplicationRescindedStatus | null);
+    /** The reason the application was restored after previously being rescinded */
+    restoredReason: (Scalars['String'] | null);
     status: ApplicationStatus;
     /** When one of the application's requirements is failing or throwing a warning, its reason will be copied here for convenience. If there is a warning and then later a failure, the failure reason will win. */
     statusReason: (Scalars['String'] | null);
@@ -304,6 +314,8 @@ export interface Application {
 }
 export interface ApplicationActions {
     advanceWorkflow: Scalars['Boolean'];
+    rescindApplication: Scalars['Boolean'];
+    restoreApplication: Scalars['Boolean'];
     reverseWorkflow: Scalars['Boolean'];
     viewAsReviewer: Scalars['Boolean'];
     __typename: 'ApplicationActions';
@@ -314,6 +326,7 @@ export interface ApplicationMetric {
     closed: Scalars['Float'];
     denied: Scalars['Float'];
     entries: ApplicationMetricEntry[];
+    rescinded: Scalars['Float'];
     started: Scalars['Float'];
     submitted: Scalars['Float'];
     toDecision: ApplicationMetricTiming;
@@ -381,6 +394,12 @@ export interface ApplicationRequirement {
     workflowStage: (PeriodWorkflowStage | null);
     __typename: 'ApplicationRequirement';
 }
+/**
+ *
+ *     The rescinded status of an application.
+ *
+ */
+export type ApplicationRescindedStatus = 'RESCINDED' | 'RESTORED';
 /**
  *
  *     The status of an application. This is usually a computed field, not stored in the database. The status
@@ -389,7 +408,7 @@ export interface ApplicationRequirement {
  *     closure / cancellation.
  *
  */
-export type ApplicationStatus = 'ACCEPTED' | 'ELIGIBLE' | 'INELIGIBLE' | 'PENDING' | 'REJECTED';
+export type ApplicationStatus = 'ACCEPTED' | 'ELIGIBLE' | 'INELIGIBLE' | 'PENDING' | 'REJECTED' | 'RESCINDED';
 export interface Category {
     /** This is indexed name of the category. Categories are indexed to allow for quick filtering of a list of items. e.g. institutionalRoles */
     category: Scalars['String'];
@@ -472,6 +491,10 @@ export interface Mutation {
     markPeriodReviewed: ValidatedPeriodResponse;
     /** Reopen the app request. This is only available if the app request is in a state that allows reopening. */
     reopenAppRequest: ValidatedAppRequestResponse;
+    /** Rescinds the approved and/or accepted application. */
+    rescind: ValidatedAppRequestResponse;
+    /** Restores a previously rescinded application to its previous state. */
+    restore: 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: ValidatedAppRequestResponse;
     /** If request is complete, undo and return to non-blocking workflow. */
@@ -582,6 +605,10 @@ export interface PeriodActions {
 }
 export interface PeriodProgram {
     actions: PeriodProgramActions;
+    /** A brief description of the program, written for applicants. */
+    applicantDescription: (Scalars['String'] | null);
+    /** A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts. */
+    eligibilityDescription: (Scalars['String'] | null);
     /** Whether the program is enabled in this period. This is set by the system administrator. */
     enabled: Scalars['Boolean'];
     key: Scalars['ID'];
@@ -637,6 +664,10 @@ export interface PeriodWorkflowStage {
     __typename: 'PeriodWorkflowStage';
 }
 export interface Program {
+    /** A brief description of the program, written for applicants. */
+    applicantDescription: (Scalars['String'] | null);
+    /** A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts. */
+    eligibilityDescription: (Scalars['String'] | null);
     key: Scalars['ID'];
     navTitle: Scalars['String'];
     title: Scalars['String'];
@@ -1133,6 +1164,8 @@ export interface AppRequestFilter {
     /** Only return appRequests that are owned by the current user. */
     own?: (Scalars['Boolean'] | null);
     periodIds?: (Scalars['ID'][] | null);
+    /** Only return appRequests where at least one application is in one of the given rescinded states. Rescinding is per-application, so this is independent of the appRequest status. */
+    rescindedStatus?: (ApplicationRescindedStatus[] | null);
     /** Only return appRequests that have had their review started. true -> return review started, false -> return not started. Note that this is NOT mutually exclusive with complete or closed, it very simply means that a non-applicant has taken an action on it. */
     reviewStarted?: (Scalars['Boolean'] | null);
     /** Search for appRequests that match this search term. This will do a prefix search across all fields that are indexed. */
@@ -1182,8 +1215,12 @@ export interface AppRequestNoteFilters {
 /** An application represents the applicant applying to a specific program. Each appRequest has multiple applications - one per program defined in the system. Some applications are mutually exclusive and/or will be eliminated early based on PREQUAL requirements, but they all technically exist in the data model - there is no concept of picking one application over another, just two applications where one dies and the other survives. */
 export interface ApplicationGenqlSelection {
     actions?: ApplicationActionsGenqlSelection;
+    /** A brief description, written for applicants, of the program this application is for. */
+    applicantDescription?: boolean | number;
     /** True when at least one reachable prompt on this application has been invalidated and must be re-answered. Status is still computed from the answers on file, so pair status displays with this flag to indicate that a correction is outstanding. */
     awaitingCorrection?: boolean | number;
+    /** A prose summary of the applicant-side requirements of the program this application is for. Intended to be shown alongside statusReason when the application becomes ineligible before submission, since an applicant disqualified early may never have seen the program's prompts and the statusReason alone lacks context. */
+    eligibilityDescription?: boolean | number;
     id?: boolean | number;
     /** The phase in which this application became ineligible for benefits. Useful for reporting / filtering. Null if the application is not (yet) ineligible. */
     ineligiblePhase?: boolean | number;
@@ -1198,6 +1235,12 @@ export interface ApplicationGenqlSelection {
     /** The program key this application corresponds to. */
     programKey?: boolean | number;
     requirements?: ApplicationRequirementGenqlSelection;
+    /** The reason the application was rescinded */
+    rescindedReason?: boolean | number;
+    /** The application rescinded status */
+    rescindedStatus?: boolean | number;
+    /** The reason the application was restored after previously being rescinded */
+    restoredReason?: boolean | number;
     status?: boolean | number;
     /** When one of the application's requirements is failing or throwing a warning, its reason will be copied here for convenience. If there is a warning and then later a failure, the failure reason will win. */
     statusReason?: boolean | number;
@@ -1212,6 +1255,8 @@ export interface ApplicationGenqlSelection {
 }
 export interface ApplicationActionsGenqlSelection {
     advanceWorkflow?: boolean | number;
+    rescindApplication?: boolean | number;
+    restoreApplication?: boolean | number;
     reverseWorkflow?: boolean | number;
     viewAsReviewer?: boolean | number;
     __typename?: boolean | number;
@@ -1223,6 +1268,7 @@ export interface ApplicationMetricGenqlSelection {
     closed?: boolean | number;
     denied?: boolean | number;
     entries?: ApplicationMetricEntryGenqlSelection;
+    rescinded?: boolean | number;
     started?: boolean | number;
     submitted?: boolean | number;
     toDecision?: ApplicationMetricTimingGenqlSelection;
@@ -1493,6 +1539,22 @@ export interface MutationGenqlSelection {
             appRequestId: Scalars['ID'];
         };
     });
+    /** Rescinds the approved and/or accepted application. */
+    rescind?: (ValidatedAppRequestResponseGenqlSelection & {
+        __args: {
+            applicationId: Scalars['ID'];
+            reason: Scalars['String'];
+            validateOnly?: (Scalars['Boolean'] | null);
+        };
+    });
+    /** Restores a previously rescinded application to its previous state. */
+    restore?: (ValidatedAppRequestResponseGenqlSelection & {
+        __args: {
+            applicationId: Scalars['ID'];
+            reason: Scalars['String'];
+            validateOnly?: (Scalars['Boolean'] | null);
+        };
+    });
     /** Return the app request to the applicant phase. This is only available if the app request is in a state that allows returning. */
     returnToApplicant?: (ValidatedAppRequestResponseGenqlSelection & {
         __args: {
@@ -1734,6 +1796,10 @@ export interface PeriodFilters {
 }
 export interface PeriodProgramGenqlSelection {
     actions?: PeriodProgramActionsGenqlSelection;
+    /** A brief description of the program, written for applicants. */
+    applicantDescription?: boolean | number;
+    /** A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts. */
+    eligibilityDescription?: boolean | number;
     /** Whether the program is enabled in this period. This is set by the system administrator. */
     enabled?: boolean | number;
     key?: boolean | number;
@@ -1801,6 +1867,10 @@ export interface PeriodWorkflowStageGenqlSelection {
     __scalar?: boolean | number;
 }
 export interface ProgramGenqlSelection {
+    /** A brief description of the program, written for applicants. */
+    applicantDescription?: boolean | number;
+    /** A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts. */
+    eligibilityDescription?: boolean | number;
     key?: boolean | number;
     navTitle?: boolean | number;
     title?: boolean | number;
@@ -2215,12 +2285,17 @@ export declare const enumApplicationPhase: {
     WORKFLOW_BLOCKING: "WORKFLOW_BLOCKING";
     WORKFLOW_NONBLOCKING: "WORKFLOW_NONBLOCKING";
 };
+export declare const enumApplicationRescindedStatus: {
+    RESCINDED: "RESCINDED";
+    RESTORED: "RESTORED";
+};
 export declare const enumApplicationStatus: {
     ACCEPTED: "ACCEPTED";
     ELIGIBLE: "ELIGIBLE";
     INELIGIBLE: "INELIGIBLE";
     PENDING: "PENDING";
     REJECTED: "REJECTED";
+    RESCINDED: "RESCINDED";
 };
 export declare const enumIneligiblePhases: {
     ACCEPTANCE: "ACCEPTANCE";

package/dist/typed-client/schema.graphql

@@ -533,6 +533,11 @@ input AppRequestFilter {
   own: Boolean
   periodIds: [ID!]
 
+  """
+  Only return appRequests where at least one application is in one of the given rescinded states. Rescinding is per-application, so this is independent of the appRequest status.
+  """
+  rescindedStatus: [ApplicationRescindedStatus!]
+
   """
   Only return appRequests that have had their review started. true -> return review started, false -> return not started. Note that this is NOT mutually exclusive with complete or closed, it very simply means that a non-applicant has taken an action on it.
   """
@@ -749,10 +754,20 @@ An application represents the applicant applying to a specific program. Each app
 type Application {
   actions: ApplicationActions!
 
+  """
+  A brief description, written for applicants, of the program this application is for.
+  """
+  applicantDescription: String
+
   """
   True when at least one reachable prompt on this application has been invalidated and must be re-answered. Status is still computed from the answers on file, so pair status displays with this flag to indicate that a correction is outstanding.
   """
   awaitingCorrection: Boolean!
+
+  """
+  A prose summary of the applicant-side requirements of the program this application is for. Intended to be shown alongside statusReason when the application becomes ineligible before submission, since an applicant disqualified early may never have seen the program's prompts and the statusReason alone lacks context.
+  """
+  eligibilityDescription: String
   id: ID!
 
   """
@@ -781,6 +796,17 @@ type Application {
   """The program key this application corresponds to."""
   programKey: String!
   requirements: [ApplicationRequirement!]!
+
+  """The reason the application was rescinded"""
+  rescindedReason: String
+
+  """The application rescinded status"""
+  rescindedStatus: ApplicationRescindedStatus
+
+  """
+  The reason the application was restored after previously being rescinded
+  """
+  restoredReason: String
   status: ApplicationStatus!
 
   """
@@ -804,6 +830,8 @@ type Application {
 
 type ApplicationActions {
   advanceWorkflow: Boolean!
+  rescindApplication: Boolean!
+  restoreApplication: Boolean!
   reverseWorkflow: Boolean!
   viewAsReviewer: Boolean!
 }
@@ -814,6 +842,7 @@ type ApplicationMetric {
   closed: Float!
   denied: Float!
   entries: [ApplicationMetricEntry!]!
+  rescinded: Float!
   started: Float!
   submitted: Float!
   toDecision: ApplicationMetricTiming!
@@ -977,6 +1006,19 @@ type ApplicationRequirement {
   workflowStage: PeriodWorkflowStage
 }
 
+"\n    The rescinded status of an application.\n  "
+enum ApplicationRescindedStatus {
+  """
+  The application has been rescinded (pulled back from applicant) post approval.
+  """
+  RESCINDED
+
+  """
+  The application, which was previously rescinded, has now been restored to its state prior to rescinding.
+  """
+  RESTORED
+}
+
 "\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 {
   """
@@ -1003,6 +1045,11 @@ enum ApplicationStatus {
   An offer was made to the applicant and at least one ACCEPTANCE requirement is not met (the applicant rejected the offer).
   """
   REJECTED
+
+  """
+  The application has been rescinded (pulled back from applicant) post approval.
+  """
+  RESCINDED
 }
 
 type Category {
@@ -1281,6 +1328,12 @@ type Mutation {
   """
   reopenAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
 
+  """Rescinds the approved and/or accepted application."""
+  rescind(applicationId: ID!, reason: String!, validateOnly: Boolean): ValidatedAppRequestResponse!
+
+  """Restores a previously rescinded application to its previous state."""
+  restore(applicationId: ID!, reason: String!, validateOnly: Boolean): ValidatedAppRequestResponse!
+
   """
   Return the app request to the applicant phase. This is only available if the app request is in a state that allows returning.
   """
@@ -1518,6 +1571,14 @@ input PeriodFilters {
 type PeriodProgram {
   actions: PeriodProgramActions!
 
+  """A brief description of the program, written for applicants."""
+  applicantDescription: String
+
+  """
+  A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts.
+  """
+  eligibilityDescription: String
+
   """
   Whether the program is enabled in this period. This is set by the system administrator.
   """
@@ -1619,6 +1680,13 @@ type PeriodWorkflowStage {
 }
 
 type Program {
+  """A brief description of the program, written for applicants."""
+  applicantDescription: String
+
+  """
+  A prose summary of the applicant-side requirements of the program. Intended to be shown to applicants who become ineligible before submission, since they may never have seen the program's prompts.
+  """
+  eligibilityDescription: String
   key: ID!
   navTitle: String!
   title: String!

package/dist/typed-client/schema.js

@@ -366,12 +366,17 @@ export const enumApplicationPhase = {
     WORKFLOW_BLOCKING: 'WORKFLOW_BLOCKING',
     WORKFLOW_NONBLOCKING: 'WORKFLOW_NONBLOCKING'
 };
+export const enumApplicationRescindedStatus = {
+    RESCINDED: 'RESCINDED',
+    RESTORED: 'RESTORED'
+};
 export const enumApplicationStatus = {
     ACCEPTED: 'ACCEPTED',
     ELIGIBLE: 'ELIGIBLE',
     INELIGIBLE: 'INELIGIBLE',
     PENDING: 'PENDING',
-    REJECTED: 'REJECTED'
+    REJECTED: 'REJECTED',
+    RESCINDED: 'RESCINDED'
 };
 export const enumIneligiblePhases = {
     ACCEPTANCE: 'ACCEPTANCE',

package/dist/typed-client/types.d.ts

@@ -246,6 +246,7 @@ declare const _default: {
             logins: number[];
             own: number[];
             periodIds: number[];
+            rescindedStatus: number[];
             reviewStarted: number[];
             search: number[];
             status: number[];
@@ -282,7 +283,9 @@ declare const _default: {
         AppRequestStatus: {};
         Application: {
             actions: number[];
+            applicantDescription: number[];
             awaitingCorrection: number[];
+            eligibilityDescription: number[];
             id: number[];
             ineligiblePhase: number[];
             navTitle: number[];
@@ -291,6 +294,9 @@ declare const _default: {
             previousWorkflowStage: number[];
             programKey: number[];
             requirements: number[];
+            rescindedReason: number[];
+            rescindedStatus: number[];
+            restoredReason: number[];
             status: number[];
             statusReason: number[];
             title: number[];
@@ -300,6 +306,8 @@ declare const _default: {
         };
         ApplicationActions: {
             advanceWorkflow: number[];
+            rescindApplication: number[];
+            restoreApplication: number[];
             reverseWorkflow: number[];
             viewAsReviewer: number[];
             __typename: number[];
@@ -309,6 +317,7 @@ declare const _default: {
             closed: number[];
             denied: number[];
             entries: number[];
+            rescinded: number[];
             started: number[];
             submitted: number[];
             toDecision: number[];
@@ -359,6 +368,7 @@ declare const _default: {
             workflowStage: number[];
             __typename: number[];
         };
+        ApplicationRescindedStatus: {};
         ApplicationStatus: {};
         Boolean: {};
         Category: {
@@ -491,6 +501,16 @@ declare const _default: {
             reopenAppRequest: (number | {
                 appRequestId: (string | number)[];
             })[];
+            rescind: (number | {
+                applicationId: (string | number)[];
+                reason: (string | number)[];
+                validateOnly: number[];
+            })[];
+            restore: (number | {
+                applicationId: (string | number)[];
+                reason: (string | number)[];
+                validateOnly: number[];
+            })[];
             returnToApplicant: (number | {
                 appRequestId: (string | number)[];
             })[];
@@ -648,6 +668,8 @@ declare const _default: {
         };
         PeriodProgram: {
             actions: number[];
+            applicantDescription: number[];
+            eligibilityDescription: number[];
             enabled: number[];
             key: number[];
             navTitle: number[];
@@ -695,6 +717,8 @@ declare const _default: {
             __typename: number[];
         };
         Program: {
+            applicantDescription: number[];
+            eligibilityDescription: number[];
             key: number[];
             navTitle: number[];
             title: number[];