@oxide/turnstile.ts 0.7.0-rc.0 → 0.8.0

package/src/Api.ts

@@ -1,13 +1,5 @@
 /* eslint-disable */
 
-/**
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, you can obtain one at https://mozilla.org/MPL/2.0/.
- *
- * Copyright Oxide Computer Company
- */
-
 import type { FetchParams } from './http-client'
 import { HttpClient, toQueryString } from './http-client'
 
@@ -82,6 +74,7 @@ export type TurnstilePermission =
     | 'WithdrawApplicationsAssigned'
     | 'ManageApplicationsAssigned'
     | 'ManageApplicationsAll'
+    | 'GetApplicationSummariesAll'
     | 'GetDocumentsAssigned'
     | 'GetDocumentsAll'
     | 'CreateDocument'
@@ -186,90 +179,90 @@ export type TurnstilePermission =
     | 'ManageMagicLinkClientsAll'
     | 'CreateAccessToken'
     | { 'GetApplicant': TypedUuidForApplicantId }
-    | { 'GetApplicants': TypedUuidForApplicantId[] }
+    | { 'GetApplicants': (TypedUuidForApplicantId)[] }
     | { 'CreateApplicant': TypedUuidForUserId }
-    | { 'CreateApplicants': TypedUuidForUserId[] }
+    | { 'CreateApplicants': (TypedUuidForUserId)[] }
     | { 'ManageApplicant': TypedUuidForApplicantId }
-    | { 'ManageApplicants': TypedUuidForApplicantId[] }
+    | { 'ManageApplicants': (TypedUuidForApplicantId)[] }
     | { 'GetApplication': TypedUuidForApplicationId }
-    | { 'GetApplications': TypedUuidForApplicationId[] }
+    | { 'GetApplications': (TypedUuidForApplicationId)[] }
     | { 'CreateApplication': TypedUuidForApplicantId }
     | { 'SubmitApplication': TypedUuidForApplicationId }
-    | { 'SubmitApplications': TypedUuidForApplicationId[] }
+    | { 'SubmitApplications': (TypedUuidForApplicationId)[] }
     | { 'WithdrawApplication': TypedUuidForApplicationId }
-    | { 'WithdrawApplications': TypedUuidForApplicationId[] }
+    | { 'WithdrawApplications': (TypedUuidForApplicationId)[] }
     | { 'ManageApplication': TypedUuidForApplicationId }
-    | { 'ManageApplications': TypedUuidForApplicationId[] }
+    | { 'ManageApplications': (TypedUuidForApplicationId)[] }
     | { 'GetDocument': TypedUuidForDocumentId }
-    | { 'GetDocuments': TypedUuidForDocumentId[] }
+    | { 'GetDocuments': (TypedUuidForDocumentId)[] }
     | { 'ManageDocument': TypedUuidForDocumentId }
-    | { 'ManageDocuments': TypedUuidForDocumentId[] }
+    | { 'ManageDocuments': (TypedUuidForDocumentId)[] }
     | { 'AttachDocument': DocumentParent }
-    | { 'AttachDocuments': DocumentParent[] }
+    | { 'AttachDocuments': (DocumentParent)[] }
     | { 'GetDepartment': TypedUuidForDepartmentId }
-    | { 'GetDepartments': TypedUuidForDepartmentId[] }
+    | { 'GetDepartments': (TypedUuidForDepartmentId)[] }
     | { 'GetRole': TypedUuidForRoleId }
-    | { 'GetRoles': TypedUuidForRoleId[] }
+    | { 'GetRoles': (TypedUuidForRoleId)[] }
     | { 'GetListing': TypedUuidForListingId }
-    | { 'GetListings': TypedUuidForListingId[] }
+    | { 'GetListings': (TypedUuidForListingId)[] }
     | { 'GetPool': TypedUuidForPoolId }
-    | { 'GetPools': TypedUuidForPoolId[] }
+    | { 'GetPools': (TypedUuidForPoolId)[] }
     | { 'GetReviewer': TypedUuidForReviewerId }
-    | { 'GetReviewers': TypedUuidForReviewerId[] }
+    | { 'GetReviewers': (TypedUuidForReviewerId)[] }
     | { 'CreateReviewer': TypedUuidForUserId }
-    | { 'CreateReviewers': TypedUuidForUserId[] }
+    | { 'CreateReviewers': (TypedUuidForUserId)[] }
     | { 'GetReview': TypedUuidForReviewId }
-    | { 'GetReviews': TypedUuidForReviewId[] }
+    | { 'GetReviews': (TypedUuidForReviewId)[] }
     | { 'ManageReview': TypedUuidForReviewId }
-    | { 'ManageReviews': TypedUuidForReviewId[] }
+    | { 'ManageReviews': (TypedUuidForReviewId)[] }
     | { 'CompleteReviewAssignment': TypedUuidForUserId }
     | { 'GetInterviewer': TypedUuidForInterviewerId }
-    | { 'GetInterviewers': TypedUuidForInterviewerId[] }
+    | { 'GetInterviewers': (TypedUuidForInterviewerId)[] }
     | { 'CreateInterviewer': TypedUuidForUserId }
-    | { 'CreateInterviewers': TypedUuidForUserId[] }
+    | { 'CreateInterviewers': (TypedUuidForUserId)[] }
     | { 'ManageInterviewer': TypedUuidForInterviewerId }
-    | { 'ManageInterviewers': TypedUuidForInterviewerId[] }
+    | { 'ManageInterviewers': (TypedUuidForInterviewerId)[] }
     | { 'GetInterview': TypedUuidForInterviewId }
-    | { 'GetInterviews': TypedUuidForInterviewId[] }
+    | { 'GetInterviews': (TypedUuidForInterviewId)[] }
     | { 'ManageInterview': TypedUuidForInterviewId }
-    | { 'ManageInterviews': TypedUuidForInterviewId[] }
+    | { 'ManageInterviews': (TypedUuidForInterviewId)[] }
     | { 'GetBackgroundCheck': TypedUuidForBackgroundCheckId }
-    | { 'GetBackgroundChecks': TypedUuidForBackgroundCheckId[] }
+    | { 'GetBackgroundChecks': (TypedUuidForBackgroundCheckId)[] }
     | { 'ManageBackgroundCheck': TypedUuidForBackgroundCheckId }
-    | { 'ManageBackgroundChecks': TypedUuidForBackgroundCheckId[] }
+    | { 'ManageBackgroundChecks': (TypedUuidForBackgroundCheckId)[] }
     | { 'GetEmployee': TypedUuidForEmployeeId }
-    | { 'GetEmployees': TypedUuidForEmployeeId[] }
+    | { 'GetEmployees': (TypedUuidForEmployeeId)[] }
     | { 'ManageEmployee': TypedUuidForEmployeeId }
-    | { 'ManageEmployees': TypedUuidForEmployeeId[] }
+    | { 'ManageEmployees': (TypedUuidForEmployeeId)[] }
     | { 'GetBatchOperation': TypedUuidForOperationId }
-    | { 'GetBatchOperations': TypedUuidForOperationId[] }
+    | { 'GetBatchOperations': (TypedUuidForOperationId)[] }
     | { 'GetApiUser': TypedUuidForUserId }
-    | { 'GetApiUsers': TypedUuidForUserId[] }
+    | { 'GetApiUsers': (TypedUuidForUserId)[] }
     | { 'ManageApiUser': TypedUuidForUserId }
-    | { 'ManageApiUsers': TypedUuidForUserId[] }
+    | { 'ManageApiUsers': (TypedUuidForUserId)[] }
     | { 'CreateApiKey': TypedUuidForUserId }
     | { 'GetApiKey': TypedUuidForApiKeyId }
-    | { 'GetApiKeys': TypedUuidForApiKeyId[] }
+    | { 'GetApiKeys': (TypedUuidForApiKeyId)[] }
     | { 'ManageApiKey': TypedUuidForApiKeyId }
-    | { 'ManageApiKeys': TypedUuidForApiKeyId[] }
+    | { 'ManageApiKeys': (TypedUuidForApiKeyId)[] }
     | { 'GetGroup': TypedUuidForAccessGroupId }
     | { 'ManageGroup': TypedUuidForAccessGroupId }
-    | { 'ManageGroups': TypedUuidForAccessGroupId[] }
+    | { 'ManageGroups': (TypedUuidForAccessGroupId)[] }
     | { 'ManageGroupMembership': TypedUuidForAccessGroupId }
-    | { 'ManageGroupMemberships': TypedUuidForAccessGroupId[] }
+    | { 'ManageGroupMemberships': (TypedUuidForAccessGroupId)[] }
     | { 'ManageMapper': TypedUuidForMapperId }
-    | { 'ManageMappers': TypedUuidForMapperId[] }
+    | { 'ManageMappers': (TypedUuidForMapperId)[] }
     | { 'GetOAuthClient': TypedUuidForOAuthClientId }
-    | { 'GetOAuthClients': TypedUuidForOAuthClientId[] }
+    | { 'GetOAuthClients': (TypedUuidForOAuthClientId)[] }
     | { 'ManageOAuthClient': TypedUuidForOAuthClientId }
-    | { 'ManageOAuthClients': TypedUuidForOAuthClientId[] }
+    | { 'ManageOAuthClients': (TypedUuidForOAuthClientId)[] }
     | { 'GetMagicLinkClient': TypedUuidForMagicLinkId }
-    | { 'GetMagicLinkClients': TypedUuidForMagicLinkId[] }
+    | { 'GetMagicLinkClients': (TypedUuidForMagicLinkId)[] }
     | { 'ManageMagicLinkClient': TypedUuidForMagicLinkId }
-    | { 'ManageMagicLinkClients': TypedUuidForMagicLinkId[] }
+    | { 'ManageMagicLinkClients': (TypedUuidForMagicLinkId)[] }
     | { 'Unsupported': Record<string, unknown> }
 
-export type Permissions_for_TurnstilePermission = TurnstilePermission[]
+export type Permissions_for_TurnstilePermission = (TurnstilePermission)[]
 
 export type AccessGroupUpdateParams_for_TurnstilePermission = {
     'name': string
@@ -278,14 +271,14 @@ export type AccessGroupUpdateParams_for_TurnstilePermission = {
 
 export type AccessGroup_for_TurnstilePermission = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForAccessGroupId
     'name': string
     'permissions': Permissions_for_TurnstilePermission
     'updatedAt': Date
 }
 
-export type AccessTokenExchangeRequest = { 'deviceCode': string; 'expiresAt'?: Date; 'grantType': string }
+export type AccessTokenExchangeRequest = { 'deviceCode': string; 'expiresAt'?: Date | null; 'grantType': string }
 
 export type AddGroupBody = { 'groupId': TypedUuidForAccessGroupId }
 
@@ -295,20 +288,20 @@ export type AddOAuthClientRedirectBody = { 'redirectUri': string }
 
 export type ApiKeyCreateParams_for_TurnstilePermission = {
     'expiresAt': Date
-    'permissions'?: Permissions_for_TurnstilePermission
+    'permissions'?: Permissions_for_TurnstilePermission | null
 }
 
 export type ApiKeyResponse_for_TurnstilePermission = {
     'createdAt': Date
     'id': TypedUuidForApiKeyId
-    'permissions'?: Permissions_for_TurnstilePermission
+    'permissions'?: Permissions_for_TurnstilePermission | null
 }
 
 export type TypedUuidForUserProviderId = string
 
 export type ApiUserContactEmail = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'email': string
     'id': TypedUuidForUserProviderId
     'updatedAt': Date
@@ -319,9 +312,9 @@ export type ApiUserEmailUpdateParams = { 'email': string }
 
 export type ApiUserProvider = {
     'createdAt': Date
-    'deletedAt'?: Date
-    'displayNames': string[]
-    'emails': string[]
+    'deletedAt'?: Date | null
+    'displayNames': (string)[]
+    'emails': (string)[]
     'id': TypedUuidForUserProviderId
     'provider': string
     'providerId': string
@@ -331,16 +324,16 @@ export type ApiUserProvider = {
 
 export type ApiUser_for_TurnstilePermission = {
     'createdAt': Date
-    'deletedAt'?: Date
-    'groups': TypedUuidForAccessGroupId[]
+    'deletedAt'?: Date | null
+    'groups': (TypedUuidForAccessGroupId)[]
     'id': TypedUuidForUserId
     'permissions': Permissions_for_TurnstilePermission
     'updatedAt': Date
 }
 
 export type ApiUserInfo_for_TurnstilePermission = {
-    'email'?: ApiUserContactEmail
-    'providers': ApiUserProvider[]
+    'email'?: ApiUserContactEmail | null
+    'providers': (ApiUserProvider)[]
     'user': ApiUser_for_TurnstilePermission
 }
 
@@ -353,14 +346,14 @@ export type ApiUserLinkRequestResponse = { 'token': SecretString }
 export type ApiUserProviderLinkPayload = { 'token': string }
 
 export type ApiUserUpdateParams_for_TurnstilePermission = {
-    'groupIds': TypedUuidForAccessGroupId[]
+    'groupIds': (TypedUuidForAccessGroupId)[]
     'permissions': Permissions_for_TurnstilePermission
 }
 
 export type Applicant = {
     'apiUserId': TypedUuidForUserId
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForApplicantId
     'updatedAt': Date
 }
@@ -382,14 +375,14 @@ export type ApplicantContactField =
 export type ApplicantContact = {
     'applicantId': TypedUuidForApplicantId
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForApplicantContactId
     'kind': ApplicantContactField
     'updatedAt': Date
-    'value'?: string
+    'value'?: string | null
 }
 
-export type ApplicantInfo = { 'contact': ApplicantContact[]; 'info': Applicant }
+export type ApplicantInfo = { 'contact': (ApplicantContact)[]; 'info': Applicant }
 
 export type InterviewingState =
     | 'scheduled'
@@ -399,13 +392,13 @@ export type InterviewingState =
     | 'complete'
 
 export type OfferState =
-    | 'start'
     | 'documents_sent'
     | 'documents_complete'
     | 'background_check_sent'
     | 'background_check_warning'
     | 'background_check_complete'
     | 'complete'
+    | { 'start': string }
 
 export type ApplicationState =
     | 'contracted'
@@ -422,13 +415,13 @@ export type ApplicationState =
 
 export type Application = {
     'applicantId': TypedUuidForApplicantId
-    'completedAt'?: Date
+    'completedAt'?: Date | null
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForApplicationId
     'listingId': TypedUuidForListingId
     'state': ApplicationState
-    'submittedAt'?: Date
+    'submittedAt'?: Date | null
     'updatedAt': Date
 }
 
@@ -449,18 +442,18 @@ export type DocumentSource =
 
 export type Document = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'externalId': string
     'id': TypedUuidForDocumentId
     'kind': DocumentKind
-    'mime'?: string
+    'mime'?: string | null
     'parentId': DocumentParent
     'source': DocumentSource
-    'status'?: string
+    'status'?: string | null
     'updatedAt': Date
 }
 
-export type ApplicationBundle = { 'applicant': ApplicantInfo; 'application': Application; 'documents': Document[] }
+export type ApplicationBundle = { 'applicant': ApplicantInfo; 'application': Application; 'documents': (Document)[] }
 
 export type TypedUuidForApplicationInterviewCodeId = string
 
@@ -476,9 +469,9 @@ export type TypedUuidForApplicationStateRecordId = string
 export type ApplicationStateRecord = {
     'applicationId': TypedUuidForApplicationId
     'createdAt': Date
-    'deletedAt'?: Date
     'id': TypedUuidForApplicationStateRecordId
     'state': ApplicationState
+    'supersededAt'?: Date | null
     'updatedAt': Date
 }
 
@@ -487,9 +480,20 @@ export type ListingPoolAssociation =
     | 'early_positive'
     | 'positive'
 
+export type TriageReason =
+    | 'has_no_ratings'
+    | 'likely_next_steps'
+    | 'likely_pass'
+    | 'possibly_next_steps'
+    | 'possibly_pass'
+    | 'very_likely_pass'
+    | 'unknown'
+
 export type PoolAction =
-    | { 'action': 'add'; 'association': ListingPoolAssociation; 'count': number }
-    | { 'action': 'triage' }
+    | 'drop'
+    | 'wait'
+    | { 'add': { 'association': ListingPoolAssociation; 'count': number } }
+    | { 'triage': { 'reason': TriageReason } }
 
 export type ReviewScore =
     | 'emphatic_yes'
@@ -501,40 +505,50 @@ export type ReviewScore =
 
 export type Reviews = {
     'applicationId': TypedUuidForApplicationId
-    'complete': TypedUuidForReviewerId[]
-    'pending': TypedUuidForReviewerId[]
-    'reviewers': TypedUuidForReviewerId[]
-    'scores': ReviewScore[]
+    'complete': (TypedUuidForReviewerId)[]
+    'pending': (TypedUuidForReviewerId)[]
+    'reviewers': (TypedUuidForReviewerId)[]
+    'scores': (ReviewScore)[]
 }
 
 export type ExpandedApplicationSummary = {
     'action': PoolAction
     'applicant': ApplicantInfo
     'application': Application
-    'documents': Document[]
-    'interviewers': TypedUuidForInterviewerId[]
-    'interviews': TypedUuidForInterviewId[]
+    'documents': (Document)[]
+    'interviewers': (TypedUuidForInterviewerId)[]
+    'interviews': (TypedUuidForInterviewId)[]
     'reviews': Reviews
 }
 
 export type Evaluator = {
-    'interviewer'?: TypedUuidForInterviewerId
-    'reviewer'?: TypedUuidForReviewerId
+    'interviewer'?: TypedUuidForInterviewerId | null
+    'reviewer'?: TypedUuidForReviewerId | null
     'user': ApiUserInfo_for_TurnstilePermission
 }
 
-export type ApplicationSummariesResponse = { 'summaries': ExpandedApplicationSummary[]; 'users': Evaluator[] }
+export type ApplicationSummariesResponse = { 'summaries': (ExpandedApplicationSummary)[]; 'users': (Evaluator)[] }
 
-export type ApplicationSummaryResponse = { 'summary': ExpandedApplicationSummary; 'users': Evaluator[] }
+export type ApplicationSummaryResponse = { 'summary': ExpandedApplicationSummary; 'users': (Evaluator)[] }
 
-export type AssignPool = { 'association': ListingPoolAssociation; 'listing': TypedUuidForListingId }
+export type AssignPool = {
+    /** Review stage of the listing this pool should be associated to */
+    'association': ListingPoolAssociation
+    /** Listing to assign this pool to */
+    'listing': TypedUuidForListingId
+}
 
-export type AttachDocument = { 'externalId': string; 'mime'?: string }
+export type AttachDocument = {
+    /** Id assigned to the document by the external datastore */
+    'externalId': string
+    /** Mime type of the document */
+    'mime'?: string | null
+}
 
 export type EmailConfig = {
     'from': string
-    'htmlTemplate'?: string
-    'name'?: string
+    'htmlTemplate'?: string | null
+    'name'?: string | null
     'subject': string
     'textTemplate': string
 }
@@ -544,19 +558,30 @@ export type TransitionMessage =
     | 'omit'
     | { 'custom': EmailConfig }
 
-export type TransitionBody = { 'message': TransitionMessage }
+export type TransitionBody = {
+    /** The message to send to the applicant */
+    'message': TransitionMessage
+}
 
 export type BatchParameter_for_TransitionBody =
     | { 'all': TransitionBody }
-    | { 'each': TransitionBody[] }
+    | { 'each': (TransitionBody)[] }
 
-export type ViewApplication = { 'application': TypedUuidForApplicationId }
+export type ViewApplication = {
+    /** Application to operate on */
+    'application': TypedUuidForApplicationId
+}
 
 export type BatchParameter_for_ViewApplication =
     | { 'all': ViewApplication }
-    | { 'each': ViewApplication[] }
+    | { 'each': (ViewApplication)[] }
 
-export type CreateApplication = { 'applicant': TypedUuidForApplicantId; 'listing': TypedUuidForListingId }
+export type CreateApplication = {
+    /** Applicant to create an application for */
+    'applicant': TypedUuidForApplicantId
+    /** Listing to apply to */
+    'listing': TypedUuidForListingId
+}
 
 export type CreateDepartment = { 'name': string }
 
@@ -566,7 +591,7 @@ export type CreateDocument = {
     'mime': string
     'parent': DocumentParent
     'source': DocumentSource
-    'status'?: string
+    'status'?: string | null
 }
 
 export type RoleListingStatus =
@@ -575,9 +600,16 @@ export type RoleListingStatus =
 
 export type CreateListing = { 'name': string; 'role': TypedUuidForRoleId; 'status': RoleListingStatus }
 
-export type CreateMapper = { 'maxActivations'?: number; 'name': string; 'rule': Record<string, unknown> }
+export type CreateMapper = { 'maxActivations'?: number | null; 'name': string; 'rule': Record<string, unknown> }
 
-export type CreatePool = { 'description'?: string; 'name': string; 'reviwers'?: TypedUuidForReviewerId[] }
+export type CreatePool = {
+    /** Optional description of the pool */
+    'description'?: string | null
+    /** Required display name for the pool */
+    'name': string
+    /** List of reviewers to assign to this pool */
+    'reviewers'?: (TypedUuidForReviewerId)[] | null
+}
 
 export type CreateReview = {
     'application': TypedUuidForApplicationId
@@ -586,24 +618,27 @@ export type CreateReview = {
     'score': ReviewScore
     'valueReflected': string
     'valueViolated': string
-    'valuesInTension': string[]
+    'valuesInTension': (string)[]
 }
 
 /**
  * Reviewers to assign to this application for review
  */
-export type CreateReviewAssignments = { 'reviewers': TypedUuidForReviewerId[] }
+export type CreateReviewAssignments = { 'reviewers': (TypedUuidForReviewerId)[] }
 
 /**
  * Failures that can occur when assigning a reviewer
  */
-export type ReviewAssignmentCreationError =
+export 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'
+)
 
 export type TypedUuidForReviewAssignmentId = string
 
@@ -614,7 +649,7 @@ export type ReviewAssignmentState =
 export type ReviewAssignment = {
     'applicationId': TypedUuidForApplicationId
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForReviewAssignmentId
     'reviewerId': TypedUuidForReviewerId
     'state': ReviewAssignmentState
@@ -640,26 +675,42 @@ export type CreatedApplication = { 'application': Application }
 
 export type Department = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForDepartmentId
     'name': string
     'updatedAt': Date
 }
 
-export type DocumentUploadUrlResponse = { 'externalId'?: string; 'url': string }
+export type DocumentUploadUrlResponse = { 'externalId'?: string | null; 'url': string }
 
-export type EmailApplicantBody = { 'from': string; 'html'?: string; 'subject': string; 'text': string }
+export type EmailApplicantBody = { 'from': string; 'html'?: string | null; 'subject': string; 'text': string }
+
+export type EmployeeState =
+    | 'onboarding'
+    | 'onboarded'
+    | 'offboarding'
+    | 'offboarded'
+    | { 'newHire': string }
+
+export type Employee = {
+    'apiUserId': TypedUuidForUserId
+    'createdAt': Date
+    'deletedAt'?: Date | null
+    'id': TypedUuidForEmployeeId
+    'state': EmployeeState
+    'updatedAt': Date
+}
 
 export type GetUserResponse_for_TurnstilePermission = {
     'info': ApiUser_for_TurnstilePermission
-    'providers': ApiUserProvider[]
+    'providers': (ApiUserProvider)[]
 }
 
 export type InitialApiKeyResponse_for_TurnstilePermission = {
     'createdAt': Date
     'id': TypedUuidForApiKeyId
     'key': SecretString
-    'permissions'?: Permissions_for_TurnstilePermission
+    'permissions'?: Permissions_for_TurnstilePermission | null
 }
 
 export type TypedUuidForMagicLinkSecretId = string
@@ -682,22 +733,22 @@ export type TypedUuidForInterviewAttendeeId = string
 
 export type InterviewAttendee = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForInterviewAttendeeId
     'interviewId': TypedUuidForInterviewId
     'interviewerDisplayName': string
     'interviewerEmail': string
-    'interviewerId'?: TypedUuidForInterviewerId
+    'interviewerId'?: TypedUuidForInterviewerId | null
     'updatedAt': Date
 }
 
 export type Interview = {
     'applicantId': TypedUuidForApplicantId
     'applicationId': TypedUuidForApplicationId
-    'attendees': InterviewAttendee[]
+    'attendees': (InterviewAttendee)[]
     'calendarSource': string
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'endTime': Date
     'externalId': string
     'id': TypedUuidForInterviewId
@@ -708,18 +759,18 @@ export type Interview = {
 export type Interviewer = {
     'apiUserId': TypedUuidForUserId
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForInterviewerId
     'updatedAt': Date
 }
 
 export type Jwk = { 'e': string; 'kid': string; 'kty': string; 'n': string; 'use': string }
 
-export type Jwks = { 'keys': Jwk[] }
+export type Jwks = { 'keys': (Jwk)[] }
 
 export type Listing = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForListingId
     'name': string
     'roleId': TypedUuidForRoleId
@@ -732,7 +783,7 @@ export type TypedUuidForListingPoolId = string
 export type ListingPool = {
     'association': ListingPoolAssociation
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForListingPoolId
     'listingId': TypedUuidForListingId
     'poolId': TypedUuidForPoolId
@@ -743,7 +794,7 @@ export type TypedUuidForMagicLinkRedirectUriId = string
 
 export type MagicLinkRedirectUri = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForMagicLinkRedirectUriId
     'magicLinkClientId': TypedUuidForMagicLinkId
     'redirectUri': string
@@ -751,7 +802,7 @@ export type MagicLinkRedirectUri = {
 
 export type MagicLinkSecret = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForMagicLinkSecretId
     'magicLinkClientId': TypedUuidForMagicLinkId
     'secretSignature': string
@@ -759,10 +810,10 @@ export type MagicLinkSecret = {
 
 export type MagicLink = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForMagicLinkId
-    'redirectUris': MagicLinkRedirectUri[]
-    'secrets': MagicLinkSecret[]
+    'redirectUris': (MagicLinkRedirectUri)[]
+    'secrets': (MagicLinkSecret)[]
 }
 
 export type TypedUuidForMagicLinkAttemptId = string
@@ -782,24 +833,28 @@ export type MagicLinkSendRequest = {
     'medium': MagicLinkMedium
     'recipient': string
     'redirectUri': string
-    'scope'?: string
+    'scope'?: string | null
     'secret': string
 }
 
 export type MagicLinkSendResponse = { 'attemptId': TypedUuidForMagicLinkAttemptId }
 
 export type Mapper = {
-    'activations'?: number
+    'activations'?: number | null
     'createdAt': Date
-    'deletedAt'?: Date
-    'depletedAt'?: Date
+    'deletedAt'?: Date | null
+    'depletedAt'?: Date | null
     'id': TypedUuidForMapperId
-    'maxActivations'?: number
+    'maxActivations'?: number | null
     'name': string
     'rule': Record<string, unknown>
     'updatedAt': Date
 }
 
+export type Provider = 'google'
+
+export type NewHireBody = { 'applicationId': TypedUuidForApplicationId; 'provider': Provider; 'providerId': string }
+
 export type NotificationMedium = 'Email'
 
 export type NotificationStatus =
@@ -810,7 +865,13 @@ export type NotificationStatus =
 
 export type TypedUuidForNotificationId = string
 
-export type RenderedEmail = { 'from': string; 'html'?: string; 'name': string; 'subject': string; 'text': string }
+export type RenderedEmail = {
+    'from': string
+    'html'?: string | null
+    'name': string
+    'subject': string
+    'text': string
+}
 
 export type RecipientId =
     | { 'Applicant': TypedUuidForApplicantId }
@@ -819,22 +880,22 @@ export type RecipientId =
 
 export type Notification_for_RenderedEmail = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForNotificationId
     'kind': string
     'medium': NotificationMedium
-    'message'?: RenderedEmail
+    'message'?: RenderedEmail | null
     'recipient': RecipientId
     'status': NotificationStatus
     'updatedAt': Date
 }
 
 export type OAuthAuthzCodeExchangeBody = {
-    'clientId'?: TypedUuidForOAuthClientId
-    'clientSecret'?: SecretString
+    'clientId'?: TypedUuidForOAuthClientId | null
+    'clientSecret'?: SecretString | null
     'code': string
     'grantType': string
-    'pkceVerifier'?: string
+    'pkceVerifier'?: string | null
     'redirectUri': string
 }
 
@@ -844,7 +905,7 @@ export type TypedUuidForOAuthRedirectUriId = string
 
 export type OAuthClientRedirectUri = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForOAuthRedirectUriId
     'oauthClientId': TypedUuidForOAuthClientId
     'redirectUri': string
@@ -852,7 +913,7 @@ export type OAuthClientRedirectUri = {
 
 export type OAuthClientSecret = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForOAuthSecretId
     'oauthClientId': TypedUuidForOAuthClientId
     'secretSignature': string
@@ -860,10 +921,10 @@ export type OAuthClientSecret = {
 
 export type OAuthClient = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForOAuthClientId
-    'redirectUris': OAuthClientRedirectUri[]
-    'secrets': OAuthClientSecret[]
+    'redirectUris': (OAuthClientRedirectUri)[]
+    'secrets': (OAuthClientSecret)[]
 }
 
 export type OAuthProviderName =
@@ -875,10 +936,16 @@ export type OAuthProviderInfo = {
     'clientId': string
     'deviceCodeEndpoint': string
     'provider': OAuthProviderName
-    'scopes': string[]
+    'scopes': (string)[]
     'tokenEndpoint': string
 }
 
+export type OfferTransitionBody = {
+    /** An optional message to send to the applicant */
+    'message'?: EmailConfig | null
+    'startDate': string
+}
+
 export type OpenIdConfiguration = { 'jwksUri': string }
 
 export type OperationState =
@@ -896,7 +963,7 @@ export type TypedUuidForOperationTaskId = string
 export type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue = {
     'body'?: Record<string, unknown>
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForOperationTaskId
     'operationId': TypedUuidForOperationId
     'path'?: Record<string, unknown>
@@ -909,7 +976,7 @@ export type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue =
 export type Operation_for_TurnstilePermission_and_String = {
     'callerPermissions': Permissions_for_TurnstilePermission
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'endpoint': string
     'id': TypedUuidForOperationId
     'state': OperationState
@@ -921,7 +988,7 @@ export type TransitionApplicationToDeclinedBatchEndpoint = string
 export type Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint = {
     'callerPermissions': Permissions_for_TurnstilePermission
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'endpoint': TransitionApplicationToDeclinedBatchEndpoint
     'id': TypedUuidForOperationId
     'state': OperationState
@@ -933,23 +1000,26 @@ export type TransitionApplicationToDeferredBatchEndpoint = string
 export type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint = {
     'callerPermissions': Permissions_for_TurnstilePermission
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'endpoint': TransitionApplicationToDeferredBatchEndpoint
     'id': TypedUuidForOperationId
     'state': OperationState
     'updatedAt': Date
 }
 
-export type OptionalTransitionBody = { 'message'?: EmailConfig }
+export type OptionalTransitionBody = {
+    /** An optional message to send to the applicant */
+    'message'?: EmailConfig | null
+}
 
 export type Pool = {
     'createdAt': Date
-    'deletedAt'?: Date
-    'description'?: string
+    'deletedAt'?: Date | null
+    'description'?: string | null
     'id': TypedUuidForPoolId
-    'listings': ListingPool[]
+    'listings': (ListingPool)[]
     'name': string
-    'reviewers': TypedUuidForReviewerId[]
+    'reviewers': (TypedUuidForReviewerId)[]
     'updatedAt': Date
 }
 
@@ -959,31 +1029,31 @@ export type Review = {
     'applicationId': TypedUuidForApplicationId
     'content': string
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForReviewId
     'reviewerId': TypedUuidForReviewerId
     'score': ReviewScore
     'updatedAt': Date
     'valueReflected': string
     'valueViolated': string
-    'valuesInTension': string[]
+    'valuesInTension': (string)[]
 }
 
 export type Reviewer = {
     'apiUserId': TypedUuidForUserId
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'id': TypedUuidForReviewerId
     'updatedAt': Date
 }
 
-export type ReviewerInfo = { 'reviewer': Reviewer; 'user'?: ApiUserInfo_for_TurnstilePermission }
+export type ReviewerInfo = { 'reviewer': Reviewer; 'user'?: ApiUserInfo_for_TurnstilePermission | null }
 
-export type ReviewInfo = { 'review': Review; 'reviewer'?: ReviewerInfo }
+export type ReviewInfo = { 'review': Review; 'reviewer'?: ReviewerInfo | null }
 
 export type Role = {
     'createdAt': Date
-    'deletedAt'?: Date
+    'deletedAt'?: Date | null
     'departmentId': TypedUuidForDepartmentId
     'id': TypedUuidForRoleId
     'name': string
@@ -1002,9 +1072,14 @@ export type TransitionApplicationToDeferredBatch = {
 
 export type UpdateApplicantContact = { 'value': string }
 
-export type UpdateDocument = { 'kind': DocumentKind; 'mime'?: string; 'source': DocumentSource; 'status'?: string }
+export type UpdateDocument = {
+    'kind': DocumentKind
+    'mime'?: string | null
+    'source': DocumentSource
+    'status'?: string | null
+}
 
-export type UpdateDocumentStatus = { 'status'?: string }
+export type UpdateDocumentStatus = { 'status'?: string | null }
 
 export type UpdateListing = { 'name': string; 'status': RoleListingStatus }
 
@@ -1013,7 +1088,7 @@ export type UpdateReview = {
     'score': ReviewScore
     'valueReflected': string
     'valueViolated': string
-    'valuesInTension': string[]
+    'valuesInTension': (string)[]
 }
 
 export type ScalarApplicationState =
@@ -1124,6 +1199,10 @@ export interface GetApplicationInterviewCodePathParams {
     application: TypedUuidForApplicationId
 }
 
+export interface NotifyApplicationReviewAssignmentsPathParams {
+    application: TypedUuidForApplicationId
+}
+
 export interface SimulateReviewActionPathParams {
     application: TypedUuidForApplicationId
 }
@@ -1254,7 +1333,7 @@ export interface AuthzCodeRedirectQueryParams {
     clientId: TypedUuidForOAuthClientId
     redirectUri: string
     responseType: string
-    scope?: string
+    scope?: string | null
     state: string
 }
 
@@ -1263,9 +1342,9 @@ export interface AuthzCodeCallbackPathParams {
 }
 
 export interface AuthzCodeCallbackQueryParams {
-    code?: string
-    error?: string
-    state?: string
+    code?: string | null
+    error?: string | null
+    state?: string | null
 }
 
 export interface AuthzCodeExchangePathParams {
@@ -1303,7 +1382,7 @@ export interface DeleteMagicLinkSecretPathParams {
 }
 
 export interface GetMappersQueryParams {
-    includeDepleted?: boolean
+    includeDepleted?: boolean | null
 }
 
 export interface DeleteMapperPathParams {
@@ -1400,6 +1479,16 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * List details for users
+         */
+        listApiUsers: (_: EmptyObj, params: FetchParams = {}) => {
+            return this.request<GetUserResponse_for_TurnstilePermission[]>({
+                path: `/api-user`,
+                method: 'GET',
+                ...params,
+            })
+        },
         /**
          * Create a new user
          */
@@ -1603,6 +1692,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View all applications
+         */
         listApplications: (_: EmptyObj, params: FetchParams = {}) => {
             return this.request<Application[]>({
                 path: `/application`,
@@ -1610,6 +1702,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Create a new application
+         */
         createApplication: ({
             body,
         }: { body: CreateApplication }, params: FetchParams = {}) => {
@@ -1620,6 +1715,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View an application
+         */
         viewApplication: ({
             path,
         }: { path: ViewApplicationPathParams }, params: FetchParams = {}) => {
@@ -1679,6 +1777,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Attach an uploaded document to an application
+         */
         attachDocument: ({
             path,
             body,
@@ -1690,6 +1791,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Generate a pre-signed upload url for uploading a document to an application
+         */
         createDocumentUploadUrl: ({
             path,
         }: { path: CreateDocumentUploadUrlPathParams }, params: FetchParams = {}) => {
@@ -1699,6 +1803,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Retrieve the interview code associated with an application
+         */
         getApplicationInterviewCode: ({
             path,
         }: { path: GetApplicationInterviewCodePathParams }, params: FetchParams = {}) => {
@@ -1708,6 +1815,18 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Send a notification to all pending reviewers
+         */
+        notifyApplicationReviewAssignments: ({
+            path,
+        }: { path: NotifyApplicationReviewAssignmentsPathParams }, params: FetchParams = {}) => {
+            return this.request<ReviewAssignment[]>({
+                path: `/application/${path.application}/notify-assignment`,
+                method: 'POST',
+                ...params,
+            })
+        },
         /**
          * Simulate the selection of the next review action without performing any changes
          */
@@ -1720,6 +1839,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Submit an application that has all required documents attached
+         */
         submitApplication: ({
             path,
         }: { path: SubmitApplicationPathParams }, params: FetchParams = {}) => {
@@ -1729,6 +1851,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Declined stage
+         */
         transitionApplicationToDeclined: ({
             path,
             body,
@@ -1740,6 +1865,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Deferred stage
+         */
         transitionApplicationToDeferred: ({
             path,
             body,
@@ -1751,6 +1879,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Interviewing stage
+         */
         transitionApplicationToInterviewing: (
             {
                 path,
@@ -1765,6 +1896,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Next Steps stage
+         */
         transitionApplicationToNextSteps: (
             {
                 path,
@@ -1779,13 +1913,13 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
-        transitionApplicationToOffer: (
-            {
-                path,
-                body,
-            }: { path: TransitionApplicationToOfferPathParams; body: OptionalTransitionBody },
-            params: FetchParams = {},
-        ) => {
+        /**
+         * Move an application to the Offer stage
+         */
+        transitionApplicationToOffer: ({
+            path,
+            body,
+        }: { path: TransitionApplicationToOfferPathParams; body: OfferTransitionBody }, params: FetchParams = {}) => {
             return this.request<ApplicationStateRecord>({
                 path: `/application/${path.application}/transition/offer`,
                 method: 'POST',
@@ -1793,6 +1927,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Withdrawn stage
+         */
         transitionApplicationToWithdrawn: (
             {
                 path,
@@ -1807,6 +1944,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * List all application summaries
+         */
         listApplicationSummaries: ({
             query = {},
         }: { query?: ListApplicationSummariesQueryParams }, params: FetchParams = {}) => {
@@ -1817,6 +1957,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View a summary that includes an application and the related evaluations
+         */
         viewApplicationSummary: ({
             path,
         }: { path: ViewApplicationSummaryPathParams }, params: FetchParams = {}) => {
@@ -1985,6 +2128,19 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Hire a new employee
+         */
+        newHire: ({
+            body,
+        }: { body: NewHireBody }, params: FetchParams = {}) => {
+            return this.request<Employee>({
+                path: `/employee/new-hire`,
+                method: 'POST',
+                body,
+                ...params,
+            })
+        },
         /**
          * List all groups
          */
@@ -2431,6 +2587,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * List reviewer pools and their associations
+         */
         listPools: (_: EmptyObj, params: FetchParams = {}) => {
             return this.request<Pool[]>({
                 path: `/pool`,
@@ -2438,6 +2597,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Create a new pool
+         */
         createPool: ({
             body,
         }: { body: CreatePool }, params: FetchParams = {}) => {
@@ -2448,6 +2610,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View a pool and its associations
+         */
         viewPool: ({
             path,
         }: { path: ViewPoolPathParams }, params: FetchParams = {}) => {
@@ -2457,6 +2622,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Update a pool
+         */
         updatePool: ({
             path,
             body,
@@ -2468,17 +2636,23 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Assign a pool to a listing
+         */
         assignPool: ({
             path,
             body,
         }: { path: AssignPoolPathParams; body: AssignPool }, params: FetchParams = {}) => {
-            return this.request<Pool>({
+            return this.request<ListingPool>({
                 path: `/pool/${path.pool}/assignment`,
                 method: 'POST',
                 body,
                 ...params,
             })
         },
+        /**
+         * Unassign a pool from a listing
+         */
         unassignPool: ({
             path,
         }: { path: UnassignPoolPathParams }, params: FetchParams = {}) => {