/** * 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 type { DocumentAttributesSchemaOrganization } from './DocumentAttributesSchemaOrganization'; import type { ResourceTimestampsSchema } from './ResourceTimestampsSchema'; /** * Recruiter view of a document instance. `reference`, `contentHash`, * `sentAt`, participant states, activity and `status` past draft are * server-managed. Content (title/body/fields/participants) is editable * ONLY while status=draft - it LOCKS at send. * @export * @interface DocumentAttributesSchema */ export interface DocumentAttributesSchema { /** * The guest link's path segment. Derived from documentType when absent at create. * @type {DocumentAttributesSchemaProcessEnum} * @memberof DocumentAttributesSchema */ process?: DocumentAttributesSchemaProcessEnum; /** * Drives the backend's documentType -> availableActions matrix (v1: employment_offer = ACCEPT+DECLINE, policy = ACCEPT, consent = ACCEPT+DECLINE, others read-only). * @type {DocumentAttributesSchemaDocumentTypeEnum} * @memberof DocumentAttributesSchema */ documentType?: DocumentAttributesSchemaDocumentTypeEnum; /** * draft -> pending is the SEND door; pending -> withdrawn the only * later recruiter write. completed/declined come from the guest * surface. expired is computed at read from expiresAt. * in_progress is reserved for multi-signer (v2). * @type {DocumentAttributesSchemaStatusEnum} * @memberof DocumentAttributesSchema */ status?: DocumentAttributesSchemaStatusEnum; /** * Partial locale map. Clients render preferred -> en-US -> first available. * @type {{ [key: string]: string; }} * @memberof DocumentAttributesSchema */ title?: { [key: string]: string; }; /** * Human reference assigned at send, e.g. OFF-2026-0142. A label - never parse it. * @type {string} * @memberof DocumentAttributesSchema */ readonly reference?: string; /** * * @type {string} * @memberof DocumentAttributesSchema */ languageCode?: string; /** * * @type {DocumentAttributesSchemaOrganization} * @memberof DocumentAttributesSchema */ organization?: DocumentAttributesSchemaOrganization; /** * The typed block tree (flat, stable ids): heading | paragraph | * list | keyValue | divider | signatureSlots; inline runs are * text | strong | em | {kind: field, fieldId}. Shape frozen in * TASK_FE_SIGN_DOCUMENTS.md. * @type {Array} * @memberof DocumentAttributesSchema */ body?: Array; /** * The field registry referenced by id from the body: * {id, label (locale map), type: text|number|date|money, required, * editableBy (none in v1), value, suffix?}. * @type {Array} * @memberof DocumentAttributesSchema */ fields?: Array; /** * Ordered participants: {id, name, email (recruiter view only), * role, party: owner|counterparty, organizationName?, state: * pending|viewed|acted|declined, actedAt?, actedVia?, order?}. * Access tokens NEVER appear - not even here. * @type {Array} * @memberof DocumentAttributesSchema */ participants?: Array; /** * Evidence trail: {id, event, at, actorId?, meta?}. Events v1: * created, sent, viewed, accepted, declined, completed, withdrawn, * reminder_sent. The accepted/declined meta carries the ceremony * evidence (contentHash, confirmations, ip, userAgent) - recruiter * view only, stripped wholesale on the guest surface. * @type {Array} * @memberof DocumentAttributesSchema */ activity?: Array; /** * SHA-256 of the canonical body+fields, stamped at send. The evidential anchor - repeated on the terminal activity entry and domain events. * @type {string} * @memberof DocumentAttributesSchema */ readonly contentHash?: string; /** * * @type {string} * @memberof DocumentAttributesSchema */ candidateId?: string; /** * * @type {string} * @memberof DocumentAttributesSchema */ jobId?: string; /** * The candidate conversation the send-link email threads onto. * @type {string} * @memberof DocumentAttributesSchema */ conversationId?: string; /** * * @type {Date} * @memberof DocumentAttributesSchema */ readonly sentAt?: Date; /** * * @type {Date} * @memberof DocumentAttributesSchema */ expiresAt?: Date; /** * * @type {ResourceTimestampsSchema} * @memberof DocumentAttributesSchema */ timestamps?: ResourceTimestampsSchema; } /** * @export */ export declare const DocumentAttributesSchemaProcessEnum: { readonly Offer: "offer"; readonly Contract: "contract"; readonly Document: "document"; }; export type DocumentAttributesSchemaProcessEnum = typeof DocumentAttributesSchemaProcessEnum[keyof typeof DocumentAttributesSchemaProcessEnum]; /** * @export */ export declare const DocumentAttributesSchemaDocumentTypeEnum: { readonly EmploymentOffer: "employment_offer"; readonly EmploymentContract: "employment_contract"; readonly B2bContract: "b2b_contract"; readonly Nda: "nda"; readonly Policy: "policy"; readonly Consent: "consent"; }; export type DocumentAttributesSchemaDocumentTypeEnum = typeof DocumentAttributesSchemaDocumentTypeEnum[keyof typeof DocumentAttributesSchemaDocumentTypeEnum]; /** * @export */ export declare const DocumentAttributesSchemaStatusEnum: { readonly Draft: "draft"; readonly Pending: "pending"; readonly Completed: "completed"; readonly Declined: "declined"; readonly Expired: "expired"; readonly Withdrawn: "withdrawn"; }; export type DocumentAttributesSchemaStatusEnum = typeof DocumentAttributesSchemaStatusEnum[keyof typeof DocumentAttributesSchemaStatusEnum]; /** * Check if a given object implements the DocumentAttributesSchema interface. */ export declare function instanceOfDocumentAttributesSchema(value: object): value is DocumentAttributesSchema; export declare function DocumentAttributesSchemaFromJSON(json: any): DocumentAttributesSchema; export declare function DocumentAttributesSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentAttributesSchema; export declare function DocumentAttributesSchemaToJSON(json: any): DocumentAttributesSchema; export declare function DocumentAttributesSchemaToJSONTyped(value?: Omit | null, ignoreDiscriminator?: boolean): any; //# sourceMappingURL=DocumentAttributesSchema.d.ts.map