@oxide/turnstile.ts 0.6.7 → 0.7.0

package/dist/{Api-tAayYJvL.d.cts → Api-Mqr0O9hE.d.cts}

@@ -76,6 +76,7 @@ type DocumentParent = {
 type TypedUuidForDepartmentId = string;
 type TypedUuidForRoleId = string;
 type TypedUuidForListingId = string;
+type TypedUuidForPoolId = string;
 type TypedUuidForReviewerId = string;
 type TypedUuidForReviewId = string;
 type TypedUuidForInterviewerId = string;
@@ -87,7 +88,7 @@ type TypedUuidForAccessGroupId = string;
 type TypedUuidForMapperId = string;
 type TypedUuidForOAuthClientId = string;
 type TypedUuidForMagicLinkId = string;
-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' | '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' | {
+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' | {
     'GetApplicant': TypedUuidForApplicantId;
 } | {
     'GetApplicants': TypedUuidForApplicantId[];
@@ -141,6 +142,10 @@ type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'S
     'GetListing': TypedUuidForListingId;
 } | {
     'GetListings': TypedUuidForListingId[];
+} | {
+    'GetPool': TypedUuidForPoolId;
+} | {
+    'GetPools': TypedUuidForPoolId[];
 } | {
     'GetReviewer': TypedUuidForReviewerId;
 } | {
@@ -411,6 +416,18 @@ type ApplicationStateRecord = {
     'state': ApplicationState;
     'updatedAt': Date;
 };
+type ListingPoolAssociation = 'first' | 'early_positive' | 'positive';
+type TriageReason = 'has_no_ratings' | 'likely_next_steps' | 'likely_pass' | 'possibly_next_steps' | 'possibly_pass' | 'very_likely_pass' | 'unknown';
+type PoolAction = 'drop' | 'wait' | {
+    'add': {
+        'association': ListingPoolAssociation;
+        'count': number;
+    };
+} | {
+    'triage': {
+        'reason': TriageReason;
+    };
+};
 type ReviewScore = 'emphatic_yes' | 'yes' | 'pass' | 'no' | 'emphatic_no' | 'incomplete';
 type Reviews = {
     'applicationId': TypedUuidForApplicationId;
@@ -420,6 +437,7 @@ type Reviews = {
     'scores': ReviewScore[];
 };
 type ExpandedApplicationSummary = {
+    'action': PoolAction;
     'applicant': ApplicantInfo;
     'application': Application;
     'documents': Document[];
@@ -440,8 +458,16 @@ type ApplicationSummaryResponse = {
     'summary': ExpandedApplicationSummary;
     'users': Evaluator[];
 };
+type AssignPool = {
+    /** Review stage of the listing this pool should be associated to */
+    'association': ListingPoolAssociation;
+    /** Listing to assign this pool to */
+    'listing': TypedUuidForListingId;
+};
 type AttachDocument = {
+    /** Id assigned to the document by the external datastore */
     'externalId': string;
+    /** Mime type of the document */
     'mime'?: string;
 };
 type EmailConfig = {
@@ -455,6 +481,7 @@ type TransitionMessage = 'default' | 'omit' | {
     'custom': EmailConfig;
 };
 type TransitionBody = {
+    /** The message to send to the applicant */
     'message': TransitionMessage;
 };
 type BatchParameter_for_TransitionBody = {
@@ -463,6 +490,7 @@ type BatchParameter_for_TransitionBody = {
     'each': TransitionBody[];
 };
 type ViewApplication = {
+    /** Application to operate on */
     'application': TypedUuidForApplicationId;
 };
 type BatchParameter_for_ViewApplication = {
@@ -471,7 +499,9 @@ type BatchParameter_for_ViewApplication = {
     'each': ViewApplication[];
 };
 type CreateApplication = {
+    /** Applicant to create an application for */
     'applicant': TypedUuidForApplicantId;
+    /** Listing to apply to */
     'listing': TypedUuidForListingId;
 };
 type CreateDepartment = {
@@ -496,6 +526,14 @@ type CreateMapper = {
     'name': string;
     'rule': Record<string, unknown>;
 };
+type CreatePool = {
+    /** Optional description of the pool */
+    'description'?: string;
+    /** Required display name for the pool */
+    'name': string;
+    /** List of reviewers to assign to this pool */
+    'reviewers'?: TypedUuidForReviewerId[];
+};
 type CreateReview = {
     'application': TypedUuidForApplicationId;
     'content': string;
@@ -511,7 +549,18 @@ type CreateReview = {
 type CreateReviewAssignments = {
     'reviewers': TypedUuidForReviewerId[];
 };
-type ReviewAssignmentCreationError = 'DoesNotExist' | 'Forbidden' | 'Internal';
+/**
+ * Failures that can occur when assigning a reviewer
+ */
+type ReviewAssignmentCreationError = 
+/** A requested object resource already exist */
+'Conflict'
+/** A requested object resource does not exist */
+ | 'DoesNotExist'
+/** Caller does not have access to a require object resource */
+ | 'Forbidden'
+/** Internal server error */
+ | 'Internal';
 type TypedUuidForReviewAssignmentId = string;
 type ReviewAssignmentState = 'pending' | 'complete';
 type ReviewAssignment = {
@@ -523,38 +572,15 @@ type ReviewAssignment = {
     'state': ReviewAssignmentState;
     'updatedAt': Date;
 };
-type TypedUuidForNotificationId = string;
-type NotificationMedium = 'Email';
-type RenderedEmail = {
-    'from': string;
-    'html'?: string;
-    'name': string;
-    'subject': string;
-    'text': string;
-};
-type RecipientId = {
-    'Applicant': TypedUuidForApplicantId;
-} | {
-    'Custom': string;
-} | {
-    'Reviewer': TypedUuidForReviewerId;
-};
-type NotificationStatus = 'Failed' | 'Pending' | 'Scheduled' | 'Sent';
-type Notification_for_RenderedEmail = {
-    'createdAt': Date;
-    'deletedAt'?: Date;
-    'id': TypedUuidForNotificationId;
-    'kind': string;
-    'medium': NotificationMedium;
-    'message'?: RenderedEmail;
-    'recipient': RecipientId;
-    'status': NotificationStatus;
-    'updatedAt': Date;
-};
+/**
+ * Wrapper containing the assignment object
+ */
 type CreatedAssignment = {
     'assignment': ReviewAssignment;
-    'notification': Notification_for_RenderedEmail;
 };
+/**
+ * Aggregate collection of results indexed by the reviewer ids that were requested to be assigned to the applcation
+ */
 type CreateReviewAssignmentsResponse = {
     'failure': Record<string, ReviewAssignmentCreationError>;
     'success': Record<string, CreatedAssignment>;
@@ -655,6 +681,16 @@ type Listing = {
     'state': RoleListingStatus;
     'updatedAt': Date;
 };
+type TypedUuidForListingPoolId = string;
+type ListingPool = {
+    'association': ListingPoolAssociation;
+    'createdAt': Date;
+    'deletedAt'?: Date;
+    'id': TypedUuidForListingPoolId;
+    'listingId': TypedUuidForListingId;
+    'poolId': TypedUuidForPoolId;
+    'updatedAt': Date;
+};
 type TypedUuidForMagicLinkRedirectUriId = string;
 type MagicLinkRedirectUri = {
     'createdAt': Date;
@@ -711,9 +747,37 @@ type Mapper = {
     'rule': Record<string, unknown>;
     'updatedAt': Date;
 };
+type NotificationMedium = 'Email';
+type NotificationStatus = 'Failed' | 'Pending' | 'Scheduled' | 'Sent';
+type TypedUuidForNotificationId = string;
+type RenderedEmail = {
+    'from': string;
+    'html'?: string;
+    'name': string;
+    'subject': string;
+    'text': string;
+};
+type RecipientId = {
+    'Applicant': TypedUuidForApplicantId;
+} | {
+    'Custom': string;
+} | {
+    'Reviewer': TypedUuidForReviewerId;
+};
+type Notification_for_RenderedEmail = {
+    'createdAt': Date;
+    'deletedAt'?: Date;
+    'id': TypedUuidForNotificationId;
+    'kind': string;
+    'medium': NotificationMedium;
+    'message'?: RenderedEmail;
+    'recipient': RecipientId;
+    'status': NotificationStatus;
+    'updatedAt': Date;
+};
 type OAuthAuthzCodeExchangeBody = {
-    'clientId': TypedUuidForOAuthClientId;
-    'clientSecret': SecretString;
+    'clientId'?: TypedUuidForOAuthClientId;
+    'clientSecret'?: SecretString;
     'code': string;
     'grantType': string;
     'pkceVerifier'?: string;
@@ -803,8 +867,19 @@ type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchE
     'updatedAt': Date;
 };
 type OptionalTransitionBody = {
+    /** An optional message to send to the applicant */
     'message'?: EmailConfig;
 };
+type Pool = {
+    'createdAt': Date;
+    'deletedAt'?: Date;
+    'description'?: string;
+    'id': TypedUuidForPoolId;
+    'listings': ListingPool[];
+    'name': string;
+    'reviewers': TypedUuidForReviewerId[];
+    'updatedAt': Date;
+};
 type RegisterApplicant = {
     'email': string;
 };
@@ -925,6 +1000,9 @@ interface UpdateApplicantContactPathParams {
 interface ViewApplicationPathParams {
     application: TypedUuidForApplicationId;
 }
+interface ApplyReviewActionPathParams {
+    application: TypedUuidForApplicationId;
+}
 interface ListApplicationReviewAssignmentsPathParams {
     application: TypedUuidForApplicationId;
 }
@@ -947,6 +1025,9 @@ interface CreateDocumentUploadUrlPathParams {
 interface GetApplicationInterviewCodePathParams {
     application: TypedUuidForApplicationId;
 }
+interface SimulateReviewActionPathParams {
+    application: TypedUuidForApplicationId;
+}
 interface SubmitApplicationPathParams {
     application: TypedUuidForApplicationId;
 }
@@ -1112,6 +1193,18 @@ interface DeleteOauthClientSecretPathParams {
     clientId: TypedUuidForOAuthClientId;
     secretId: TypedUuidForOAuthSecretId;
 }
+interface ViewPoolPathParams {
+    pool: TypedUuidForPoolId;
+}
+interface UpdatePoolPathParams {
+    pool: TypedUuidForPoolId;
+}
+interface AssignPoolPathParams {
+    pool: TypedUuidForPoolId;
+}
+interface UnassignPoolPathParams {
+    assignment: TypedUuidForListingPoolId;
+}
 interface ListReviewsQueryParams {
     application?: TypedUuidForApplicationId;
     reviewer?: TypedUuidForReviewerId;
@@ -1227,16 +1320,37 @@ declare class Api extends HttpClient {
             path: UpdateApplicantContactPathParams;
             body: UpdateApplicantContact;
         }, params?: FetchParams) => Promise<ApiResult<ApplicantInfo>>;
+        /**
+         * View all applications
+         */
         listApplications: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Application[]>>;
+        /**
+         * Create a new application
+         */
         createApplication: ({ body, }: {
             body: CreateApplication;
         }, params?: FetchParams) => Promise<ApiResult<CreatedApplication>>;
+        /**
+         * View an application
+         */
         viewApplication: ({ path, }: {
             path: ViewApplicationPathParams;
         }, params?: FetchParams) => Promise<ApiResult<Application>>;
+        /**
+         * Compute the next review action to take on this application and apply the necessary changes
+         */
+        applyReviewAction: ({ path, }: {
+            path: ApplyReviewActionPathParams;
+        }, params?: FetchParams) => Promise<ApiResult<ReviewAssignment[]>>;
+        /**
+         * List the individual reviewers that are assigned to this application
+         */
         listApplicationReviewAssignments: ({ path, }: {
             path: ListApplicationReviewAssignmentsPathParams;
         }, params?: FetchParams) => Promise<ApiResult<ReviewAssignment[]>>;
+        /**
+         * Assign individual reviewers to this application
+         */
         createApplicationReviewAssignments: ({ path, body, }: {
             path: CreateApplicationReviewAssignmentsPathParams;
             body: CreateReviewAssignments;
@@ -1244,46 +1358,88 @@ declare class Api extends HttpClient {
         viewApplicationBundle: ({ path, }: {
             path: ViewApplicationBundlePathParams;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationBundle>>;
+        /**
+         * Attach an uploaded document to an application
+         */
         attachDocument: ({ path, body, }: {
             path: AttachDocumentPathParams;
             body: AttachDocument;
         }, params?: FetchParams) => Promise<ApiResult<Document>>;
+        /**
+         * Generate a pre-signed upload url for uploading a document to an application
+         */
         createDocumentUploadUrl: ({ path, }: {
             path: CreateDocumentUploadUrlPathParams;
         }, params?: FetchParams) => Promise<ApiResult<DocumentUploadUrlResponse>>;
+        /**
+         * Retrieve the interview code associated with an application
+         */
         getApplicationInterviewCode: ({ path, }: {
             path: GetApplicationInterviewCodePathParams;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationInterviewCode>>;
+        /**
+         * Simulate the selection of the next review action without performing any changes
+         */
+        simulateReviewAction: ({ path, }: {
+            path: SimulateReviewActionPathParams;
+        }, params?: FetchParams) => Promise<ApiResult<PoolAction>>;
+        /**
+         * Submit an application that has all required documents attached
+         */
         submitApplication: ({ path, }: {
             path: SubmitApplicationPathParams;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * Move an application to the Declined stage
+         */
         transitionApplicationToDeclined: ({ path, body, }: {
             path: TransitionApplicationToDeclinedPathParams;
             body: TransitionBody;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * Move an application to the Deferred stage
+         */
         transitionApplicationToDeferred: ({ path, body, }: {
             path: TransitionApplicationToDeferredPathParams;
             body: TransitionBody;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * Move an application to the Interviewing stage
+         */
         transitionApplicationToInterviewing: ({ path, body, }: {
             path: TransitionApplicationToInterviewingPathParams;
             body: OptionalTransitionBody;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * Move an application to the Next Steps stage
+         */
         transitionApplicationToNextSteps: ({ path, body, }: {
             path: TransitionApplicationToNextStepsPathParams;
             body: OptionalTransitionBody;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * Move an application to the Offer stage
+         */
         transitionApplicationToOffer: ({ path, body, }: {
             path: TransitionApplicationToOfferPathParams;
             body: OptionalTransitionBody;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * Move an application to the Withdrawn stage
+         */
         transitionApplicationToWithdrawn: ({ path, body, }: {
             path: TransitionApplicationToWithdrawnPathParams;
             body: OptionalTransitionBody;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
+        /**
+         * List all application summaries
+         */
         listApplicationSummaries: ({ query, }: {
             query?: ListApplicationSummariesQueryParams;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationSummariesResponse>>;
+        /**
+         * View a summary that includes an application and the related evaluations
+         */
         viewApplicationSummary: ({ path, }: {
             path: ViewApplicationSummaryPathParams;
         }, params?: FetchParams) => Promise<ApiResult<ApplicationSummaryResponse>>;
@@ -1540,6 +1696,42 @@ declare class Api extends HttpClient {
         deleteOauthClientSecret: ({ path, }: {
             path: DeleteOauthClientSecretPathParams;
         }, params?: FetchParams) => Promise<ApiResult<OAuthClientSecret>>;
+        /**
+         * List reviewer pools and their associations
+         */
+        listPools: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Pool[]>>;
+        /**
+         * Create a new pool
+         */
+        createPool: ({ body, }: {
+            body: CreatePool;
+        }, params?: FetchParams) => Promise<ApiResult<Pool>>;
+        /**
+         * View a pool and its associations
+         */
+        viewPool: ({ path, }: {
+            path: ViewPoolPathParams;
+        }, params?: FetchParams) => Promise<ApiResult<Pool>>;
+        /**
+         * Update a pool
+         */
+        updatePool: ({ path, body, }: {
+            path: UpdatePoolPathParams;
+            body: CreatePool;
+        }, params?: FetchParams) => Promise<ApiResult<Pool>>;
+        /**
+         * Assign a pool to a listing
+         */
+        assignPool: ({ path, body, }: {
+            path: AssignPoolPathParams;
+            body: AssignPool;
+        }, params?: FetchParams) => Promise<ApiResult<ListingPool>>;
+        /**
+         * Unassign a pool from a listing
+         */
+        unassignPool: ({ path, }: {
+            path: UnassignPoolPathParams;
+        }, params?: FetchParams) => Promise<ApiResult<void>>;
         listReviews: ({ query, }: {
             query?: ListReviewsQueryParams;
         }, params?: FetchParams) => Promise<ApiResult<ReviewInfo[]>>;
@@ -1576,4 +1768,4 @@ declare class Api extends HttpClient {
     ws: {};
 }
 
-export { type ApplicationState as $, type ApiConfig as A, type AddMagicLinkRedirectBody as B, type AddOAuthClientRedirectBody as C, type DocumentParent as D, type ApiKeyCreateParams_for_TurnstilePermission as E, type FullParams as F, type ApiKeyResponse_for_TurnstilePermission as G, type TypedUuidForUserProviderId as H, type ApiUserContactEmail as I, type ApiUserEmailUpdateParams as J, type ApiUserProvider as K, type ApiUser_for_TurnstilePermission as L, type ApiUserInfo_for_TurnstilePermission as M, type ApiUserLinkRequestPayload as N, type ApiUserLinkRequestResponse as O, type Permissions_for_TurnstilePermission as P, type ApiUserProviderLinkPayload as Q, type ApiUserUpdateParams_for_TurnstilePermission as R, type SecretString as S, type TypedUuidForApplicantId as T, type Applicant as U, type TypedUuidForApplicantContactId as V, type ApplicantContactField as W, type ApplicantContact as X, type ApplicantInfo as Y, type InterviewingState as Z, type OfferState as _, Api as a, type MagicLink as a$, type Application as a0, type DocumentKind as a1, type DocumentSource as a2, type Document as a3, type ApplicationBundle as a4, type TypedUuidForApplicationInterviewCodeId as a5, type ApplicationInterviewCode as a6, type TypedUuidForApplicationStateRecordId as a7, type ApplicationStateRecord as a8, type ReviewScore as a9, type RenderedEmail as aA, type RecipientId as aB, type NotificationStatus as aC, type Notification_for_RenderedEmail 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 TypedUuidForMagicLinkRedirectUriId as aY, type MagicLinkRedirectUri as aZ, type MagicLinkSecret as a_, type Reviews as aa, type ExpandedApplicationSummary as ab, type Evaluator as ac, type ApplicationSummariesResponse as ad, type ApplicationSummaryResponse as ae, type AttachDocument as af, type EmailConfig as ag, type TransitionMessage as ah, type TransitionBody as ai, type BatchParameter_for_TransitionBody as aj, type ViewApplication as ak, type BatchParameter_for_ViewApplication as al, type CreateApplication as am, type CreateDepartment as an, type CreateDocument as ao, type RoleListingStatus as ap, type CreateListing as aq, type CreateMapper as ar, type CreateReview as as, type CreateReviewAssignments as at, type ReviewAssignmentCreationError as au, type TypedUuidForReviewAssignmentId as av, type ReviewAssignmentState as aw, type ReviewAssignment as ax, type TypedUuidForNotificationId as ay, type NotificationMedium as az, type ApiResult as b, type TransitionApplicationToDeferredPathParams as b$, type TypedUuidForMagicLinkAttemptId as b0, type MagicLinkExchangeRequest as b1, type MagicLinkExchangeResponse as b2, type MagicLinkMedium as b3, type MagicLinkSendRequest as b4, type MagicLinkSendResponse as b5, type Mapper as b6, type OAuthAuthzCodeExchangeBody as b7, type OAuthAuthzCodeExchangeResponse as b8, type TypedUuidForOAuthRedirectUriId as b9, type UpdateDocumentStatus as bA, type UpdateListing as bB, type UpdateReview as bC, type ScalarApplicationState as bD, type GetApiUserPathParams as bE, type UpdateApiUserPathParams as bF, type SetApiUserContactEmailPathParams as bG, type AddApiUserToGroupPathParams as bH, type RemoveApiUserFromGroupPathParams as bI, type LinkProviderPathParams as bJ, type ListApiUserTokensPathParams as bK, type CreateApiUserTokenPathParams as bL, type GetApiUserTokenPathParams as bM, type DeleteApiUserTokenPathParams as bN, type CreateLinkTokenPathParams as bO, type ListApplicantsQueryParams as bP, type ViewApplicantPathParams as bQ, type UpdateApplicantContactPathParams as bR, type ViewApplicationPathParams as bS, type ListApplicationReviewAssignmentsPathParams as bT, type CreateApplicationReviewAssignmentsPathParams as bU, type ViewApplicationBundlePathParams as bV, type AttachDocumentPathParams as bW, type CreateDocumentUploadUrlPathParams as bX, type GetApplicationInterviewCodePathParams as bY, type SubmitApplicationPathParams as bZ, type TransitionApplicationToDeclinedPathParams as b_, type OAuthClientRedirectUri as ba, type OAuthClientSecret as bb, type OAuthClient as bc, type OAuthProviderName as bd, type OAuthProviderInfo as be, type OpenIdConfiguration as bf, type OperationState as bg, type OperationTaskState as bh, type TypedUuidForOperationTaskId as bi, type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue as bj, type Operation_for_TurnstilePermission_and_String as bk, type TransitionApplicationToDeclinedBatchEndpoint as bl, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint as bm, type TransitionApplicationToDeferredBatchEndpoint as bn, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint as bo, type OptionalTransitionBody as bp, type RegisterApplicant as bq, type Review as br, type Reviewer as bs, type ReviewerInfo as bt, type ReviewInfo as bu, type Role as bv, type TransitionApplicationToDeclinedBatch as bw, type TransitionApplicationToDeferredBatch as bx, type UpdateApplicantContact as by, type UpdateDocument as bz, type TypedUuidForUserId as c, type TransitionApplicationToInterviewingPathParams as c0, type TransitionApplicationToNextStepsPathParams as c1, type TransitionApplicationToOfferPathParams as c2, type TransitionApplicationToWithdrawnPathParams as c3, type ListApplicationSummariesQueryParams as c4, type ViewApplicationSummaryPathParams as c5, type ListOperationsQueryParams as c6, type GetOperationPathParams as c7, type ListOperationTasksQueryParams as c8, type ViewDepartmentPathParams as c9, type DeleteMagicLinkSecretPathParams as cA, type GetMappersQueryParams as cB, type DeleteMapperPathParams as cC, type ListNotificationsQueryParams as cD, type EmailApplicantPathParams as cE, type GetOauthClientPathParams as cF, type CreateOauthClientRedirectUriPathParams as cG, type DeleteOauthClientRedirectUriPathParams as cH, type CreateOauthClientSecretPathParams as cI, type DeleteOauthClientSecretPathParams as cJ, type ListReviewsQueryParams as cK, type ViewReviewPathParams as cL, type UpdateReviewPathParams as cM, type DeleteReviewPathParams as cN, type ListReviewersQueryParams as cO, type ViewRolePathParams as cP, type ErrorBody as cQ, type ErrorResult as cR, type ListDocumentsQueryParams as ca, type ViewDocumentPathParams as cb, type UpdateDocumentPathParams as cc, type DeleteDocumentPathParams as cd, type ViewDocumentDataPathParams as ce, type UpdateDocumentStatusPathParams as cf, type UpdateGroupPathParams as cg, type DeleteGroupPathParams as ch, type ListInterviewsQueryParams as ci, type ListInterviewersQueryParams as cj, type ViewListingPathParams as ck, type UpdateListingPathParams as cl, type UpdateListingStatePathParams as cm, type MagicLinkExchangePathParams as cn, type MagicLinkSendPathParams as co, type AuthzCodeRedirectPathParams as cp, type AuthzCodeRedirectQueryParams as cq, type AuthzCodeCallbackPathParams as cr, type AuthzCodeCallbackQueryParams as cs, type AuthzCodeExchangePathParams as ct, type GetDeviceProviderPathParams as cu, type ExchangeDeviceTokenPathParams as cv, type GetMagicLinkPathParams as cw, type CreateMagicLinkRedirectUriPathParams as cx, type DeleteMagicLinkRedirectUriPathParams as cy, type CreateMagicLinkSecretPathParams as cz, type TypedUuidForApplicationId as d, 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 TypedUuidForReviewerId as k, type TypedUuidForReviewId as l, type TypedUuidForInterviewerId as m, type TypedUuidForInterviewId as n, type TypedUuidForBackgroundCheckId as o, type TypedUuidForOperationId as p, type TypedUuidForApiKeyId as q, type TypedUuidForAccessGroupId as r, type TypedUuidForMapperId as s, type TypedUuidForOAuthClientId as t, type TypedUuidForMagicLinkId as u, type TurnstilePermission as v, type AccessGroupUpdateParams_for_TurnstilePermission as w, type AccessGroup_for_TurnstilePermission as x, type AccessTokenExchangeRequest as y, type AddGroupBody as z };
+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 };