@oxide/turnstile.ts 0.7.0-rc.0 → 0.7.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/dist/{Api-Z7zZcVks.d.cts → Api-Mqr0O9hE.d.cts} +91 -10
- package/dist/{Api-Z7zZcVks.d.ts → Api-Mqr0O9hE.d.ts} +91 -10
- package/dist/Api.cjs +63 -0
- package/dist/Api.d.cts +1 -1
- package/dist/Api.d.ts +1 -1
- package/dist/Api.js +63 -0
- package/dist/retry.cjs +63 -0
- package/dist/retry.d.cts +1 -1
- package/dist/retry.d.ts +1 -1
- package/dist/retry.js +63 -0
- package/dist/validate.cjs +20 -6
- package/dist/validate.d.cts +370 -251
- package/dist/validate.d.ts +370 -251
- package/dist/validate.js +19 -6
- package/package.json +1 -1
- package/src/Api.ts +118 -10
- package/src/validate.ts +19 -6
|
@@ -88,7 +88,7 @@ type TypedUuidForAccessGroupId = string;
|
|
|
88
88
|
type TypedUuidForMapperId = string;
|
|
89
89
|
type TypedUuidForOAuthClientId = string;
|
|
90
90
|
type TypedUuidForMagicLinkId = string;
|
|
91
|
-
type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'ScheduleNotification' | 'SendNotification' | 'GetApplicantsAssigned' | 'GetApplicantsAll' | 'GetApplicantSelf' | 'CreateApplicantsAssigned' | 'CreateApplicantsAll' | 'CreateApplicantSelf' | 'ManageApplicantsAssigned' | 'ManageApplicantsAll' | 'ManageApplicantSelf' | 'GetApplicationsAssigned' | 'GetApplicationsAll' | 'CreateApplicationAssigned' | 'CreateApplicationSelf' | 'SubmitApplicationsAssigned' | 'WithdrawApplicationsAssigned' | 'ManageApplicationsAssigned' | 'ManageApplicationsAll' | 'GetDocumentsAssigned' | 'GetDocumentsAll' | 'CreateDocument' | 'ManageDocumentsAssigned' | 'ManageDocumentsAll' | 'AttachDocumentsAssigned' | 'AttachDocumentsAll' | 'GetDepartmentsAssigned' | 'GetDepartmentsAll' | 'CreateDepartment' | 'GetRolesAssigned' | 'GetRolesAll' | 'CreateRole' | 'GetListingsAssigned' | 'GetListingsAll' | 'CreateListing' | 'ManageListingsAll' | 'GetPoolsAssigned' | 'GetPoolsAll' | 'CreatePool' | 'ManagePoolsAll' | 'GetReviewersAssigned' | 'GetReviewersAll' | 'GetReviewerSelf' | 'CreateReviewersAssigned' | 'CreateReviewersAll' | 'CreateReviewerSelf' | 'GetReviewsAssigned' | 'GetReviewsAll' | 'CreateReview' | 'ManageReviewsAssigned' | 'ManageReviewsAll' | 'GetReviewAssignmentsAll' | 'CompleteReviewAssignmentSelf' | 'CompleteReviewAssignmentsAll' | 'ManageReviewAssignmentsAll' | 'GetReviewSummariesAll' | 'GetInterviewersAssigned' | 'GetInterviewersAll' | 'CreateInterviewersAssigned' | 'CreateInterviewersAll' | 'CreateInterviewerSelf' | 'ManageInterviewersAssigned' | 'ManageInterviewersAll' | 'GetInterviewsAssigned' | 'GetInterviewsAll' | 'CreateInterview' | 'ManageInterviewsAssigned' | 'ManageInterviewsAll' | 'GetBackgroundChecksAssigned' | 'GetBackgroundChecksAll' | 'CreateBackgroundChecksAll' | 'ManageBackgroundChecksAssigned' | 'ManageBackgroundChecksAll' | 'GetEnvelope' | 'SendEnvelope' | 'GetEmployeesAssigned' | 'GetEmployeesAll' | 'CreateEmployee' | 'ManageEmployeesAssigned' | 'ManageEmployeesAll' | 'GetOnboardingsAll' | 'CreateOnboarding' | 'GetBatchOperationsAssigned' | 'GetBatchOperationsAll' | 'CreateBatchOperation' | 'ManageBatchOperationsAll' | 'CreateApiUser' | 'GetApiUserSelf' | 'GetApiUsersAssigned' | 'GetApiUsersAll' | 'ManageApiUsersAssigned' | 'ManageApiUsersAll' | 'CreateApiKeySelf' | 'CreateApiKeyAssigned' | 'CreateApiKeyAll' | 'GetApiKeysAssigned' | 'GetApiKeysAll' | 'ManageApiKeysAssigned' | 'ManageApiKeysAll' | 'CreateUserApiProviderLinkToken' | 'CreateGroup' | 'GetGroupsJoined' | 'GetGroupsAll' | 'ManageGroupsAssigned' | 'ManageGroupsAll' | 'ManageGroupMembershipsAssigned' | 'ManageGroupMembershipsAll' | 'CreateMapper' | 'GetMappersAll' | 'ManageMappersAssigned' | 'ManageMappersAll' | 'CreateOAuthClient' | 'GetOAuthClientsAssigned' | 'GetOAuthClientsAll' | 'ManageOAuthClientsAssigned' | 'ManageOAuthClientsAll' | 'CreateMagicLinkClient' | 'GetMagicLinkClientsAssigned' | 'GetMagicLinkClientsAll' | 'ManageMagicLinkClientsAssigned' | 'ManageMagicLinkClientsAll' | 'CreateAccessToken' | {
|
|
91
|
+
type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'ScheduleNotification' | 'SendNotification' | 'GetApplicantsAssigned' | 'GetApplicantsAll' | 'GetApplicantSelf' | 'CreateApplicantsAssigned' | 'CreateApplicantsAll' | 'CreateApplicantSelf' | 'ManageApplicantsAssigned' | 'ManageApplicantsAll' | 'ManageApplicantSelf' | 'GetApplicationsAssigned' | 'GetApplicationsAll' | 'CreateApplicationAssigned' | 'CreateApplicationSelf' | 'SubmitApplicationsAssigned' | 'WithdrawApplicationsAssigned' | 'ManageApplicationsAssigned' | 'ManageApplicationsAll' | 'GetApplicationSummariesAll' | 'GetDocumentsAssigned' | 'GetDocumentsAll' | 'CreateDocument' | 'ManageDocumentsAssigned' | 'ManageDocumentsAll' | 'AttachDocumentsAssigned' | 'AttachDocumentsAll' | 'GetDepartmentsAssigned' | 'GetDepartmentsAll' | 'CreateDepartment' | 'GetRolesAssigned' | 'GetRolesAll' | 'CreateRole' | 'GetListingsAssigned' | 'GetListingsAll' | 'CreateListing' | 'ManageListingsAll' | 'GetPoolsAssigned' | 'GetPoolsAll' | 'CreatePool' | 'ManagePoolsAll' | 'GetReviewersAssigned' | 'GetReviewersAll' | 'GetReviewerSelf' | 'CreateReviewersAssigned' | 'CreateReviewersAll' | 'CreateReviewerSelf' | 'GetReviewsAssigned' | 'GetReviewsAll' | 'CreateReview' | 'ManageReviewsAssigned' | 'ManageReviewsAll' | 'GetReviewAssignmentsAll' | 'CompleteReviewAssignmentSelf' | 'CompleteReviewAssignmentsAll' | 'ManageReviewAssignmentsAll' | 'GetReviewSummariesAll' | 'GetInterviewersAssigned' | 'GetInterviewersAll' | 'CreateInterviewersAssigned' | 'CreateInterviewersAll' | 'CreateInterviewerSelf' | 'ManageInterviewersAssigned' | 'ManageInterviewersAll' | 'GetInterviewsAssigned' | 'GetInterviewsAll' | 'CreateInterview' | 'ManageInterviewsAssigned' | 'ManageInterviewsAll' | 'GetBackgroundChecksAssigned' | 'GetBackgroundChecksAll' | 'CreateBackgroundChecksAll' | 'ManageBackgroundChecksAssigned' | 'ManageBackgroundChecksAll' | 'GetEnvelope' | 'SendEnvelope' | 'GetEmployeesAssigned' | 'GetEmployeesAll' | 'CreateEmployee' | 'ManageEmployeesAssigned' | 'ManageEmployeesAll' | 'GetOnboardingsAll' | 'CreateOnboarding' | 'GetBatchOperationsAssigned' | 'GetBatchOperationsAll' | 'CreateBatchOperation' | 'ManageBatchOperationsAll' | 'CreateApiUser' | 'GetApiUserSelf' | 'GetApiUsersAssigned' | 'GetApiUsersAll' | 'ManageApiUsersAssigned' | 'ManageApiUsersAll' | 'CreateApiKeySelf' | 'CreateApiKeyAssigned' | 'CreateApiKeyAll' | 'GetApiKeysAssigned' | 'GetApiKeysAll' | 'ManageApiKeysAssigned' | 'ManageApiKeysAll' | 'CreateUserApiProviderLinkToken' | 'CreateGroup' | 'GetGroupsJoined' | 'GetGroupsAll' | 'ManageGroupsAssigned' | 'ManageGroupsAll' | 'ManageGroupMembershipsAssigned' | 'ManageGroupMembershipsAll' | 'CreateMapper' | 'GetMappersAll' | 'ManageMappersAssigned' | 'ManageMappersAll' | 'CreateOAuthClient' | 'GetOAuthClientsAssigned' | 'GetOAuthClientsAll' | 'ManageOAuthClientsAssigned' | 'ManageOAuthClientsAll' | 'CreateMagicLinkClient' | 'GetMagicLinkClientsAssigned' | 'GetMagicLinkClientsAll' | 'ManageMagicLinkClientsAssigned' | 'ManageMagicLinkClientsAll' | 'CreateAccessToken' | {
|
|
92
92
|
'GetApplicant': TypedUuidForApplicantId;
|
|
93
93
|
} | {
|
|
94
94
|
'GetApplicants': TypedUuidForApplicantId[];
|
|
@@ -417,12 +417,16 @@ type ApplicationStateRecord = {
|
|
|
417
417
|
'updatedAt': Date;
|
|
418
418
|
};
|
|
419
419
|
type ListingPoolAssociation = 'first' | 'early_positive' | 'positive';
|
|
420
|
-
type
|
|
421
|
-
|
|
422
|
-
'
|
|
423
|
-
|
|
420
|
+
type TriageReason = 'has_no_ratings' | 'likely_next_steps' | 'likely_pass' | 'possibly_next_steps' | 'possibly_pass' | 'very_likely_pass' | 'unknown';
|
|
421
|
+
type PoolAction = 'drop' | 'wait' | {
|
|
422
|
+
'add': {
|
|
423
|
+
'association': ListingPoolAssociation;
|
|
424
|
+
'count': number;
|
|
425
|
+
};
|
|
424
426
|
} | {
|
|
425
|
-
'
|
|
427
|
+
'triage': {
|
|
428
|
+
'reason': TriageReason;
|
|
429
|
+
};
|
|
426
430
|
};
|
|
427
431
|
type ReviewScore = 'emphatic_yes' | 'yes' | 'pass' | 'no' | 'emphatic_no' | 'incomplete';
|
|
428
432
|
type Reviews = {
|
|
@@ -455,11 +459,15 @@ type ApplicationSummaryResponse = {
|
|
|
455
459
|
'users': Evaluator[];
|
|
456
460
|
};
|
|
457
461
|
type AssignPool = {
|
|
462
|
+
/** Review stage of the listing this pool should be associated to */
|
|
458
463
|
'association': ListingPoolAssociation;
|
|
464
|
+
/** Listing to assign this pool to */
|
|
459
465
|
'listing': TypedUuidForListingId;
|
|
460
466
|
};
|
|
461
467
|
type AttachDocument = {
|
|
468
|
+
/** Id assigned to the document by the external datastore */
|
|
462
469
|
'externalId': string;
|
|
470
|
+
/** Mime type of the document */
|
|
463
471
|
'mime'?: string;
|
|
464
472
|
};
|
|
465
473
|
type EmailConfig = {
|
|
@@ -473,6 +481,7 @@ type TransitionMessage = 'default' | 'omit' | {
|
|
|
473
481
|
'custom': EmailConfig;
|
|
474
482
|
};
|
|
475
483
|
type TransitionBody = {
|
|
484
|
+
/** The message to send to the applicant */
|
|
476
485
|
'message': TransitionMessage;
|
|
477
486
|
};
|
|
478
487
|
type BatchParameter_for_TransitionBody = {
|
|
@@ -481,6 +490,7 @@ type BatchParameter_for_TransitionBody = {
|
|
|
481
490
|
'each': TransitionBody[];
|
|
482
491
|
};
|
|
483
492
|
type ViewApplication = {
|
|
493
|
+
/** Application to operate on */
|
|
484
494
|
'application': TypedUuidForApplicationId;
|
|
485
495
|
};
|
|
486
496
|
type BatchParameter_for_ViewApplication = {
|
|
@@ -489,7 +499,9 @@ type BatchParameter_for_ViewApplication = {
|
|
|
489
499
|
'each': ViewApplication[];
|
|
490
500
|
};
|
|
491
501
|
type CreateApplication = {
|
|
502
|
+
/** Applicant to create an application for */
|
|
492
503
|
'applicant': TypedUuidForApplicantId;
|
|
504
|
+
/** Listing to apply to */
|
|
493
505
|
'listing': TypedUuidForListingId;
|
|
494
506
|
};
|
|
495
507
|
type CreateDepartment = {
|
|
@@ -515,9 +527,12 @@ type CreateMapper = {
|
|
|
515
527
|
'rule': Record<string, unknown>;
|
|
516
528
|
};
|
|
517
529
|
type CreatePool = {
|
|
530
|
+
/** Optional description of the pool */
|
|
518
531
|
'description'?: string;
|
|
532
|
+
/** Required display name for the pool */
|
|
519
533
|
'name': string;
|
|
520
|
-
|
|
534
|
+
/** List of reviewers to assign to this pool */
|
|
535
|
+
'reviewers'?: TypedUuidForReviewerId[];
|
|
521
536
|
};
|
|
522
537
|
type CreateReview = {
|
|
523
538
|
'application': TypedUuidForApplicationId;
|
|
@@ -538,8 +553,10 @@ type CreateReviewAssignments = {
|
|
|
538
553
|
* Failures that can occur when assigning a reviewer
|
|
539
554
|
*/
|
|
540
555
|
type ReviewAssignmentCreationError =
|
|
556
|
+
/** A requested object resource already exist */
|
|
557
|
+
'Conflict'
|
|
541
558
|
/** A requested object resource does not exist */
|
|
542
|
-
'DoesNotExist'
|
|
559
|
+
| 'DoesNotExist'
|
|
543
560
|
/** Caller does not have access to a require object resource */
|
|
544
561
|
| 'Forbidden'
|
|
545
562
|
/** Internal server error */
|
|
@@ -850,6 +867,7 @@ type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchE
|
|
|
850
867
|
'updatedAt': Date;
|
|
851
868
|
};
|
|
852
869
|
type OptionalTransitionBody = {
|
|
870
|
+
/** An optional message to send to the applicant */
|
|
853
871
|
'message'?: EmailConfig;
|
|
854
872
|
};
|
|
855
873
|
type Pool = {
|
|
@@ -1302,10 +1320,19 @@ declare class Api extends HttpClient {
|
|
|
1302
1320
|
path: UpdateApplicantContactPathParams;
|
|
1303
1321
|
body: UpdateApplicantContact;
|
|
1304
1322
|
}, params?: FetchParams) => Promise<ApiResult<ApplicantInfo>>;
|
|
1323
|
+
/**
|
|
1324
|
+
* View all applications
|
|
1325
|
+
*/
|
|
1305
1326
|
listApplications: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Application[]>>;
|
|
1327
|
+
/**
|
|
1328
|
+
* Create a new application
|
|
1329
|
+
*/
|
|
1306
1330
|
createApplication: ({ body, }: {
|
|
1307
1331
|
body: CreateApplication;
|
|
1308
1332
|
}, params?: FetchParams) => Promise<ApiResult<CreatedApplication>>;
|
|
1333
|
+
/**
|
|
1334
|
+
* View an application
|
|
1335
|
+
*/
|
|
1309
1336
|
viewApplication: ({ path, }: {
|
|
1310
1337
|
path: ViewApplicationPathParams;
|
|
1311
1338
|
}, params?: FetchParams) => Promise<ApiResult<Application>>;
|
|
@@ -1331,13 +1358,22 @@ declare class Api extends HttpClient {
|
|
|
1331
1358
|
viewApplicationBundle: ({ path, }: {
|
|
1332
1359
|
path: ViewApplicationBundlePathParams;
|
|
1333
1360
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationBundle>>;
|
|
1361
|
+
/**
|
|
1362
|
+
* Attach an uploaded document to an application
|
|
1363
|
+
*/
|
|
1334
1364
|
attachDocument: ({ path, body, }: {
|
|
1335
1365
|
path: AttachDocumentPathParams;
|
|
1336
1366
|
body: AttachDocument;
|
|
1337
1367
|
}, params?: FetchParams) => Promise<ApiResult<Document>>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Generate a pre-signed upload url for uploading a document to an application
|
|
1370
|
+
*/
|
|
1338
1371
|
createDocumentUploadUrl: ({ path, }: {
|
|
1339
1372
|
path: CreateDocumentUploadUrlPathParams;
|
|
1340
1373
|
}, params?: FetchParams) => Promise<ApiResult<DocumentUploadUrlResponse>>;
|
|
1374
|
+
/**
|
|
1375
|
+
* Retrieve the interview code associated with an application
|
|
1376
|
+
*/
|
|
1341
1377
|
getApplicationInterviewCode: ({ path, }: {
|
|
1342
1378
|
path: GetApplicationInterviewCodePathParams;
|
|
1343
1379
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationInterviewCode>>;
|
|
@@ -1347,36 +1383,63 @@ declare class Api extends HttpClient {
|
|
|
1347
1383
|
simulateReviewAction: ({ path, }: {
|
|
1348
1384
|
path: SimulateReviewActionPathParams;
|
|
1349
1385
|
}, params?: FetchParams) => Promise<ApiResult<PoolAction>>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Submit an application that has all required documents attached
|
|
1388
|
+
*/
|
|
1350
1389
|
submitApplication: ({ path, }: {
|
|
1351
1390
|
path: SubmitApplicationPathParams;
|
|
1352
1391
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Move an application to the Declined stage
|
|
1394
|
+
*/
|
|
1353
1395
|
transitionApplicationToDeclined: ({ path, body, }: {
|
|
1354
1396
|
path: TransitionApplicationToDeclinedPathParams;
|
|
1355
1397
|
body: TransitionBody;
|
|
1356
1398
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1399
|
+
/**
|
|
1400
|
+
* Move an application to the Deferred stage
|
|
1401
|
+
*/
|
|
1357
1402
|
transitionApplicationToDeferred: ({ path, body, }: {
|
|
1358
1403
|
path: TransitionApplicationToDeferredPathParams;
|
|
1359
1404
|
body: TransitionBody;
|
|
1360
1405
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1406
|
+
/**
|
|
1407
|
+
* Move an application to the Interviewing stage
|
|
1408
|
+
*/
|
|
1361
1409
|
transitionApplicationToInterviewing: ({ path, body, }: {
|
|
1362
1410
|
path: TransitionApplicationToInterviewingPathParams;
|
|
1363
1411
|
body: OptionalTransitionBody;
|
|
1364
1412
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1413
|
+
/**
|
|
1414
|
+
* Move an application to the Next Steps stage
|
|
1415
|
+
*/
|
|
1365
1416
|
transitionApplicationToNextSteps: ({ path, body, }: {
|
|
1366
1417
|
path: TransitionApplicationToNextStepsPathParams;
|
|
1367
1418
|
body: OptionalTransitionBody;
|
|
1368
1419
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Move an application to the Offer stage
|
|
1422
|
+
*/
|
|
1369
1423
|
transitionApplicationToOffer: ({ path, body, }: {
|
|
1370
1424
|
path: TransitionApplicationToOfferPathParams;
|
|
1371
1425
|
body: OptionalTransitionBody;
|
|
1372
1426
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1427
|
+
/**
|
|
1428
|
+
* Move an application to the Withdrawn stage
|
|
1429
|
+
*/
|
|
1373
1430
|
transitionApplicationToWithdrawn: ({ path, body, }: {
|
|
1374
1431
|
path: TransitionApplicationToWithdrawnPathParams;
|
|
1375
1432
|
body: OptionalTransitionBody;
|
|
1376
1433
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1434
|
+
/**
|
|
1435
|
+
* List all application summaries
|
|
1436
|
+
*/
|
|
1377
1437
|
listApplicationSummaries: ({ query, }: {
|
|
1378
1438
|
query?: ListApplicationSummariesQueryParams;
|
|
1379
1439
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationSummariesResponse>>;
|
|
1440
|
+
/**
|
|
1441
|
+
* View a summary that includes an application and the related evaluations
|
|
1442
|
+
*/
|
|
1380
1443
|
viewApplicationSummary: ({ path, }: {
|
|
1381
1444
|
path: ViewApplicationSummaryPathParams;
|
|
1382
1445
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationSummaryResponse>>;
|
|
@@ -1633,21 +1696,39 @@ declare class Api extends HttpClient {
|
|
|
1633
1696
|
deleteOauthClientSecret: ({ path, }: {
|
|
1634
1697
|
path: DeleteOauthClientSecretPathParams;
|
|
1635
1698
|
}, params?: FetchParams) => Promise<ApiResult<OAuthClientSecret>>;
|
|
1699
|
+
/**
|
|
1700
|
+
* List reviewer pools and their associations
|
|
1701
|
+
*/
|
|
1636
1702
|
listPools: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Pool[]>>;
|
|
1703
|
+
/**
|
|
1704
|
+
* Create a new pool
|
|
1705
|
+
*/
|
|
1637
1706
|
createPool: ({ body, }: {
|
|
1638
1707
|
body: CreatePool;
|
|
1639
1708
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1709
|
+
/**
|
|
1710
|
+
* View a pool and its associations
|
|
1711
|
+
*/
|
|
1640
1712
|
viewPool: ({ path, }: {
|
|
1641
1713
|
path: ViewPoolPathParams;
|
|
1642
1714
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1715
|
+
/**
|
|
1716
|
+
* Update a pool
|
|
1717
|
+
*/
|
|
1643
1718
|
updatePool: ({ path, body, }: {
|
|
1644
1719
|
path: UpdatePoolPathParams;
|
|
1645
1720
|
body: CreatePool;
|
|
1646
1721
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1722
|
+
/**
|
|
1723
|
+
* Assign a pool to a listing
|
|
1724
|
+
*/
|
|
1647
1725
|
assignPool: ({ path, body, }: {
|
|
1648
1726
|
path: AssignPoolPathParams;
|
|
1649
1727
|
body: AssignPool;
|
|
1650
|
-
}, params?: FetchParams) => Promise<ApiResult<
|
|
1728
|
+
}, params?: FetchParams) => Promise<ApiResult<ListingPool>>;
|
|
1729
|
+
/**
|
|
1730
|
+
* Unassign a pool from a listing
|
|
1731
|
+
*/
|
|
1651
1732
|
unassignPool: ({ path, }: {
|
|
1652
1733
|
path: UnassignPoolPathParams;
|
|
1653
1734
|
}, params?: FetchParams) => Promise<ApiResult<void>>;
|
|
@@ -1687,4 +1768,4 @@ declare class Api extends HttpClient {
|
|
|
1687
1768
|
ws: {};
|
|
1688
1769
|
}
|
|
1689
1770
|
|
|
1690
|
-
export { type OfferState as $, type ApiConfig as A, type AddGroupBody as B, type AddMagicLinkRedirectBody as C, type DocumentParent as D, type AddOAuthClientRedirectBody as E, type FullParams as F, type ApiKeyCreateParams_for_TurnstilePermission as G, type ApiKeyResponse_for_TurnstilePermission as H, type TypedUuidForUserProviderId as I, type ApiUserContactEmail as J, type ApiUserEmailUpdateParams as K, type ApiUserProvider as L, type ApiUser_for_TurnstilePermission as M, type ApiUserInfo_for_TurnstilePermission as N, type ApiUserLinkRequestPayload as O, type Permissions_for_TurnstilePermission as P, type ApiUserLinkRequestResponse as Q, type ApiUserProviderLinkPayload as R, type SecretString as S, type TypedUuidForApplicantId as T, type ApiUserUpdateParams_for_TurnstilePermission as U, type Applicant as V, type TypedUuidForApplicantContactId as W, type ApplicantContactField as X, type ApplicantContact as Y, type ApplicantInfo as Z, type InterviewingState as _, Api as a, type
|
|
1771
|
+
export { type OfferState as $, type ApiConfig as A, type AddGroupBody as B, type AddMagicLinkRedirectBody as C, type DocumentParent as D, type AddOAuthClientRedirectBody as E, type FullParams as F, type ApiKeyCreateParams_for_TurnstilePermission as G, type ApiKeyResponse_for_TurnstilePermission as H, type TypedUuidForUserProviderId as I, type ApiUserContactEmail as J, type ApiUserEmailUpdateParams as K, type ApiUserProvider as L, type ApiUser_for_TurnstilePermission as M, type ApiUserInfo_for_TurnstilePermission as N, type ApiUserLinkRequestPayload as O, type Permissions_for_TurnstilePermission as P, type ApiUserLinkRequestResponse as Q, type ApiUserProviderLinkPayload as R, type SecretString as S, type TypedUuidForApplicantId as T, type ApiUserUpdateParams_for_TurnstilePermission as U, type Applicant as V, type TypedUuidForApplicantContactId as W, type ApplicantContactField as X, type ApplicantContact as Y, type ApplicantInfo as Z, type InterviewingState as _, Api as a, type MagicLinkRedirectUri as a$, type ApplicationState as a0, type Application as a1, type DocumentKind as a2, type DocumentSource as a3, type Document as a4, type ApplicationBundle as a5, type TypedUuidForApplicationInterviewCodeId as a6, type ApplicationInterviewCode as a7, type TypedUuidForApplicationStateRecordId as a8, type ApplicationStateRecord as a9, type ReviewAssignmentCreationError as aA, type TypedUuidForReviewAssignmentId as aB, type ReviewAssignmentState as aC, type ReviewAssignment as aD, type CreatedAssignment as aE, type CreateReviewAssignmentsResponse as aF, type CreateRole as aG, type CreatedApplication as aH, type Department as aI, type DocumentUploadUrlResponse as aJ, type EmailApplicantBody as aK, type GetUserResponse_for_TurnstilePermission as aL, type InitialApiKeyResponse_for_TurnstilePermission as aM, type TypedUuidForMagicLinkSecretId as aN, type InitialMagicLinkSecretResponse as aO, type TypedUuidForOAuthSecretId as aP, type InitialOAuthClientSecretResponse as aQ, type TypedUuidForInterviewAttendeeId as aR, type InterviewAttendee as aS, type Interview as aT, type Interviewer as aU, type Jwk as aV, type Jwks as aW, type Listing as aX, type TypedUuidForListingPoolId as aY, type ListingPool as aZ, type TypedUuidForMagicLinkRedirectUriId as a_, type ListingPoolAssociation as aa, type TriageReason as ab, type PoolAction as ac, type ReviewScore as ad, type Reviews as ae, type ExpandedApplicationSummary as af, type Evaluator as ag, type ApplicationSummariesResponse as ah, type ApplicationSummaryResponse as ai, type AssignPool as aj, type AttachDocument as ak, type EmailConfig as al, type TransitionMessage as am, type TransitionBody as an, type BatchParameter_for_TransitionBody as ao, type ViewApplication as ap, type BatchParameter_for_ViewApplication as aq, type CreateApplication as ar, type CreateDepartment as as, type CreateDocument as at, type RoleListingStatus as au, type CreateListing as av, type CreateMapper as aw, type CreatePool as ax, type CreateReview as ay, type CreateReviewAssignments as az, type ApiResult as b, type ViewApplicationPathParams as b$, type MagicLinkSecret as b0, type MagicLink as b1, type TypedUuidForMagicLinkAttemptId as b2, type MagicLinkExchangeRequest as b3, type MagicLinkExchangeResponse as b4, type MagicLinkMedium as b5, type MagicLinkSendRequest as b6, type MagicLinkSendResponse as b7, type Mapper as b8, type NotificationMedium as b9, type Review as bA, type Reviewer as bB, type ReviewerInfo as bC, type ReviewInfo as bD, type Role as bE, type TransitionApplicationToDeclinedBatch as bF, type TransitionApplicationToDeferredBatch as bG, type UpdateApplicantContact as bH, type UpdateDocument as bI, type UpdateDocumentStatus as bJ, type UpdateListing as bK, type UpdateReview as bL, type ScalarApplicationState as bM, type GetApiUserPathParams as bN, type UpdateApiUserPathParams as bO, type SetApiUserContactEmailPathParams as bP, type AddApiUserToGroupPathParams as bQ, type RemoveApiUserFromGroupPathParams as bR, type LinkProviderPathParams as bS, type ListApiUserTokensPathParams as bT, type CreateApiUserTokenPathParams as bU, type GetApiUserTokenPathParams as bV, type DeleteApiUserTokenPathParams as bW, type CreateLinkTokenPathParams as bX, type ListApplicantsQueryParams as bY, type ViewApplicantPathParams as bZ, type UpdateApplicantContactPathParams as b_, type NotificationStatus as ba, type TypedUuidForNotificationId as bb, type RenderedEmail as bc, type RecipientId as bd, type Notification_for_RenderedEmail as be, type OAuthAuthzCodeExchangeBody as bf, type OAuthAuthzCodeExchangeResponse as bg, type TypedUuidForOAuthRedirectUriId as bh, type OAuthClientRedirectUri as bi, type OAuthClientSecret as bj, type OAuthClient as bk, type OAuthProviderName as bl, type OAuthProviderInfo as bm, type OpenIdConfiguration as bn, type OperationState as bo, type OperationTaskState as bp, type TypedUuidForOperationTaskId as bq, type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue as br, type Operation_for_TurnstilePermission_and_String as bs, type TransitionApplicationToDeclinedBatchEndpoint as bt, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint as bu, type TransitionApplicationToDeferredBatchEndpoint as bv, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint as bw, type OptionalTransitionBody as bx, type Pool as by, type RegisterApplicant as bz, type TypedUuidForUserId as c, type UpdateReviewPathParams as c$, type ApplyReviewActionPathParams as c0, type ListApplicationReviewAssignmentsPathParams as c1, type CreateApplicationReviewAssignmentsPathParams as c2, type ViewApplicationBundlePathParams as c3, type AttachDocumentPathParams as c4, type CreateDocumentUploadUrlPathParams as c5, type GetApplicationInterviewCodePathParams as c6, type SimulateReviewActionPathParams as c7, type SubmitApplicationPathParams as c8, type TransitionApplicationToDeclinedPathParams as c9, type AuthzCodeRedirectPathParams as cA, type AuthzCodeRedirectQueryParams as cB, type AuthzCodeCallbackPathParams as cC, type AuthzCodeCallbackQueryParams as cD, type AuthzCodeExchangePathParams as cE, type GetDeviceProviderPathParams as cF, type ExchangeDeviceTokenPathParams as cG, type GetMagicLinkPathParams as cH, type CreateMagicLinkRedirectUriPathParams as cI, type DeleteMagicLinkRedirectUriPathParams as cJ, type CreateMagicLinkSecretPathParams as cK, type DeleteMagicLinkSecretPathParams as cL, type GetMappersQueryParams as cM, type DeleteMapperPathParams as cN, type ListNotificationsQueryParams as cO, type EmailApplicantPathParams as cP, type GetOauthClientPathParams as cQ, type CreateOauthClientRedirectUriPathParams as cR, type DeleteOauthClientRedirectUriPathParams as cS, type CreateOauthClientSecretPathParams as cT, type DeleteOauthClientSecretPathParams as cU, type ViewPoolPathParams as cV, type UpdatePoolPathParams as cW, type AssignPoolPathParams as cX, type UnassignPoolPathParams as cY, type ListReviewsQueryParams as cZ, type ViewReviewPathParams as c_, type TransitionApplicationToDeferredPathParams as ca, type TransitionApplicationToInterviewingPathParams as cb, type TransitionApplicationToNextStepsPathParams as cc, type TransitionApplicationToOfferPathParams as cd, type TransitionApplicationToWithdrawnPathParams as ce, type ListApplicationSummariesQueryParams as cf, type ViewApplicationSummaryPathParams as cg, type ListOperationsQueryParams as ch, type GetOperationPathParams as ci, type ListOperationTasksQueryParams as cj, type ViewDepartmentPathParams as ck, type ListDocumentsQueryParams as cl, type ViewDocumentPathParams as cm, type UpdateDocumentPathParams as cn, type DeleteDocumentPathParams as co, type ViewDocumentDataPathParams as cp, type UpdateDocumentStatusPathParams as cq, type UpdateGroupPathParams as cr, type DeleteGroupPathParams as cs, type ListInterviewsQueryParams as ct, type ListInterviewersQueryParams as cu, type ViewListingPathParams as cv, type UpdateListingPathParams as cw, type UpdateListingStatePathParams as cx, type MagicLinkExchangePathParams as cy, type MagicLinkSendPathParams as cz, type TypedUuidForApplicationId as d, type DeleteReviewPathParams as d0, type ListReviewersQueryParams as d1, type ViewRolePathParams as d2, type ErrorBody as d3, type ErrorResult as d4, type TypedUuidForDocumentId as e, type TypedUuidForEmployeeId as f, type TypedUuidForOnboardingId as g, type TypedUuidForDepartmentId as h, type TypedUuidForRoleId as i, type TypedUuidForListingId as j, type TypedUuidForPoolId as k, type TypedUuidForReviewerId as l, type TypedUuidForReviewId as m, type TypedUuidForInterviewerId as n, type TypedUuidForInterviewId as o, type TypedUuidForBackgroundCheckId as p, type TypedUuidForOperationId as q, type TypedUuidForApiKeyId as r, type TypedUuidForAccessGroupId as s, type TypedUuidForMapperId as t, type TypedUuidForOAuthClientId as u, type TypedUuidForMagicLinkId as v, type TurnstilePermission as w, type AccessGroupUpdateParams_for_TurnstilePermission as x, type AccessGroup_for_TurnstilePermission as y, type AccessTokenExchangeRequest as z };
|
|
@@ -88,7 +88,7 @@ type TypedUuidForAccessGroupId = string;
|
|
|
88
88
|
type TypedUuidForMapperId = string;
|
|
89
89
|
type TypedUuidForOAuthClientId = string;
|
|
90
90
|
type TypedUuidForMagicLinkId = string;
|
|
91
|
-
type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'ScheduleNotification' | 'SendNotification' | 'GetApplicantsAssigned' | 'GetApplicantsAll' | 'GetApplicantSelf' | 'CreateApplicantsAssigned' | 'CreateApplicantsAll' | 'CreateApplicantSelf' | 'ManageApplicantsAssigned' | 'ManageApplicantsAll' | 'ManageApplicantSelf' | 'GetApplicationsAssigned' | 'GetApplicationsAll' | 'CreateApplicationAssigned' | 'CreateApplicationSelf' | 'SubmitApplicationsAssigned' | 'WithdrawApplicationsAssigned' | 'ManageApplicationsAssigned' | 'ManageApplicationsAll' | 'GetDocumentsAssigned' | 'GetDocumentsAll' | 'CreateDocument' | 'ManageDocumentsAssigned' | 'ManageDocumentsAll' | 'AttachDocumentsAssigned' | 'AttachDocumentsAll' | 'GetDepartmentsAssigned' | 'GetDepartmentsAll' | 'CreateDepartment' | 'GetRolesAssigned' | 'GetRolesAll' | 'CreateRole' | 'GetListingsAssigned' | 'GetListingsAll' | 'CreateListing' | 'ManageListingsAll' | 'GetPoolsAssigned' | 'GetPoolsAll' | 'CreatePool' | 'ManagePoolsAll' | 'GetReviewersAssigned' | 'GetReviewersAll' | 'GetReviewerSelf' | 'CreateReviewersAssigned' | 'CreateReviewersAll' | 'CreateReviewerSelf' | 'GetReviewsAssigned' | 'GetReviewsAll' | 'CreateReview' | 'ManageReviewsAssigned' | 'ManageReviewsAll' | 'GetReviewAssignmentsAll' | 'CompleteReviewAssignmentSelf' | 'CompleteReviewAssignmentsAll' | 'ManageReviewAssignmentsAll' | 'GetReviewSummariesAll' | 'GetInterviewersAssigned' | 'GetInterviewersAll' | 'CreateInterviewersAssigned' | 'CreateInterviewersAll' | 'CreateInterviewerSelf' | 'ManageInterviewersAssigned' | 'ManageInterviewersAll' | 'GetInterviewsAssigned' | 'GetInterviewsAll' | 'CreateInterview' | 'ManageInterviewsAssigned' | 'ManageInterviewsAll' | 'GetBackgroundChecksAssigned' | 'GetBackgroundChecksAll' | 'CreateBackgroundChecksAll' | 'ManageBackgroundChecksAssigned' | 'ManageBackgroundChecksAll' | 'GetEnvelope' | 'SendEnvelope' | 'GetEmployeesAssigned' | 'GetEmployeesAll' | 'CreateEmployee' | 'ManageEmployeesAssigned' | 'ManageEmployeesAll' | 'GetOnboardingsAll' | 'CreateOnboarding' | 'GetBatchOperationsAssigned' | 'GetBatchOperationsAll' | 'CreateBatchOperation' | 'ManageBatchOperationsAll' | 'CreateApiUser' | 'GetApiUserSelf' | 'GetApiUsersAssigned' | 'GetApiUsersAll' | 'ManageApiUsersAssigned' | 'ManageApiUsersAll' | 'CreateApiKeySelf' | 'CreateApiKeyAssigned' | 'CreateApiKeyAll' | 'GetApiKeysAssigned' | 'GetApiKeysAll' | 'ManageApiKeysAssigned' | 'ManageApiKeysAll' | 'CreateUserApiProviderLinkToken' | 'CreateGroup' | 'GetGroupsJoined' | 'GetGroupsAll' | 'ManageGroupsAssigned' | 'ManageGroupsAll' | 'ManageGroupMembershipsAssigned' | 'ManageGroupMembershipsAll' | 'CreateMapper' | 'GetMappersAll' | 'ManageMappersAssigned' | 'ManageMappersAll' | 'CreateOAuthClient' | 'GetOAuthClientsAssigned' | 'GetOAuthClientsAll' | 'ManageOAuthClientsAssigned' | 'ManageOAuthClientsAll' | 'CreateMagicLinkClient' | 'GetMagicLinkClientsAssigned' | 'GetMagicLinkClientsAll' | 'ManageMagicLinkClientsAssigned' | 'ManageMagicLinkClientsAll' | 'CreateAccessToken' | {
|
|
91
|
+
type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'ScheduleNotification' | 'SendNotification' | 'GetApplicantsAssigned' | 'GetApplicantsAll' | 'GetApplicantSelf' | 'CreateApplicantsAssigned' | 'CreateApplicantsAll' | 'CreateApplicantSelf' | 'ManageApplicantsAssigned' | 'ManageApplicantsAll' | 'ManageApplicantSelf' | 'GetApplicationsAssigned' | 'GetApplicationsAll' | 'CreateApplicationAssigned' | 'CreateApplicationSelf' | 'SubmitApplicationsAssigned' | 'WithdrawApplicationsAssigned' | 'ManageApplicationsAssigned' | 'ManageApplicationsAll' | 'GetApplicationSummariesAll' | 'GetDocumentsAssigned' | 'GetDocumentsAll' | 'CreateDocument' | 'ManageDocumentsAssigned' | 'ManageDocumentsAll' | 'AttachDocumentsAssigned' | 'AttachDocumentsAll' | 'GetDepartmentsAssigned' | 'GetDepartmentsAll' | 'CreateDepartment' | 'GetRolesAssigned' | 'GetRolesAll' | 'CreateRole' | 'GetListingsAssigned' | 'GetListingsAll' | 'CreateListing' | 'ManageListingsAll' | 'GetPoolsAssigned' | 'GetPoolsAll' | 'CreatePool' | 'ManagePoolsAll' | 'GetReviewersAssigned' | 'GetReviewersAll' | 'GetReviewerSelf' | 'CreateReviewersAssigned' | 'CreateReviewersAll' | 'CreateReviewerSelf' | 'GetReviewsAssigned' | 'GetReviewsAll' | 'CreateReview' | 'ManageReviewsAssigned' | 'ManageReviewsAll' | 'GetReviewAssignmentsAll' | 'CompleteReviewAssignmentSelf' | 'CompleteReviewAssignmentsAll' | 'ManageReviewAssignmentsAll' | 'GetReviewSummariesAll' | 'GetInterviewersAssigned' | 'GetInterviewersAll' | 'CreateInterviewersAssigned' | 'CreateInterviewersAll' | 'CreateInterviewerSelf' | 'ManageInterviewersAssigned' | 'ManageInterviewersAll' | 'GetInterviewsAssigned' | 'GetInterviewsAll' | 'CreateInterview' | 'ManageInterviewsAssigned' | 'ManageInterviewsAll' | 'GetBackgroundChecksAssigned' | 'GetBackgroundChecksAll' | 'CreateBackgroundChecksAll' | 'ManageBackgroundChecksAssigned' | 'ManageBackgroundChecksAll' | 'GetEnvelope' | 'SendEnvelope' | 'GetEmployeesAssigned' | 'GetEmployeesAll' | 'CreateEmployee' | 'ManageEmployeesAssigned' | 'ManageEmployeesAll' | 'GetOnboardingsAll' | 'CreateOnboarding' | 'GetBatchOperationsAssigned' | 'GetBatchOperationsAll' | 'CreateBatchOperation' | 'ManageBatchOperationsAll' | 'CreateApiUser' | 'GetApiUserSelf' | 'GetApiUsersAssigned' | 'GetApiUsersAll' | 'ManageApiUsersAssigned' | 'ManageApiUsersAll' | 'CreateApiKeySelf' | 'CreateApiKeyAssigned' | 'CreateApiKeyAll' | 'GetApiKeysAssigned' | 'GetApiKeysAll' | 'ManageApiKeysAssigned' | 'ManageApiKeysAll' | 'CreateUserApiProviderLinkToken' | 'CreateGroup' | 'GetGroupsJoined' | 'GetGroupsAll' | 'ManageGroupsAssigned' | 'ManageGroupsAll' | 'ManageGroupMembershipsAssigned' | 'ManageGroupMembershipsAll' | 'CreateMapper' | 'GetMappersAll' | 'ManageMappersAssigned' | 'ManageMappersAll' | 'CreateOAuthClient' | 'GetOAuthClientsAssigned' | 'GetOAuthClientsAll' | 'ManageOAuthClientsAssigned' | 'ManageOAuthClientsAll' | 'CreateMagicLinkClient' | 'GetMagicLinkClientsAssigned' | 'GetMagicLinkClientsAll' | 'ManageMagicLinkClientsAssigned' | 'ManageMagicLinkClientsAll' | 'CreateAccessToken' | {
|
|
92
92
|
'GetApplicant': TypedUuidForApplicantId;
|
|
93
93
|
} | {
|
|
94
94
|
'GetApplicants': TypedUuidForApplicantId[];
|
|
@@ -417,12 +417,16 @@ type ApplicationStateRecord = {
|
|
|
417
417
|
'updatedAt': Date;
|
|
418
418
|
};
|
|
419
419
|
type ListingPoolAssociation = 'first' | 'early_positive' | 'positive';
|
|
420
|
-
type
|
|
421
|
-
|
|
422
|
-
'
|
|
423
|
-
|
|
420
|
+
type TriageReason = 'has_no_ratings' | 'likely_next_steps' | 'likely_pass' | 'possibly_next_steps' | 'possibly_pass' | 'very_likely_pass' | 'unknown';
|
|
421
|
+
type PoolAction = 'drop' | 'wait' | {
|
|
422
|
+
'add': {
|
|
423
|
+
'association': ListingPoolAssociation;
|
|
424
|
+
'count': number;
|
|
425
|
+
};
|
|
424
426
|
} | {
|
|
425
|
-
'
|
|
427
|
+
'triage': {
|
|
428
|
+
'reason': TriageReason;
|
|
429
|
+
};
|
|
426
430
|
};
|
|
427
431
|
type ReviewScore = 'emphatic_yes' | 'yes' | 'pass' | 'no' | 'emphatic_no' | 'incomplete';
|
|
428
432
|
type Reviews = {
|
|
@@ -455,11 +459,15 @@ type ApplicationSummaryResponse = {
|
|
|
455
459
|
'users': Evaluator[];
|
|
456
460
|
};
|
|
457
461
|
type AssignPool = {
|
|
462
|
+
/** Review stage of the listing this pool should be associated to */
|
|
458
463
|
'association': ListingPoolAssociation;
|
|
464
|
+
/** Listing to assign this pool to */
|
|
459
465
|
'listing': TypedUuidForListingId;
|
|
460
466
|
};
|
|
461
467
|
type AttachDocument = {
|
|
468
|
+
/** Id assigned to the document by the external datastore */
|
|
462
469
|
'externalId': string;
|
|
470
|
+
/** Mime type of the document */
|
|
463
471
|
'mime'?: string;
|
|
464
472
|
};
|
|
465
473
|
type EmailConfig = {
|
|
@@ -473,6 +481,7 @@ type TransitionMessage = 'default' | 'omit' | {
|
|
|
473
481
|
'custom': EmailConfig;
|
|
474
482
|
};
|
|
475
483
|
type TransitionBody = {
|
|
484
|
+
/** The message to send to the applicant */
|
|
476
485
|
'message': TransitionMessage;
|
|
477
486
|
};
|
|
478
487
|
type BatchParameter_for_TransitionBody = {
|
|
@@ -481,6 +490,7 @@ type BatchParameter_for_TransitionBody = {
|
|
|
481
490
|
'each': TransitionBody[];
|
|
482
491
|
};
|
|
483
492
|
type ViewApplication = {
|
|
493
|
+
/** Application to operate on */
|
|
484
494
|
'application': TypedUuidForApplicationId;
|
|
485
495
|
};
|
|
486
496
|
type BatchParameter_for_ViewApplication = {
|
|
@@ -489,7 +499,9 @@ type BatchParameter_for_ViewApplication = {
|
|
|
489
499
|
'each': ViewApplication[];
|
|
490
500
|
};
|
|
491
501
|
type CreateApplication = {
|
|
502
|
+
/** Applicant to create an application for */
|
|
492
503
|
'applicant': TypedUuidForApplicantId;
|
|
504
|
+
/** Listing to apply to */
|
|
493
505
|
'listing': TypedUuidForListingId;
|
|
494
506
|
};
|
|
495
507
|
type CreateDepartment = {
|
|
@@ -515,9 +527,12 @@ type CreateMapper = {
|
|
|
515
527
|
'rule': Record<string, unknown>;
|
|
516
528
|
};
|
|
517
529
|
type CreatePool = {
|
|
530
|
+
/** Optional description of the pool */
|
|
518
531
|
'description'?: string;
|
|
532
|
+
/** Required display name for the pool */
|
|
519
533
|
'name': string;
|
|
520
|
-
|
|
534
|
+
/** List of reviewers to assign to this pool */
|
|
535
|
+
'reviewers'?: TypedUuidForReviewerId[];
|
|
521
536
|
};
|
|
522
537
|
type CreateReview = {
|
|
523
538
|
'application': TypedUuidForApplicationId;
|
|
@@ -538,8 +553,10 @@ type CreateReviewAssignments = {
|
|
|
538
553
|
* Failures that can occur when assigning a reviewer
|
|
539
554
|
*/
|
|
540
555
|
type ReviewAssignmentCreationError =
|
|
556
|
+
/** A requested object resource already exist */
|
|
557
|
+
'Conflict'
|
|
541
558
|
/** A requested object resource does not exist */
|
|
542
|
-
'DoesNotExist'
|
|
559
|
+
| 'DoesNotExist'
|
|
543
560
|
/** Caller does not have access to a require object resource */
|
|
544
561
|
| 'Forbidden'
|
|
545
562
|
/** Internal server error */
|
|
@@ -850,6 +867,7 @@ type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchE
|
|
|
850
867
|
'updatedAt': Date;
|
|
851
868
|
};
|
|
852
869
|
type OptionalTransitionBody = {
|
|
870
|
+
/** An optional message to send to the applicant */
|
|
853
871
|
'message'?: EmailConfig;
|
|
854
872
|
};
|
|
855
873
|
type Pool = {
|
|
@@ -1302,10 +1320,19 @@ declare class Api extends HttpClient {
|
|
|
1302
1320
|
path: UpdateApplicantContactPathParams;
|
|
1303
1321
|
body: UpdateApplicantContact;
|
|
1304
1322
|
}, params?: FetchParams) => Promise<ApiResult<ApplicantInfo>>;
|
|
1323
|
+
/**
|
|
1324
|
+
* View all applications
|
|
1325
|
+
*/
|
|
1305
1326
|
listApplications: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Application[]>>;
|
|
1327
|
+
/**
|
|
1328
|
+
* Create a new application
|
|
1329
|
+
*/
|
|
1306
1330
|
createApplication: ({ body, }: {
|
|
1307
1331
|
body: CreateApplication;
|
|
1308
1332
|
}, params?: FetchParams) => Promise<ApiResult<CreatedApplication>>;
|
|
1333
|
+
/**
|
|
1334
|
+
* View an application
|
|
1335
|
+
*/
|
|
1309
1336
|
viewApplication: ({ path, }: {
|
|
1310
1337
|
path: ViewApplicationPathParams;
|
|
1311
1338
|
}, params?: FetchParams) => Promise<ApiResult<Application>>;
|
|
@@ -1331,13 +1358,22 @@ declare class Api extends HttpClient {
|
|
|
1331
1358
|
viewApplicationBundle: ({ path, }: {
|
|
1332
1359
|
path: ViewApplicationBundlePathParams;
|
|
1333
1360
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationBundle>>;
|
|
1361
|
+
/**
|
|
1362
|
+
* Attach an uploaded document to an application
|
|
1363
|
+
*/
|
|
1334
1364
|
attachDocument: ({ path, body, }: {
|
|
1335
1365
|
path: AttachDocumentPathParams;
|
|
1336
1366
|
body: AttachDocument;
|
|
1337
1367
|
}, params?: FetchParams) => Promise<ApiResult<Document>>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Generate a pre-signed upload url for uploading a document to an application
|
|
1370
|
+
*/
|
|
1338
1371
|
createDocumentUploadUrl: ({ path, }: {
|
|
1339
1372
|
path: CreateDocumentUploadUrlPathParams;
|
|
1340
1373
|
}, params?: FetchParams) => Promise<ApiResult<DocumentUploadUrlResponse>>;
|
|
1374
|
+
/**
|
|
1375
|
+
* Retrieve the interview code associated with an application
|
|
1376
|
+
*/
|
|
1341
1377
|
getApplicationInterviewCode: ({ path, }: {
|
|
1342
1378
|
path: GetApplicationInterviewCodePathParams;
|
|
1343
1379
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationInterviewCode>>;
|
|
@@ -1347,36 +1383,63 @@ declare class Api extends HttpClient {
|
|
|
1347
1383
|
simulateReviewAction: ({ path, }: {
|
|
1348
1384
|
path: SimulateReviewActionPathParams;
|
|
1349
1385
|
}, params?: FetchParams) => Promise<ApiResult<PoolAction>>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Submit an application that has all required documents attached
|
|
1388
|
+
*/
|
|
1350
1389
|
submitApplication: ({ path, }: {
|
|
1351
1390
|
path: SubmitApplicationPathParams;
|
|
1352
1391
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Move an application to the Declined stage
|
|
1394
|
+
*/
|
|
1353
1395
|
transitionApplicationToDeclined: ({ path, body, }: {
|
|
1354
1396
|
path: TransitionApplicationToDeclinedPathParams;
|
|
1355
1397
|
body: TransitionBody;
|
|
1356
1398
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1399
|
+
/**
|
|
1400
|
+
* Move an application to the Deferred stage
|
|
1401
|
+
*/
|
|
1357
1402
|
transitionApplicationToDeferred: ({ path, body, }: {
|
|
1358
1403
|
path: TransitionApplicationToDeferredPathParams;
|
|
1359
1404
|
body: TransitionBody;
|
|
1360
1405
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1406
|
+
/**
|
|
1407
|
+
* Move an application to the Interviewing stage
|
|
1408
|
+
*/
|
|
1361
1409
|
transitionApplicationToInterviewing: ({ path, body, }: {
|
|
1362
1410
|
path: TransitionApplicationToInterviewingPathParams;
|
|
1363
1411
|
body: OptionalTransitionBody;
|
|
1364
1412
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1413
|
+
/**
|
|
1414
|
+
* Move an application to the Next Steps stage
|
|
1415
|
+
*/
|
|
1365
1416
|
transitionApplicationToNextSteps: ({ path, body, }: {
|
|
1366
1417
|
path: TransitionApplicationToNextStepsPathParams;
|
|
1367
1418
|
body: OptionalTransitionBody;
|
|
1368
1419
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Move an application to the Offer stage
|
|
1422
|
+
*/
|
|
1369
1423
|
transitionApplicationToOffer: ({ path, body, }: {
|
|
1370
1424
|
path: TransitionApplicationToOfferPathParams;
|
|
1371
1425
|
body: OptionalTransitionBody;
|
|
1372
1426
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1427
|
+
/**
|
|
1428
|
+
* Move an application to the Withdrawn stage
|
|
1429
|
+
*/
|
|
1373
1430
|
transitionApplicationToWithdrawn: ({ path, body, }: {
|
|
1374
1431
|
path: TransitionApplicationToWithdrawnPathParams;
|
|
1375
1432
|
body: OptionalTransitionBody;
|
|
1376
1433
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1434
|
+
/**
|
|
1435
|
+
* List all application summaries
|
|
1436
|
+
*/
|
|
1377
1437
|
listApplicationSummaries: ({ query, }: {
|
|
1378
1438
|
query?: ListApplicationSummariesQueryParams;
|
|
1379
1439
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationSummariesResponse>>;
|
|
1440
|
+
/**
|
|
1441
|
+
* View a summary that includes an application and the related evaluations
|
|
1442
|
+
*/
|
|
1380
1443
|
viewApplicationSummary: ({ path, }: {
|
|
1381
1444
|
path: ViewApplicationSummaryPathParams;
|
|
1382
1445
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationSummaryResponse>>;
|
|
@@ -1633,21 +1696,39 @@ declare class Api extends HttpClient {
|
|
|
1633
1696
|
deleteOauthClientSecret: ({ path, }: {
|
|
1634
1697
|
path: DeleteOauthClientSecretPathParams;
|
|
1635
1698
|
}, params?: FetchParams) => Promise<ApiResult<OAuthClientSecret>>;
|
|
1699
|
+
/**
|
|
1700
|
+
* List reviewer pools and their associations
|
|
1701
|
+
*/
|
|
1636
1702
|
listPools: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Pool[]>>;
|
|
1703
|
+
/**
|
|
1704
|
+
* Create a new pool
|
|
1705
|
+
*/
|
|
1637
1706
|
createPool: ({ body, }: {
|
|
1638
1707
|
body: CreatePool;
|
|
1639
1708
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1709
|
+
/**
|
|
1710
|
+
* View a pool and its associations
|
|
1711
|
+
*/
|
|
1640
1712
|
viewPool: ({ path, }: {
|
|
1641
1713
|
path: ViewPoolPathParams;
|
|
1642
1714
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1715
|
+
/**
|
|
1716
|
+
* Update a pool
|
|
1717
|
+
*/
|
|
1643
1718
|
updatePool: ({ path, body, }: {
|
|
1644
1719
|
path: UpdatePoolPathParams;
|
|
1645
1720
|
body: CreatePool;
|
|
1646
1721
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1722
|
+
/**
|
|
1723
|
+
* Assign a pool to a listing
|
|
1724
|
+
*/
|
|
1647
1725
|
assignPool: ({ path, body, }: {
|
|
1648
1726
|
path: AssignPoolPathParams;
|
|
1649
1727
|
body: AssignPool;
|
|
1650
|
-
}, params?: FetchParams) => Promise<ApiResult<
|
|
1728
|
+
}, params?: FetchParams) => Promise<ApiResult<ListingPool>>;
|
|
1729
|
+
/**
|
|
1730
|
+
* Unassign a pool from a listing
|
|
1731
|
+
*/
|
|
1651
1732
|
unassignPool: ({ path, }: {
|
|
1652
1733
|
path: UnassignPoolPathParams;
|
|
1653
1734
|
}, params?: FetchParams) => Promise<ApiResult<void>>;
|
|
@@ -1687,4 +1768,4 @@ declare class Api extends HttpClient {
|
|
|
1687
1768
|
ws: {};
|
|
1688
1769
|
}
|
|
1689
1770
|
|
|
1690
|
-
export { type OfferState as $, type ApiConfig as A, type AddGroupBody as B, type AddMagicLinkRedirectBody as C, type DocumentParent as D, type AddOAuthClientRedirectBody as E, type FullParams as F, type ApiKeyCreateParams_for_TurnstilePermission as G, type ApiKeyResponse_for_TurnstilePermission as H, type TypedUuidForUserProviderId as I, type ApiUserContactEmail as J, type ApiUserEmailUpdateParams as K, type ApiUserProvider as L, type ApiUser_for_TurnstilePermission as M, type ApiUserInfo_for_TurnstilePermission as N, type ApiUserLinkRequestPayload as O, type Permissions_for_TurnstilePermission as P, type ApiUserLinkRequestResponse as Q, type ApiUserProviderLinkPayload as R, type SecretString as S, type TypedUuidForApplicantId as T, type ApiUserUpdateParams_for_TurnstilePermission as U, type Applicant as V, type TypedUuidForApplicantContactId as W, type ApplicantContactField as X, type ApplicantContact as Y, type ApplicantInfo as Z, type InterviewingState as _, Api as a, type
|
|
1771
|
+
export { type OfferState as $, type ApiConfig as A, type AddGroupBody as B, type AddMagicLinkRedirectBody as C, type DocumentParent as D, type AddOAuthClientRedirectBody as E, type FullParams as F, type ApiKeyCreateParams_for_TurnstilePermission as G, type ApiKeyResponse_for_TurnstilePermission as H, type TypedUuidForUserProviderId as I, type ApiUserContactEmail as J, type ApiUserEmailUpdateParams as K, type ApiUserProvider as L, type ApiUser_for_TurnstilePermission as M, type ApiUserInfo_for_TurnstilePermission as N, type ApiUserLinkRequestPayload as O, type Permissions_for_TurnstilePermission as P, type ApiUserLinkRequestResponse as Q, type ApiUserProviderLinkPayload as R, type SecretString as S, type TypedUuidForApplicantId as T, type ApiUserUpdateParams_for_TurnstilePermission as U, type Applicant as V, type TypedUuidForApplicantContactId as W, type ApplicantContactField as X, type ApplicantContact as Y, type ApplicantInfo as Z, type InterviewingState as _, Api as a, type MagicLinkRedirectUri as a$, type ApplicationState as a0, type Application as a1, type DocumentKind as a2, type DocumentSource as a3, type Document as a4, type ApplicationBundle as a5, type TypedUuidForApplicationInterviewCodeId as a6, type ApplicationInterviewCode as a7, type TypedUuidForApplicationStateRecordId as a8, type ApplicationStateRecord as a9, type ReviewAssignmentCreationError as aA, type TypedUuidForReviewAssignmentId as aB, type ReviewAssignmentState as aC, type ReviewAssignment as aD, type CreatedAssignment as aE, type CreateReviewAssignmentsResponse as aF, type CreateRole as aG, type CreatedApplication as aH, type Department as aI, type DocumentUploadUrlResponse as aJ, type EmailApplicantBody as aK, type GetUserResponse_for_TurnstilePermission as aL, type InitialApiKeyResponse_for_TurnstilePermission as aM, type TypedUuidForMagicLinkSecretId as aN, type InitialMagicLinkSecretResponse as aO, type TypedUuidForOAuthSecretId as aP, type InitialOAuthClientSecretResponse as aQ, type TypedUuidForInterviewAttendeeId as aR, type InterviewAttendee as aS, type Interview as aT, type Interviewer as aU, type Jwk as aV, type Jwks as aW, type Listing as aX, type TypedUuidForListingPoolId as aY, type ListingPool as aZ, type TypedUuidForMagicLinkRedirectUriId as a_, type ListingPoolAssociation as aa, type TriageReason as ab, type PoolAction as ac, type ReviewScore as ad, type Reviews as ae, type ExpandedApplicationSummary as af, type Evaluator as ag, type ApplicationSummariesResponse as ah, type ApplicationSummaryResponse as ai, type AssignPool as aj, type AttachDocument as ak, type EmailConfig as al, type TransitionMessage as am, type TransitionBody as an, type BatchParameter_for_TransitionBody as ao, type ViewApplication as ap, type BatchParameter_for_ViewApplication as aq, type CreateApplication as ar, type CreateDepartment as as, type CreateDocument as at, type RoleListingStatus as au, type CreateListing as av, type CreateMapper as aw, type CreatePool as ax, type CreateReview as ay, type CreateReviewAssignments as az, type ApiResult as b, type ViewApplicationPathParams as b$, type MagicLinkSecret as b0, type MagicLink as b1, type TypedUuidForMagicLinkAttemptId as b2, type MagicLinkExchangeRequest as b3, type MagicLinkExchangeResponse as b4, type MagicLinkMedium as b5, type MagicLinkSendRequest as b6, type MagicLinkSendResponse as b7, type Mapper as b8, type NotificationMedium as b9, type Review as bA, type Reviewer as bB, type ReviewerInfo as bC, type ReviewInfo as bD, type Role as bE, type TransitionApplicationToDeclinedBatch as bF, type TransitionApplicationToDeferredBatch as bG, type UpdateApplicantContact as bH, type UpdateDocument as bI, type UpdateDocumentStatus as bJ, type UpdateListing as bK, type UpdateReview as bL, type ScalarApplicationState as bM, type GetApiUserPathParams as bN, type UpdateApiUserPathParams as bO, type SetApiUserContactEmailPathParams as bP, type AddApiUserToGroupPathParams as bQ, type RemoveApiUserFromGroupPathParams as bR, type LinkProviderPathParams as bS, type ListApiUserTokensPathParams as bT, type CreateApiUserTokenPathParams as bU, type GetApiUserTokenPathParams as bV, type DeleteApiUserTokenPathParams as bW, type CreateLinkTokenPathParams as bX, type ListApplicantsQueryParams as bY, type ViewApplicantPathParams as bZ, type UpdateApplicantContactPathParams as b_, type NotificationStatus as ba, type TypedUuidForNotificationId as bb, type RenderedEmail as bc, type RecipientId as bd, type Notification_for_RenderedEmail as be, type OAuthAuthzCodeExchangeBody as bf, type OAuthAuthzCodeExchangeResponse as bg, type TypedUuidForOAuthRedirectUriId as bh, type OAuthClientRedirectUri as bi, type OAuthClientSecret as bj, type OAuthClient as bk, type OAuthProviderName as bl, type OAuthProviderInfo as bm, type OpenIdConfiguration as bn, type OperationState as bo, type OperationTaskState as bp, type TypedUuidForOperationTaskId as bq, type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue as br, type Operation_for_TurnstilePermission_and_String as bs, type TransitionApplicationToDeclinedBatchEndpoint as bt, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint as bu, type TransitionApplicationToDeferredBatchEndpoint as bv, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint as bw, type OptionalTransitionBody as bx, type Pool as by, type RegisterApplicant as bz, type TypedUuidForUserId as c, type UpdateReviewPathParams as c$, type ApplyReviewActionPathParams as c0, type ListApplicationReviewAssignmentsPathParams as c1, type CreateApplicationReviewAssignmentsPathParams as c2, type ViewApplicationBundlePathParams as c3, type AttachDocumentPathParams as c4, type CreateDocumentUploadUrlPathParams as c5, type GetApplicationInterviewCodePathParams as c6, type SimulateReviewActionPathParams as c7, type SubmitApplicationPathParams as c8, type TransitionApplicationToDeclinedPathParams as c9, type AuthzCodeRedirectPathParams as cA, type AuthzCodeRedirectQueryParams as cB, type AuthzCodeCallbackPathParams as cC, type AuthzCodeCallbackQueryParams as cD, type AuthzCodeExchangePathParams as cE, type GetDeviceProviderPathParams as cF, type ExchangeDeviceTokenPathParams as cG, type GetMagicLinkPathParams as cH, type CreateMagicLinkRedirectUriPathParams as cI, type DeleteMagicLinkRedirectUriPathParams as cJ, type CreateMagicLinkSecretPathParams as cK, type DeleteMagicLinkSecretPathParams as cL, type GetMappersQueryParams as cM, type DeleteMapperPathParams as cN, type ListNotificationsQueryParams as cO, type EmailApplicantPathParams as cP, type GetOauthClientPathParams as cQ, type CreateOauthClientRedirectUriPathParams as cR, type DeleteOauthClientRedirectUriPathParams as cS, type CreateOauthClientSecretPathParams as cT, type DeleteOauthClientSecretPathParams as cU, type ViewPoolPathParams as cV, type UpdatePoolPathParams as cW, type AssignPoolPathParams as cX, type UnassignPoolPathParams as cY, type ListReviewsQueryParams as cZ, type ViewReviewPathParams as c_, type TransitionApplicationToDeferredPathParams as ca, type TransitionApplicationToInterviewingPathParams as cb, type TransitionApplicationToNextStepsPathParams as cc, type TransitionApplicationToOfferPathParams as cd, type TransitionApplicationToWithdrawnPathParams as ce, type ListApplicationSummariesQueryParams as cf, type ViewApplicationSummaryPathParams as cg, type ListOperationsQueryParams as ch, type GetOperationPathParams as ci, type ListOperationTasksQueryParams as cj, type ViewDepartmentPathParams as ck, type ListDocumentsQueryParams as cl, type ViewDocumentPathParams as cm, type UpdateDocumentPathParams as cn, type DeleteDocumentPathParams as co, type ViewDocumentDataPathParams as cp, type UpdateDocumentStatusPathParams as cq, type UpdateGroupPathParams as cr, type DeleteGroupPathParams as cs, type ListInterviewsQueryParams as ct, type ListInterviewersQueryParams as cu, type ViewListingPathParams as cv, type UpdateListingPathParams as cw, type UpdateListingStatePathParams as cx, type MagicLinkExchangePathParams as cy, type MagicLinkSendPathParams as cz, type TypedUuidForApplicationId as d, type DeleteReviewPathParams as d0, type ListReviewersQueryParams as d1, type ViewRolePathParams as d2, type ErrorBody as d3, type ErrorResult as d4, type TypedUuidForDocumentId as e, type TypedUuidForEmployeeId as f, type TypedUuidForOnboardingId as g, type TypedUuidForDepartmentId as h, type TypedUuidForRoleId as i, type TypedUuidForListingId as j, type TypedUuidForPoolId as k, type TypedUuidForReviewerId as l, type TypedUuidForReviewId as m, type TypedUuidForInterviewerId as n, type TypedUuidForInterviewId as o, type TypedUuidForBackgroundCheckId as p, type TypedUuidForOperationId as q, type TypedUuidForApiKeyId as r, type TypedUuidForAccessGroupId as s, type TypedUuidForMapperId as t, type TypedUuidForOAuthClientId as u, type TypedUuidForMagicLinkId as v, type TurnstilePermission as w, type AccessGroupUpdateParams_for_TurnstilePermission as x, type AccessGroup_for_TurnstilePermission as y, type AccessTokenExchangeRequest as z };
|