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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Api.cjs CHANGED
@@ -352,6 +352,9 @@ var Api = class extends HttpClient {
352
352
  ...params
353
353
  });
354
354
  },
355
+ /**
356
+ * View all applications
357
+ */
355
358
  listApplications: (_, params = {}) => {
356
359
  return this.request({
357
360
  path: `/application`,
@@ -359,6 +362,9 @@ var Api = class extends HttpClient {
359
362
  ...params
360
363
  });
361
364
  },
365
+ /**
366
+ * Create a new application
367
+ */
362
368
  createApplication: ({
363
369
  body
364
370
  }, params = {}) => {
@@ -369,6 +375,9 @@ var Api = class extends HttpClient {
369
375
  ...params
370
376
  });
371
377
  },
378
+ /**
379
+ * View an application
380
+ */
372
381
  viewApplication: ({
373
382
  path
374
383
  }, params = {}) => {
@@ -425,6 +434,9 @@ var Api = class extends HttpClient {
425
434
  ...params
426
435
  });
427
436
  },
437
+ /**
438
+ * Attach an uploaded document to an application
439
+ */
428
440
  attachDocument: ({
429
441
  path,
430
442
  body
@@ -436,6 +448,9 @@ var Api = class extends HttpClient {
436
448
  ...params
437
449
  });
438
450
  },
451
+ /**
452
+ * Generate a pre-signed upload url for uploading a document to an application
453
+ */
439
454
  createDocumentUploadUrl: ({
440
455
  path
441
456
  }, params = {}) => {
@@ -445,6 +460,9 @@ var Api = class extends HttpClient {
445
460
  ...params
446
461
  });
447
462
  },
463
+ /**
464
+ * Retrieve the interview code associated with an application
465
+ */
448
466
  getApplicationInterviewCode: ({
449
467
  path
450
468
  }, params = {}) => {
@@ -466,6 +484,9 @@ var Api = class extends HttpClient {
466
484
  ...params
467
485
  });
468
486
  },
487
+ /**
488
+ * Submit an application that has all required documents attached
489
+ */
469
490
  submitApplication: ({
470
491
  path
471
492
  }, params = {}) => {
@@ -475,6 +496,9 @@ var Api = class extends HttpClient {
475
496
  ...params
476
497
  });
477
498
  },
499
+ /**
500
+ * Move an application to the Declined stage
501
+ */
478
502
  transitionApplicationToDeclined: ({
479
503
  path,
480
504
  body
@@ -486,6 +510,9 @@ var Api = class extends HttpClient {
486
510
  ...params
487
511
  });
488
512
  },
513
+ /**
514
+ * Move an application to the Deferred stage
515
+ */
489
516
  transitionApplicationToDeferred: ({
490
517
  path,
491
518
  body
@@ -497,6 +524,9 @@ var Api = class extends HttpClient {
497
524
  ...params
498
525
  });
499
526
  },
527
+ /**
528
+ * Move an application to the Interviewing stage
529
+ */
500
530
  transitionApplicationToInterviewing: ({
501
531
  path,
502
532
  body
@@ -508,6 +538,9 @@ var Api = class extends HttpClient {
508
538
  ...params
509
539
  });
510
540
  },
541
+ /**
542
+ * Move an application to the Next Steps stage
543
+ */
511
544
  transitionApplicationToNextSteps: ({
512
545
  path,
513
546
  body
@@ -519,6 +552,9 @@ var Api = class extends HttpClient {
519
552
  ...params
520
553
  });
521
554
  },
555
+ /**
556
+ * Move an application to the Offer stage
557
+ */
522
558
  transitionApplicationToOffer: ({
523
559
  path,
524
560
  body
@@ -530,6 +566,9 @@ var Api = class extends HttpClient {
530
566
  ...params
531
567
  });
532
568
  },
569
+ /**
570
+ * Move an application to the Withdrawn stage
571
+ */
533
572
  transitionApplicationToWithdrawn: ({
534
573
  path,
535
574
  body
@@ -541,6 +580,9 @@ var Api = class extends HttpClient {
541
580
  ...params
542
581
  });
543
582
  },
583
+ /**
584
+ * List all application summaries
585
+ */
544
586
  listApplicationSummaries: ({
545
587
  query = {}
546
588
  }, params = {}) => {
@@ -551,6 +593,9 @@ var Api = class extends HttpClient {
551
593
  ...params
552
594
  });
553
595
  },
596
+ /**
597
+ * View a summary that includes an application and the related evaluations
598
+ */
554
599
  viewApplicationSummary: ({
555
600
  path
556
601
  }, params = {}) => {
@@ -1156,6 +1201,9 @@ var Api = class extends HttpClient {
1156
1201
  ...params
1157
1202
  });
1158
1203
  },
1204
+ /**
1205
+ * List reviewer pools and their associations
1206
+ */
1159
1207
  listPools: (_, params = {}) => {
1160
1208
  return this.request({
1161
1209
  path: `/pool`,
@@ -1163,6 +1211,9 @@ var Api = class extends HttpClient {
1163
1211
  ...params
1164
1212
  });
1165
1213
  },
1214
+ /**
1215
+ * Create a new pool
1216
+ */
1166
1217
  createPool: ({
1167
1218
  body
1168
1219
  }, params = {}) => {
@@ -1173,6 +1224,9 @@ var Api = class extends HttpClient {
1173
1224
  ...params
1174
1225
  });
1175
1226
  },
1227
+ /**
1228
+ * View a pool and its associations
1229
+ */
1176
1230
  viewPool: ({
1177
1231
  path
1178
1232
  }, params = {}) => {
@@ -1182,6 +1236,9 @@ var Api = class extends HttpClient {
1182
1236
  ...params
1183
1237
  });
1184
1238
  },
1239
+ /**
1240
+ * Update a pool
1241
+ */
1185
1242
  updatePool: ({
1186
1243
  path,
1187
1244
  body
@@ -1193,6 +1250,9 @@ var Api = class extends HttpClient {
1193
1250
  ...params
1194
1251
  });
1195
1252
  },
1253
+ /**
1254
+ * Assign a pool to a listing
1255
+ */
1196
1256
  assignPool: ({
1197
1257
  path,
1198
1258
  body
@@ -1204,6 +1264,9 @@ var Api = class extends HttpClient {
1204
1264
  ...params
1205
1265
  });
1206
1266
  },
1267
+ /**
1268
+ * Unassign a pool from a listing
1269
+ */
1207
1270
  unassignPool: ({
1208
1271
  path
1209
1272
  }, params = {}) => {
package/dist/Api.d.cts CHANGED
@@ -1 +1 @@
1
- export { x as AccessGroupUpdateParams_for_TurnstilePermission, y as AccessGroup_for_TurnstilePermission, z as AccessTokenExchangeRequest, bP as AddApiUserToGroupPathParams, B as AddGroupBody, C as AddMagicLinkRedirectBody, E as AddOAuthClientRedirectBody, a as Api, A as ApiConfig, G as ApiKeyCreateParams_for_TurnstilePermission, H as ApiKeyResponse_for_TurnstilePermission, b as ApiResult, J as ApiUserContactEmail, K as ApiUserEmailUpdateParams, N as ApiUserInfo_for_TurnstilePermission, O as ApiUserLinkRequestPayload, Q as ApiUserLinkRequestResponse, L as ApiUserProvider, R as ApiUserProviderLinkPayload, U as ApiUserUpdateParams_for_TurnstilePermission, M as ApiUser_for_TurnstilePermission, V as Applicant, Y as ApplicantContact, X as ApplicantContactField, Z as ApplicantInfo, a1 as Application, a5 as ApplicationBundle, a7 as ApplicationInterviewCode, a0 as ApplicationState, a9 as ApplicationStateRecord, ag as ApplicationSummariesResponse, ah as ApplicationSummaryResponse, b$ as ApplyReviewActionPathParams, ai as AssignPool, cW as AssignPoolPathParams, aj as AttachDocument, c3 as AttachDocumentPathParams, cB as AuthzCodeCallbackPathParams, cC as AuthzCodeCallbackQueryParams, cD as AuthzCodeExchangePathParams, cz as AuthzCodeRedirectPathParams, cA as AuthzCodeRedirectQueryParams, an as BatchParameter_for_TransitionBody, ap as BatchParameter_for_ViewApplication, bT as CreateApiUserTokenPathParams, aq as CreateApplication, c1 as CreateApplicationReviewAssignmentsPathParams, ar as CreateDepartment, as as CreateDocument, c4 as CreateDocumentUploadUrlPathParams, bW as CreateLinkTokenPathParams, au as CreateListing, cH as CreateMagicLinkRedirectUriPathParams, cJ as CreateMagicLinkSecretPathParams, av as CreateMapper, cQ as CreateOauthClientRedirectUriPathParams, cS as CreateOauthClientSecretPathParams, aw as CreatePool, ax as CreateReview, ay as CreateReviewAssignments, aE as CreateReviewAssignmentsResponse, aF as CreateRole, aG as CreatedApplication, aD as CreatedAssignment, bV as DeleteApiUserTokenPathParams, cn as DeleteDocumentPathParams, cr as DeleteGroupPathParams, cI as DeleteMagicLinkRedirectUriPathParams, cK as DeleteMagicLinkSecretPathParams, cM as DeleteMapperPathParams, cR as DeleteOauthClientRedirectUriPathParams, cT as DeleteOauthClientSecretPathParams, c$ as DeleteReviewPathParams, aH as Department, a4 as Document, a2 as DocumentKind, D as DocumentParent, a3 as DocumentSource, aI as DocumentUploadUrlResponse, aJ as EmailApplicantBody, cO as EmailApplicantPathParams, ak as EmailConfig, d2 as ErrorBody, d3 as ErrorResult, af as Evaluator, cF as ExchangeDeviceTokenPathParams, ae as ExpandedApplicationSummary, bM as GetApiUserPathParams, bU as GetApiUserTokenPathParams, c5 as GetApplicationInterviewCodePathParams, cE as GetDeviceProviderPathParams, cG as GetMagicLinkPathParams, cL as GetMappersQueryParams, cP as GetOauthClientPathParams, ch as GetOperationPathParams, aK as GetUserResponse_for_TurnstilePermission, aL as InitialApiKeyResponse_for_TurnstilePermission, aN as InitialMagicLinkSecretResponse, aP as InitialOAuthClientSecretResponse, aS as Interview, aR as InterviewAttendee, aT as Interviewer, _ as InterviewingState, aU as Jwk, aV as Jwks, bR as LinkProviderPathParams, bS as ListApiUserTokensPathParams, bX as ListApplicantsQueryParams, c0 as ListApplicationReviewAssignmentsPathParams, ce as ListApplicationSummariesQueryParams, ck as ListDocumentsQueryParams, ct as ListInterviewersQueryParams, cs as ListInterviewsQueryParams, cN as ListNotificationsQueryParams, ci as ListOperationTasksQueryParams, cg as ListOperationsQueryParams, d0 as ListReviewersQueryParams, cY as ListReviewsQueryParams, aW as Listing, aY as ListingPool, aa as ListingPoolAssociation, b0 as MagicLink, cx as MagicLinkExchangePathParams, b2 as MagicLinkExchangeRequest, b3 as MagicLinkExchangeResponse, b4 as MagicLinkMedium, a_ as MagicLinkRedirectUri, a$ as MagicLinkSecret, cy as MagicLinkSendPathParams, b5 as MagicLinkSendRequest, b6 as MagicLinkSendResponse, b7 as Mapper, b8 as NotificationMedium, b9 as NotificationStatus, bd as Notification_for_RenderedEmail, be as OAuthAuthzCodeExchangeBody, bf as OAuthAuthzCodeExchangeResponse, bj as OAuthClient, bh as OAuthClientRedirectUri, bi as OAuthClientSecret, bl as OAuthProviderInfo, bk as OAuthProviderName, $ as OfferState, bm as OpenIdConfiguration, bn as OperationState, bo as OperationTaskState, bq as OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue, br as Operation_for_TurnstilePermission_and_String, bt as Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint, bv as Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint, bw as OptionalTransitionBody, P as Permissions_for_TurnstilePermission, bx as Pool, ab as PoolAction, bc as RecipientId, by as RegisterApplicant, bQ as RemoveApiUserFromGroupPathParams, bb as RenderedEmail, bz as Review, aC as ReviewAssignment, az as ReviewAssignmentCreationError, aB as ReviewAssignmentState, bC as ReviewInfo, ac as ReviewScore, bA as Reviewer, bB as ReviewerInfo, ad as Reviews, bD as Role, at as RoleListingStatus, bL as ScalarApplicationState, S as SecretString, bO as SetApiUserContactEmailPathParams, c6 as SimulateReviewActionPathParams, c7 as SubmitApplicationPathParams, bE as TransitionApplicationToDeclinedBatch, bs as TransitionApplicationToDeclinedBatchEndpoint, c8 as TransitionApplicationToDeclinedPathParams, bF as TransitionApplicationToDeferredBatch, bu as TransitionApplicationToDeferredBatchEndpoint, c9 as TransitionApplicationToDeferredPathParams, ca as TransitionApplicationToInterviewingPathParams, cb as TransitionApplicationToNextStepsPathParams, cc as TransitionApplicationToOfferPathParams, cd as TransitionApplicationToWithdrawnPathParams, am as TransitionBody, al as TransitionMessage, w as TurnstilePermission, s as TypedUuidForAccessGroupId, r as TypedUuidForApiKeyId, W as TypedUuidForApplicantContactId, T as TypedUuidForApplicantId, d as TypedUuidForApplicationId, a6 as TypedUuidForApplicationInterviewCodeId, a8 as TypedUuidForApplicationStateRecordId, p as TypedUuidForBackgroundCheckId, h as TypedUuidForDepartmentId, e as TypedUuidForDocumentId, f as TypedUuidForEmployeeId, aQ as TypedUuidForInterviewAttendeeId, o as TypedUuidForInterviewId, n as TypedUuidForInterviewerId, j as TypedUuidForListingId, aX as TypedUuidForListingPoolId, b1 as TypedUuidForMagicLinkAttemptId, v as TypedUuidForMagicLinkId, aZ as TypedUuidForMagicLinkRedirectUriId, aM as TypedUuidForMagicLinkSecretId, t as TypedUuidForMapperId, ba as TypedUuidForNotificationId, u as TypedUuidForOAuthClientId, bg as TypedUuidForOAuthRedirectUriId, aO as TypedUuidForOAuthSecretId, g as TypedUuidForOnboardingId, q as TypedUuidForOperationId, bp as TypedUuidForOperationTaskId, k as TypedUuidForPoolId, aA as TypedUuidForReviewAssignmentId, m as TypedUuidForReviewId, l as TypedUuidForReviewerId, i as TypedUuidForRoleId, c as TypedUuidForUserId, I as TypedUuidForUserProviderId, cX as UnassignPoolPathParams, bN as UpdateApiUserPathParams, bG as UpdateApplicantContact, bZ as UpdateApplicantContactPathParams, bH as UpdateDocument, cm as UpdateDocumentPathParams, bI as UpdateDocumentStatus, cp as UpdateDocumentStatusPathParams, cq as UpdateGroupPathParams, bJ as UpdateListing, cv as UpdateListingPathParams, cw as UpdateListingStatePathParams, cV as UpdatePoolPathParams, bK as UpdateReview, c_ as UpdateReviewPathParams, bY as ViewApplicantPathParams, ao as ViewApplication, c2 as ViewApplicationBundlePathParams, b_ as ViewApplicationPathParams, cf as ViewApplicationSummaryPathParams, cj as ViewDepartmentPathParams, co as ViewDocumentDataPathParams, cl as ViewDocumentPathParams, cu as ViewListingPathParams, cU as ViewPoolPathParams, cZ as ViewReviewPathParams, d1 as ViewRolePathParams, a as default } from './Api-Z7zZcVks.cjs';
1
+ export { x as AccessGroupUpdateParams_for_TurnstilePermission, y as AccessGroup_for_TurnstilePermission, z as AccessTokenExchangeRequest, bQ as AddApiUserToGroupPathParams, B as AddGroupBody, C as AddMagicLinkRedirectBody, E as AddOAuthClientRedirectBody, a as Api, A as ApiConfig, G as ApiKeyCreateParams_for_TurnstilePermission, H as ApiKeyResponse_for_TurnstilePermission, b as ApiResult, J as ApiUserContactEmail, K as ApiUserEmailUpdateParams, N as ApiUserInfo_for_TurnstilePermission, O as ApiUserLinkRequestPayload, Q as ApiUserLinkRequestResponse, L as ApiUserProvider, R as ApiUserProviderLinkPayload, U as ApiUserUpdateParams_for_TurnstilePermission, M as ApiUser_for_TurnstilePermission, V as Applicant, Y as ApplicantContact, X as ApplicantContactField, Z as ApplicantInfo, a1 as Application, a5 as ApplicationBundle, a7 as ApplicationInterviewCode, a0 as ApplicationState, a9 as ApplicationStateRecord, ah as ApplicationSummariesResponse, ai as ApplicationSummaryResponse, c0 as ApplyReviewActionPathParams, aj as AssignPool, cX as AssignPoolPathParams, ak as AttachDocument, c4 as AttachDocumentPathParams, cC as AuthzCodeCallbackPathParams, cD as AuthzCodeCallbackQueryParams, cE as AuthzCodeExchangePathParams, cA as AuthzCodeRedirectPathParams, cB as AuthzCodeRedirectQueryParams, ao as BatchParameter_for_TransitionBody, aq as BatchParameter_for_ViewApplication, bU as CreateApiUserTokenPathParams, ar as CreateApplication, c2 as CreateApplicationReviewAssignmentsPathParams, as as CreateDepartment, at as CreateDocument, c5 as CreateDocumentUploadUrlPathParams, bX as CreateLinkTokenPathParams, av as CreateListing, cI as CreateMagicLinkRedirectUriPathParams, cK as CreateMagicLinkSecretPathParams, aw as CreateMapper, cR as CreateOauthClientRedirectUriPathParams, cT as CreateOauthClientSecretPathParams, ax as CreatePool, ay as CreateReview, az as CreateReviewAssignments, aF as CreateReviewAssignmentsResponse, aG as CreateRole, aH as CreatedApplication, aE as CreatedAssignment, bW as DeleteApiUserTokenPathParams, co as DeleteDocumentPathParams, cs as DeleteGroupPathParams, cJ as DeleteMagicLinkRedirectUriPathParams, cL as DeleteMagicLinkSecretPathParams, cN as DeleteMapperPathParams, cS as DeleteOauthClientRedirectUriPathParams, cU as DeleteOauthClientSecretPathParams, d0 as DeleteReviewPathParams, aI as Department, a4 as Document, a2 as DocumentKind, D as DocumentParent, a3 as DocumentSource, aJ as DocumentUploadUrlResponse, aK as EmailApplicantBody, cP as EmailApplicantPathParams, al as EmailConfig, d3 as ErrorBody, d4 as ErrorResult, ag as Evaluator, cG as ExchangeDeviceTokenPathParams, af as ExpandedApplicationSummary, bN as GetApiUserPathParams, bV as GetApiUserTokenPathParams, c6 as GetApplicationInterviewCodePathParams, cF as GetDeviceProviderPathParams, cH as GetMagicLinkPathParams, cM as GetMappersQueryParams, cQ as GetOauthClientPathParams, ci as GetOperationPathParams, aL as GetUserResponse_for_TurnstilePermission, aM as InitialApiKeyResponse_for_TurnstilePermission, aO as InitialMagicLinkSecretResponse, aQ as InitialOAuthClientSecretResponse, aT as Interview, aS as InterviewAttendee, aU as Interviewer, _ as InterviewingState, aV as Jwk, aW as Jwks, bS as LinkProviderPathParams, bT as ListApiUserTokensPathParams, bY as ListApplicantsQueryParams, c1 as ListApplicationReviewAssignmentsPathParams, cf as ListApplicationSummariesQueryParams, cl as ListDocumentsQueryParams, cu as ListInterviewersQueryParams, ct as ListInterviewsQueryParams, cO as ListNotificationsQueryParams, cj as ListOperationTasksQueryParams, ch as ListOperationsQueryParams, d1 as ListReviewersQueryParams, cZ as ListReviewsQueryParams, aX as Listing, aZ as ListingPool, aa as ListingPoolAssociation, b1 as MagicLink, cy as MagicLinkExchangePathParams, b3 as MagicLinkExchangeRequest, b4 as MagicLinkExchangeResponse, b5 as MagicLinkMedium, a$ as MagicLinkRedirectUri, b0 as MagicLinkSecret, cz as MagicLinkSendPathParams, b6 as MagicLinkSendRequest, b7 as MagicLinkSendResponse, b8 as Mapper, b9 as NotificationMedium, ba as NotificationStatus, be as Notification_for_RenderedEmail, bf as OAuthAuthzCodeExchangeBody, bg as OAuthAuthzCodeExchangeResponse, bk as OAuthClient, bi as OAuthClientRedirectUri, bj as OAuthClientSecret, bm as OAuthProviderInfo, bl as OAuthProviderName, $ as OfferState, bn as OpenIdConfiguration, bo as OperationState, bp as OperationTaskState, br as OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue, bs as Operation_for_TurnstilePermission_and_String, bu as Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint, bw as Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint, bx as OptionalTransitionBody, P as Permissions_for_TurnstilePermission, by as Pool, ac as PoolAction, bd as RecipientId, bz as RegisterApplicant, bR as RemoveApiUserFromGroupPathParams, bc as RenderedEmail, bA as Review, aD as ReviewAssignment, aA as ReviewAssignmentCreationError, aC as ReviewAssignmentState, bD as ReviewInfo, ad as ReviewScore, bB as Reviewer, bC as ReviewerInfo, ae as Reviews, bE as Role, au as RoleListingStatus, bM as ScalarApplicationState, S as SecretString, bP as SetApiUserContactEmailPathParams, c7 as SimulateReviewActionPathParams, c8 as SubmitApplicationPathParams, bF as TransitionApplicationToDeclinedBatch, bt as TransitionApplicationToDeclinedBatchEndpoint, c9 as TransitionApplicationToDeclinedPathParams, bG as TransitionApplicationToDeferredBatch, bv as TransitionApplicationToDeferredBatchEndpoint, ca as TransitionApplicationToDeferredPathParams, cb as TransitionApplicationToInterviewingPathParams, cc as TransitionApplicationToNextStepsPathParams, cd as TransitionApplicationToOfferPathParams, ce as TransitionApplicationToWithdrawnPathParams, an as TransitionBody, am as TransitionMessage, ab as TriageReason, w as TurnstilePermission, s as TypedUuidForAccessGroupId, r as TypedUuidForApiKeyId, W as TypedUuidForApplicantContactId, T as TypedUuidForApplicantId, d as TypedUuidForApplicationId, a6 as TypedUuidForApplicationInterviewCodeId, a8 as TypedUuidForApplicationStateRecordId, p as TypedUuidForBackgroundCheckId, h as TypedUuidForDepartmentId, e as TypedUuidForDocumentId, f as TypedUuidForEmployeeId, aR as TypedUuidForInterviewAttendeeId, o as TypedUuidForInterviewId, n as TypedUuidForInterviewerId, j as TypedUuidForListingId, aY as TypedUuidForListingPoolId, b2 as TypedUuidForMagicLinkAttemptId, v as TypedUuidForMagicLinkId, a_ as TypedUuidForMagicLinkRedirectUriId, aN as TypedUuidForMagicLinkSecretId, t as TypedUuidForMapperId, bb as TypedUuidForNotificationId, u as TypedUuidForOAuthClientId, bh as TypedUuidForOAuthRedirectUriId, aP as TypedUuidForOAuthSecretId, g as TypedUuidForOnboardingId, q as TypedUuidForOperationId, bq as TypedUuidForOperationTaskId, k as TypedUuidForPoolId, aB as TypedUuidForReviewAssignmentId, m as TypedUuidForReviewId, l as TypedUuidForReviewerId, i as TypedUuidForRoleId, c as TypedUuidForUserId, I as TypedUuidForUserProviderId, cY as UnassignPoolPathParams, bO as UpdateApiUserPathParams, bH as UpdateApplicantContact, b_ as UpdateApplicantContactPathParams, bI as UpdateDocument, cn as UpdateDocumentPathParams, bJ as UpdateDocumentStatus, cq as UpdateDocumentStatusPathParams, cr as UpdateGroupPathParams, bK as UpdateListing, cw as UpdateListingPathParams, cx as UpdateListingStatePathParams, cW as UpdatePoolPathParams, bL as UpdateReview, c$ as UpdateReviewPathParams, bZ as ViewApplicantPathParams, ap as ViewApplication, c3 as ViewApplicationBundlePathParams, b$ as ViewApplicationPathParams, cg as ViewApplicationSummaryPathParams, ck as ViewDepartmentPathParams, cp as ViewDocumentDataPathParams, cm as ViewDocumentPathParams, cv as ViewListingPathParams, cV as ViewPoolPathParams, c_ as ViewReviewPathParams, d2 as ViewRolePathParams, a as default } from './Api-Mqr0O9hE.cjs';
package/dist/Api.d.ts CHANGED
@@ -1 +1 @@
1
- export { x as AccessGroupUpdateParams_for_TurnstilePermission, y as AccessGroup_for_TurnstilePermission, z as AccessTokenExchangeRequest, bP as AddApiUserToGroupPathParams, B as AddGroupBody, C as AddMagicLinkRedirectBody, E as AddOAuthClientRedirectBody, a as Api, A as ApiConfig, G as ApiKeyCreateParams_for_TurnstilePermission, H as ApiKeyResponse_for_TurnstilePermission, b as ApiResult, J as ApiUserContactEmail, K as ApiUserEmailUpdateParams, N as ApiUserInfo_for_TurnstilePermission, O as ApiUserLinkRequestPayload, Q as ApiUserLinkRequestResponse, L as ApiUserProvider, R as ApiUserProviderLinkPayload, U as ApiUserUpdateParams_for_TurnstilePermission, M as ApiUser_for_TurnstilePermission, V as Applicant, Y as ApplicantContact, X as ApplicantContactField, Z as ApplicantInfo, a1 as Application, a5 as ApplicationBundle, a7 as ApplicationInterviewCode, a0 as ApplicationState, a9 as ApplicationStateRecord, ag as ApplicationSummariesResponse, ah as ApplicationSummaryResponse, b$ as ApplyReviewActionPathParams, ai as AssignPool, cW as AssignPoolPathParams, aj as AttachDocument, c3 as AttachDocumentPathParams, cB as AuthzCodeCallbackPathParams, cC as AuthzCodeCallbackQueryParams, cD as AuthzCodeExchangePathParams, cz as AuthzCodeRedirectPathParams, cA as AuthzCodeRedirectQueryParams, an as BatchParameter_for_TransitionBody, ap as BatchParameter_for_ViewApplication, bT as CreateApiUserTokenPathParams, aq as CreateApplication, c1 as CreateApplicationReviewAssignmentsPathParams, ar as CreateDepartment, as as CreateDocument, c4 as CreateDocumentUploadUrlPathParams, bW as CreateLinkTokenPathParams, au as CreateListing, cH as CreateMagicLinkRedirectUriPathParams, cJ as CreateMagicLinkSecretPathParams, av as CreateMapper, cQ as CreateOauthClientRedirectUriPathParams, cS as CreateOauthClientSecretPathParams, aw as CreatePool, ax as CreateReview, ay as CreateReviewAssignments, aE as CreateReviewAssignmentsResponse, aF as CreateRole, aG as CreatedApplication, aD as CreatedAssignment, bV as DeleteApiUserTokenPathParams, cn as DeleteDocumentPathParams, cr as DeleteGroupPathParams, cI as DeleteMagicLinkRedirectUriPathParams, cK as DeleteMagicLinkSecretPathParams, cM as DeleteMapperPathParams, cR as DeleteOauthClientRedirectUriPathParams, cT as DeleteOauthClientSecretPathParams, c$ as DeleteReviewPathParams, aH as Department, a4 as Document, a2 as DocumentKind, D as DocumentParent, a3 as DocumentSource, aI as DocumentUploadUrlResponse, aJ as EmailApplicantBody, cO as EmailApplicantPathParams, ak as EmailConfig, d2 as ErrorBody, d3 as ErrorResult, af as Evaluator, cF as ExchangeDeviceTokenPathParams, ae as ExpandedApplicationSummary, bM as GetApiUserPathParams, bU as GetApiUserTokenPathParams, c5 as GetApplicationInterviewCodePathParams, cE as GetDeviceProviderPathParams, cG as GetMagicLinkPathParams, cL as GetMappersQueryParams, cP as GetOauthClientPathParams, ch as GetOperationPathParams, aK as GetUserResponse_for_TurnstilePermission, aL as InitialApiKeyResponse_for_TurnstilePermission, aN as InitialMagicLinkSecretResponse, aP as InitialOAuthClientSecretResponse, aS as Interview, aR as InterviewAttendee, aT as Interviewer, _ as InterviewingState, aU as Jwk, aV as Jwks, bR as LinkProviderPathParams, bS as ListApiUserTokensPathParams, bX as ListApplicantsQueryParams, c0 as ListApplicationReviewAssignmentsPathParams, ce as ListApplicationSummariesQueryParams, ck as ListDocumentsQueryParams, ct as ListInterviewersQueryParams, cs as ListInterviewsQueryParams, cN as ListNotificationsQueryParams, ci as ListOperationTasksQueryParams, cg as ListOperationsQueryParams, d0 as ListReviewersQueryParams, cY as ListReviewsQueryParams, aW as Listing, aY as ListingPool, aa as ListingPoolAssociation, b0 as MagicLink, cx as MagicLinkExchangePathParams, b2 as MagicLinkExchangeRequest, b3 as MagicLinkExchangeResponse, b4 as MagicLinkMedium, a_ as MagicLinkRedirectUri, a$ as MagicLinkSecret, cy as MagicLinkSendPathParams, b5 as MagicLinkSendRequest, b6 as MagicLinkSendResponse, b7 as Mapper, b8 as NotificationMedium, b9 as NotificationStatus, bd as Notification_for_RenderedEmail, be as OAuthAuthzCodeExchangeBody, bf as OAuthAuthzCodeExchangeResponse, bj as OAuthClient, bh as OAuthClientRedirectUri, bi as OAuthClientSecret, bl as OAuthProviderInfo, bk as OAuthProviderName, $ as OfferState, bm as OpenIdConfiguration, bn as OperationState, bo as OperationTaskState, bq as OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue, br as Operation_for_TurnstilePermission_and_String, bt as Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint, bv as Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint, bw as OptionalTransitionBody, P as Permissions_for_TurnstilePermission, bx as Pool, ab as PoolAction, bc as RecipientId, by as RegisterApplicant, bQ as RemoveApiUserFromGroupPathParams, bb as RenderedEmail, bz as Review, aC as ReviewAssignment, az as ReviewAssignmentCreationError, aB as ReviewAssignmentState, bC as ReviewInfo, ac as ReviewScore, bA as Reviewer, bB as ReviewerInfo, ad as Reviews, bD as Role, at as RoleListingStatus, bL as ScalarApplicationState, S as SecretString, bO as SetApiUserContactEmailPathParams, c6 as SimulateReviewActionPathParams, c7 as SubmitApplicationPathParams, bE as TransitionApplicationToDeclinedBatch, bs as TransitionApplicationToDeclinedBatchEndpoint, c8 as TransitionApplicationToDeclinedPathParams, bF as TransitionApplicationToDeferredBatch, bu as TransitionApplicationToDeferredBatchEndpoint, c9 as TransitionApplicationToDeferredPathParams, ca as TransitionApplicationToInterviewingPathParams, cb as TransitionApplicationToNextStepsPathParams, cc as TransitionApplicationToOfferPathParams, cd as TransitionApplicationToWithdrawnPathParams, am as TransitionBody, al as TransitionMessage, w as TurnstilePermission, s as TypedUuidForAccessGroupId, r as TypedUuidForApiKeyId, W as TypedUuidForApplicantContactId, T as TypedUuidForApplicantId, d as TypedUuidForApplicationId, a6 as TypedUuidForApplicationInterviewCodeId, a8 as TypedUuidForApplicationStateRecordId, p as TypedUuidForBackgroundCheckId, h as TypedUuidForDepartmentId, e as TypedUuidForDocumentId, f as TypedUuidForEmployeeId, aQ as TypedUuidForInterviewAttendeeId, o as TypedUuidForInterviewId, n as TypedUuidForInterviewerId, j as TypedUuidForListingId, aX as TypedUuidForListingPoolId, b1 as TypedUuidForMagicLinkAttemptId, v as TypedUuidForMagicLinkId, aZ as TypedUuidForMagicLinkRedirectUriId, aM as TypedUuidForMagicLinkSecretId, t as TypedUuidForMapperId, ba as TypedUuidForNotificationId, u as TypedUuidForOAuthClientId, bg as TypedUuidForOAuthRedirectUriId, aO as TypedUuidForOAuthSecretId, g as TypedUuidForOnboardingId, q as TypedUuidForOperationId, bp as TypedUuidForOperationTaskId, k as TypedUuidForPoolId, aA as TypedUuidForReviewAssignmentId, m as TypedUuidForReviewId, l as TypedUuidForReviewerId, i as TypedUuidForRoleId, c as TypedUuidForUserId, I as TypedUuidForUserProviderId, cX as UnassignPoolPathParams, bN as UpdateApiUserPathParams, bG as UpdateApplicantContact, bZ as UpdateApplicantContactPathParams, bH as UpdateDocument, cm as UpdateDocumentPathParams, bI as UpdateDocumentStatus, cp as UpdateDocumentStatusPathParams, cq as UpdateGroupPathParams, bJ as UpdateListing, cv as UpdateListingPathParams, cw as UpdateListingStatePathParams, cV as UpdatePoolPathParams, bK as UpdateReview, c_ as UpdateReviewPathParams, bY as ViewApplicantPathParams, ao as ViewApplication, c2 as ViewApplicationBundlePathParams, b_ as ViewApplicationPathParams, cf as ViewApplicationSummaryPathParams, cj as ViewDepartmentPathParams, co as ViewDocumentDataPathParams, cl as ViewDocumentPathParams, cu as ViewListingPathParams, cU as ViewPoolPathParams, cZ as ViewReviewPathParams, d1 as ViewRolePathParams, a as default } from './Api-Z7zZcVks.js';
1
+ export { x as AccessGroupUpdateParams_for_TurnstilePermission, y as AccessGroup_for_TurnstilePermission, z as AccessTokenExchangeRequest, bQ as AddApiUserToGroupPathParams, B as AddGroupBody, C as AddMagicLinkRedirectBody, E as AddOAuthClientRedirectBody, a as Api, A as ApiConfig, G as ApiKeyCreateParams_for_TurnstilePermission, H as ApiKeyResponse_for_TurnstilePermission, b as ApiResult, J as ApiUserContactEmail, K as ApiUserEmailUpdateParams, N as ApiUserInfo_for_TurnstilePermission, O as ApiUserLinkRequestPayload, Q as ApiUserLinkRequestResponse, L as ApiUserProvider, R as ApiUserProviderLinkPayload, U as ApiUserUpdateParams_for_TurnstilePermission, M as ApiUser_for_TurnstilePermission, V as Applicant, Y as ApplicantContact, X as ApplicantContactField, Z as ApplicantInfo, a1 as Application, a5 as ApplicationBundle, a7 as ApplicationInterviewCode, a0 as ApplicationState, a9 as ApplicationStateRecord, ah as ApplicationSummariesResponse, ai as ApplicationSummaryResponse, c0 as ApplyReviewActionPathParams, aj as AssignPool, cX as AssignPoolPathParams, ak as AttachDocument, c4 as AttachDocumentPathParams, cC as AuthzCodeCallbackPathParams, cD as AuthzCodeCallbackQueryParams, cE as AuthzCodeExchangePathParams, cA as AuthzCodeRedirectPathParams, cB as AuthzCodeRedirectQueryParams, ao as BatchParameter_for_TransitionBody, aq as BatchParameter_for_ViewApplication, bU as CreateApiUserTokenPathParams, ar as CreateApplication, c2 as CreateApplicationReviewAssignmentsPathParams, as as CreateDepartment, at as CreateDocument, c5 as CreateDocumentUploadUrlPathParams, bX as CreateLinkTokenPathParams, av as CreateListing, cI as CreateMagicLinkRedirectUriPathParams, cK as CreateMagicLinkSecretPathParams, aw as CreateMapper, cR as CreateOauthClientRedirectUriPathParams, cT as CreateOauthClientSecretPathParams, ax as CreatePool, ay as CreateReview, az as CreateReviewAssignments, aF as CreateReviewAssignmentsResponse, aG as CreateRole, aH as CreatedApplication, aE as CreatedAssignment, bW as DeleteApiUserTokenPathParams, co as DeleteDocumentPathParams, cs as DeleteGroupPathParams, cJ as DeleteMagicLinkRedirectUriPathParams, cL as DeleteMagicLinkSecretPathParams, cN as DeleteMapperPathParams, cS as DeleteOauthClientRedirectUriPathParams, cU as DeleteOauthClientSecretPathParams, d0 as DeleteReviewPathParams, aI as Department, a4 as Document, a2 as DocumentKind, D as DocumentParent, a3 as DocumentSource, aJ as DocumentUploadUrlResponse, aK as EmailApplicantBody, cP as EmailApplicantPathParams, al as EmailConfig, d3 as ErrorBody, d4 as ErrorResult, ag as Evaluator, cG as ExchangeDeviceTokenPathParams, af as ExpandedApplicationSummary, bN as GetApiUserPathParams, bV as GetApiUserTokenPathParams, c6 as GetApplicationInterviewCodePathParams, cF as GetDeviceProviderPathParams, cH as GetMagicLinkPathParams, cM as GetMappersQueryParams, cQ as GetOauthClientPathParams, ci as GetOperationPathParams, aL as GetUserResponse_for_TurnstilePermission, aM as InitialApiKeyResponse_for_TurnstilePermission, aO as InitialMagicLinkSecretResponse, aQ as InitialOAuthClientSecretResponse, aT as Interview, aS as InterviewAttendee, aU as Interviewer, _ as InterviewingState, aV as Jwk, aW as Jwks, bS as LinkProviderPathParams, bT as ListApiUserTokensPathParams, bY as ListApplicantsQueryParams, c1 as ListApplicationReviewAssignmentsPathParams, cf as ListApplicationSummariesQueryParams, cl as ListDocumentsQueryParams, cu as ListInterviewersQueryParams, ct as ListInterviewsQueryParams, cO as ListNotificationsQueryParams, cj as ListOperationTasksQueryParams, ch as ListOperationsQueryParams, d1 as ListReviewersQueryParams, cZ as ListReviewsQueryParams, aX as Listing, aZ as ListingPool, aa as ListingPoolAssociation, b1 as MagicLink, cy as MagicLinkExchangePathParams, b3 as MagicLinkExchangeRequest, b4 as MagicLinkExchangeResponse, b5 as MagicLinkMedium, a$ as MagicLinkRedirectUri, b0 as MagicLinkSecret, cz as MagicLinkSendPathParams, b6 as MagicLinkSendRequest, b7 as MagicLinkSendResponse, b8 as Mapper, b9 as NotificationMedium, ba as NotificationStatus, be as Notification_for_RenderedEmail, bf as OAuthAuthzCodeExchangeBody, bg as OAuthAuthzCodeExchangeResponse, bk as OAuthClient, bi as OAuthClientRedirectUri, bj as OAuthClientSecret, bm as OAuthProviderInfo, bl as OAuthProviderName, $ as OfferState, bn as OpenIdConfiguration, bo as OperationState, bp as OperationTaskState, br as OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue, bs as Operation_for_TurnstilePermission_and_String, bu as Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint, bw as Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint, bx as OptionalTransitionBody, P as Permissions_for_TurnstilePermission, by as Pool, ac as PoolAction, bd as RecipientId, bz as RegisterApplicant, bR as RemoveApiUserFromGroupPathParams, bc as RenderedEmail, bA as Review, aD as ReviewAssignment, aA as ReviewAssignmentCreationError, aC as ReviewAssignmentState, bD as ReviewInfo, ad as ReviewScore, bB as Reviewer, bC as ReviewerInfo, ae as Reviews, bE as Role, au as RoleListingStatus, bM as ScalarApplicationState, S as SecretString, bP as SetApiUserContactEmailPathParams, c7 as SimulateReviewActionPathParams, c8 as SubmitApplicationPathParams, bF as TransitionApplicationToDeclinedBatch, bt as TransitionApplicationToDeclinedBatchEndpoint, c9 as TransitionApplicationToDeclinedPathParams, bG as TransitionApplicationToDeferredBatch, bv as TransitionApplicationToDeferredBatchEndpoint, ca as TransitionApplicationToDeferredPathParams, cb as TransitionApplicationToInterviewingPathParams, cc as TransitionApplicationToNextStepsPathParams, cd as TransitionApplicationToOfferPathParams, ce as TransitionApplicationToWithdrawnPathParams, an as TransitionBody, am as TransitionMessage, ab as TriageReason, w as TurnstilePermission, s as TypedUuidForAccessGroupId, r as TypedUuidForApiKeyId, W as TypedUuidForApplicantContactId, T as TypedUuidForApplicantId, d as TypedUuidForApplicationId, a6 as TypedUuidForApplicationInterviewCodeId, a8 as TypedUuidForApplicationStateRecordId, p as TypedUuidForBackgroundCheckId, h as TypedUuidForDepartmentId, e as TypedUuidForDocumentId, f as TypedUuidForEmployeeId, aR as TypedUuidForInterviewAttendeeId, o as TypedUuidForInterviewId, n as TypedUuidForInterviewerId, j as TypedUuidForListingId, aY as TypedUuidForListingPoolId, b2 as TypedUuidForMagicLinkAttemptId, v as TypedUuidForMagicLinkId, a_ as TypedUuidForMagicLinkRedirectUriId, aN as TypedUuidForMagicLinkSecretId, t as TypedUuidForMapperId, bb as TypedUuidForNotificationId, u as TypedUuidForOAuthClientId, bh as TypedUuidForOAuthRedirectUriId, aP as TypedUuidForOAuthSecretId, g as TypedUuidForOnboardingId, q as TypedUuidForOperationId, bq as TypedUuidForOperationTaskId, k as TypedUuidForPoolId, aB as TypedUuidForReviewAssignmentId, m as TypedUuidForReviewId, l as TypedUuidForReviewerId, i as TypedUuidForRoleId, c as TypedUuidForUserId, I as TypedUuidForUserProviderId, cY as UnassignPoolPathParams, bO as UpdateApiUserPathParams, bH as UpdateApplicantContact, b_ as UpdateApplicantContactPathParams, bI as UpdateDocument, cn as UpdateDocumentPathParams, bJ as UpdateDocumentStatus, cq as UpdateDocumentStatusPathParams, cr as UpdateGroupPathParams, bK as UpdateListing, cw as UpdateListingPathParams, cx as UpdateListingStatePathParams, cW as UpdatePoolPathParams, bL as UpdateReview, c$ as UpdateReviewPathParams, bZ as ViewApplicantPathParams, ap as ViewApplication, c3 as ViewApplicationBundlePathParams, b$ as ViewApplicationPathParams, cg as ViewApplicationSummaryPathParams, ck as ViewDepartmentPathParams, cp as ViewDocumentDataPathParams, cm as ViewDocumentPathParams, cv as ViewListingPathParams, cV as ViewPoolPathParams, c_ as ViewReviewPathParams, d2 as ViewRolePathParams, a as default } from './Api-Mqr0O9hE.js';
package/dist/Api.js CHANGED
@@ -325,6 +325,9 @@ var Api = class extends HttpClient {
325
325
  ...params
326
326
  });
327
327
  },
328
+ /**
329
+ * View all applications
330
+ */
328
331
  listApplications: (_, params = {}) => {
329
332
  return this.request({
330
333
  path: `/application`,
@@ -332,6 +335,9 @@ var Api = class extends HttpClient {
332
335
  ...params
333
336
  });
334
337
  },
338
+ /**
339
+ * Create a new application
340
+ */
335
341
  createApplication: ({
336
342
  body
337
343
  }, params = {}) => {
@@ -342,6 +348,9 @@ var Api = class extends HttpClient {
342
348
  ...params
343
349
  });
344
350
  },
351
+ /**
352
+ * View an application
353
+ */
345
354
  viewApplication: ({
346
355
  path
347
356
  }, params = {}) => {
@@ -398,6 +407,9 @@ var Api = class extends HttpClient {
398
407
  ...params
399
408
  });
400
409
  },
410
+ /**
411
+ * Attach an uploaded document to an application
412
+ */
401
413
  attachDocument: ({
402
414
  path,
403
415
  body
@@ -409,6 +421,9 @@ var Api = class extends HttpClient {
409
421
  ...params
410
422
  });
411
423
  },
424
+ /**
425
+ * Generate a pre-signed upload url for uploading a document to an application
426
+ */
412
427
  createDocumentUploadUrl: ({
413
428
  path
414
429
  }, params = {}) => {
@@ -418,6 +433,9 @@ var Api = class extends HttpClient {
418
433
  ...params
419
434
  });
420
435
  },
436
+ /**
437
+ * Retrieve the interview code associated with an application
438
+ */
421
439
  getApplicationInterviewCode: ({
422
440
  path
423
441
  }, params = {}) => {
@@ -439,6 +457,9 @@ var Api = class extends HttpClient {
439
457
  ...params
440
458
  });
441
459
  },
460
+ /**
461
+ * Submit an application that has all required documents attached
462
+ */
442
463
  submitApplication: ({
443
464
  path
444
465
  }, params = {}) => {
@@ -448,6 +469,9 @@ var Api = class extends HttpClient {
448
469
  ...params
449
470
  });
450
471
  },
472
+ /**
473
+ * Move an application to the Declined stage
474
+ */
451
475
  transitionApplicationToDeclined: ({
452
476
  path,
453
477
  body
@@ -459,6 +483,9 @@ var Api = class extends HttpClient {
459
483
  ...params
460
484
  });
461
485
  },
486
+ /**
487
+ * Move an application to the Deferred stage
488
+ */
462
489
  transitionApplicationToDeferred: ({
463
490
  path,
464
491
  body
@@ -470,6 +497,9 @@ var Api = class extends HttpClient {
470
497
  ...params
471
498
  });
472
499
  },
500
+ /**
501
+ * Move an application to the Interviewing stage
502
+ */
473
503
  transitionApplicationToInterviewing: ({
474
504
  path,
475
505
  body
@@ -481,6 +511,9 @@ var Api = class extends HttpClient {
481
511
  ...params
482
512
  });
483
513
  },
514
+ /**
515
+ * Move an application to the Next Steps stage
516
+ */
484
517
  transitionApplicationToNextSteps: ({
485
518
  path,
486
519
  body
@@ -492,6 +525,9 @@ var Api = class extends HttpClient {
492
525
  ...params
493
526
  });
494
527
  },
528
+ /**
529
+ * Move an application to the Offer stage
530
+ */
495
531
  transitionApplicationToOffer: ({
496
532
  path,
497
533
  body
@@ -503,6 +539,9 @@ var Api = class extends HttpClient {
503
539
  ...params
504
540
  });
505
541
  },
542
+ /**
543
+ * Move an application to the Withdrawn stage
544
+ */
506
545
  transitionApplicationToWithdrawn: ({
507
546
  path,
508
547
  body
@@ -514,6 +553,9 @@ var Api = class extends HttpClient {
514
553
  ...params
515
554
  });
516
555
  },
556
+ /**
557
+ * List all application summaries
558
+ */
517
559
  listApplicationSummaries: ({
518
560
  query = {}
519
561
  }, params = {}) => {
@@ -524,6 +566,9 @@ var Api = class extends HttpClient {
524
566
  ...params
525
567
  });
526
568
  },
569
+ /**
570
+ * View a summary that includes an application and the related evaluations
571
+ */
527
572
  viewApplicationSummary: ({
528
573
  path
529
574
  }, params = {}) => {
@@ -1129,6 +1174,9 @@ var Api = class extends HttpClient {
1129
1174
  ...params
1130
1175
  });
1131
1176
  },
1177
+ /**
1178
+ * List reviewer pools and their associations
1179
+ */
1132
1180
  listPools: (_, params = {}) => {
1133
1181
  return this.request({
1134
1182
  path: `/pool`,
@@ -1136,6 +1184,9 @@ var Api = class extends HttpClient {
1136
1184
  ...params
1137
1185
  });
1138
1186
  },
1187
+ /**
1188
+ * Create a new pool
1189
+ */
1139
1190
  createPool: ({
1140
1191
  body
1141
1192
  }, params = {}) => {
@@ -1146,6 +1197,9 @@ var Api = class extends HttpClient {
1146
1197
  ...params
1147
1198
  });
1148
1199
  },
1200
+ /**
1201
+ * View a pool and its associations
1202
+ */
1149
1203
  viewPool: ({
1150
1204
  path
1151
1205
  }, params = {}) => {
@@ -1155,6 +1209,9 @@ var Api = class extends HttpClient {
1155
1209
  ...params
1156
1210
  });
1157
1211
  },
1212
+ /**
1213
+ * Update a pool
1214
+ */
1158
1215
  updatePool: ({
1159
1216
  path,
1160
1217
  body
@@ -1166,6 +1223,9 @@ var Api = class extends HttpClient {
1166
1223
  ...params
1167
1224
  });
1168
1225
  },
1226
+ /**
1227
+ * Assign a pool to a listing
1228
+ */
1169
1229
  assignPool: ({
1170
1230
  path,
1171
1231
  body
@@ -1177,6 +1237,9 @@ var Api = class extends HttpClient {
1177
1237
  ...params
1178
1238
  });
1179
1239
  },
1240
+ /**
1241
+ * Unassign a pool from a listing
1242
+ */
1180
1243
  unassignPool: ({
1181
1244
  path
1182
1245
  }, params = {}) => {
package/dist/retry.cjs CHANGED
@@ -352,6 +352,9 @@ var Api = class extends HttpClient {
352
352
  ...params
353
353
  });
354
354
  },
355
+ /**
356
+ * View all applications
357
+ */
355
358
  listApplications: (_, params = {}) => {
356
359
  return this.request({
357
360
  path: `/application`,
@@ -359,6 +362,9 @@ var Api = class extends HttpClient {
359
362
  ...params
360
363
  });
361
364
  },
365
+ /**
366
+ * Create a new application
367
+ */
362
368
  createApplication: ({
363
369
  body
364
370
  }, params = {}) => {
@@ -369,6 +375,9 @@ var Api = class extends HttpClient {
369
375
  ...params
370
376
  });
371
377
  },
378
+ /**
379
+ * View an application
380
+ */
372
381
  viewApplication: ({
373
382
  path
374
383
  }, params = {}) => {
@@ -425,6 +434,9 @@ var Api = class extends HttpClient {
425
434
  ...params
426
435
  });
427
436
  },
437
+ /**
438
+ * Attach an uploaded document to an application
439
+ */
428
440
  attachDocument: ({
429
441
  path,
430
442
  body
@@ -436,6 +448,9 @@ var Api = class extends HttpClient {
436
448
  ...params
437
449
  });
438
450
  },
451
+ /**
452
+ * Generate a pre-signed upload url for uploading a document to an application
453
+ */
439
454
  createDocumentUploadUrl: ({
440
455
  path
441
456
  }, params = {}) => {
@@ -445,6 +460,9 @@ var Api = class extends HttpClient {
445
460
  ...params
446
461
  });
447
462
  },
463
+ /**
464
+ * Retrieve the interview code associated with an application
465
+ */
448
466
  getApplicationInterviewCode: ({
449
467
  path
450
468
  }, params = {}) => {
@@ -466,6 +484,9 @@ var Api = class extends HttpClient {
466
484
  ...params
467
485
  });
468
486
  },
487
+ /**
488
+ * Submit an application that has all required documents attached
489
+ */
469
490
  submitApplication: ({
470
491
  path
471
492
  }, params = {}) => {
@@ -475,6 +496,9 @@ var Api = class extends HttpClient {
475
496
  ...params
476
497
  });
477
498
  },
499
+ /**
500
+ * Move an application to the Declined stage
501
+ */
478
502
  transitionApplicationToDeclined: ({
479
503
  path,
480
504
  body
@@ -486,6 +510,9 @@ var Api = class extends HttpClient {
486
510
  ...params
487
511
  });
488
512
  },
513
+ /**
514
+ * Move an application to the Deferred stage
515
+ */
489
516
  transitionApplicationToDeferred: ({
490
517
  path,
491
518
  body
@@ -497,6 +524,9 @@ var Api = class extends HttpClient {
497
524
  ...params
498
525
  });
499
526
  },
527
+ /**
528
+ * Move an application to the Interviewing stage
529
+ */
500
530
  transitionApplicationToInterviewing: ({
501
531
  path,
502
532
  body
@@ -508,6 +538,9 @@ var Api = class extends HttpClient {
508
538
  ...params
509
539
  });
510
540
  },
541
+ /**
542
+ * Move an application to the Next Steps stage
543
+ */
511
544
  transitionApplicationToNextSteps: ({
512
545
  path,
513
546
  body
@@ -519,6 +552,9 @@ var Api = class extends HttpClient {
519
552
  ...params
520
553
  });
521
554
  },
555
+ /**
556
+ * Move an application to the Offer stage
557
+ */
522
558
  transitionApplicationToOffer: ({
523
559
  path,
524
560
  body
@@ -530,6 +566,9 @@ var Api = class extends HttpClient {
530
566
  ...params
531
567
  });
532
568
  },
569
+ /**
570
+ * Move an application to the Withdrawn stage
571
+ */
533
572
  transitionApplicationToWithdrawn: ({
534
573
  path,
535
574
  body
@@ -541,6 +580,9 @@ var Api = class extends HttpClient {
541
580
  ...params
542
581
  });
543
582
  },
583
+ /**
584
+ * List all application summaries
585
+ */
544
586
  listApplicationSummaries: ({
545
587
  query = {}
546
588
  }, params = {}) => {
@@ -551,6 +593,9 @@ var Api = class extends HttpClient {
551
593
  ...params
552
594
  });
553
595
  },
596
+ /**
597
+ * View a summary that includes an application and the related evaluations
598
+ */
554
599
  viewApplicationSummary: ({
555
600
  path
556
601
  }, params = {}) => {
@@ -1156,6 +1201,9 @@ var Api = class extends HttpClient {
1156
1201
  ...params
1157
1202
  });
1158
1203
  },
1204
+ /**
1205
+ * List reviewer pools and their associations
1206
+ */
1159
1207
  listPools: (_, params = {}) => {
1160
1208
  return this.request({
1161
1209
  path: `/pool`,
@@ -1163,6 +1211,9 @@ var Api = class extends HttpClient {
1163
1211
  ...params
1164
1212
  });
1165
1213
  },
1214
+ /**
1215
+ * Create a new pool
1216
+ */
1166
1217
  createPool: ({
1167
1218
  body
1168
1219
  }, params = {}) => {
@@ -1173,6 +1224,9 @@ var Api = class extends HttpClient {
1173
1224
  ...params
1174
1225
  });
1175
1226
  },
1227
+ /**
1228
+ * View a pool and its associations
1229
+ */
1176
1230
  viewPool: ({
1177
1231
  path
1178
1232
  }, params = {}) => {
@@ -1182,6 +1236,9 @@ var Api = class extends HttpClient {
1182
1236
  ...params
1183
1237
  });
1184
1238
  },
1239
+ /**
1240
+ * Update a pool
1241
+ */
1185
1242
  updatePool: ({
1186
1243
  path,
1187
1244
  body
@@ -1193,6 +1250,9 @@ var Api = class extends HttpClient {
1193
1250
  ...params
1194
1251
  });
1195
1252
  },
1253
+ /**
1254
+ * Assign a pool to a listing
1255
+ */
1196
1256
  assignPool: ({
1197
1257
  path,
1198
1258
  body
@@ -1204,6 +1264,9 @@ var Api = class extends HttpClient {
1204
1264
  ...params
1205
1265
  });
1206
1266
  },
1267
+ /**
1268
+ * Unassign a pool from a listing
1269
+ */
1207
1270
  unassignPool: ({
1208
1271
  path
1209
1272
  }, params = {}) => {