/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AttemptSchema, AttemptsSchema, CreateAttemptRequestBody, GuestAttemptSchema, StartGuestAttemptRequestBody, UpdateAttemptRequestBody, UpdateGuestAttemptRequestBody, UploadGuestAttemptFileRequestBody, UploadGuestAttemptFileResponseSchema } from '../models/index'; export interface AttemptOptionsRequest { attemptId: string; } export interface CreateAttemptRequest { createAttemptRequestBody: CreateAttemptRequestBody; } export interface DeleteAttemptRequest { attemptId: string; permanentDelete?: DeleteAttemptPermanentDeleteEnum; } export interface GuestAttemptOptionsRequest { attemptId: string; } export interface ListAttemptsRequest { filterStatus?: ListAttemptsFilterStatusEnum; filterAssessmentId?: string; filterCandidateId?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ReevaluateAttemptRequest { attemptId: string; } export interface ReevaluateAttemptOptionsRequest { attemptId: string; } export interface ShowAttemptRequest { attemptId: string; include?: string; } export interface ShowGuestAttemptRequest { attemptId: string; tenantId: string; token: string; include?: string; } export interface StartGuestAttemptRequest { startGuestAttemptRequestBody: StartGuestAttemptRequestBody; } export interface UpdateAttemptRequest { attemptId: string; updateAttemptRequestBody: UpdateAttemptRequestBody; } export interface UpdateGuestAttemptRequest { attemptId: string; updateGuestAttemptRequestBody: UpdateGuestAttemptRequestBody; } export interface UploadGuestAttemptFileRequest { uploadGuestAttemptFileRequestBody: UploadGuestAttemptFileRequestBody; } /** * */ export declare class AttemptsApi extends runtime.BaseAPI { /** * Creates request options for attemptOptions without sending the request */ attemptOptionsRequestOpts(requestParameters: AttemptOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Attempt Options */ attemptOptionsRaw(requestParameters: AttemptOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Attempt Options */ attemptOptions(requestParameters: AttemptOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for attemptsOptions without sending the request */ attemptsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Attempts Options */ attemptsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Attempts Options */ attemptsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createAttempt without sending the request */ createAttemptRequestOpts(requestParameters: CreateAttemptRequest): Promise; /** * Assigns an assessment template to a candidate. Generates an access token (returned in meta.accessToken on the response) that the FE composes into a candidate link of shape `https://assess.{domain}/attempts/{attemptId}?token={hex}`. Required relationships: assessment (FK), candidate. * Create Attempt */ createAttemptRaw(requestParameters: CreateAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Assigns an assessment template to a candidate. Generates an access token (returned in meta.accessToken on the response) that the FE composes into a candidate link of shape `https://assess.{domain}/attempts/{attemptId}?token={hex}`. Required relationships: assessment (FK), candidate. * Create Attempt */ createAttempt(requestParameters: CreateAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteAttempt without sending the request */ deleteAttemptRequestOpts(requestParameters: DeleteAttemptRequest): Promise; /** * Soft delete (status=anonymized + drops PII) by default. `?permanentDelete=true` for hard delete (GDPR right to erasure). Soft default keeps evaluation summary for analytics. * Delete Attempt */ deleteAttemptRaw(requestParameters: DeleteAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Soft delete (status=anonymized + drops PII) by default. `?permanentDelete=true` for hard delete (GDPR right to erasure). Soft default keeps evaluation summary for analytics. * Delete Attempt */ deleteAttempt(requestParameters: DeleteAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for guestAttemptOptions without sending the request */ guestAttemptOptionsRequestOpts(requestParameters: GuestAttemptOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Guest Attempt Options */ guestAttemptOptionsRaw(requestParameters: GuestAttemptOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Guest Attempt Options */ guestAttemptOptions(requestParameters: GuestAttemptOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for guestAttemptUploadOptions without sending the request */ guestAttemptUploadOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Guest Attempt Upload Options */ guestAttemptUploadOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Guest Attempt Upload Options */ guestAttemptUploadOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for guestAttemptsOptions without sending the request */ guestAttemptsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Guest Attempts Options */ guestAttemptsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Guest Attempts Options */ guestAttemptsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listAttempts without sending the request */ listAttemptsRequestOpts(requestParameters: ListAttemptsRequest): Promise; /** * List attempts. Most common queries: - `filterAssessmentId=` - all attempts of a template - `filterCandidateId=` - all attempts by a candidate - `filterStatus=evaluated` - completed evaluations * List Attempts */ listAttemptsRaw(requestParameters: ListAttemptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List attempts. Most common queries: - `filterAssessmentId=` - all attempts of a template - `filterCandidateId=` - all attempts by a candidate - `filterStatus=evaluated` - completed evaluations * List Attempts */ listAttempts(requestParameters?: ListAttemptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for reevaluateAttempt without sending the request */ reevaluateAttemptRequestOpts(requestParameters: ReevaluateAttemptRequest): Promise; /** * Re-runs the evaluation Step Function against the same answers (e.g. after the AI evaluator was upgraded). Resets evaluation.status=\'pending\' and emits ATTEMPT_REEVALUATION_REQUESTED. Action-style endpoint (POST + verb suffix) because this triggers work, not just a state mutation. * Reevaluate Attempt */ reevaluateAttemptRaw(requestParameters: ReevaluateAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Re-runs the evaluation Step Function against the same answers (e.g. after the AI evaluator was upgraded). Resets evaluation.status=\'pending\' and emits ATTEMPT_REEVALUATION_REQUESTED. Action-style endpoint (POST + verb suffix) because this triggers work, not just a state mutation. * Reevaluate Attempt */ reevaluateAttempt(requestParameters: ReevaluateAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for reevaluateAttemptOptions without sending the request */ reevaluateAttemptOptionsRequestOpts(requestParameters: ReevaluateAttemptOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Reevaluate Options */ reevaluateAttemptOptionsRaw(requestParameters: ReevaluateAttemptOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Reevaluate Options */ reevaluateAttemptOptions(requestParameters: ReevaluateAttemptOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showAttempt without sending the request */ showAttemptRequestOpts(requestParameters: ShowAttemptRequest): Promise; /** * Returns full attempt details including evaluation block (recruiter view). Use `?include=files` (JSON:API standard) to sideload the attempt\'s `relationships.files` FileResources in the `included[]` array of the response. Single round-trip for review pages that need preview data per uploaded answer file. * Show Attempt */ showAttemptRaw(requestParameters: ShowAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns full attempt details including evaluation block (recruiter view). Use `?include=files` (JSON:API standard) to sideload the attempt\'s `relationships.files` FileResources in the `included[]` array of the response. Single round-trip for review pages that need preview data per uploaded answer file. * Show Attempt */ showAttempt(requestParameters: ShowAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showGuestAttempt without sending the request */ showGuestAttemptRequestOpts(requestParameters: ShowGuestAttemptRequest): Promise; /** * Read-only fetch. tenantId + token via query string. Returns attempt + filtered template (no answer keys). Returns 404 on token mismatch (intentionally - we don\'t leak whether a given attempt exists). Use `?include=files` (JSON:API standard) to sideload the attempt\'s `relationships.files` FileResources in `included[]`. Lets the candidate UI render thumbnails of their own uploads without a second round-trip. Returned FileResources are filtered for guest-safe fields (no internal status / audit). * Show Guest Attempt */ showGuestAttemptRaw(requestParameters: ShowGuestAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Read-only fetch. tenantId + token via query string. Returns attempt + filtered template (no answer keys). Returns 404 on token mismatch (intentionally - we don\'t leak whether a given attempt exists). Use `?include=files` (JSON:API standard) to sideload the attempt\'s `relationships.files` FileResources in `included[]`. Lets the candidate UI render thumbnails of their own uploads without a second round-trip. Returned FileResources are filtered for guest-safe fields (no internal status / audit). * Show Guest Attempt */ showGuestAttempt(requestParameters: ShowGuestAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for startGuestAttempt without sending the request */ startGuestAttemptRequestOpts(requestParameters: StartGuestAttemptRequest): Promise; /** * Candidate clicks the assessment link. Validates token and transitions the attempt from pending -> inProgress (idempotent). Returns attempt + filtered template (no answer keys). * Start Guest Attempt */ startGuestAttemptRaw(requestParameters: StartGuestAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Candidate clicks the assessment link. Validates token and transitions the attempt from pending -> inProgress (idempotent). Returns attempt + filtered template (no answer keys). * Start Guest Attempt */ startGuestAttempt(requestParameters: StartGuestAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateAttempt without sending the request */ updateAttemptRequestOpts(requestParameters: UpdateAttemptRequest): Promise; /** * Recruiter / admin override path. Allowed updates: status, languageCode, evaluation (manual override), proctoring, expiresAt, durationMinutes, evaluatorVersion. answers is NOT allowed - candidate\'s guest endpoint owns that. * Update Attempt */ updateAttemptRaw(requestParameters: UpdateAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Recruiter / admin override path. Allowed updates: status, languageCode, evaluation (manual override), proctoring, expiresAt, durationMinutes, evaluatorVersion. answers is NOT allowed - candidate\'s guest endpoint owns that. * Update Attempt */ updateAttempt(requestParameters: UpdateAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateGuestAttempt without sending the request */ updateGuestAttemptRequestOpts(requestParameters: UpdateGuestAttemptRequest): Promise; /** * Candidate autosave OR finalize. Two flows in one operation: - autosave: data.attributes.answers / proctoring updates while status=inProgress - finalize: data.attributes.status=\'submitted\' transitions attempt and emits ATTEMPT_SUBMITTED (eval SF picks it up) * Update Guest Attempt */ updateGuestAttemptRaw(requestParameters: UpdateGuestAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Candidate autosave OR finalize. Two flows in one operation: - autosave: data.attributes.answers / proctoring updates while status=inProgress - finalize: data.attributes.status=\'submitted\' transitions attempt and emits ATTEMPT_SUBMITTED (eval SF picks it up) * Update Guest Attempt */ updateGuestAttempt(requestParameters: UpdateGuestAttemptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for uploadGuestAttemptFile without sending the request */ uploadGuestAttemptFileRequestOpts(requestParameters: UploadGuestAttemptFileRequest): Promise; /** * Get a presigned PUT URL for a candidate file upload. Used by file-upload and video-recording question types. Auth is the same accessToken that gates the rest of the guest endpoints. Server validates the attempt exists, token matches, and status is `inProgress`. Returns the URL the FE then PUTs the file to, plus the fileKey to attach to the answer\'s files[]. * Upload Attempt File (Guest) */ uploadGuestAttemptFileRaw(requestParameters: UploadGuestAttemptFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get a presigned PUT URL for a candidate file upload. Used by file-upload and video-recording question types. Auth is the same accessToken that gates the rest of the guest endpoints. Server validates the attempt exists, token matches, and status is `inProgress`. Returns the URL the FE then PUTs the file to, plus the fileKey to attach to the answer\'s files[]. * Upload Attempt File (Guest) */ uploadGuestAttemptFile(requestParameters: UploadGuestAttemptFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const DeleteAttemptPermanentDeleteEnum: { readonly True: "true"; readonly False: "false"; }; export type DeleteAttemptPermanentDeleteEnum = typeof DeleteAttemptPermanentDeleteEnum[keyof typeof DeleteAttemptPermanentDeleteEnum]; /** * @export */ export declare const ListAttemptsFilterStatusEnum: { readonly Pending: "pending"; readonly InProgress: "inProgress"; readonly Submitted: "submitted"; readonly Evaluated: "evaluated"; readonly Reviewed: "reviewed"; readonly Anonymized: "anonymized"; readonly Failed: "failed"; }; export type ListAttemptsFilterStatusEnum = typeof ListAttemptsFilterStatusEnum[keyof typeof ListAttemptsFilterStatusEnum]; //# sourceMappingURL=AttemptsApi.d.ts.map