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

package/dist/validate.js

@@ -91,6 +91,7 @@ var TurnstilePermission = z.preprocess(
       "WithdrawApplicationsAssigned",
       "ManageApplicationsAssigned",
       "ManageApplicationsAll",
+      "GetApplicationSummariesAll",
       "GetDocumentsAssigned",
       "GetDocumentsAll",
       "CreateDocument",
@@ -509,15 +510,26 @@ var ApplicationStateRecord = z.preprocess(
   })
 );
 var ListingPoolAssociation = z.preprocess(processResponseBody, z.enum(["first", "early_positive", "positive"]));
+var TriageReason = z.preprocess(
+  processResponseBody,
+  z.enum([
+    "has_no_ratings",
+    "likely_next_steps",
+    "likely_pass",
+    "possibly_next_steps",
+    "possibly_pass",
+    "very_likely_pass",
+    "unknown"
+  ])
+);
 var PoolAction = z.preprocess(
   processResponseBody,
   z.union([
+    z.enum(["drop", "wait"]),
     z.object({
-      "action": z.enum(["add"]),
-      "association": ListingPoolAssociation,
-      "count": z.number().min(0).max(4294967295)
+      "add": z.object({ "association": ListingPoolAssociation, "count": z.number().min(0).max(4294967295) })
     }),
-    z.object({ "action": z.enum(["triage"]) })
+    z.object({ "triage": z.object({ "reason": TriageReason }) })
   ])
 );
 var ReviewScore = z.preprocess(
@@ -637,7 +649,7 @@ var CreatePool = z.preprocess(
   z.object({
     "description": z.string().optional(),
     "name": z.string(),
-    "reviwers": TypedUuidForReviewerId.array().optional()
+    "reviewers": TypedUuidForReviewerId.array().optional()
   })
 );
 var CreateReview = z.preprocess(
@@ -658,7 +670,7 @@ var CreateReviewAssignments = z.preprocess(
 );
 var ReviewAssignmentCreationError = z.preprocess(
   processResponseBody,
-  z.enum(["DoesNotExist", "Forbidden", "Internal"])
+  z.enum(["Conflict", "DoesNotExist", "Forbidden", "Internal"])
 );
 var TypedUuidForReviewAssignmentId = z.preprocess(processResponseBody, z.string().uuid());
 var ReviewAssignmentState = z.preprocess(processResponseBody, z.enum(["pending", "complete"]));
@@ -2294,6 +2306,7 @@ export {
   TransitionApplicationToWithdrawnParams,
   TransitionBody,
   TransitionMessage,
+  TriageReason,
   TurnstilePermission,
   TypedUuidForAccessGroupId,
   TypedUuidForApiKeyId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxide/turnstile.ts",
-  "version": "0.7.0-rc.0",
+  "version": "0.7.0",
   "description": "TypeScript client for the Turnstile API",
   "engines": {
     "node": ">=18"

package/src/Api.ts

@@ -82,6 +82,7 @@ export type TurnstilePermission =
     | 'WithdrawApplicationsAssigned'
     | 'ManageApplicationsAssigned'
     | 'ManageApplicationsAll'
+    | 'GetApplicationSummariesAll'
     | 'GetDocumentsAssigned'
     | 'GetDocumentsAll'
     | 'CreateDocument'
@@ -487,9 +488,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'
@@ -527,9 +539,19 @@ export type ApplicationSummariesResponse = { 'summaries': ExpandedApplicationSum
 
 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
+}
 
 export type EmailConfig = {
     'from': string
@@ -544,19 +566,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[] }
 
-export type ViewApplication = { 'application': TypedUuidForApplicationId }
+export type ViewApplication = {
+    /** Application to operate on */
+    'application': TypedUuidForApplicationId
+}
 
 export type BatchParameter_for_ViewApplication =
     | { 'all': 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 }
 
@@ -577,7 +610,14 @@ export type CreateListing = { 'name': string; 'role': TypedUuidForRoleId; 'statu
 
 export type CreateMapper = { 'maxActivations'?: number; '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
+    /** Required display name for the pool */
+    'name': string
+    /** List of reviewers to assign to this pool */
+    'reviewers'?: TypedUuidForReviewerId[]
+}
 
 export type CreateReview = {
     'application': TypedUuidForApplicationId
@@ -598,6 +638,8 @@ export type CreateReviewAssignments = { 'reviewers': TypedUuidForReviewerId[] }
  * Failures that can occur when assigning a reviewer
  */
 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 */
@@ -940,7 +982,10 @@ export type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferre
     'updatedAt': Date
 }
 
-export type OptionalTransitionBody = { 'message'?: EmailConfig }
+export type OptionalTransitionBody = {
+    /** An optional message to send to the applicant */
+    'message'?: EmailConfig
+}
 
 export type Pool = {
     'createdAt': Date
@@ -1603,6 +1648,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View all applications
+         */
         listApplications: (_: EmptyObj, params: FetchParams = {}) => {
             return this.request<Application[]>({
                 path: `/application`,
@@ -1610,6 +1658,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Create a new application
+         */
         createApplication: ({
             body,
         }: { body: CreateApplication }, params: FetchParams = {}) => {
@@ -1620,6 +1671,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View an application
+         */
         viewApplication: ({
             path,
         }: { path: ViewApplicationPathParams }, params: FetchParams = {}) => {
@@ -1679,6 +1733,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Attach an uploaded document to an application
+         */
         attachDocument: ({
             path,
             body,
@@ -1690,6 +1747,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 +1759,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Retrieve the interview code associated with an application
+         */
         getApplicationInterviewCode: ({
             path,
         }: { path: GetApplicationInterviewCodePathParams }, params: FetchParams = {}) => {
@@ -1720,6 +1783,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Submit an application that has all required documents attached
+         */
         submitApplication: ({
             path,
         }: { path: SubmitApplicationPathParams }, params: FetchParams = {}) => {
@@ -1729,6 +1795,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Declined stage
+         */
         transitionApplicationToDeclined: ({
             path,
             body,
@@ -1740,6 +1809,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Deferred stage
+         */
         transitionApplicationToDeferred: ({
             path,
             body,
@@ -1751,6 +1823,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Interviewing stage
+         */
         transitionApplicationToInterviewing: (
             {
                 path,
@@ -1765,6 +1840,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Next Steps stage
+         */
         transitionApplicationToNextSteps: (
             {
                 path,
@@ -1779,6 +1857,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Offer stage
+         */
         transitionApplicationToOffer: (
             {
                 path,
@@ -1793,6 +1874,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Move an application to the Withdrawn stage
+         */
         transitionApplicationToWithdrawn: (
             {
                 path,
@@ -1807,6 +1891,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * List all application summaries
+         */
         listApplicationSummaries: ({
             query = {},
         }: { query?: ListApplicationSummariesQueryParams }, params: FetchParams = {}) => {
@@ -1817,6 +1904,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View a summary that includes an application and the related evaluations
+         */
         viewApplicationSummary: ({
             path,
         }: { path: ViewApplicationSummaryPathParams }, params: FetchParams = {}) => {
@@ -2431,6 +2521,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 +2531,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Create a new pool
+         */
         createPool: ({
             body,
         }: { body: CreatePool }, params: FetchParams = {}) => {
@@ -2448,6 +2544,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * View a pool and its associations
+         */
         viewPool: ({
             path,
         }: { path: ViewPoolPathParams }, params: FetchParams = {}) => {
@@ -2457,6 +2556,9 @@ export class Api extends HttpClient {
                 ...params,
             })
         },
+        /**
+         * Update a pool
+         */
         updatePool: ({
             path,
             body,
@@ -2468,17 +2570,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 = {}) => {

package/src/validate.ts

@@ -100,6 +100,7 @@ export const TurnstilePermission = z.preprocess(
             'WithdrawApplicationsAssigned',
             'ManageApplicationsAssigned',
             'ManageApplicationsAll',
+            'GetApplicationSummariesAll',
             'GetDocumentsAssigned',
             'GetDocumentsAll',
             'CreateDocument',
@@ -557,15 +558,27 @@ export const ApplicationStateRecord = z.preprocess(
 
 export const ListingPoolAssociation = z.preprocess(processResponseBody, z.enum(['first', 'early_positive', 'positive']))
 
+export const TriageReason = z.preprocess(
+    processResponseBody,
+    z.enum([
+        'has_no_ratings',
+        'likely_next_steps',
+        'likely_pass',
+        'possibly_next_steps',
+        'possibly_pass',
+        'very_likely_pass',
+        'unknown',
+    ]),
+)
+
 export const PoolAction = z.preprocess(
     processResponseBody,
     z.union([
+        z.enum(['drop', 'wait']),
         z.object({
-            'action': z.enum(['add']),
-            'association': ListingPoolAssociation,
-            'count': z.number().min(0).max(4294967295),
+            'add': z.object({ 'association': ListingPoolAssociation, 'count': z.number().min(0).max(4294967295) }),
         }),
-        z.object({ 'action': z.enum(['triage']) }),
+        z.object({ 'triage': z.object({ 'reason': TriageReason }) }),
     ]),
 )
 
@@ -706,7 +719,7 @@ export const CreatePool = z.preprocess(
     z.object({
         'description': z.string().optional(),
         'name': z.string(),
-        'reviwers': TypedUuidForReviewerId.array().optional(),
+        'reviewers': TypedUuidForReviewerId.array().optional(),
     }),
 )
 
@@ -736,7 +749,7 @@ export const CreateReviewAssignments = z.preprocess(
  */
 export const ReviewAssignmentCreationError = z.preprocess(
     processResponseBody,
-    z.enum(['DoesNotExist', 'Forbidden', 'Internal']),
+    z.enum(['Conflict', 'DoesNotExist', 'Forbidden', 'Internal']),
 )
 
 export const TypedUuidForReviewAssignmentId = z.preprocess(processResponseBody, z.string().uuid())