@reqquest/ui 1.10.0 → 1.11.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.
@@ -295,6 +295,12 @@ export interface Application {
295
295
  /** The program key this application corresponds to. */
296
296
  programKey: Scalars['String'];
297
297
  requirements: ApplicationRequirement[];
298
+ /** The reason the application was rescinded */
299
+ rescindedReason: (Scalars['String'] | null);
300
+ /** The application rescinded status */
301
+ rescindedStatus: (ApplicationRescindedStatus | null);
302
+ /** The reason the application was restored after previously being rescinded */
303
+ restoredReason: (Scalars['String'] | null);
298
304
  status: ApplicationStatus;
299
305
  /** 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. */
300
306
  statusReason: (Scalars['String'] | null);
@@ -308,6 +314,8 @@ export interface Application {
308
314
  }
309
315
  export interface ApplicationActions {
310
316
  advanceWorkflow: Scalars['Boolean'];
317
+ rescindApplication: Scalars['Boolean'];
318
+ restoreApplication: Scalars['Boolean'];
311
319
  reverseWorkflow: Scalars['Boolean'];
312
320
  viewAsReviewer: Scalars['Boolean'];
313
321
  __typename: 'ApplicationActions';
@@ -318,6 +326,7 @@ export interface ApplicationMetric {
318
326
  closed: Scalars['Float'];
319
327
  denied: Scalars['Float'];
320
328
  entries: ApplicationMetricEntry[];
329
+ rescinded: Scalars['Float'];
321
330
  started: Scalars['Float'];
322
331
  submitted: Scalars['Float'];
323
332
  toDecision: ApplicationMetricTiming;
@@ -385,6 +394,12 @@ export interface ApplicationRequirement {
385
394
  workflowStage: (PeriodWorkflowStage | null);
386
395
  __typename: 'ApplicationRequirement';
387
396
  }
397
+ /**
398
+ *
399
+ * The rescinded status of an application.
400
+ *
401
+ */
402
+ export type ApplicationRescindedStatus = 'RESCINDED' | 'RESTORED';
388
403
  /**
389
404
  *
390
405
  * The status of an application. This is usually a computed field, not stored in the database. The status
@@ -393,7 +408,7 @@ export interface ApplicationRequirement {
393
408
  * closure / cancellation.
394
409
  *
395
410
  */
396
- export type ApplicationStatus = 'ACCEPTED' | 'ELIGIBLE' | 'INELIGIBLE' | 'PENDING' | 'REJECTED';
411
+ export type ApplicationStatus = 'ACCEPTED' | 'ELIGIBLE' | 'INELIGIBLE' | 'PENDING' | 'REJECTED' | 'RESCINDED';
397
412
  export interface Category {
398
413
  /** This is indexed name of the category. Categories are indexed to allow for quick filtering of a list of items. e.g. institutionalRoles */
399
414
  category: Scalars['String'];
@@ -476,6 +491,10 @@ export interface Mutation {
476
491
  markPeriodReviewed: ValidatedPeriodResponse;
477
492
  /** Reopen the app request. This is only available if the app request is in a state that allows reopening. */
478
493
  reopenAppRequest: ValidatedAppRequestResponse;
494
+ /** Rescinds the approved and/or accepted application. */
495
+ rescind: ValidatedAppRequestResponse;
496
+ /** Restores a previously rescinded application to its previous state. */
497
+ restore: ValidatedAppRequestResponse;
479
498
  /** Return the app request to the applicant phase. This is only available if the app request is in a state that allows returning. */
480
499
  returnToApplicant: ValidatedAppRequestResponse;
481
500
  /** If request is complete, undo and return to non-blocking workflow. */
@@ -1145,6 +1164,8 @@ export interface AppRequestFilter {
1145
1164
  /** Only return appRequests that are owned by the current user. */
1146
1165
  own?: (Scalars['Boolean'] | null);
1147
1166
  periodIds?: (Scalars['ID'][] | null);
1167
+ /** 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. */
1168
+ rescindedStatus?: (ApplicationRescindedStatus[] | null);
1148
1169
  /** 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. */
1149
1170
  reviewStarted?: (Scalars['Boolean'] | null);
1150
1171
  /** Search for appRequests that match this search term. This will do a prefix search across all fields that are indexed. */
@@ -1214,6 +1235,12 @@ export interface ApplicationGenqlSelection {
1214
1235
  /** The program key this application corresponds to. */
1215
1236
  programKey?: boolean | number;
1216
1237
  requirements?: ApplicationRequirementGenqlSelection;
1238
+ /** The reason the application was rescinded */
1239
+ rescindedReason?: boolean | number;
1240
+ /** The application rescinded status */
1241
+ rescindedStatus?: boolean | number;
1242
+ /** The reason the application was restored after previously being rescinded */
1243
+ restoredReason?: boolean | number;
1217
1244
  status?: boolean | number;
1218
1245
  /** 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. */
1219
1246
  statusReason?: boolean | number;
@@ -1228,6 +1255,8 @@ export interface ApplicationGenqlSelection {
1228
1255
  }
1229
1256
  export interface ApplicationActionsGenqlSelection {
1230
1257
  advanceWorkflow?: boolean | number;
1258
+ rescindApplication?: boolean | number;
1259
+ restoreApplication?: boolean | number;
1231
1260
  reverseWorkflow?: boolean | number;
1232
1261
  viewAsReviewer?: boolean | number;
1233
1262
  __typename?: boolean | number;
@@ -1239,6 +1268,7 @@ export interface ApplicationMetricGenqlSelection {
1239
1268
  closed?: boolean | number;
1240
1269
  denied?: boolean | number;
1241
1270
  entries?: ApplicationMetricEntryGenqlSelection;
1271
+ rescinded?: boolean | number;
1242
1272
  started?: boolean | number;
1243
1273
  submitted?: boolean | number;
1244
1274
  toDecision?: ApplicationMetricTimingGenqlSelection;
@@ -1509,6 +1539,22 @@ export interface MutationGenqlSelection {
1509
1539
  appRequestId: Scalars['ID'];
1510
1540
  };
1511
1541
  });
1542
+ /** Rescinds the approved and/or accepted application. */
1543
+ rescind?: (ValidatedAppRequestResponseGenqlSelection & {
1544
+ __args: {
1545
+ applicationId: Scalars['ID'];
1546
+ reason: Scalars['String'];
1547
+ validateOnly?: (Scalars['Boolean'] | null);
1548
+ };
1549
+ });
1550
+ /** Restores a previously rescinded application to its previous state. */
1551
+ restore?: (ValidatedAppRequestResponseGenqlSelection & {
1552
+ __args: {
1553
+ applicationId: Scalars['ID'];
1554
+ reason: Scalars['String'];
1555
+ validateOnly?: (Scalars['Boolean'] | null);
1556
+ };
1557
+ });
1512
1558
  /** Return the app request to the applicant phase. This is only available if the app request is in a state that allows returning. */
1513
1559
  returnToApplicant?: (ValidatedAppRequestResponseGenqlSelection & {
1514
1560
  __args: {
@@ -2239,12 +2285,17 @@ export declare const enumApplicationPhase: {
2239
2285
  WORKFLOW_BLOCKING: "WORKFLOW_BLOCKING";
2240
2286
  WORKFLOW_NONBLOCKING: "WORKFLOW_NONBLOCKING";
2241
2287
  };
2288
+ export declare const enumApplicationRescindedStatus: {
2289
+ RESCINDED: "RESCINDED";
2290
+ RESTORED: "RESTORED";
2291
+ };
2242
2292
  export declare const enumApplicationStatus: {
2243
2293
  ACCEPTED: "ACCEPTED";
2244
2294
  ELIGIBLE: "ELIGIBLE";
2245
2295
  INELIGIBLE: "INELIGIBLE";
2246
2296
  PENDING: "PENDING";
2247
2297
  REJECTED: "REJECTED";
2298
+ RESCINDED: "RESCINDED";
2248
2299
  };
2249
2300
  export declare const enumIneligiblePhases: {
2250
2301
  ACCEPTANCE: "ACCEPTANCE";
@@ -533,6 +533,11 @@ input AppRequestFilter {
533
533
  own: Boolean
534
534
  periodIds: [ID!]
535
535
 
536
+ """
537
+ 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.
538
+ """
539
+ rescindedStatus: [ApplicationRescindedStatus!]
540
+
536
541
  """
537
542
  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.
538
543
  """
@@ -791,6 +796,17 @@ type Application {
791
796
  """The program key this application corresponds to."""
792
797
  programKey: String!
793
798
  requirements: [ApplicationRequirement!]!
799
+
800
+ """The reason the application was rescinded"""
801
+ rescindedReason: String
802
+
803
+ """The application rescinded status"""
804
+ rescindedStatus: ApplicationRescindedStatus
805
+
806
+ """
807
+ The reason the application was restored after previously being rescinded
808
+ """
809
+ restoredReason: String
794
810
  status: ApplicationStatus!
795
811
 
796
812
  """
@@ -814,6 +830,8 @@ type Application {
814
830
 
815
831
  type ApplicationActions {
816
832
  advanceWorkflow: Boolean!
833
+ rescindApplication: Boolean!
834
+ restoreApplication: Boolean!
817
835
  reverseWorkflow: Boolean!
818
836
  viewAsReviewer: Boolean!
819
837
  }
@@ -824,6 +842,7 @@ type ApplicationMetric {
824
842
  closed: Float!
825
843
  denied: Float!
826
844
  entries: [ApplicationMetricEntry!]!
845
+ rescinded: Float!
827
846
  started: Float!
828
847
  submitted: Float!
829
848
  toDecision: ApplicationMetricTiming!
@@ -987,6 +1006,19 @@ type ApplicationRequirement {
987
1006
  workflowStage: PeriodWorkflowStage
988
1007
  }
989
1008
 
1009
+ "\n The rescinded status of an application.\n "
1010
+ enum ApplicationRescindedStatus {
1011
+ """
1012
+ The application has been rescinded (pulled back from applicant) post approval.
1013
+ """
1014
+ RESCINDED
1015
+
1016
+ """
1017
+ The application, which was previously rescinded, has now been restored to its state prior to rescinding.
1018
+ """
1019
+ RESTORED
1020
+ }
1021
+
990
1022
  "\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 "
991
1023
  enum ApplicationStatus {
992
1024
  """
@@ -1013,6 +1045,11 @@ enum ApplicationStatus {
1013
1045
  An offer was made to the applicant and at least one ACCEPTANCE requirement is not met (the applicant rejected the offer).
1014
1046
  """
1015
1047
  REJECTED
1048
+
1049
+ """
1050
+ The application has been rescinded (pulled back from applicant) post approval.
1051
+ """
1052
+ RESCINDED
1016
1053
  }
1017
1054
 
1018
1055
  type Category {
@@ -1291,6 +1328,12 @@ type Mutation {
1291
1328
  """
1292
1329
  reopenAppRequest(appRequestId: ID!): ValidatedAppRequestResponse!
1293
1330
 
1331
+ """Rescinds the approved and/or accepted application."""
1332
+ rescind(applicationId: ID!, reason: String!, validateOnly: Boolean): ValidatedAppRequestResponse!
1333
+
1334
+ """Restores a previously rescinded application to its previous state."""
1335
+ restore(applicationId: ID!, reason: String!, validateOnly: Boolean): ValidatedAppRequestResponse!
1336
+
1294
1337
  """
1295
1338
  Return the app request to the applicant phase. This is only available if the app request is in a state that allows returning.
1296
1339
  """
@@ -366,12 +366,17 @@ export const enumApplicationPhase = {
366
366
  WORKFLOW_BLOCKING: 'WORKFLOW_BLOCKING',
367
367
  WORKFLOW_NONBLOCKING: 'WORKFLOW_NONBLOCKING'
368
368
  };
369
+ export const enumApplicationRescindedStatus = {
370
+ RESCINDED: 'RESCINDED',
371
+ RESTORED: 'RESTORED'
372
+ };
369
373
  export const enumApplicationStatus = {
370
374
  ACCEPTED: 'ACCEPTED',
371
375
  ELIGIBLE: 'ELIGIBLE',
372
376
  INELIGIBLE: 'INELIGIBLE',
373
377
  PENDING: 'PENDING',
374
- REJECTED: 'REJECTED'
378
+ REJECTED: 'REJECTED',
379
+ RESCINDED: 'RESCINDED'
375
380
  };
376
381
  export const enumIneligiblePhases = {
377
382
  ACCEPTANCE: 'ACCEPTANCE',
@@ -246,6 +246,7 @@ declare const _default: {
246
246
  logins: number[];
247
247
  own: number[];
248
248
  periodIds: number[];
249
+ rescindedStatus: number[];
249
250
  reviewStarted: number[];
250
251
  search: number[];
251
252
  status: number[];
@@ -293,6 +294,9 @@ declare const _default: {
293
294
  previousWorkflowStage: number[];
294
295
  programKey: number[];
295
296
  requirements: number[];
297
+ rescindedReason: number[];
298
+ rescindedStatus: number[];
299
+ restoredReason: number[];
296
300
  status: number[];
297
301
  statusReason: number[];
298
302
  title: number[];
@@ -302,6 +306,8 @@ declare const _default: {
302
306
  };
303
307
  ApplicationActions: {
304
308
  advanceWorkflow: number[];
309
+ rescindApplication: number[];
310
+ restoreApplication: number[];
305
311
  reverseWorkflow: number[];
306
312
  viewAsReviewer: number[];
307
313
  __typename: number[];
@@ -311,6 +317,7 @@ declare const _default: {
311
317
  closed: number[];
312
318
  denied: number[];
313
319
  entries: number[];
320
+ rescinded: number[];
314
321
  started: number[];
315
322
  submitted: number[];
316
323
  toDecision: number[];
@@ -361,6 +368,7 @@ declare const _default: {
361
368
  workflowStage: number[];
362
369
  __typename: number[];
363
370
  };
371
+ ApplicationRescindedStatus: {};
364
372
  ApplicationStatus: {};
365
373
  Boolean: {};
366
374
  Category: {
@@ -493,6 +501,16 @@ declare const _default: {
493
501
  reopenAppRequest: (number | {
494
502
  appRequestId: (string | number)[];
495
503
  })[];
504
+ rescind: (number | {
505
+ applicationId: (string | number)[];
506
+ reason: (string | number)[];
507
+ validateOnly: number[];
508
+ })[];
509
+ restore: (number | {
510
+ applicationId: (string | number)[];
511
+ reason: (string | number)[];
512
+ validateOnly: number[];
513
+ })[];
496
514
  returnToApplicant: (number | {
497
515
  appRequestId: (string | number)[];
498
516
  })[];