@abcagency/hire-control-sdk 1.1.26 → 1.1.27

package/dist/types/form.d.ts

@@ -4,7 +4,65 @@ interface IntegrationSettings {
     webhooks?: FormWebhook[];
 }
 interface FormWebhook {
+    id?: string;
+    name?: string;
     url: string;
+    isApproved?: boolean;
+}
+export type FormExperienceType = "guided-v1";
+export interface GuidedBranchTrigger {
+    type: "page-transition" | "answer-condition";
+    fromPageName?: string;
+    toPageName?: string;
+    fieldName?: string;
+    operator?: "equals" | "not-equals";
+    value?: string;
+}
+export interface GuidedBranchDestination {
+    type: "notification" | "webhook";
+    recipientIds?: string[];
+    webhookId?: string;
+}
+export interface GuidedBranchAction {
+    id: string;
+    name: string;
+    enabled: boolean;
+    trigger: GuidedBranchTrigger;
+    destination: GuidedBranchDestination;
+    subject?: string;
+    message?: string;
+}
+export interface GuidedFormSettings {
+    version: 1;
+    branchActions: GuidedBranchAction[];
+}
+export interface JobTargetingSettings {
+    enabled: boolean;
+    priority: number;
+    jobFilterIds: string[];
+}
+export type SubmissionConditionOperator = "equals" | "not-equals" | "in" | "not-in";
+export interface SubmissionAutomationRule {
+    id: string;
+    name: string;
+    enabled: boolean;
+    trigger: {
+        type: "submit-condition";
+        fieldName: string;
+        operator: SubmissionConditionOperator;
+        value?: string;
+        values: string[];
+    };
+    action: {
+        type: "require-approval";
+        approverUserIds: string[];
+        notificationSubject?: string;
+        notificationMessage?: string;
+    };
+}
+export interface SubmissionAutomationSettings {
+    version: 1;
+    rules: SubmissionAutomationRule[];
 }
 interface FormSettings {
     useRecruiterFromJob: boolean;
@@ -18,6 +76,9 @@ interface FormSettings {
     confirmationEmailSubject?: string;
     confirmationEmailPreviewText?: string;
     confirmationEmailBody?: string;
+    guided?: GuidedFormSettings;
+    jobTargeting?: JobTargetingSettings;
+    submissionAutomations?: SubmissionAutomationSettings;
 }
 interface Form {
     id: string;
@@ -38,9 +99,41 @@ interface Form {
     };
     jsonSchema?: string;
     type: string;
+    experienceType?: FormExperienceType;
     formUsage: FormUsage[];
     settings?: FormSettings;
 }
+export interface GuidedActionExecutionRequest {
+    sessionId: string;
+    actionId: string;
+    fromPageName?: string;
+    toPageName?: string;
+    answers: Record<string, unknown>;
+}
+export interface GuidedActionExecutionResult {
+    executed: boolean;
+    duplicate: boolean;
+    status: string;
+}
+export interface JobTargetedFormSelection {
+    form?: EasyApplyForm;
+    source: "targeted" | "default" | "existing-default";
+    priority?: number;
+    matchedFilterId?: string;
+}
+export interface EasyApplyForm {
+    id: string;
+    name?: string;
+    jsonSchema?: string;
+    type?: string;
+    experienceType?: FormExperienceType;
+    successTitle?: string;
+    successMessage?: string;
+    guided?: {
+        version: 1;
+        branchActions: Array<Pick<GuidedBranchAction, "id" | "name" | "enabled" | "trigger">>;
+    };
+}
 interface FormUpdateOptions {
     fieldRenames?: Record<string, string>;
     applyFieldRenamesToSubmissions?: boolean;

package/dist/types/formSubmission.d.ts

@@ -11,6 +11,28 @@ type FormSubmission = {
     deletedAt?: string;
     formFields?: Record<string, string>;
     snapshotJobData?: Record<string, any>;
+    approval?: SubmissionApproval;
+};
+export type SubmissionApproval = {
+    ruleId: string;
+    ruleName: string;
+    approverUserIds: string[];
+    notificationSubject?: string;
+    notificationMessage?: string;
+    requestedAt: string;
+    notificationStatus: "pending" | "processing" | "sent" | "failed";
+    notificationAttempts: number;
+    notificationSentAt?: string;
+    notificationLastError?: string;
+    decision?: "approve" | "deny";
+    reviewedByUserId?: string;
+    reviewedByName?: string;
+    reviewedAt?: string;
+    reviewNote?: string;
+};
+export type SubmissionApprovalReviewRequest = {
+    decision: "approve" | "deny";
+    note?: string;
 };
 export declare enum FormSubmissionStatus {
     Submitted = 1,
@@ -18,6 +40,7 @@ export declare enum FormSubmissionStatus {
     Rejected = 3,
     Sent = 4,
     Failed = 5,
-    Blacklisted = 6
+    Blacklisted = 6,
+    PendingApproval = 7
 }
 export default FormSubmission;

package/dist/types/integrationConfig.d.ts

@@ -0,0 +1,19 @@
+export declare enum IntegrationType {
+    Custom = 0,
+    SearchWrite = 1,
+    SearchRead = 2,
+    ExternalSync = 3
+}
+type IntegrationConfig = {
+    id?: string;
+    companyId?: string;
+    type: IntegrationType | keyof typeof IntegrationType | string;
+    provider: string;
+    title: string;
+    enabled: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    settings: Record<string, string>;
+    secrets: Record<string, string>;
+};
+export default IntegrationConfig;

package/dist/types/user.d.ts

@@ -1,4 +1,5 @@
 type User = {
+    userId?: string;
     firstName: string;
     lastName: string;
     email: string;

package/index.ts

@@ -58,13 +58,34 @@ import { Listing } from "./types/listing";
 import Filters from "./types/filters/filters";
 import AppendListing from "./types/appendListing";
 import Form, {
+  FormExperienceType,
+  EasyApplyForm,
   FormFieldMigrationRequest,
   FormUpdateOptions,
+  GuidedActionExecutionRequest,
+  GuidedActionExecutionResult,
+  GuidedBranchAction,
+  GuidedBranchDestination,
+  GuidedBranchTrigger,
+  GuidedFormSettings,
+  JobTargetedFormSelection,
+  JobTargetingSettings,
+  SubmissionAutomationRule,
+  SubmissionAutomationSettings,
+  SubmissionConditionOperator,
 } from "./types/form";
-import FormSubmission, { FormSubmissionStatus } from "./types/formSubmission";
+import FormSubmission, {
+  FormSubmissionStatus,
+  SubmissionApproval,
+  SubmissionApprovalReviewRequest,
+} from "./types/formSubmission";
 import FormSettings, { FormSettingsSaveRequest } from "./types/formSettings";
 import ResultsWrapper from "./types/resultsWrapper";
-import { JobListing, JobListingSaveResult, JobStatus } from "./types/JobListing";
+import {
+  JobListing,
+  JobListingSaveResult,
+  JobStatus,
+} from "./types/JobListing";
 import FieldTypeDefinition from "./types/content/fieldDefinition";
 import ValidatorDefinition from "./types/content/validatorDefinition";
 import ContentModel, {
@@ -107,7 +128,9 @@ import ListingEntityMedia from "./types/listingEntityMedia";
 import CompletionRequest, {
   CompletionResponse,
 } from "./types/completionRequest";
-import SearchReadConfig from "./types/searchReadConfig";
+import type SearchReadConfig from "./types/searchReadConfig";
+import type IntegrationConfig from "./types/integrationConfig";
+import { IntegrationType } from "./types/integrationConfig";
 import {
   BLOCK_KEYS,
   BLOCK_KEY_ALIASES,
@@ -172,6 +195,10 @@ export const clientAuthConfig = {
 };
 
 export const integrationConfig = {
+  getAll: integrationConfigController.getAll,
+  create: integrationConfigController.create,
+  update: integrationConfigController.update,
+  delete: integrationConfigController.delete,
   getSearchRead: integrationConfigController.getSearchReadConfig,
 };
 
@@ -349,6 +376,7 @@ export const formSubmissions = {
   exportFormSubmissionsCsv: formSubmissionController.exportFormSubmissionsCsv,
   getFormSubmissionTypes: formSubmissionController.getFormSubmissionTypes,
   deleteFormSubmission: formSubmissionController.deleteFormSubmission,
+  reviewSubmissionApproval: formSubmissionController.reviewSubmissionApproval,
 };
 export { BLOCK_KEYS, BLOCK_KEY_ALIASES, FIELD_TYPES };
 //types
@@ -371,9 +399,24 @@ export type {
   Filters,
   AppendListing,
   Form,
+  EasyApplyForm,
+  FormExperienceType,
   FormFieldMigrationRequest,
   FormUpdateOptions,
+  GuidedActionExecutionRequest,
+  GuidedActionExecutionResult,
+  GuidedBranchAction,
+  GuidedBranchDestination,
+  GuidedBranchTrigger,
+  GuidedFormSettings,
+  JobTargetedFormSelection,
+  JobTargetingSettings,
+  SubmissionAutomationRule,
+  SubmissionAutomationSettings,
+  SubmissionConditionOperator,
   FormSubmission,
+  SubmissionApproval,
+  SubmissionApprovalReviewRequest,
   FormSettings,
   FormSettingsSaveRequest,
   ResultsWrapper,
@@ -414,9 +457,8 @@ export type {
   ListingEntityMedia,
   CompletionRequest,
   CompletionResponse,
-  SearchReadConfig,
 };
-export type { BlockKey, FieldType };
+export type { BlockKey, FieldType, SearchReadConfig, IntegrationConfig };
 
 export {
   EventType,
@@ -424,6 +466,7 @@ export {
   FormSubmissionStatus,
   FeedHandlingOption,
   JobStatus,
+  IntegrationType,
 };
 
 const hcApi = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abcagency/hire-control-sdk",
-  "version": "1.1.26",
+  "version": "1.1.27",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",

package/types/form.ts

@@ -9,7 +9,78 @@ interface IntegrationSettings {
 }
 
 interface FormWebhook {
+  id?: string;
+  name?: string;
   url: string;
+  isApproved?: boolean;
+}
+
+export type FormExperienceType = "guided-v1";
+
+export interface GuidedBranchTrigger {
+  type: "page-transition" | "answer-condition";
+  fromPageName?: string;
+  toPageName?: string;
+  fieldName?: string;
+  operator?: "equals" | "not-equals";
+  value?: string;
+}
+
+export interface GuidedBranchDestination {
+  type: "notification" | "webhook";
+  recipientIds?: string[];
+  webhookId?: string;
+}
+
+export interface GuidedBranchAction {
+  id: string;
+  name: string;
+  enabled: boolean;
+  trigger: GuidedBranchTrigger;
+  destination: GuidedBranchDestination;
+  subject?: string;
+  message?: string;
+}
+
+export interface GuidedFormSettings {
+  version: 1;
+  branchActions: GuidedBranchAction[];
+}
+
+export interface JobTargetingSettings {
+  enabled: boolean;
+  priority: number;
+  jobFilterIds: string[];
+}
+
+export type SubmissionConditionOperator =
+  | "equals"
+  | "not-equals"
+  | "in"
+  | "not-in";
+
+export interface SubmissionAutomationRule {
+  id: string;
+  name: string;
+  enabled: boolean;
+  trigger: {
+    type: "submit-condition";
+    fieldName: string;
+    operator: SubmissionConditionOperator;
+    value?: string;
+    values: string[];
+  };
+  action: {
+    type: "require-approval";
+    approverUserIds: string[];
+    notificationSubject?: string;
+    notificationMessage?: string;
+  };
+}
+
+export interface SubmissionAutomationSettings {
+  version: 1;
+  rules: SubmissionAutomationRule[];
 }
 
 interface FormSettings {
@@ -24,6 +95,9 @@ interface FormSettings {
   confirmationEmailSubject?: string;
   confirmationEmailPreviewText?: string;
   confirmationEmailBody?: string;
+  guided?: GuidedFormSettings;
+  jobTargeting?: JobTargetingSettings;
+  submissionAutomations?: SubmissionAutomationSettings;
 }
 
 interface Form {
@@ -45,10 +119,48 @@ interface Form {
   };
   jsonSchema?: string;
   type: string;
+  experienceType?: FormExperienceType;
   formUsage: FormUsage[];
   settings?: FormSettings;
 }
 
+export interface GuidedActionExecutionRequest {
+  sessionId: string;
+  actionId: string;
+  fromPageName?: string;
+  toPageName?: string;
+  answers: Record<string, unknown>;
+}
+
+export interface GuidedActionExecutionResult {
+  executed: boolean;
+  duplicate: boolean;
+  status: string;
+}
+
+export interface JobTargetedFormSelection {
+  form?: EasyApplyForm;
+  source: "targeted" | "default" | "existing-default";
+  priority?: number;
+  matchedFilterId?: string;
+}
+
+export interface EasyApplyForm {
+  id: string;
+  name?: string;
+  jsonSchema?: string;
+  type?: string;
+  experienceType?: FormExperienceType;
+  successTitle?: string;
+  successMessage?: string;
+  guided?: {
+    version: 1;
+    branchActions: Array<
+      Pick<GuidedBranchAction, "id" | "name" | "enabled" | "trigger">
+    >;
+  };
+}
+
 interface FormUpdateOptions {
   fieldRenames?: Record<string, string>;
   applyFieldRenamesToSubmissions?: boolean;

package/types/formSubmission.ts

@@ -11,6 +11,30 @@ type FormSubmission = {
   deletedAt?: string;
   formFields?: Record<string, string>;
   snapshotJobData?: Record<string, any>;
+  approval?: SubmissionApproval;
+};
+
+export type SubmissionApproval = {
+  ruleId: string;
+  ruleName: string;
+  approverUserIds: string[];
+  notificationSubject?: string;
+  notificationMessage?: string;
+  requestedAt: string;
+  notificationStatus: "pending" | "processing" | "sent" | "failed";
+  notificationAttempts: number;
+  notificationSentAt?: string;
+  notificationLastError?: string;
+  decision?: "approve" | "deny";
+  reviewedByUserId?: string;
+  reviewedByName?: string;
+  reviewedAt?: string;
+  reviewNote?: string;
+};
+
+export type SubmissionApprovalReviewRequest = {
+  decision: "approve" | "deny";
+  note?: string;
 };
 
 export enum FormSubmissionStatus {
@@ -20,6 +44,7 @@ export enum FormSubmissionStatus {
   Sent = 4,
   Failed = 5,
   Blacklisted = 6,
+  PendingApproval = 7,
 }
 
 export default FormSubmission;

package/types/integrationConfig.ts

@@ -0,0 +1,21 @@
+export enum IntegrationType {
+  Custom = 0,
+  SearchWrite = 1,
+  SearchRead = 2,
+  ExternalSync = 3,
+}
+
+type IntegrationConfig = {
+  id?: string;
+  companyId?: string;
+  type: IntegrationType | keyof typeof IntegrationType | string;
+  provider: string;
+  title: string;
+  enabled: boolean;
+  createdAt?: string;
+  updatedAt?: string;
+  settings: Record<string, string>;
+  secrets: Record<string, string>;
+};
+
+export default IntegrationConfig;

package/types/user.ts

@@ -1,4 +1,5 @@
 type User = {
+  userId?: string;
   firstName: string;
   lastName: string;
   email: string;

package/.gitattributes

@@ -1 +0,0 @@
-* text=auto eol=lf

package/controllers/jobDataAlertsController.ts

@@ -1,94 +0,0 @@
-import FetchHandler from "../handlers/fetchHandler";
-import { API_URL } from "../constants/config";
-import {
-  JobDataAlert,
-  JobDataAlertCounts,
-  JobDataAlertQuery,
-} from "../types/jobDataAlert";
-
-const fetchHandler = new FetchHandler(API_URL);
-
-class JobDataAlertsController {
-  async getAll(
-    query: JobDataAlertQuery = {},
-    authToken: string | null = null
-  ): Promise<JobDataAlert[]> {
-    const params = new URLSearchParams();
-    if (query.feedId) params.set("feedId", query.feedId);
-    if (query.status) params.set("status", query.status);
-    if (query.alertType) params.set("alertType", query.alertType);
-    if (query.severity) params.set("severity", query.severity);
-    if (query.search) params.set("search", query.search);
-    if (query.pageSize) params.set("pageSize", query.pageSize.toString());
-    if (query.pageNumber) params.set("pageNumber", query.pageNumber.toString());
-
-    const qs = params.toString();
-    return fetchHandler.get<JobDataAlert[]>(
-      `/jobdataalerts${qs ? `?${qs}` : ""}`,
-      true,
-      authToken
-    );
-  }
-
-  async counts(authToken: string | null = null): Promise<JobDataAlertCounts> {
-    return fetchHandler.get<JobDataAlertCounts>(
-      "/jobdataalerts/counts",
-      true,
-      authToken
-    );
-  }
-
-  async acknowledge(
-    id: string,
-    authToken: string | null = null
-  ): Promise<JobDataAlert> {
-    return fetchHandler.post<Record<string, never>, JobDataAlert>(
-      `/jobdataalerts/${id}/acknowledge`,
-      {},
-      true,
-      authToken
-    );
-  }
-
-  async mute(
-    id: string,
-    muted: boolean,
-    authToken: string | null = null
-  ): Promise<JobDataAlert> {
-    return fetchHandler.post<{ muted: boolean }, JobDataAlert>(
-      `/jobdataalerts/${id}/mute`,
-      { muted },
-      true,
-      authToken
-    );
-  }
-
-  async resolve(
-    id: string,
-    authToken: string | null = null
-  ): Promise<JobDataAlert> {
-    return fetchHandler.post<Record<string, never>, JobDataAlert>(
-      `/jobdataalerts/${id}/resolve`,
-      {},
-      true,
-      authToken
-    );
-  }
-
-  async sendPendingEmail(
-    feedId: string | null = null,
-    authToken: string | null = null
-  ): Promise<{ sentCount: number }> {
-    const params = new URLSearchParams();
-    if (feedId) params.set("feedId", feedId);
-    const qs = params.toString();
-    return fetchHandler.post<Record<string, never>, { sentCount: number }>(
-      `/jobdataalerts/send-pending-email${qs ? `?${qs}` : ""}`,
-      {},
-      true,
-      authToken
-    );
-  }
-}
-
-export default new JobDataAlertsController();

package/dist/controllers/jobDataAlertsController.d.ts

@@ -1,13 +0,0 @@
-import { JobDataAlert, JobDataAlertCounts, JobDataAlertQuery } from "../types/jobDataAlert";
-declare class JobDataAlertsController {
-    getAll(query?: JobDataAlertQuery, authToken?: string | null): Promise<JobDataAlert[]>;
-    counts(authToken?: string | null): Promise<JobDataAlertCounts>;
-    acknowledge(id: string, authToken?: string | null): Promise<JobDataAlert>;
-    mute(id: string, muted: boolean, authToken?: string | null): Promise<JobDataAlert>;
-    resolve(id: string, authToken?: string | null): Promise<JobDataAlert>;
-    sendPendingEmail(feedId?: string | null, authToken?: string | null): Promise<{
-        sentCount: number;
-    }>;
-}
-declare const _default: JobDataAlertsController;
-export default _default;

package/dist/types/jobDataAlert.d.ts

@@ -1,59 +0,0 @@
-import { AuditTrailEntry } from "./jobFeed";
-export type JobDataAlertSeverity = "info" | "warning" | "error";
-export type JobDataAlertType = "importIssue" | "missingUniqueId" | "missingRequiredField" | "unmatchedValue" | "autoAddedCategoryValue" | "approvalRequired" | "syncFailure";
-export type JobDataAlert = {
-    id: string;
-    companyId: string;
-    feedId?: string | null;
-    feedName?: string | null;
-    jobListingId?: string | null;
-    jobUniqueId?: string | null;
-    jobReferenceNumber?: number | null;
-    jobTitle?: string | null;
-    sourceItemKey?: string | null;
-    fieldPath?: string | null;
-    alertType: JobDataAlertType | string;
-    severity: JobDataAlertSeverity | string;
-    value?: string | null;
-    valueFingerprint: string;
-    identityHash: string;
-    message: string;
-    open: boolean;
-    acknowledged: boolean;
-    muted: boolean;
-    resolved: boolean;
-    pendingNotification: boolean;
-    firstSeenAt: string;
-    lastSeenAt: string;
-    lastChangedAt?: string | null;
-    resolvedAt?: string | null;
-    lastNotifiedAt?: string | null;
-    acknowledgedAt?: string | null;
-    acknowledgedBy?: string | null;
-    mutedAt?: string | null;
-    mutedBy?: string | null;
-    resolvedBy?: string | null;
-    occurrenceCount: number;
-    context?: Record<string, string> | null;
-    auditTrail?: AuditTrailEntry[];
-};
-export type JobDataAlertQuery = {
-    feedId?: string | null;
-    status?: "open" | "acknowledged" | "muted" | "resolved" | "pendingNotification" | string;
-    alertType?: string | null;
-    severity?: string | null;
-    search?: string | null;
-    pageSize?: number | null;
-    pageNumber?: number | null;
-};
-export type JobDataAlertCounts = {
-    open: number;
-    acknowledged: number;
-    muted: number;
-    resolved: number;
-    pendingNotification: number;
-};
-export type JobDataAlertSettings = {
-    enabled: boolean;
-    requiredFields: string[];
-};