@oxide/turnstile.ts 0.7.0-rc.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{Api-Z7zZcVks.d.cts → Api-IM66ePFV.d.cts} +285 -161
- package/dist/{Api-Z7zZcVks.d.ts → Api-IM66ePFV.d.ts} +285 -161
- package/dist/Api.cjs +101 -2
- package/dist/Api.d.cts +1 -1
- package/dist/Api.d.ts +1 -1
- package/dist/Api.js +101 -2
- package/dist/retry.cjs +101 -2
- package/dist/retry.d.cts +1 -1
- package/dist/retry.d.ts +1 -1
- package/dist/retry.js +101 -2
- package/dist/validate.cjs +1110 -1013
- package/dist/validate.d.cts +8417 -38672
- package/dist/validate.d.ts +8417 -38672
- package/dist/validate.js +223 -135
- package/package.json +2 -5
- package/src/Api.ts +343 -169
- package/src/util.ts +12 -2
- package/src/validate.ts +220 -141
|
@@ -88,181 +88,181 @@ type TypedUuidForAccessGroupId = string;
|
|
|
88
88
|
type TypedUuidForMapperId = string;
|
|
89
89
|
type TypedUuidForOAuthClientId = string;
|
|
90
90
|
type TypedUuidForMagicLinkId = string;
|
|
91
|
-
type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'ScheduleNotification' | 'SendNotification' | 'GetApplicantsAssigned' | 'GetApplicantsAll' | 'GetApplicantSelf' | 'CreateApplicantsAssigned' | 'CreateApplicantsAll' | 'CreateApplicantSelf' | 'ManageApplicantsAssigned' | 'ManageApplicantsAll' | 'ManageApplicantSelf' | 'GetApplicationsAssigned' | 'GetApplicationsAll' | 'CreateApplicationAssigned' | 'CreateApplicationSelf' | 'SubmitApplicationsAssigned' | 'WithdrawApplicationsAssigned' | 'ManageApplicationsAssigned' | 'ManageApplicationsAll' | 'GetDocumentsAssigned' | 'GetDocumentsAll' | 'CreateDocument' | 'ManageDocumentsAssigned' | 'ManageDocumentsAll' | 'AttachDocumentsAssigned' | 'AttachDocumentsAll' | 'GetDepartmentsAssigned' | 'GetDepartmentsAll' | 'CreateDepartment' | 'GetRolesAssigned' | 'GetRolesAll' | 'CreateRole' | 'GetListingsAssigned' | 'GetListingsAll' | 'CreateListing' | 'ManageListingsAll' | 'GetPoolsAssigned' | 'GetPoolsAll' | 'CreatePool' | 'ManagePoolsAll' | 'GetReviewersAssigned' | 'GetReviewersAll' | 'GetReviewerSelf' | 'CreateReviewersAssigned' | 'CreateReviewersAll' | 'CreateReviewerSelf' | 'GetReviewsAssigned' | 'GetReviewsAll' | 'CreateReview' | 'ManageReviewsAssigned' | 'ManageReviewsAll' | 'GetReviewAssignmentsAll' | 'CompleteReviewAssignmentSelf' | 'CompleteReviewAssignmentsAll' | 'ManageReviewAssignmentsAll' | 'GetReviewSummariesAll' | 'GetInterviewersAssigned' | 'GetInterviewersAll' | 'CreateInterviewersAssigned' | 'CreateInterviewersAll' | 'CreateInterviewerSelf' | 'ManageInterviewersAssigned' | 'ManageInterviewersAll' | 'GetInterviewsAssigned' | 'GetInterviewsAll' | 'CreateInterview' | 'ManageInterviewsAssigned' | 'ManageInterviewsAll' | 'GetBackgroundChecksAssigned' | 'GetBackgroundChecksAll' | 'CreateBackgroundChecksAll' | 'ManageBackgroundChecksAssigned' | 'ManageBackgroundChecksAll' | 'GetEnvelope' | 'SendEnvelope' | 'GetEmployeesAssigned' | 'GetEmployeesAll' | 'CreateEmployee' | 'ManageEmployeesAssigned' | 'ManageEmployeesAll' | 'GetOnboardingsAll' | 'CreateOnboarding' | 'GetBatchOperationsAssigned' | 'GetBatchOperationsAll' | 'CreateBatchOperation' | 'ManageBatchOperationsAll' | 'CreateApiUser' | 'GetApiUserSelf' | 'GetApiUsersAssigned' | 'GetApiUsersAll' | 'ManageApiUsersAssigned' | 'ManageApiUsersAll' | 'CreateApiKeySelf' | 'CreateApiKeyAssigned' | 'CreateApiKeyAll' | 'GetApiKeysAssigned' | 'GetApiKeysAll' | 'ManageApiKeysAssigned' | 'ManageApiKeysAll' | 'CreateUserApiProviderLinkToken' | 'CreateGroup' | 'GetGroupsJoined' | 'GetGroupsAll' | 'ManageGroupsAssigned' | 'ManageGroupsAll' | 'ManageGroupMembershipsAssigned' | 'ManageGroupMembershipsAll' | 'CreateMapper' | 'GetMappersAll' | 'ManageMappersAssigned' | 'ManageMappersAll' | 'CreateOAuthClient' | 'GetOAuthClientsAssigned' | 'GetOAuthClientsAll' | 'ManageOAuthClientsAssigned' | 'ManageOAuthClientsAll' | 'CreateMagicLinkClient' | 'GetMagicLinkClientsAssigned' | 'GetMagicLinkClientsAll' | 'ManageMagicLinkClientsAssigned' | 'ManageMagicLinkClientsAll' | 'CreateAccessToken' | {
|
|
91
|
+
type TurnstilePermission = 'CreateNotificationsAll' | 'GetNotificationsAll' | 'ScheduleNotification' | 'SendNotification' | 'GetApplicantsAssigned' | 'GetApplicantsAll' | 'GetApplicantSelf' | 'CreateApplicantsAssigned' | 'CreateApplicantsAll' | 'CreateApplicantSelf' | 'ManageApplicantsAssigned' | 'ManageApplicantsAll' | 'ManageApplicantSelf' | 'GetApplicationsAssigned' | 'GetApplicationsAll' | 'CreateApplicationAssigned' | 'CreateApplicationSelf' | 'SubmitApplicationsAssigned' | 'WithdrawApplicationsAssigned' | 'ManageApplicationsAssigned' | 'ManageApplicationsAll' | 'GetApplicationSummariesAll' | 'GetDocumentsAssigned' | 'GetDocumentsAll' | 'CreateDocument' | 'ManageDocumentsAssigned' | 'ManageDocumentsAll' | 'AttachDocumentsAssigned' | 'AttachDocumentsAll' | 'GetDepartmentsAssigned' | 'GetDepartmentsAll' | 'CreateDepartment' | 'GetRolesAssigned' | 'GetRolesAll' | 'CreateRole' | 'GetListingsAssigned' | 'GetListingsAll' | 'CreateListing' | 'ManageListingsAll' | 'GetPoolsAssigned' | 'GetPoolsAll' | 'CreatePool' | 'ManagePoolsAll' | 'GetReviewersAssigned' | 'GetReviewersAll' | 'GetReviewerSelf' | 'CreateReviewersAssigned' | 'CreateReviewersAll' | 'CreateReviewerSelf' | 'GetReviewsAssigned' | 'GetReviewsAll' | 'CreateReview' | 'ManageReviewsAssigned' | 'ManageReviewsAll' | 'GetReviewAssignmentsAll' | 'CompleteReviewAssignmentSelf' | 'CompleteReviewAssignmentsAll' | 'ManageReviewAssignmentsAll' | 'GetReviewSummariesAll' | 'GetInterviewersAssigned' | 'GetInterviewersAll' | 'CreateInterviewersAssigned' | 'CreateInterviewersAll' | 'CreateInterviewerSelf' | 'ManageInterviewersAssigned' | 'ManageInterviewersAll' | 'GetInterviewsAssigned' | 'GetInterviewsAll' | 'CreateInterview' | 'ManageInterviewsAssigned' | 'ManageInterviewsAll' | 'GetBackgroundChecksAssigned' | 'GetBackgroundChecksAll' | 'CreateBackgroundChecksAll' | 'ManageBackgroundChecksAssigned' | 'ManageBackgroundChecksAll' | 'GetEnvelope' | 'SendEnvelope' | 'GetEmployeesAssigned' | 'GetEmployeesAll' | 'CreateEmployee' | 'ManageEmployeesAssigned' | 'ManageEmployeesAll' | 'GetOnboardingsAll' | 'CreateOnboarding' | 'GetBatchOperationsAssigned' | 'GetBatchOperationsAll' | 'CreateBatchOperation' | 'ManageBatchOperationsAll' | 'CreateApiUser' | 'GetApiUserSelf' | 'GetApiUsersAssigned' | 'GetApiUsersAll' | 'ManageApiUsersAssigned' | 'ManageApiUsersAll' | 'CreateApiKeySelf' | 'CreateApiKeyAssigned' | 'CreateApiKeyAll' | 'GetApiKeysAssigned' | 'GetApiKeysAll' | 'ManageApiKeysAssigned' | 'ManageApiKeysAll' | 'CreateUserApiProviderLinkToken' | 'CreateGroup' | 'GetGroupsJoined' | 'GetGroupsAll' | 'ManageGroupsAssigned' | 'ManageGroupsAll' | 'ManageGroupMembershipsAssigned' | 'ManageGroupMembershipsAll' | 'CreateMapper' | 'GetMappersAll' | 'ManageMappersAssigned' | 'ManageMappersAll' | 'CreateOAuthClient' | 'GetOAuthClientsAssigned' | 'GetOAuthClientsAll' | 'ManageOAuthClientsAssigned' | 'ManageOAuthClientsAll' | 'CreateMagicLinkClient' | 'GetMagicLinkClientsAssigned' | 'GetMagicLinkClientsAll' | 'ManageMagicLinkClientsAssigned' | 'ManageMagicLinkClientsAll' | 'CreateAccessToken' | {
|
|
92
92
|
'GetApplicant': TypedUuidForApplicantId;
|
|
93
93
|
} | {
|
|
94
|
-
'GetApplicants': TypedUuidForApplicantId[];
|
|
94
|
+
'GetApplicants': (TypedUuidForApplicantId)[];
|
|
95
95
|
} | {
|
|
96
96
|
'CreateApplicant': TypedUuidForUserId;
|
|
97
97
|
} | {
|
|
98
|
-
'CreateApplicants': TypedUuidForUserId[];
|
|
98
|
+
'CreateApplicants': (TypedUuidForUserId)[];
|
|
99
99
|
} | {
|
|
100
100
|
'ManageApplicant': TypedUuidForApplicantId;
|
|
101
101
|
} | {
|
|
102
|
-
'ManageApplicants': TypedUuidForApplicantId[];
|
|
102
|
+
'ManageApplicants': (TypedUuidForApplicantId)[];
|
|
103
103
|
} | {
|
|
104
104
|
'GetApplication': TypedUuidForApplicationId;
|
|
105
105
|
} | {
|
|
106
|
-
'GetApplications': TypedUuidForApplicationId[];
|
|
106
|
+
'GetApplications': (TypedUuidForApplicationId)[];
|
|
107
107
|
} | {
|
|
108
108
|
'CreateApplication': TypedUuidForApplicantId;
|
|
109
109
|
} | {
|
|
110
110
|
'SubmitApplication': TypedUuidForApplicationId;
|
|
111
111
|
} | {
|
|
112
|
-
'SubmitApplications': TypedUuidForApplicationId[];
|
|
112
|
+
'SubmitApplications': (TypedUuidForApplicationId)[];
|
|
113
113
|
} | {
|
|
114
114
|
'WithdrawApplication': TypedUuidForApplicationId;
|
|
115
115
|
} | {
|
|
116
|
-
'WithdrawApplications': TypedUuidForApplicationId[];
|
|
116
|
+
'WithdrawApplications': (TypedUuidForApplicationId)[];
|
|
117
117
|
} | {
|
|
118
118
|
'ManageApplication': TypedUuidForApplicationId;
|
|
119
119
|
} | {
|
|
120
|
-
'ManageApplications': TypedUuidForApplicationId[];
|
|
120
|
+
'ManageApplications': (TypedUuidForApplicationId)[];
|
|
121
121
|
} | {
|
|
122
122
|
'GetDocument': TypedUuidForDocumentId;
|
|
123
123
|
} | {
|
|
124
|
-
'GetDocuments': TypedUuidForDocumentId[];
|
|
124
|
+
'GetDocuments': (TypedUuidForDocumentId)[];
|
|
125
125
|
} | {
|
|
126
126
|
'ManageDocument': TypedUuidForDocumentId;
|
|
127
127
|
} | {
|
|
128
|
-
'ManageDocuments': TypedUuidForDocumentId[];
|
|
128
|
+
'ManageDocuments': (TypedUuidForDocumentId)[];
|
|
129
129
|
} | {
|
|
130
130
|
'AttachDocument': DocumentParent;
|
|
131
131
|
} | {
|
|
132
|
-
'AttachDocuments': DocumentParent[];
|
|
132
|
+
'AttachDocuments': (DocumentParent)[];
|
|
133
133
|
} | {
|
|
134
134
|
'GetDepartment': TypedUuidForDepartmentId;
|
|
135
135
|
} | {
|
|
136
|
-
'GetDepartments': TypedUuidForDepartmentId[];
|
|
136
|
+
'GetDepartments': (TypedUuidForDepartmentId)[];
|
|
137
137
|
} | {
|
|
138
138
|
'GetRole': TypedUuidForRoleId;
|
|
139
139
|
} | {
|
|
140
|
-
'GetRoles': TypedUuidForRoleId[];
|
|
140
|
+
'GetRoles': (TypedUuidForRoleId)[];
|
|
141
141
|
} | {
|
|
142
142
|
'GetListing': TypedUuidForListingId;
|
|
143
143
|
} | {
|
|
144
|
-
'GetListings': TypedUuidForListingId[];
|
|
144
|
+
'GetListings': (TypedUuidForListingId)[];
|
|
145
145
|
} | {
|
|
146
146
|
'GetPool': TypedUuidForPoolId;
|
|
147
147
|
} | {
|
|
148
|
-
'GetPools': TypedUuidForPoolId[];
|
|
148
|
+
'GetPools': (TypedUuidForPoolId)[];
|
|
149
149
|
} | {
|
|
150
150
|
'GetReviewer': TypedUuidForReviewerId;
|
|
151
151
|
} | {
|
|
152
|
-
'GetReviewers': TypedUuidForReviewerId[];
|
|
152
|
+
'GetReviewers': (TypedUuidForReviewerId)[];
|
|
153
153
|
} | {
|
|
154
154
|
'CreateReviewer': TypedUuidForUserId;
|
|
155
155
|
} | {
|
|
156
|
-
'CreateReviewers': TypedUuidForUserId[];
|
|
156
|
+
'CreateReviewers': (TypedUuidForUserId)[];
|
|
157
157
|
} | {
|
|
158
158
|
'GetReview': TypedUuidForReviewId;
|
|
159
159
|
} | {
|
|
160
|
-
'GetReviews': TypedUuidForReviewId[];
|
|
160
|
+
'GetReviews': (TypedUuidForReviewId)[];
|
|
161
161
|
} | {
|
|
162
162
|
'ManageReview': TypedUuidForReviewId;
|
|
163
163
|
} | {
|
|
164
|
-
'ManageReviews': TypedUuidForReviewId[];
|
|
164
|
+
'ManageReviews': (TypedUuidForReviewId)[];
|
|
165
165
|
} | {
|
|
166
166
|
'CompleteReviewAssignment': TypedUuidForUserId;
|
|
167
167
|
} | {
|
|
168
168
|
'GetInterviewer': TypedUuidForInterviewerId;
|
|
169
169
|
} | {
|
|
170
|
-
'GetInterviewers': TypedUuidForInterviewerId[];
|
|
170
|
+
'GetInterviewers': (TypedUuidForInterviewerId)[];
|
|
171
171
|
} | {
|
|
172
172
|
'CreateInterviewer': TypedUuidForUserId;
|
|
173
173
|
} | {
|
|
174
|
-
'CreateInterviewers': TypedUuidForUserId[];
|
|
174
|
+
'CreateInterviewers': (TypedUuidForUserId)[];
|
|
175
175
|
} | {
|
|
176
176
|
'ManageInterviewer': TypedUuidForInterviewerId;
|
|
177
177
|
} | {
|
|
178
|
-
'ManageInterviewers': TypedUuidForInterviewerId[];
|
|
178
|
+
'ManageInterviewers': (TypedUuidForInterviewerId)[];
|
|
179
179
|
} | {
|
|
180
180
|
'GetInterview': TypedUuidForInterviewId;
|
|
181
181
|
} | {
|
|
182
|
-
'GetInterviews': TypedUuidForInterviewId[];
|
|
182
|
+
'GetInterviews': (TypedUuidForInterviewId)[];
|
|
183
183
|
} | {
|
|
184
184
|
'ManageInterview': TypedUuidForInterviewId;
|
|
185
185
|
} | {
|
|
186
|
-
'ManageInterviews': TypedUuidForInterviewId[];
|
|
186
|
+
'ManageInterviews': (TypedUuidForInterviewId)[];
|
|
187
187
|
} | {
|
|
188
188
|
'GetBackgroundCheck': TypedUuidForBackgroundCheckId;
|
|
189
189
|
} | {
|
|
190
|
-
'GetBackgroundChecks': TypedUuidForBackgroundCheckId[];
|
|
190
|
+
'GetBackgroundChecks': (TypedUuidForBackgroundCheckId)[];
|
|
191
191
|
} | {
|
|
192
192
|
'ManageBackgroundCheck': TypedUuidForBackgroundCheckId;
|
|
193
193
|
} | {
|
|
194
|
-
'ManageBackgroundChecks': TypedUuidForBackgroundCheckId[];
|
|
194
|
+
'ManageBackgroundChecks': (TypedUuidForBackgroundCheckId)[];
|
|
195
195
|
} | {
|
|
196
196
|
'GetEmployee': TypedUuidForEmployeeId;
|
|
197
197
|
} | {
|
|
198
|
-
'GetEmployees': TypedUuidForEmployeeId[];
|
|
198
|
+
'GetEmployees': (TypedUuidForEmployeeId)[];
|
|
199
199
|
} | {
|
|
200
200
|
'ManageEmployee': TypedUuidForEmployeeId;
|
|
201
201
|
} | {
|
|
202
|
-
'ManageEmployees': TypedUuidForEmployeeId[];
|
|
202
|
+
'ManageEmployees': (TypedUuidForEmployeeId)[];
|
|
203
203
|
} | {
|
|
204
204
|
'GetBatchOperation': TypedUuidForOperationId;
|
|
205
205
|
} | {
|
|
206
|
-
'GetBatchOperations': TypedUuidForOperationId[];
|
|
206
|
+
'GetBatchOperations': (TypedUuidForOperationId)[];
|
|
207
207
|
} | {
|
|
208
208
|
'GetApiUser': TypedUuidForUserId;
|
|
209
209
|
} | {
|
|
210
|
-
'GetApiUsers': TypedUuidForUserId[];
|
|
210
|
+
'GetApiUsers': (TypedUuidForUserId)[];
|
|
211
211
|
} | {
|
|
212
212
|
'ManageApiUser': TypedUuidForUserId;
|
|
213
213
|
} | {
|
|
214
|
-
'ManageApiUsers': TypedUuidForUserId[];
|
|
214
|
+
'ManageApiUsers': (TypedUuidForUserId)[];
|
|
215
215
|
} | {
|
|
216
216
|
'CreateApiKey': TypedUuidForUserId;
|
|
217
217
|
} | {
|
|
218
218
|
'GetApiKey': TypedUuidForApiKeyId;
|
|
219
219
|
} | {
|
|
220
|
-
'GetApiKeys': TypedUuidForApiKeyId[];
|
|
220
|
+
'GetApiKeys': (TypedUuidForApiKeyId)[];
|
|
221
221
|
} | {
|
|
222
222
|
'ManageApiKey': TypedUuidForApiKeyId;
|
|
223
223
|
} | {
|
|
224
|
-
'ManageApiKeys': TypedUuidForApiKeyId[];
|
|
224
|
+
'ManageApiKeys': (TypedUuidForApiKeyId)[];
|
|
225
225
|
} | {
|
|
226
226
|
'GetGroup': TypedUuidForAccessGroupId;
|
|
227
227
|
} | {
|
|
228
228
|
'ManageGroup': TypedUuidForAccessGroupId;
|
|
229
229
|
} | {
|
|
230
|
-
'ManageGroups': TypedUuidForAccessGroupId[];
|
|
230
|
+
'ManageGroups': (TypedUuidForAccessGroupId)[];
|
|
231
231
|
} | {
|
|
232
232
|
'ManageGroupMembership': TypedUuidForAccessGroupId;
|
|
233
233
|
} | {
|
|
234
|
-
'ManageGroupMemberships': TypedUuidForAccessGroupId[];
|
|
234
|
+
'ManageGroupMemberships': (TypedUuidForAccessGroupId)[];
|
|
235
235
|
} | {
|
|
236
236
|
'ManageMapper': TypedUuidForMapperId;
|
|
237
237
|
} | {
|
|
238
|
-
'ManageMappers': TypedUuidForMapperId[];
|
|
238
|
+
'ManageMappers': (TypedUuidForMapperId)[];
|
|
239
239
|
} | {
|
|
240
240
|
'GetOAuthClient': TypedUuidForOAuthClientId;
|
|
241
241
|
} | {
|
|
242
|
-
'GetOAuthClients': TypedUuidForOAuthClientId[];
|
|
242
|
+
'GetOAuthClients': (TypedUuidForOAuthClientId)[];
|
|
243
243
|
} | {
|
|
244
244
|
'ManageOAuthClient': TypedUuidForOAuthClientId;
|
|
245
245
|
} | {
|
|
246
|
-
'ManageOAuthClients': TypedUuidForOAuthClientId[];
|
|
246
|
+
'ManageOAuthClients': (TypedUuidForOAuthClientId)[];
|
|
247
247
|
} | {
|
|
248
248
|
'GetMagicLinkClient': TypedUuidForMagicLinkId;
|
|
249
249
|
} | {
|
|
250
|
-
'GetMagicLinkClients': TypedUuidForMagicLinkId[];
|
|
250
|
+
'GetMagicLinkClients': (TypedUuidForMagicLinkId)[];
|
|
251
251
|
} | {
|
|
252
252
|
'ManageMagicLinkClient': TypedUuidForMagicLinkId;
|
|
253
253
|
} | {
|
|
254
|
-
'ManageMagicLinkClients': TypedUuidForMagicLinkId[];
|
|
254
|
+
'ManageMagicLinkClients': (TypedUuidForMagicLinkId)[];
|
|
255
255
|
} | {
|
|
256
256
|
'Unsupported': Record<string, unknown>;
|
|
257
257
|
};
|
|
258
|
-
type Permissions_for_TurnstilePermission = TurnstilePermission[];
|
|
258
|
+
type Permissions_for_TurnstilePermission = (TurnstilePermission)[];
|
|
259
259
|
type AccessGroupUpdateParams_for_TurnstilePermission = {
|
|
260
260
|
'name': string;
|
|
261
261
|
'permissions': Permissions_for_TurnstilePermission;
|
|
262
262
|
};
|
|
263
263
|
type AccessGroup_for_TurnstilePermission = {
|
|
264
264
|
'createdAt': Date;
|
|
265
|
-
'deletedAt'?: Date;
|
|
265
|
+
'deletedAt'?: Date | null;
|
|
266
266
|
'id': TypedUuidForAccessGroupId;
|
|
267
267
|
'name': string;
|
|
268
268
|
'permissions': Permissions_for_TurnstilePermission;
|
|
@@ -270,7 +270,7 @@ type AccessGroup_for_TurnstilePermission = {
|
|
|
270
270
|
};
|
|
271
271
|
type AccessTokenExchangeRequest = {
|
|
272
272
|
'deviceCode': string;
|
|
273
|
-
'expiresAt'?: Date;
|
|
273
|
+
'expiresAt'?: Date | null;
|
|
274
274
|
'grantType': string;
|
|
275
275
|
};
|
|
276
276
|
type AddGroupBody = {
|
|
@@ -284,17 +284,17 @@ type AddOAuthClientRedirectBody = {
|
|
|
284
284
|
};
|
|
285
285
|
type ApiKeyCreateParams_for_TurnstilePermission = {
|
|
286
286
|
'expiresAt': Date;
|
|
287
|
-
'permissions'?: Permissions_for_TurnstilePermission;
|
|
287
|
+
'permissions'?: Permissions_for_TurnstilePermission | null;
|
|
288
288
|
};
|
|
289
289
|
type ApiKeyResponse_for_TurnstilePermission = {
|
|
290
290
|
'createdAt': Date;
|
|
291
291
|
'id': TypedUuidForApiKeyId;
|
|
292
|
-
'permissions'?: Permissions_for_TurnstilePermission;
|
|
292
|
+
'permissions'?: Permissions_for_TurnstilePermission | null;
|
|
293
293
|
};
|
|
294
294
|
type TypedUuidForUserProviderId = string;
|
|
295
295
|
type ApiUserContactEmail = {
|
|
296
296
|
'createdAt': Date;
|
|
297
|
-
'deletedAt'?: Date;
|
|
297
|
+
'deletedAt'?: Date | null;
|
|
298
298
|
'email': string;
|
|
299
299
|
'id': TypedUuidForUserProviderId;
|
|
300
300
|
'updatedAt': Date;
|
|
@@ -305,9 +305,9 @@ type ApiUserEmailUpdateParams = {
|
|
|
305
305
|
};
|
|
306
306
|
type ApiUserProvider = {
|
|
307
307
|
'createdAt': Date;
|
|
308
|
-
'deletedAt'?: Date;
|
|
309
|
-
'displayNames': string[];
|
|
310
|
-
'emails': string[];
|
|
308
|
+
'deletedAt'?: Date | null;
|
|
309
|
+
'displayNames': (string)[];
|
|
310
|
+
'emails': (string)[];
|
|
311
311
|
'id': TypedUuidForUserProviderId;
|
|
312
312
|
'provider': string;
|
|
313
313
|
'providerId': string;
|
|
@@ -316,15 +316,15 @@ type ApiUserProvider = {
|
|
|
316
316
|
};
|
|
317
317
|
type ApiUser_for_TurnstilePermission = {
|
|
318
318
|
'createdAt': Date;
|
|
319
|
-
'deletedAt'?: Date;
|
|
320
|
-
'groups': TypedUuidForAccessGroupId[];
|
|
319
|
+
'deletedAt'?: Date | null;
|
|
320
|
+
'groups': (TypedUuidForAccessGroupId)[];
|
|
321
321
|
'id': TypedUuidForUserId;
|
|
322
322
|
'permissions': Permissions_for_TurnstilePermission;
|
|
323
323
|
'updatedAt': Date;
|
|
324
324
|
};
|
|
325
325
|
type ApiUserInfo_for_TurnstilePermission = {
|
|
326
|
-
'email'?: ApiUserContactEmail;
|
|
327
|
-
'providers': ApiUserProvider[];
|
|
326
|
+
'email'?: ApiUserContactEmail | null;
|
|
327
|
+
'providers': (ApiUserProvider)[];
|
|
328
328
|
'user': ApiUser_for_TurnstilePermission;
|
|
329
329
|
};
|
|
330
330
|
type ApiUserLinkRequestPayload = {
|
|
@@ -338,13 +338,13 @@ type ApiUserProviderLinkPayload = {
|
|
|
338
338
|
'token': string;
|
|
339
339
|
};
|
|
340
340
|
type ApiUserUpdateParams_for_TurnstilePermission = {
|
|
341
|
-
'groupIds': TypedUuidForAccessGroupId[];
|
|
341
|
+
'groupIds': (TypedUuidForAccessGroupId)[];
|
|
342
342
|
'permissions': Permissions_for_TurnstilePermission;
|
|
343
343
|
};
|
|
344
344
|
type Applicant = {
|
|
345
345
|
'apiUserId': TypedUuidForUserId;
|
|
346
346
|
'createdAt': Date;
|
|
347
|
-
'deletedAt'?: Date;
|
|
347
|
+
'deletedAt'?: Date | null;
|
|
348
348
|
'id': TypedUuidForApplicantId;
|
|
349
349
|
'updatedAt': Date;
|
|
350
350
|
};
|
|
@@ -353,18 +353,20 @@ type ApplicantContactField = 'country' | 'email' | 'github' | 'gitlab' | 'linked
|
|
|
353
353
|
type ApplicantContact = {
|
|
354
354
|
'applicantId': TypedUuidForApplicantId;
|
|
355
355
|
'createdAt': Date;
|
|
356
|
-
'deletedAt'?: Date;
|
|
356
|
+
'deletedAt'?: Date | null;
|
|
357
357
|
'id': TypedUuidForApplicantContactId;
|
|
358
358
|
'kind': ApplicantContactField;
|
|
359
359
|
'updatedAt': Date;
|
|
360
|
-
'value'?: string;
|
|
360
|
+
'value'?: string | null;
|
|
361
361
|
};
|
|
362
362
|
type ApplicantInfo = {
|
|
363
|
-
'contact': ApplicantContact[];
|
|
363
|
+
'contact': (ApplicantContact)[];
|
|
364
364
|
'info': Applicant;
|
|
365
365
|
};
|
|
366
366
|
type InterviewingState = 'scheduled' | 'schedule_updating' | 'packet_updated_needed' | 'packet_updating' | 'complete';
|
|
367
|
-
type OfferState = '
|
|
367
|
+
type OfferState = 'documents_sent' | 'documents_complete' | 'background_check_sent' | 'background_check_warning' | 'background_check_complete' | 'complete' | {
|
|
368
|
+
'start': string;
|
|
369
|
+
};
|
|
368
370
|
type ApplicationState = 'contracted' | 'declined' | 'deferred' | 'hired' | 'next_steps' | 'pending' | 'submitted' | 'triage' | 'withdrawn' | {
|
|
369
371
|
'interviewing': InterviewingState;
|
|
370
372
|
} | {
|
|
@@ -372,33 +374,33 @@ type ApplicationState = 'contracted' | 'declined' | 'deferred' | 'hired' | 'next
|
|
|
372
374
|
};
|
|
373
375
|
type Application = {
|
|
374
376
|
'applicantId': TypedUuidForApplicantId;
|
|
375
|
-
'completedAt'?: Date;
|
|
377
|
+
'completedAt'?: Date | null;
|
|
376
378
|
'createdAt': Date;
|
|
377
|
-
'deletedAt'?: Date;
|
|
379
|
+
'deletedAt'?: Date | null;
|
|
378
380
|
'id': TypedUuidForApplicationId;
|
|
379
381
|
'listingId': TypedUuidForListingId;
|
|
380
382
|
'state': ApplicationState;
|
|
381
|
-
'submittedAt'?: Date;
|
|
383
|
+
'submittedAt'?: Date | null;
|
|
382
384
|
'updatedAt': Date;
|
|
383
385
|
};
|
|
384
386
|
type DocumentKind = 'interview_packet' | 'materials' | 'offer_letter' | 'onboarding_issue' | 'piia_agreement' | 'portfolio' | 'resume';
|
|
385
387
|
type DocumentSource = 'aws_s3' | 'docusign' | 'github' | 'google_drive';
|
|
386
388
|
type Document = {
|
|
387
389
|
'createdAt': Date;
|
|
388
|
-
'deletedAt'?: Date;
|
|
390
|
+
'deletedAt'?: Date | null;
|
|
389
391
|
'externalId': string;
|
|
390
392
|
'id': TypedUuidForDocumentId;
|
|
391
393
|
'kind': DocumentKind;
|
|
392
|
-
'mime'?: string;
|
|
394
|
+
'mime'?: string | null;
|
|
393
395
|
'parentId': DocumentParent;
|
|
394
396
|
'source': DocumentSource;
|
|
395
|
-
'status'?: string;
|
|
397
|
+
'status'?: string | null;
|
|
396
398
|
'updatedAt': Date;
|
|
397
399
|
};
|
|
398
400
|
type ApplicationBundle = {
|
|
399
401
|
'applicant': ApplicantInfo;
|
|
400
402
|
'application': Application;
|
|
401
|
-
'documents': Document[];
|
|
403
|
+
'documents': (Document)[];
|
|
402
404
|
};
|
|
403
405
|
type TypedUuidForApplicationInterviewCodeId = string;
|
|
404
406
|
type ApplicationInterviewCode = {
|
|
@@ -411,61 +413,69 @@ type TypedUuidForApplicationStateRecordId = string;
|
|
|
411
413
|
type ApplicationStateRecord = {
|
|
412
414
|
'applicationId': TypedUuidForApplicationId;
|
|
413
415
|
'createdAt': Date;
|
|
414
|
-
'deletedAt'?: Date;
|
|
415
416
|
'id': TypedUuidForApplicationStateRecordId;
|
|
416
417
|
'state': ApplicationState;
|
|
418
|
+
'supersededAt'?: Date | null;
|
|
417
419
|
'updatedAt': Date;
|
|
418
420
|
};
|
|
419
421
|
type ListingPoolAssociation = 'first' | 'early_positive' | 'positive';
|
|
420
|
-
type
|
|
421
|
-
|
|
422
|
-
'
|
|
423
|
-
|
|
422
|
+
type TriageReason = 'has_no_ratings' | 'likely_next_steps' | 'likely_pass' | 'possibly_next_steps' | 'possibly_pass' | 'very_likely_pass' | 'unknown';
|
|
423
|
+
type PoolAction = 'drop' | 'wait' | {
|
|
424
|
+
'add': {
|
|
425
|
+
'association': ListingPoolAssociation;
|
|
426
|
+
'count': number;
|
|
427
|
+
};
|
|
424
428
|
} | {
|
|
425
|
-
'
|
|
429
|
+
'triage': {
|
|
430
|
+
'reason': TriageReason;
|
|
431
|
+
};
|
|
426
432
|
};
|
|
427
433
|
type ReviewScore = 'emphatic_yes' | 'yes' | 'pass' | 'no' | 'emphatic_no' | 'incomplete';
|
|
428
434
|
type Reviews = {
|
|
429
435
|
'applicationId': TypedUuidForApplicationId;
|
|
430
|
-
'complete': TypedUuidForReviewerId[];
|
|
431
|
-
'pending': TypedUuidForReviewerId[];
|
|
432
|
-
'reviewers': TypedUuidForReviewerId[];
|
|
433
|
-
'scores': ReviewScore[];
|
|
436
|
+
'complete': (TypedUuidForReviewerId)[];
|
|
437
|
+
'pending': (TypedUuidForReviewerId)[];
|
|
438
|
+
'reviewers': (TypedUuidForReviewerId)[];
|
|
439
|
+
'scores': (ReviewScore)[];
|
|
434
440
|
};
|
|
435
441
|
type ExpandedApplicationSummary = {
|
|
436
442
|
'action': PoolAction;
|
|
437
443
|
'applicant': ApplicantInfo;
|
|
438
444
|
'application': Application;
|
|
439
|
-
'documents': Document[];
|
|
440
|
-
'interviewers': TypedUuidForInterviewerId[];
|
|
441
|
-
'interviews': TypedUuidForInterviewId[];
|
|
445
|
+
'documents': (Document)[];
|
|
446
|
+
'interviewers': (TypedUuidForInterviewerId)[];
|
|
447
|
+
'interviews': (TypedUuidForInterviewId)[];
|
|
442
448
|
'reviews': Reviews;
|
|
443
449
|
};
|
|
444
450
|
type Evaluator = {
|
|
445
|
-
'interviewer'?: TypedUuidForInterviewerId;
|
|
446
|
-
'reviewer'?: TypedUuidForReviewerId;
|
|
451
|
+
'interviewer'?: TypedUuidForInterviewerId | null;
|
|
452
|
+
'reviewer'?: TypedUuidForReviewerId | null;
|
|
447
453
|
'user': ApiUserInfo_for_TurnstilePermission;
|
|
448
454
|
};
|
|
449
455
|
type ApplicationSummariesResponse = {
|
|
450
|
-
'summaries': ExpandedApplicationSummary[];
|
|
451
|
-
'users': Evaluator[];
|
|
456
|
+
'summaries': (ExpandedApplicationSummary)[];
|
|
457
|
+
'users': (Evaluator)[];
|
|
452
458
|
};
|
|
453
459
|
type ApplicationSummaryResponse = {
|
|
454
460
|
'summary': ExpandedApplicationSummary;
|
|
455
|
-
'users': Evaluator[];
|
|
461
|
+
'users': (Evaluator)[];
|
|
456
462
|
};
|
|
457
463
|
type AssignPool = {
|
|
464
|
+
/** Review stage of the listing this pool should be associated to */
|
|
458
465
|
'association': ListingPoolAssociation;
|
|
466
|
+
/** Listing to assign this pool to */
|
|
459
467
|
'listing': TypedUuidForListingId;
|
|
460
468
|
};
|
|
461
469
|
type AttachDocument = {
|
|
470
|
+
/** Id assigned to the document by the external datastore */
|
|
462
471
|
'externalId': string;
|
|
463
|
-
|
|
472
|
+
/** Mime type of the document */
|
|
473
|
+
'mime'?: string | null;
|
|
464
474
|
};
|
|
465
475
|
type EmailConfig = {
|
|
466
476
|
'from': string;
|
|
467
|
-
'htmlTemplate'?: string;
|
|
468
|
-
'name'?: string;
|
|
477
|
+
'htmlTemplate'?: string | null;
|
|
478
|
+
'name'?: string | null;
|
|
469
479
|
'subject': string;
|
|
470
480
|
'textTemplate': string;
|
|
471
481
|
};
|
|
@@ -473,23 +483,27 @@ type TransitionMessage = 'default' | 'omit' | {
|
|
|
473
483
|
'custom': EmailConfig;
|
|
474
484
|
};
|
|
475
485
|
type TransitionBody = {
|
|
486
|
+
/** The message to send to the applicant */
|
|
476
487
|
'message': TransitionMessage;
|
|
477
488
|
};
|
|
478
489
|
type BatchParameter_for_TransitionBody = {
|
|
479
490
|
'all': TransitionBody;
|
|
480
491
|
} | {
|
|
481
|
-
'each': TransitionBody[];
|
|
492
|
+
'each': (TransitionBody)[];
|
|
482
493
|
};
|
|
483
494
|
type ViewApplication = {
|
|
495
|
+
/** Application to operate on */
|
|
484
496
|
'application': TypedUuidForApplicationId;
|
|
485
497
|
};
|
|
486
498
|
type BatchParameter_for_ViewApplication = {
|
|
487
499
|
'all': ViewApplication;
|
|
488
500
|
} | {
|
|
489
|
-
'each': ViewApplication[];
|
|
501
|
+
'each': (ViewApplication)[];
|
|
490
502
|
};
|
|
491
503
|
type CreateApplication = {
|
|
504
|
+
/** Applicant to create an application for */
|
|
492
505
|
'applicant': TypedUuidForApplicantId;
|
|
506
|
+
/** Listing to apply to */
|
|
493
507
|
'listing': TypedUuidForListingId;
|
|
494
508
|
};
|
|
495
509
|
type CreateDepartment = {
|
|
@@ -501,7 +515,7 @@ type CreateDocument = {
|
|
|
501
515
|
'mime': string;
|
|
502
516
|
'parent': DocumentParent;
|
|
503
517
|
'source': DocumentSource;
|
|
504
|
-
'status'?: string;
|
|
518
|
+
'status'?: string | null;
|
|
505
519
|
};
|
|
506
520
|
type RoleListingStatus = 'open' | 'closed';
|
|
507
521
|
type CreateListing = {
|
|
@@ -510,14 +524,17 @@ type CreateListing = {
|
|
|
510
524
|
'status': RoleListingStatus;
|
|
511
525
|
};
|
|
512
526
|
type CreateMapper = {
|
|
513
|
-
'maxActivations'?: number;
|
|
527
|
+
'maxActivations'?: number | null;
|
|
514
528
|
'name': string;
|
|
515
529
|
'rule': Record<string, unknown>;
|
|
516
530
|
};
|
|
517
531
|
type CreatePool = {
|
|
518
|
-
|
|
532
|
+
/** Optional description of the pool */
|
|
533
|
+
'description'?: string | null;
|
|
534
|
+
/** Required display name for the pool */
|
|
519
535
|
'name': string;
|
|
520
|
-
|
|
536
|
+
/** List of reviewers to assign to this pool */
|
|
537
|
+
'reviewers'?: (TypedUuidForReviewerId)[] | null;
|
|
521
538
|
};
|
|
522
539
|
type CreateReview = {
|
|
523
540
|
'application': TypedUuidForApplicationId;
|
|
@@ -526,30 +543,32 @@ type CreateReview = {
|
|
|
526
543
|
'score': ReviewScore;
|
|
527
544
|
'valueReflected': string;
|
|
528
545
|
'valueViolated': string;
|
|
529
|
-
'valuesInTension': string[];
|
|
546
|
+
'valuesInTension': (string)[];
|
|
530
547
|
};
|
|
531
548
|
/**
|
|
532
549
|
* Reviewers to assign to this application for review
|
|
533
550
|
*/
|
|
534
551
|
type CreateReviewAssignments = {
|
|
535
|
-
'reviewers': TypedUuidForReviewerId[];
|
|
552
|
+
'reviewers': (TypedUuidForReviewerId)[];
|
|
536
553
|
};
|
|
537
554
|
/**
|
|
538
555
|
* Failures that can occur when assigning a reviewer
|
|
539
556
|
*/
|
|
540
|
-
type ReviewAssignmentCreationError =
|
|
557
|
+
type ReviewAssignmentCreationError = (
|
|
558
|
+
/** A requested object resource already exist */
|
|
559
|
+
'Conflict'
|
|
541
560
|
/** A requested object resource does not exist */
|
|
542
|
-
'DoesNotExist'
|
|
561
|
+
| 'DoesNotExist'
|
|
543
562
|
/** Caller does not have access to a require object resource */
|
|
544
563
|
| 'Forbidden'
|
|
545
564
|
/** Internal server error */
|
|
546
|
-
| 'Internal';
|
|
565
|
+
| 'Internal');
|
|
547
566
|
type TypedUuidForReviewAssignmentId = string;
|
|
548
567
|
type ReviewAssignmentState = 'pending' | 'complete';
|
|
549
568
|
type ReviewAssignment = {
|
|
550
569
|
'applicationId': TypedUuidForApplicationId;
|
|
551
570
|
'createdAt': Date;
|
|
552
|
-
'deletedAt'?: Date;
|
|
571
|
+
'deletedAt'?: Date | null;
|
|
553
572
|
'id': TypedUuidForReviewAssignmentId;
|
|
554
573
|
'reviewerId': TypedUuidForReviewerId;
|
|
555
574
|
'state': ReviewAssignmentState;
|
|
@@ -577,30 +596,41 @@ type CreatedApplication = {
|
|
|
577
596
|
};
|
|
578
597
|
type Department = {
|
|
579
598
|
'createdAt': Date;
|
|
580
|
-
'deletedAt'?: Date;
|
|
599
|
+
'deletedAt'?: Date | null;
|
|
581
600
|
'id': TypedUuidForDepartmentId;
|
|
582
601
|
'name': string;
|
|
583
602
|
'updatedAt': Date;
|
|
584
603
|
};
|
|
585
604
|
type DocumentUploadUrlResponse = {
|
|
586
|
-
'externalId'?: string;
|
|
605
|
+
'externalId'?: string | null;
|
|
587
606
|
'url': string;
|
|
588
607
|
};
|
|
589
608
|
type EmailApplicantBody = {
|
|
590
609
|
'from': string;
|
|
591
|
-
'html'?: string;
|
|
610
|
+
'html'?: string | null;
|
|
592
611
|
'subject': string;
|
|
593
612
|
'text': string;
|
|
594
613
|
};
|
|
614
|
+
type EmployeeState = 'onboarding' | 'onboarded' | 'offboarding' | 'offboarded' | {
|
|
615
|
+
'newHire': string;
|
|
616
|
+
};
|
|
617
|
+
type Employee = {
|
|
618
|
+
'apiUserId': TypedUuidForUserId;
|
|
619
|
+
'createdAt': Date;
|
|
620
|
+
'deletedAt'?: Date | null;
|
|
621
|
+
'id': TypedUuidForEmployeeId;
|
|
622
|
+
'state': EmployeeState;
|
|
623
|
+
'updatedAt': Date;
|
|
624
|
+
};
|
|
595
625
|
type GetUserResponse_for_TurnstilePermission = {
|
|
596
626
|
'info': ApiUser_for_TurnstilePermission;
|
|
597
|
-
'providers': ApiUserProvider[];
|
|
627
|
+
'providers': (ApiUserProvider)[];
|
|
598
628
|
};
|
|
599
629
|
type InitialApiKeyResponse_for_TurnstilePermission = {
|
|
600
630
|
'createdAt': Date;
|
|
601
631
|
'id': TypedUuidForApiKeyId;
|
|
602
632
|
'key': SecretString;
|
|
603
|
-
'permissions'?: Permissions_for_TurnstilePermission;
|
|
633
|
+
'permissions'?: Permissions_for_TurnstilePermission | null;
|
|
604
634
|
};
|
|
605
635
|
type TypedUuidForMagicLinkSecretId = string;
|
|
606
636
|
type InitialMagicLinkSecretResponse = {
|
|
@@ -617,21 +647,21 @@ type InitialOAuthClientSecretResponse = {
|
|
|
617
647
|
type TypedUuidForInterviewAttendeeId = string;
|
|
618
648
|
type InterviewAttendee = {
|
|
619
649
|
'createdAt': Date;
|
|
620
|
-
'deletedAt'?: Date;
|
|
650
|
+
'deletedAt'?: Date | null;
|
|
621
651
|
'id': TypedUuidForInterviewAttendeeId;
|
|
622
652
|
'interviewId': TypedUuidForInterviewId;
|
|
623
653
|
'interviewerDisplayName': string;
|
|
624
654
|
'interviewerEmail': string;
|
|
625
|
-
'interviewerId'?: TypedUuidForInterviewerId;
|
|
655
|
+
'interviewerId'?: TypedUuidForInterviewerId | null;
|
|
626
656
|
'updatedAt': Date;
|
|
627
657
|
};
|
|
628
658
|
type Interview = {
|
|
629
659
|
'applicantId': TypedUuidForApplicantId;
|
|
630
660
|
'applicationId': TypedUuidForApplicationId;
|
|
631
|
-
'attendees': InterviewAttendee[];
|
|
661
|
+
'attendees': (InterviewAttendee)[];
|
|
632
662
|
'calendarSource': string;
|
|
633
663
|
'createdAt': Date;
|
|
634
|
-
'deletedAt'?: Date;
|
|
664
|
+
'deletedAt'?: Date | null;
|
|
635
665
|
'endTime': Date;
|
|
636
666
|
'externalId': string;
|
|
637
667
|
'id': TypedUuidForInterviewId;
|
|
@@ -641,7 +671,7 @@ type Interview = {
|
|
|
641
671
|
type Interviewer = {
|
|
642
672
|
'apiUserId': TypedUuidForUserId;
|
|
643
673
|
'createdAt': Date;
|
|
644
|
-
'deletedAt'?: Date;
|
|
674
|
+
'deletedAt'?: Date | null;
|
|
645
675
|
'id': TypedUuidForInterviewerId;
|
|
646
676
|
'updatedAt': Date;
|
|
647
677
|
};
|
|
@@ -653,11 +683,11 @@ type Jwk = {
|
|
|
653
683
|
'use': string;
|
|
654
684
|
};
|
|
655
685
|
type Jwks = {
|
|
656
|
-
'keys': Jwk[];
|
|
686
|
+
'keys': (Jwk)[];
|
|
657
687
|
};
|
|
658
688
|
type Listing = {
|
|
659
689
|
'createdAt': Date;
|
|
660
|
-
'deletedAt'?: Date;
|
|
690
|
+
'deletedAt'?: Date | null;
|
|
661
691
|
'id': TypedUuidForListingId;
|
|
662
692
|
'name': string;
|
|
663
693
|
'roleId': TypedUuidForRoleId;
|
|
@@ -668,7 +698,7 @@ type TypedUuidForListingPoolId = string;
|
|
|
668
698
|
type ListingPool = {
|
|
669
699
|
'association': ListingPoolAssociation;
|
|
670
700
|
'createdAt': Date;
|
|
671
|
-
'deletedAt'?: Date;
|
|
701
|
+
'deletedAt'?: Date | null;
|
|
672
702
|
'id': TypedUuidForListingPoolId;
|
|
673
703
|
'listingId': TypedUuidForListingId;
|
|
674
704
|
'poolId': TypedUuidForPoolId;
|
|
@@ -677,24 +707,24 @@ type ListingPool = {
|
|
|
677
707
|
type TypedUuidForMagicLinkRedirectUriId = string;
|
|
678
708
|
type MagicLinkRedirectUri = {
|
|
679
709
|
'createdAt': Date;
|
|
680
|
-
'deletedAt'?: Date;
|
|
710
|
+
'deletedAt'?: Date | null;
|
|
681
711
|
'id': TypedUuidForMagicLinkRedirectUriId;
|
|
682
712
|
'magicLinkClientId': TypedUuidForMagicLinkId;
|
|
683
713
|
'redirectUri': string;
|
|
684
714
|
};
|
|
685
715
|
type MagicLinkSecret = {
|
|
686
716
|
'createdAt': Date;
|
|
687
|
-
'deletedAt'?: Date;
|
|
717
|
+
'deletedAt'?: Date | null;
|
|
688
718
|
'id': TypedUuidForMagicLinkSecretId;
|
|
689
719
|
'magicLinkClientId': TypedUuidForMagicLinkId;
|
|
690
720
|
'secretSignature': string;
|
|
691
721
|
};
|
|
692
722
|
type MagicLink = {
|
|
693
723
|
'createdAt': Date;
|
|
694
|
-
'deletedAt'?: Date;
|
|
724
|
+
'deletedAt'?: Date | null;
|
|
695
725
|
'id': TypedUuidForMagicLinkId;
|
|
696
|
-
'redirectUris': MagicLinkRedirectUri[];
|
|
697
|
-
'secrets': MagicLinkSecret[];
|
|
726
|
+
'redirectUris': (MagicLinkRedirectUri)[];
|
|
727
|
+
'secrets': (MagicLinkSecret)[];
|
|
698
728
|
};
|
|
699
729
|
type TypedUuidForMagicLinkAttemptId = string;
|
|
700
730
|
type MagicLinkExchangeRequest = {
|
|
@@ -713,29 +743,35 @@ type MagicLinkSendRequest = {
|
|
|
713
743
|
'medium': MagicLinkMedium;
|
|
714
744
|
'recipient': string;
|
|
715
745
|
'redirectUri': string;
|
|
716
|
-
'scope'?: string;
|
|
746
|
+
'scope'?: string | null;
|
|
717
747
|
'secret': string;
|
|
718
748
|
};
|
|
719
749
|
type MagicLinkSendResponse = {
|
|
720
750
|
'attemptId': TypedUuidForMagicLinkAttemptId;
|
|
721
751
|
};
|
|
722
752
|
type Mapper = {
|
|
723
|
-
'activations'?: number;
|
|
753
|
+
'activations'?: number | null;
|
|
724
754
|
'createdAt': Date;
|
|
725
|
-
'deletedAt'?: Date;
|
|
726
|
-
'depletedAt'?: Date;
|
|
755
|
+
'deletedAt'?: Date | null;
|
|
756
|
+
'depletedAt'?: Date | null;
|
|
727
757
|
'id': TypedUuidForMapperId;
|
|
728
|
-
'maxActivations'?: number;
|
|
758
|
+
'maxActivations'?: number | null;
|
|
729
759
|
'name': string;
|
|
730
760
|
'rule': Record<string, unknown>;
|
|
731
761
|
'updatedAt': Date;
|
|
732
762
|
};
|
|
763
|
+
type Provider = 'google';
|
|
764
|
+
type NewHireBody = {
|
|
765
|
+
'applicationId': TypedUuidForApplicationId;
|
|
766
|
+
'provider': Provider;
|
|
767
|
+
'providerId': string;
|
|
768
|
+
};
|
|
733
769
|
type NotificationMedium = 'Email';
|
|
734
770
|
type NotificationStatus = 'Failed' | 'Pending' | 'Scheduled' | 'Sent';
|
|
735
771
|
type TypedUuidForNotificationId = string;
|
|
736
772
|
type RenderedEmail = {
|
|
737
773
|
'from': string;
|
|
738
|
-
'html'?: string;
|
|
774
|
+
'html'?: string | null;
|
|
739
775
|
'name': string;
|
|
740
776
|
'subject': string;
|
|
741
777
|
'text': string;
|
|
@@ -749,21 +785,21 @@ type RecipientId = {
|
|
|
749
785
|
};
|
|
750
786
|
type Notification_for_RenderedEmail = {
|
|
751
787
|
'createdAt': Date;
|
|
752
|
-
'deletedAt'?: Date;
|
|
788
|
+
'deletedAt'?: Date | null;
|
|
753
789
|
'id': TypedUuidForNotificationId;
|
|
754
790
|
'kind': string;
|
|
755
791
|
'medium': NotificationMedium;
|
|
756
|
-
'message'?: RenderedEmail;
|
|
792
|
+
'message'?: RenderedEmail | null;
|
|
757
793
|
'recipient': RecipientId;
|
|
758
794
|
'status': NotificationStatus;
|
|
759
795
|
'updatedAt': Date;
|
|
760
796
|
};
|
|
761
797
|
type OAuthAuthzCodeExchangeBody = {
|
|
762
|
-
'clientId'?: TypedUuidForOAuthClientId;
|
|
763
|
-
'clientSecret'?: SecretString;
|
|
798
|
+
'clientId'?: TypedUuidForOAuthClientId | null;
|
|
799
|
+
'clientSecret'?: SecretString | null;
|
|
764
800
|
'code': string;
|
|
765
801
|
'grantType': string;
|
|
766
|
-
'pkceVerifier'?: string;
|
|
802
|
+
'pkceVerifier'?: string | null;
|
|
767
803
|
'redirectUri': string;
|
|
768
804
|
};
|
|
769
805
|
type OAuthAuthzCodeExchangeResponse = {
|
|
@@ -774,24 +810,24 @@ type OAuthAuthzCodeExchangeResponse = {
|
|
|
774
810
|
type TypedUuidForOAuthRedirectUriId = string;
|
|
775
811
|
type OAuthClientRedirectUri = {
|
|
776
812
|
'createdAt': Date;
|
|
777
|
-
'deletedAt'?: Date;
|
|
813
|
+
'deletedAt'?: Date | null;
|
|
778
814
|
'id': TypedUuidForOAuthRedirectUriId;
|
|
779
815
|
'oauthClientId': TypedUuidForOAuthClientId;
|
|
780
816
|
'redirectUri': string;
|
|
781
817
|
};
|
|
782
818
|
type OAuthClientSecret = {
|
|
783
819
|
'createdAt': Date;
|
|
784
|
-
'deletedAt'?: Date;
|
|
820
|
+
'deletedAt'?: Date | null;
|
|
785
821
|
'id': TypedUuidForOAuthSecretId;
|
|
786
822
|
'oauthClientId': TypedUuidForOAuthClientId;
|
|
787
823
|
'secretSignature': string;
|
|
788
824
|
};
|
|
789
825
|
type OAuthClient = {
|
|
790
826
|
'createdAt': Date;
|
|
791
|
-
'deletedAt'?: Date;
|
|
827
|
+
'deletedAt'?: Date | null;
|
|
792
828
|
'id': TypedUuidForOAuthClientId;
|
|
793
|
-
'redirectUris': OAuthClientRedirectUri[];
|
|
794
|
-
'secrets': OAuthClientSecret[];
|
|
829
|
+
'redirectUris': (OAuthClientRedirectUri)[];
|
|
830
|
+
'secrets': (OAuthClientSecret)[];
|
|
795
831
|
};
|
|
796
832
|
type OAuthProviderName = 'github' | 'google';
|
|
797
833
|
type OAuthProviderInfo = {
|
|
@@ -799,9 +835,14 @@ type OAuthProviderInfo = {
|
|
|
799
835
|
'clientId': string;
|
|
800
836
|
'deviceCodeEndpoint': string;
|
|
801
837
|
'provider': OAuthProviderName;
|
|
802
|
-
'scopes': string[];
|
|
838
|
+
'scopes': (string)[];
|
|
803
839
|
'tokenEndpoint': string;
|
|
804
840
|
};
|
|
841
|
+
type OfferTransitionBody = {
|
|
842
|
+
/** An optional message to send to the applicant */
|
|
843
|
+
'message'?: EmailConfig | null;
|
|
844
|
+
'startDate': string;
|
|
845
|
+
};
|
|
805
846
|
type OpenIdConfiguration = {
|
|
806
847
|
'jwksUri': string;
|
|
807
848
|
};
|
|
@@ -811,7 +852,7 @@ type TypedUuidForOperationTaskId = string;
|
|
|
811
852
|
type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue = {
|
|
812
853
|
'body'?: Record<string, unknown>;
|
|
813
854
|
'createdAt': Date;
|
|
814
|
-
'deletedAt'?: Date;
|
|
855
|
+
'deletedAt'?: Date | null;
|
|
815
856
|
'id': TypedUuidForOperationTaskId;
|
|
816
857
|
'operationId': TypedUuidForOperationId;
|
|
817
858
|
'path'?: Record<string, unknown>;
|
|
@@ -823,7 +864,7 @@ type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue = {
|
|
|
823
864
|
type Operation_for_TurnstilePermission_and_String = {
|
|
824
865
|
'callerPermissions': Permissions_for_TurnstilePermission;
|
|
825
866
|
'createdAt': Date;
|
|
826
|
-
'deletedAt'?: Date;
|
|
867
|
+
'deletedAt'?: Date | null;
|
|
827
868
|
'endpoint': string;
|
|
828
869
|
'id': TypedUuidForOperationId;
|
|
829
870
|
'state': OperationState;
|
|
@@ -833,7 +874,7 @@ type TransitionApplicationToDeclinedBatchEndpoint = string;
|
|
|
833
874
|
type Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint = {
|
|
834
875
|
'callerPermissions': Permissions_for_TurnstilePermission;
|
|
835
876
|
'createdAt': Date;
|
|
836
|
-
'deletedAt'?: Date;
|
|
877
|
+
'deletedAt'?: Date | null;
|
|
837
878
|
'endpoint': TransitionApplicationToDeclinedBatchEndpoint;
|
|
838
879
|
'id': TypedUuidForOperationId;
|
|
839
880
|
'state': OperationState;
|
|
@@ -843,23 +884,24 @@ type TransitionApplicationToDeferredBatchEndpoint = string;
|
|
|
843
884
|
type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint = {
|
|
844
885
|
'callerPermissions': Permissions_for_TurnstilePermission;
|
|
845
886
|
'createdAt': Date;
|
|
846
|
-
'deletedAt'?: Date;
|
|
887
|
+
'deletedAt'?: Date | null;
|
|
847
888
|
'endpoint': TransitionApplicationToDeferredBatchEndpoint;
|
|
848
889
|
'id': TypedUuidForOperationId;
|
|
849
890
|
'state': OperationState;
|
|
850
891
|
'updatedAt': Date;
|
|
851
892
|
};
|
|
852
893
|
type OptionalTransitionBody = {
|
|
853
|
-
|
|
894
|
+
/** An optional message to send to the applicant */
|
|
895
|
+
'message'?: EmailConfig | null;
|
|
854
896
|
};
|
|
855
897
|
type Pool = {
|
|
856
898
|
'createdAt': Date;
|
|
857
|
-
'deletedAt'?: Date;
|
|
858
|
-
'description'?: string;
|
|
899
|
+
'deletedAt'?: Date | null;
|
|
900
|
+
'description'?: string | null;
|
|
859
901
|
'id': TypedUuidForPoolId;
|
|
860
|
-
'listings': ListingPool[];
|
|
902
|
+
'listings': (ListingPool)[];
|
|
861
903
|
'name': string;
|
|
862
|
-
'reviewers': TypedUuidForReviewerId[];
|
|
904
|
+
'reviewers': (TypedUuidForReviewerId)[];
|
|
863
905
|
'updatedAt': Date;
|
|
864
906
|
};
|
|
865
907
|
type RegisterApplicant = {
|
|
@@ -869,33 +911,33 @@ type Review = {
|
|
|
869
911
|
'applicationId': TypedUuidForApplicationId;
|
|
870
912
|
'content': string;
|
|
871
913
|
'createdAt': Date;
|
|
872
|
-
'deletedAt'?: Date;
|
|
914
|
+
'deletedAt'?: Date | null;
|
|
873
915
|
'id': TypedUuidForReviewId;
|
|
874
916
|
'reviewerId': TypedUuidForReviewerId;
|
|
875
917
|
'score': ReviewScore;
|
|
876
918
|
'updatedAt': Date;
|
|
877
919
|
'valueReflected': string;
|
|
878
920
|
'valueViolated': string;
|
|
879
|
-
'valuesInTension': string[];
|
|
921
|
+
'valuesInTension': (string)[];
|
|
880
922
|
};
|
|
881
923
|
type Reviewer = {
|
|
882
924
|
'apiUserId': TypedUuidForUserId;
|
|
883
925
|
'createdAt': Date;
|
|
884
|
-
'deletedAt'?: Date;
|
|
926
|
+
'deletedAt'?: Date | null;
|
|
885
927
|
'id': TypedUuidForReviewerId;
|
|
886
928
|
'updatedAt': Date;
|
|
887
929
|
};
|
|
888
930
|
type ReviewerInfo = {
|
|
889
931
|
'reviewer': Reviewer;
|
|
890
|
-
'user'?: ApiUserInfo_for_TurnstilePermission;
|
|
932
|
+
'user'?: ApiUserInfo_for_TurnstilePermission | null;
|
|
891
933
|
};
|
|
892
934
|
type ReviewInfo = {
|
|
893
935
|
'review': Review;
|
|
894
|
-
'reviewer'?: ReviewerInfo;
|
|
936
|
+
'reviewer'?: ReviewerInfo | null;
|
|
895
937
|
};
|
|
896
938
|
type Role = {
|
|
897
939
|
'createdAt': Date;
|
|
898
|
-
'deletedAt'?: Date;
|
|
940
|
+
'deletedAt'?: Date | null;
|
|
899
941
|
'departmentId': TypedUuidForDepartmentId;
|
|
900
942
|
'id': TypedUuidForRoleId;
|
|
901
943
|
'name': string;
|
|
@@ -914,12 +956,12 @@ type UpdateApplicantContact = {
|
|
|
914
956
|
};
|
|
915
957
|
type UpdateDocument = {
|
|
916
958
|
'kind': DocumentKind;
|
|
917
|
-
'mime'?: string;
|
|
959
|
+
'mime'?: string | null;
|
|
918
960
|
'source': DocumentSource;
|
|
919
|
-
'status'?: string;
|
|
961
|
+
'status'?: string | null;
|
|
920
962
|
};
|
|
921
963
|
type UpdateDocumentStatus = {
|
|
922
|
-
'status'?: string;
|
|
964
|
+
'status'?: string | null;
|
|
923
965
|
};
|
|
924
966
|
type UpdateListing = {
|
|
925
967
|
'name': string;
|
|
@@ -930,7 +972,7 @@ type UpdateReview = {
|
|
|
930
972
|
'score': ReviewScore;
|
|
931
973
|
'valueReflected': string;
|
|
932
974
|
'valueViolated': string;
|
|
933
|
-
'valuesInTension': string[];
|
|
975
|
+
'valuesInTension': (string)[];
|
|
934
976
|
};
|
|
935
977
|
type ScalarApplicationState = 'declined' | 'deferred' | 'hired' | 'interviewing' | 'next_steps' | 'offer' | 'pending' | 'submitted' | 'triage' | 'withdrawn';
|
|
936
978
|
interface GetApiUserPathParams {
|
|
@@ -1007,6 +1049,9 @@ interface CreateDocumentUploadUrlPathParams {
|
|
|
1007
1049
|
interface GetApplicationInterviewCodePathParams {
|
|
1008
1050
|
application: TypedUuidForApplicationId;
|
|
1009
1051
|
}
|
|
1052
|
+
interface NotifyApplicationReviewAssignmentsPathParams {
|
|
1053
|
+
application: TypedUuidForApplicationId;
|
|
1054
|
+
}
|
|
1010
1055
|
interface SimulateReviewActionPathParams {
|
|
1011
1056
|
application: TypedUuidForApplicationId;
|
|
1012
1057
|
}
|
|
@@ -1107,16 +1152,16 @@ interface AuthzCodeRedirectQueryParams {
|
|
|
1107
1152
|
clientId: TypedUuidForOAuthClientId;
|
|
1108
1153
|
redirectUri: string;
|
|
1109
1154
|
responseType: string;
|
|
1110
|
-
scope?: string;
|
|
1155
|
+
scope?: string | null;
|
|
1111
1156
|
state: string;
|
|
1112
1157
|
}
|
|
1113
1158
|
interface AuthzCodeCallbackPathParams {
|
|
1114
1159
|
provider: OAuthProviderName;
|
|
1115
1160
|
}
|
|
1116
1161
|
interface AuthzCodeCallbackQueryParams {
|
|
1117
|
-
code?: string;
|
|
1118
|
-
error?: string;
|
|
1119
|
-
state?: string;
|
|
1162
|
+
code?: string | null;
|
|
1163
|
+
error?: string | null;
|
|
1164
|
+
state?: string | null;
|
|
1120
1165
|
}
|
|
1121
1166
|
interface AuthzCodeExchangePathParams {
|
|
1122
1167
|
provider: OAuthProviderName;
|
|
@@ -1145,7 +1190,7 @@ interface DeleteMagicLinkSecretPathParams {
|
|
|
1145
1190
|
secretId: TypedUuidForMagicLinkSecretId;
|
|
1146
1191
|
}
|
|
1147
1192
|
interface GetMappersQueryParams {
|
|
1148
|
-
includeDepleted?: boolean;
|
|
1193
|
+
includeDepleted?: boolean | null;
|
|
1149
1194
|
}
|
|
1150
1195
|
interface DeleteMapperPathParams {
|
|
1151
1196
|
mapperId: TypedUuidForMapperId;
|
|
@@ -1211,6 +1256,10 @@ declare class Api extends HttpClient {
|
|
|
1211
1256
|
methods: {
|
|
1212
1257
|
jwksJson: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Jwks>>;
|
|
1213
1258
|
openidConfiguration: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<OpenIdConfiguration>>;
|
|
1259
|
+
/**
|
|
1260
|
+
* List details for users
|
|
1261
|
+
*/
|
|
1262
|
+
listApiUsers: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<GetUserResponse_for_TurnstilePermission[]>>;
|
|
1214
1263
|
/**
|
|
1215
1264
|
* Create a new user
|
|
1216
1265
|
*/
|
|
@@ -1302,10 +1351,19 @@ declare class Api extends HttpClient {
|
|
|
1302
1351
|
path: UpdateApplicantContactPathParams;
|
|
1303
1352
|
body: UpdateApplicantContact;
|
|
1304
1353
|
}, params?: FetchParams) => Promise<ApiResult<ApplicantInfo>>;
|
|
1354
|
+
/**
|
|
1355
|
+
* View all applications
|
|
1356
|
+
*/
|
|
1305
1357
|
listApplications: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Application[]>>;
|
|
1358
|
+
/**
|
|
1359
|
+
* Create a new application
|
|
1360
|
+
*/
|
|
1306
1361
|
createApplication: ({ body, }: {
|
|
1307
1362
|
body: CreateApplication;
|
|
1308
1363
|
}, params?: FetchParams) => Promise<ApiResult<CreatedApplication>>;
|
|
1364
|
+
/**
|
|
1365
|
+
* View an application
|
|
1366
|
+
*/
|
|
1309
1367
|
viewApplication: ({ path, }: {
|
|
1310
1368
|
path: ViewApplicationPathParams;
|
|
1311
1369
|
}, params?: FetchParams) => Promise<ApiResult<Application>>;
|
|
@@ -1331,52 +1389,94 @@ declare class Api extends HttpClient {
|
|
|
1331
1389
|
viewApplicationBundle: ({ path, }: {
|
|
1332
1390
|
path: ViewApplicationBundlePathParams;
|
|
1333
1391
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationBundle>>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Attach an uploaded document to an application
|
|
1394
|
+
*/
|
|
1334
1395
|
attachDocument: ({ path, body, }: {
|
|
1335
1396
|
path: AttachDocumentPathParams;
|
|
1336
1397
|
body: AttachDocument;
|
|
1337
1398
|
}, params?: FetchParams) => Promise<ApiResult<Document>>;
|
|
1399
|
+
/**
|
|
1400
|
+
* Generate a pre-signed upload url for uploading a document to an application
|
|
1401
|
+
*/
|
|
1338
1402
|
createDocumentUploadUrl: ({ path, }: {
|
|
1339
1403
|
path: CreateDocumentUploadUrlPathParams;
|
|
1340
1404
|
}, params?: FetchParams) => Promise<ApiResult<DocumentUploadUrlResponse>>;
|
|
1405
|
+
/**
|
|
1406
|
+
* Retrieve the interview code associated with an application
|
|
1407
|
+
*/
|
|
1341
1408
|
getApplicationInterviewCode: ({ path, }: {
|
|
1342
1409
|
path: GetApplicationInterviewCodePathParams;
|
|
1343
1410
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationInterviewCode>>;
|
|
1411
|
+
/**
|
|
1412
|
+
* Send a notification to all pending reviewers
|
|
1413
|
+
*/
|
|
1414
|
+
notifyApplicationReviewAssignments: ({ path, }: {
|
|
1415
|
+
path: NotifyApplicationReviewAssignmentsPathParams;
|
|
1416
|
+
}, params?: FetchParams) => Promise<ApiResult<ReviewAssignment[]>>;
|
|
1344
1417
|
/**
|
|
1345
1418
|
* Simulate the selection of the next review action without performing any changes
|
|
1346
1419
|
*/
|
|
1347
1420
|
simulateReviewAction: ({ path, }: {
|
|
1348
1421
|
path: SimulateReviewActionPathParams;
|
|
1349
1422
|
}, params?: FetchParams) => Promise<ApiResult<PoolAction>>;
|
|
1423
|
+
/**
|
|
1424
|
+
* Submit an application that has all required documents attached
|
|
1425
|
+
*/
|
|
1350
1426
|
submitApplication: ({ path, }: {
|
|
1351
1427
|
path: SubmitApplicationPathParams;
|
|
1352
1428
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1429
|
+
/**
|
|
1430
|
+
* Move an application to the Declined stage
|
|
1431
|
+
*/
|
|
1353
1432
|
transitionApplicationToDeclined: ({ path, body, }: {
|
|
1354
1433
|
path: TransitionApplicationToDeclinedPathParams;
|
|
1355
1434
|
body: TransitionBody;
|
|
1356
1435
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1436
|
+
/**
|
|
1437
|
+
* Move an application to the Deferred stage
|
|
1438
|
+
*/
|
|
1357
1439
|
transitionApplicationToDeferred: ({ path, body, }: {
|
|
1358
1440
|
path: TransitionApplicationToDeferredPathParams;
|
|
1359
1441
|
body: TransitionBody;
|
|
1360
1442
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1443
|
+
/**
|
|
1444
|
+
* Move an application to the Interviewing stage
|
|
1445
|
+
*/
|
|
1361
1446
|
transitionApplicationToInterviewing: ({ path, body, }: {
|
|
1362
1447
|
path: TransitionApplicationToInterviewingPathParams;
|
|
1363
1448
|
body: OptionalTransitionBody;
|
|
1364
1449
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1450
|
+
/**
|
|
1451
|
+
* Move an application to the Next Steps stage
|
|
1452
|
+
*/
|
|
1365
1453
|
transitionApplicationToNextSteps: ({ path, body, }: {
|
|
1366
1454
|
path: TransitionApplicationToNextStepsPathParams;
|
|
1367
1455
|
body: OptionalTransitionBody;
|
|
1368
1456
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Move an application to the Offer stage
|
|
1459
|
+
*/
|
|
1369
1460
|
transitionApplicationToOffer: ({ path, body, }: {
|
|
1370
1461
|
path: TransitionApplicationToOfferPathParams;
|
|
1371
|
-
body:
|
|
1462
|
+
body: OfferTransitionBody;
|
|
1372
1463
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1464
|
+
/**
|
|
1465
|
+
* Move an application to the Withdrawn stage
|
|
1466
|
+
*/
|
|
1373
1467
|
transitionApplicationToWithdrawn: ({ path, body, }: {
|
|
1374
1468
|
path: TransitionApplicationToWithdrawnPathParams;
|
|
1375
1469
|
body: OptionalTransitionBody;
|
|
1376
1470
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationStateRecord>>;
|
|
1471
|
+
/**
|
|
1472
|
+
* List all application summaries
|
|
1473
|
+
*/
|
|
1377
1474
|
listApplicationSummaries: ({ query, }: {
|
|
1378
1475
|
query?: ListApplicationSummariesQueryParams;
|
|
1379
1476
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationSummariesResponse>>;
|
|
1477
|
+
/**
|
|
1478
|
+
* View a summary that includes an application and the related evaluations
|
|
1479
|
+
*/
|
|
1380
1480
|
viewApplicationSummary: ({ path, }: {
|
|
1381
1481
|
path: ViewApplicationSummaryPathParams;
|
|
1382
1482
|
}, params?: FetchParams) => Promise<ApiResult<ApplicationSummaryResponse>>;
|
|
@@ -1440,6 +1540,12 @@ declare class Api extends HttpClient {
|
|
|
1440
1540
|
path: UpdateDocumentStatusPathParams;
|
|
1441
1541
|
body: UpdateDocumentStatus;
|
|
1442
1542
|
}, params?: FetchParams) => Promise<ApiResult<Document>>;
|
|
1543
|
+
/**
|
|
1544
|
+
* Hire a new employee
|
|
1545
|
+
*/
|
|
1546
|
+
newHire: ({ body, }: {
|
|
1547
|
+
body: NewHireBody;
|
|
1548
|
+
}, params?: FetchParams) => Promise<ApiResult<Employee>>;
|
|
1443
1549
|
/**
|
|
1444
1550
|
* List all groups
|
|
1445
1551
|
*/
|
|
@@ -1633,21 +1739,39 @@ declare class Api extends HttpClient {
|
|
|
1633
1739
|
deleteOauthClientSecret: ({ path, }: {
|
|
1634
1740
|
path: DeleteOauthClientSecretPathParams;
|
|
1635
1741
|
}, params?: FetchParams) => Promise<ApiResult<OAuthClientSecret>>;
|
|
1742
|
+
/**
|
|
1743
|
+
* List reviewer pools and their associations
|
|
1744
|
+
*/
|
|
1636
1745
|
listPools: (_: EmptyObj, params?: FetchParams) => Promise<ApiResult<Pool[]>>;
|
|
1746
|
+
/**
|
|
1747
|
+
* Create a new pool
|
|
1748
|
+
*/
|
|
1637
1749
|
createPool: ({ body, }: {
|
|
1638
1750
|
body: CreatePool;
|
|
1639
1751
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1752
|
+
/**
|
|
1753
|
+
* View a pool and its associations
|
|
1754
|
+
*/
|
|
1640
1755
|
viewPool: ({ path, }: {
|
|
1641
1756
|
path: ViewPoolPathParams;
|
|
1642
1757
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1758
|
+
/**
|
|
1759
|
+
* Update a pool
|
|
1760
|
+
*/
|
|
1643
1761
|
updatePool: ({ path, body, }: {
|
|
1644
1762
|
path: UpdatePoolPathParams;
|
|
1645
1763
|
body: CreatePool;
|
|
1646
1764
|
}, params?: FetchParams) => Promise<ApiResult<Pool>>;
|
|
1765
|
+
/**
|
|
1766
|
+
* Assign a pool to a listing
|
|
1767
|
+
*/
|
|
1647
1768
|
assignPool: ({ path, body, }: {
|
|
1648
1769
|
path: AssignPoolPathParams;
|
|
1649
1770
|
body: AssignPool;
|
|
1650
|
-
}, params?: FetchParams) => Promise<ApiResult<
|
|
1771
|
+
}, params?: FetchParams) => Promise<ApiResult<ListingPool>>;
|
|
1772
|
+
/**
|
|
1773
|
+
* Unassign a pool from a listing
|
|
1774
|
+
*/
|
|
1651
1775
|
unassignPool: ({ path, }: {
|
|
1652
1776
|
path: UnassignPoolPathParams;
|
|
1653
1777
|
}, params?: FetchParams) => Promise<ApiResult<void>>;
|
|
@@ -1687,4 +1811,4 @@ declare class Api extends HttpClient {
|
|
|
1687
1811
|
ws: {};
|
|
1688
1812
|
}
|
|
1689
1813
|
|
|
1690
|
-
export { type OfferState as $, type ApiConfig as A, type AddGroupBody as B, type AddMagicLinkRedirectBody as C, type DocumentParent as D, type AddOAuthClientRedirectBody as E, type FullParams as F, type ApiKeyCreateParams_for_TurnstilePermission as G, type ApiKeyResponse_for_TurnstilePermission as H, type TypedUuidForUserProviderId as I, type ApiUserContactEmail as J, type ApiUserEmailUpdateParams as K, type ApiUserProvider as L, type ApiUser_for_TurnstilePermission as M, type ApiUserInfo_for_TurnstilePermission as N, type ApiUserLinkRequestPayload as O, type Permissions_for_TurnstilePermission as P, type ApiUserLinkRequestResponse as Q, type ApiUserProviderLinkPayload as R, type SecretString as S, type TypedUuidForApplicantId as T, type ApiUserUpdateParams_for_TurnstilePermission as U, type Applicant as V, type TypedUuidForApplicantContactId as W, type ApplicantContactField as X, type ApplicantContact as Y, type ApplicantInfo as Z, type InterviewingState as _, Api as a, type
|
|
1814
|
+
export { type OfferState as $, type ApiConfig as A, type AddGroupBody as B, type AddMagicLinkRedirectBody as C, type DocumentParent as D, type AddOAuthClientRedirectBody as E, type FullParams as F, type ApiKeyCreateParams_for_TurnstilePermission as G, type ApiKeyResponse_for_TurnstilePermission as H, type TypedUuidForUserProviderId as I, type ApiUserContactEmail as J, type ApiUserEmailUpdateParams as K, type ApiUserProvider as L, type ApiUser_for_TurnstilePermission as M, type ApiUserInfo_for_TurnstilePermission as N, type ApiUserLinkRequestPayload as O, type Permissions_for_TurnstilePermission as P, type ApiUserLinkRequestResponse as Q, type ApiUserProviderLinkPayload as R, type SecretString as S, type TypedUuidForApplicantId as T, type ApiUserUpdateParams_for_TurnstilePermission as U, type Applicant as V, type TypedUuidForApplicantContactId as W, type ApplicantContactField as X, type ApplicantContact as Y, type ApplicantInfo as Z, type InterviewingState as _, Api as a, type ListingPool as a$, type ApplicationState as a0, type Application as a1, type DocumentKind as a2, type DocumentSource as a3, type Document as a4, type ApplicationBundle as a5, type TypedUuidForApplicationInterviewCodeId as a6, type ApplicationInterviewCode as a7, type TypedUuidForApplicationStateRecordId as a8, type ApplicationStateRecord as a9, type ReviewAssignmentCreationError as aA, type TypedUuidForReviewAssignmentId as aB, type ReviewAssignmentState as aC, type ReviewAssignment as aD, type CreatedAssignment as aE, type CreateReviewAssignmentsResponse as aF, type CreateRole as aG, type CreatedApplication as aH, type Department as aI, type DocumentUploadUrlResponse as aJ, type EmailApplicantBody as aK, type EmployeeState as aL, type Employee as aM, type GetUserResponse_for_TurnstilePermission as aN, type InitialApiKeyResponse_for_TurnstilePermission as aO, type TypedUuidForMagicLinkSecretId as aP, type InitialMagicLinkSecretResponse as aQ, type TypedUuidForOAuthSecretId as aR, type InitialOAuthClientSecretResponse as aS, type TypedUuidForInterviewAttendeeId as aT, type InterviewAttendee as aU, type Interview as aV, type Interviewer as aW, type Jwk as aX, type Jwks as aY, type Listing as aZ, type TypedUuidForListingPoolId as a_, type ListingPoolAssociation as aa, type TriageReason as ab, type PoolAction as ac, type ReviewScore as ad, type Reviews as ae, type ExpandedApplicationSummary as af, type Evaluator as ag, type ApplicationSummariesResponse as ah, type ApplicationSummaryResponse as ai, type AssignPool as aj, type AttachDocument as ak, type EmailConfig as al, type TransitionMessage as am, type TransitionBody as an, type BatchParameter_for_TransitionBody as ao, type ViewApplication as ap, type BatchParameter_for_ViewApplication as aq, type CreateApplication as ar, type CreateDepartment as as, type CreateDocument as at, type RoleListingStatus as au, type CreateListing as av, type CreateMapper as aw, type CreatePool as ax, type CreateReview as ay, type CreateReviewAssignments as az, type ApiResult as b, type DeleteApiUserTokenPathParams as b$, type TypedUuidForMagicLinkRedirectUriId as b0, type MagicLinkRedirectUri as b1, type MagicLinkSecret as b2, type MagicLink as b3, type TypedUuidForMagicLinkAttemptId as b4, type MagicLinkExchangeRequest as b5, type MagicLinkExchangeResponse as b6, type MagicLinkMedium as b7, type MagicLinkSendRequest as b8, type MagicLinkSendResponse as b9, type TransitionApplicationToDeferredBatchEndpoint as bA, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeferredBatchEndpoint as bB, type OptionalTransitionBody as bC, type Pool as bD, type RegisterApplicant as bE, type Review as bF, type Reviewer as bG, type ReviewerInfo as bH, type ReviewInfo as bI, type Role as bJ, type TransitionApplicationToDeclinedBatch as bK, type TransitionApplicationToDeferredBatch as bL, type UpdateApplicantContact as bM, type UpdateDocument as bN, type UpdateDocumentStatus as bO, type UpdateListing as bP, type UpdateReview as bQ, type ScalarApplicationState as bR, type GetApiUserPathParams as bS, type UpdateApiUserPathParams as bT, type SetApiUserContactEmailPathParams as bU, type AddApiUserToGroupPathParams as bV, type RemoveApiUserFromGroupPathParams as bW, type LinkProviderPathParams as bX, type ListApiUserTokensPathParams as bY, type CreateApiUserTokenPathParams as bZ, type GetApiUserTokenPathParams as b_, type Mapper as ba, type Provider as bb, type NewHireBody as bc, type NotificationMedium as bd, type NotificationStatus as be, type TypedUuidForNotificationId as bf, type RenderedEmail as bg, type RecipientId as bh, type Notification_for_RenderedEmail as bi, type OAuthAuthzCodeExchangeBody as bj, type OAuthAuthzCodeExchangeResponse as bk, type TypedUuidForOAuthRedirectUriId as bl, type OAuthClientRedirectUri as bm, type OAuthClientSecret as bn, type OAuthClient as bo, type OAuthProviderName as bp, type OAuthProviderInfo as bq, type OfferTransitionBody as br, type OpenIdConfiguration as bs, type OperationState as bt, type OperationTaskState as bu, type TypedUuidForOperationTaskId as bv, type OperationTask_for_AnyValue_and_AnyValue_and_AnyValue_and_AnyValue as bw, type Operation_for_TurnstilePermission_and_String as bx, type TransitionApplicationToDeclinedBatchEndpoint as by, type Operation_for_TurnstilePermission_and_TransitionApplicationToDeclinedBatchEndpoint as bz, type TypedUuidForUserId as c, type ViewPoolPathParams as c$, type CreateLinkTokenPathParams as c0, type ListApplicantsQueryParams as c1, type ViewApplicantPathParams as c2, type UpdateApplicantContactPathParams as c3, type ViewApplicationPathParams as c4, type ApplyReviewActionPathParams as c5, type ListApplicationReviewAssignmentsPathParams as c6, type CreateApplicationReviewAssignmentsPathParams as c7, type ViewApplicationBundlePathParams as c8, type AttachDocumentPathParams as c9, type ListInterviewersQueryParams as cA, type ViewListingPathParams as cB, type UpdateListingPathParams as cC, type UpdateListingStatePathParams as cD, type MagicLinkExchangePathParams as cE, type MagicLinkSendPathParams as cF, type AuthzCodeRedirectPathParams as cG, type AuthzCodeRedirectQueryParams as cH, type AuthzCodeCallbackPathParams as cI, type AuthzCodeCallbackQueryParams as cJ, type AuthzCodeExchangePathParams as cK, type GetDeviceProviderPathParams as cL, type ExchangeDeviceTokenPathParams as cM, type GetMagicLinkPathParams as cN, type CreateMagicLinkRedirectUriPathParams as cO, type DeleteMagicLinkRedirectUriPathParams as cP, type CreateMagicLinkSecretPathParams as cQ, type DeleteMagicLinkSecretPathParams as cR, type GetMappersQueryParams as cS, type DeleteMapperPathParams as cT, type ListNotificationsQueryParams as cU, type EmailApplicantPathParams as cV, type GetOauthClientPathParams as cW, type CreateOauthClientRedirectUriPathParams as cX, type DeleteOauthClientRedirectUriPathParams as cY, type CreateOauthClientSecretPathParams as cZ, type DeleteOauthClientSecretPathParams as c_, type CreateDocumentUploadUrlPathParams as ca, type GetApplicationInterviewCodePathParams as cb, type NotifyApplicationReviewAssignmentsPathParams as cc, type SimulateReviewActionPathParams as cd, type SubmitApplicationPathParams as ce, type TransitionApplicationToDeclinedPathParams as cf, type TransitionApplicationToDeferredPathParams as cg, type TransitionApplicationToInterviewingPathParams as ch, type TransitionApplicationToNextStepsPathParams as ci, type TransitionApplicationToOfferPathParams as cj, type TransitionApplicationToWithdrawnPathParams as ck, type ListApplicationSummariesQueryParams as cl, type ViewApplicationSummaryPathParams as cm, type ListOperationsQueryParams as cn, type GetOperationPathParams as co, type ListOperationTasksQueryParams as cp, type ViewDepartmentPathParams as cq, type ListDocumentsQueryParams as cr, type ViewDocumentPathParams as cs, type UpdateDocumentPathParams as ct, type DeleteDocumentPathParams as cu, type ViewDocumentDataPathParams as cv, type UpdateDocumentStatusPathParams as cw, type UpdateGroupPathParams as cx, type DeleteGroupPathParams as cy, type ListInterviewsQueryParams as cz, type TypedUuidForApplicationId as d, type UpdatePoolPathParams as d0, type AssignPoolPathParams as d1, type UnassignPoolPathParams as d2, type ListReviewsQueryParams as d3, type ViewReviewPathParams as d4, type UpdateReviewPathParams as d5, type DeleteReviewPathParams as d6, type ListReviewersQueryParams as d7, type ViewRolePathParams as d8, type ErrorBody as d9, type ErrorResult as da, type TypedUuidForDocumentId as e, type TypedUuidForEmployeeId as f, type TypedUuidForOnboardingId as g, type TypedUuidForDepartmentId as h, type TypedUuidForRoleId as i, type TypedUuidForListingId as j, type TypedUuidForPoolId as k, type TypedUuidForReviewerId as l, type TypedUuidForReviewId as m, type TypedUuidForInterviewerId as n, type TypedUuidForInterviewId as o, type TypedUuidForBackgroundCheckId as p, type TypedUuidForOperationId as q, type TypedUuidForApiKeyId as r, type TypedUuidForAccessGroupId as s, type TypedUuidForMapperId as t, type TypedUuidForOAuthClientId as u, type TypedUuidForMagicLinkId as v, type TurnstilePermission as w, type AccessGroupUpdateParams_for_TurnstilePermission as x, type AccessGroup_for_TurnstilePermission as y, type AccessTokenExchangeRequest as z };
|