@brivioio/api-server-types 7.15.0 → 7.17.0

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 export * from './jobRoleChatHistory.types';
 export * from './jobRoles.types';
 export * from './meetingBots.types';
+export * from './organizationDomains.types';
 export * from './organizationUsers.types';
 export * from './organizations.types';
+export * from './requirements.types';
 export * from './slackChannels.types';
 export * from './slackMessages.types';
 export * from './slackWorkspaces.types';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -1,8 +1,10 @@
 export * from './jobRoleChatHistory.types';
 export * from './jobRoles.types';
 export * from './meetingBots.types';
+export * from './organizationDomains.types';
 export * from './organizationUsers.types';
 export * from './organizations.types';
+export * from './requirements.types';
 export * from './slackChannels.types';
 export * from './slackMessages.types';
 export * from './slackWorkspaces.types';

package/dist/jobRoleChatHistory.types.d.ts

@@ -49,11 +49,21 @@ export type TUserMultiChoiceResponse = {
     selectedOptionIds: string[];
     customText?: string;
 };
+/**
+ * A recruiter's verdict on a calibration candidate.
+ * - `positive` / `negative` — thumbs up / down for taste calibration.
+ * - `shortlist` — strong signal: the recruiter wants Brivio to reach out to this
+ *   exact person. Downstream sourcing guarantees shortlisted candidates appear in
+ *   the role's shortlist regardless of search ranking.
+ * - `neutral` — no verdict given (card left untouched).
+ */
+export type TCandidateReviewSentiment = 'positive' | 'negative' | 'neutral' | 'shortlist';
 export type TUserCandidateReviewResponse = {
     type: EJobRoleChatMessageType.CANDIDATE_REVIEW;
     reviews: {
         candidateId: string;
-        sentiment: 'positive' | 'negative' | 'neutral';
+        sentiment: TCandidateReviewSentiment;
+        /** Mandatory whenever `sentiment` is not `neutral` — the recruiter must say why. */
         note?: string;
     }[];
 };

package/dist/jobRoleChatHistory.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jobRoleChatHistory.types.d.ts","sourceRoot":"","sources":["../src/jobRoleChatHistory.types.ts"],"names":[],"mappings":"AACA,oBAAY,sBAAsB;IAChC,iBAAiB,qBAAqB;IACtC,KAAK,UAAU;CAChB;AAED,oBAAY,uBAAuB;IACjC,UAAU,eAAe;IACzB,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;CACtC;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,uBAAuB,CAAC,aAAa,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B,yBAAyB,GACzB,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,uBAAuB,CAAC,aAAa,CAAC;IAC5C,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAC3C,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAC/C,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;QAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B,yBAAyB,GACzB,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAE9E,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;IACJ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QACN,IAAI,EAAE,sBAAsB,CAAC;QAC7B,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;KACnB,CAAC;IACF,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,uBAAuB,CAAC;IACrC,cAAc,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC5C,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACjD,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"jobRoleChatHistory.types.d.ts","sourceRoot":"","sources":["../src/jobRoleChatHistory.types.ts"],"names":[],"mappings":"AACA,oBAAY,sBAAsB;IAChC,iBAAiB,qBAAqB;IACtC,KAAK,UAAU;CAChB;AAED,oBAAY,uBAAuB;IACjC,UAAU,eAAe;IACzB,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;CACtC;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,uBAAuB,CAAC,aAAa,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B,yBAAyB,GACzB,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,uBAAuB,CAAC,aAAa,CAAC;IAC5C,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAC3C,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,yBAAyB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,CAAC;AAE1F,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAC/C,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,yBAAyB,CAAC;QACrC,oFAAoF;QACpF,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAC5B,yBAAyB,GACzB,wBAAwB,GACxB,4BAA4B,CAAC;AAEjC,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAE9E,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;IACJ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QACN,IAAI,EAAE,sBAAsB,CAAC;QAC7B,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;KACnB,CAAC;IACF,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,uBAAuB,CAAC;IACrC,cAAc,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC5C,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACjD,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/organizationDomains.types.d.ts

@@ -0,0 +1,80 @@
+import type { IResponse } from './utils.types';
+export type TDomainCapability = 'enabled' | 'disabled';
+export type TDomainStatus = 'not_started' | 'pending' | 'verified' | 'failed' | 'temporary_failure';
+export type TDomainTlsMode = 'opportunistic' | 'enforced';
+export type TDomainDnsRecordType = 'TXT' | 'MX' | 'CNAME';
+export interface IDomainDnsRecord {
+    record: string;
+    name: string;
+    type: TDomainDnsRecordType;
+    value: string;
+    ttl?: string;
+    priority?: number;
+    status?: TDomainStatus;
+}
+export interface IOrganizationDomain {
+    _id: string;
+    organization: string;
+    resendDomainId: string;
+    name: string;
+    region: string;
+    status: TDomainStatus;
+    capabilities: {
+        sending: TDomainCapability;
+        receiving: TDomainCapability;
+    };
+    tls: TDomainTlsMode;
+    openTracking: boolean;
+    clickTracking: boolean;
+    customReturnPath?: string;
+    dnsRecords: IDomainDnsRecord[];
+    lastVerificationAttemptAt?: string;
+    verifiedAt?: string;
+    isDeleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export type TOrganizationDomainPublic = {
+    id: string;
+    name: string;
+    region: string;
+    status: TDomainStatus;
+    capabilities: {
+        sending: TDomainCapability;
+        receiving: TDomainCapability;
+    };
+    tls: TDomainTlsMode;
+    openTracking: boolean;
+    clickTracking: boolean;
+    customReturnPath?: string;
+    dnsRecords: IDomainDnsRecord[];
+    lastVerificationAttemptAt: string | null;
+    verifiedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+export declare namespace OrganizationDomainAPITypes {
+    type TGetDomainResponse = IResponse<{
+        domain: TOrganizationDomainPublic | null;
+    } | null>;
+    type TCreateDomainRequestBody = {
+        domain: string;
+    };
+    type TCreateDomainResponse = IResponse<{
+        domain: TOrganizationDomainPublic;
+    } | null>;
+    type TVerifyDomainResponse = IResponse<{
+        domain: TOrganizationDomainPublic;
+    } | null>;
+    type TRefreshDomainResponse = IResponse<{
+        domain: TOrganizationDomainPublic;
+    } | null>;
+    type TDeleteDomainResponse = IResponse<null>;
+    type TSendItInstructionsRequestBody = {
+        receivers: string[];
+    };
+    type TSendItInstructionsResponse = IResponse<{
+        sentCount: number;
+    } | null>;
+}
+//# sourceMappingURL=organizationDomains.types.d.ts.map

package/dist/organizationDomains.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"organizationDomains.types.d.ts","sourceRoot":"","sources":["../src/organizationDomains.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,UAAU,CAAC;AAMvD,MAAM,MAAM,aAAa,GAAG,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,mBAAmB,CAAC;AAEpG,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,UAAU,CAAC;AAE1D,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC;AAK1D,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,oBAAoB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE;QACZ,OAAO,EAAE,iBAAiB,CAAC;QAC3B,SAAS,EAAE,iBAAiB,CAAC;KAC9B,CAAC;IACF,GAAG,EAAE,cAAc,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE;QACZ,OAAO,EAAE,iBAAiB,CAAC;QAC3B,SAAS,EAAE,iBAAiB,CAAC;KAC9B,CAAC;IACF,GAAG,EAAE,cAAc,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,yBAAiB,0BAA0B,CAAC;IAC1C,KAAY,kBAAkB,GAAG,SAAS,CAAC;QACzC,MAAM,EAAE,yBAAyB,GAAG,IAAI,CAAC;KAC1C,GAAG,IAAI,CAAC,CAAC;IAEV,KAAY,wBAAwB,GAAG;QAGrC,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAY,qBAAqB,GAAG,SAAS,CAAC;QAC5C,MAAM,EAAE,yBAAyB,CAAC;KACnC,GAAG,IAAI,CAAC,CAAC;IAEV,KAAY,qBAAqB,GAAG,SAAS,CAAC;QAC5C,MAAM,EAAE,yBAAyB,CAAC;KACnC,GAAG,IAAI,CAAC,CAAC;IAEV,KAAY,sBAAsB,GAAG,SAAS,CAAC;QAC7C,MAAM,EAAE,yBAAyB,CAAC;KACnC,GAAG,IAAI,CAAC,CAAC;IAEV,KAAY,qBAAqB,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAEpD,KAAY,8BAA8B,GAAG;QAC3C,SAAS,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IACF,KAAY,2BAA2B,GAAG,SAAS,CAAC;QAClD,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,IAAI,CAAC,CAAC;CACX"}

package/dist/organizationDomains.types.js

@@ -0,0 +1 @@
+export {};

package/dist/requirements.types.d.ts

@@ -0,0 +1,92 @@
+import type { IResponse } from './utils.types';
+/**
+ * Where a role's candidate-facing job description came from. This is the JD that
+ * gets shared with candidates over email during sourcing — distinct from
+ * `requirementsText`, which is the agent's internal brain dump.
+ */
+export declare enum EJobDescriptionSource {
+    /** Recruiter uploaded a JD file (PDF / image) during closeout. */
+    ATTACHMENT = "attachment",
+    /** Recruiter pasted an external JD link (careers page, Notion, etc.). */
+    LINK = "link",
+    /** No JD provided — the agent drafted one and the recruiter confirmed it. */
+    GENERATED = "generated"
+}
+export interface IJobDescription {
+    source: EJobDescriptionSource;
+    /**
+     * Candidate-facing JD body (markdown). Always populated for `generated` and
+     * `attachment` (extracted text); for `link` it may be a short blurb alongside
+     * the URL.
+     */
+    content: string;
+    /** External URL when `source = link` (or a hosted copy of an attachment). */
+    url: string | null;
+    /** Server-side workspace path of the uploaded file when `source = attachment`. */
+    attachmentPath: string | null;
+    /** True once the recruiter has explicitly confirmed this JD in the chat. */
+    confirmedByUser: boolean;
+}
+/**
+ * One immutable snapshot of a role's requirements. A new version is committed at
+ * intake closeout (v1) and again whenever a post-closeout change touches the
+ * role. Downstream sourcing always reads the `isLatest` version, and every
+ * search / shortlist record is tagged with this `version` number so results are
+ * traceable to the exact requirement they were sourced against.
+ */
+export interface IRequirement {
+    _id: string;
+    organizationId: string;
+    jobRoleId: string;
+    /** Sequential per role, starting at 1. The canonical tag for search/shortlist records. */
+    version: number;
+    /** Full `requirements.md` brain dump as it stood when this version was committed. */
+    requirementsText: string;
+    jobDescription: IJobDescription;
+    /** One-line note on what triggered this version (e.g. "Initial intake", "Salary band raised"). */
+    changeSummary: string;
+    /** The chat message that led to this version; null when committed outside a user turn. */
+    triggeredByMessageId: string | null;
+    /** Timestamp of `triggeredByMessageId` — the "version timestamp". */
+    triggeredByMessageAt: string;
+    /** Exactly one version per role is `isLatest: true`. */
+    isLatest: boolean;
+    /** Org user who owned the triggering turn; null when agent-authored. */
+    createdBy: string | null;
+    internalTags: {
+        key: string;
+        value: string;
+    }[];
+    isDeleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export type TJobDescription = {
+    source: EJobDescriptionSource;
+    content: string;
+    url: string | null;
+    attachmentPath: string | null;
+    confirmedByUser: boolean;
+};
+export type TRequirementVersion = {
+    id: string;
+    organizationId: string;
+    jobRoleId: string;
+    version: number;
+    requirementsText: string;
+    jobDescription: TJobDescription;
+    changeSummary: string;
+    triggeredByMessageAt: string;
+    isLatest: boolean;
+    createdAt: string;
+    updatedAt: string;
+};
+export declare namespace RequirementsAPITypes {
+    type TListRequirementVersionsResponse = IResponse<{
+        versions: TRequirementVersion[];
+    } | null>;
+    type TGetLatestRequirementVersionResponse = IResponse<{
+        version: TRequirementVersion | null;
+    } | null>;
+}
+//# sourceMappingURL=requirements.types.d.ts.map

package/dist/requirements.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requirements.types.d.ts","sourceRoot":"","sources":["../src/requirements.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;GAIG;AACH,oBAAY,qBAAqB;IAC/B,kEAAkE;IAClE,UAAU,eAAe;IACzB,yEAAyE;IACzE,IAAI,SAAS;IACb,6EAA6E;IAC7E,SAAS,cAAc;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,qBAAqB,CAAC;IAC9B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,6EAA6E;IAC7E,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,kFAAkF;IAClF,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,4EAA4E;IAC5E,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,0FAA0F;IAC1F,OAAO,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,eAAe,CAAC;IAChC,kGAAkG;IAClG,aAAa,EAAE,MAAM,CAAC;IACtB,0FAA0F;IAC1F,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,qEAAqE;IACrE,oBAAoB,EAAE,MAAM,CAAC;IAC7B,wDAAwD;IACxD,QAAQ,EAAE,OAAO,CAAC;IAClB,wEAAwE;IACxE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;IACJ,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,eAAe,CAAC;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,yBAAiB,oBAAoB,CAAC;IACpC,KAAY,gCAAgC,GAAG,SAAS,CAAC;QACvD,QAAQ,EAAE,mBAAmB,EAAE,CAAC;KACjC,GAAG,IAAI,CAAC,CAAC;IAEV,KAAY,oCAAoC,GAAG,SAAS,CAAC;QAC3D,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;KACrC,GAAG,IAAI,CAAC,CAAC;CACX"}

package/dist/requirements.types.js

@@ -0,0 +1,14 @@
+/**
+ * Where a role's candidate-facing job description came from. This is the JD that
+ * gets shared with candidates over email during sourcing — distinct from
+ * `requirementsText`, which is the agent's internal brain dump.
+ */
+export var EJobDescriptionSource;
+(function (EJobDescriptionSource) {
+    /** Recruiter uploaded a JD file (PDF / image) during closeout. */
+    EJobDescriptionSource["ATTACHMENT"] = "attachment";
+    /** Recruiter pasted an external JD link (careers page, Notion, etc.). */
+    EJobDescriptionSource["LINK"] = "link";
+    /** No JD provided — the agent drafted one and the recruiter confirmed it. */
+    EJobDescriptionSource["GENERATED"] = "generated";
+})(EJobDescriptionSource || (EJobDescriptionSource = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brivioio/api-server-types",
-  "version": "7.15.0",
+  "version": "7.17.0",
   "description": "TypeScript type definitions for Brivio API Server",
   "type": "module",
   "main": "dist/index.js",