node-behind-api-client 2.0.48

package/docs/behind-api-client/easyjob/README.md

@@ -0,0 +1,647 @@
+# EasyJob JavaScript API Client Documentation
+
+This document describes the JavaScript client methods for the EasyJob recruitment management system. All methods are asynchronous and return promises.
+
+## Installation & Setup
+
+```javascript
+// Initialize the API client
+const behindAPI = require('your-api-client');
+
+// All EasyJob methods are available under:
+behindAPI.easyjob.V10
+```
+
+## Authentication
+All methods require a valid authenticated session. The client automatically handles user authentication and session management.
+
+## Response Format
+All methods return a response object with the following structure:
+
+**Success Response:**
+```javascript
+{
+    success: true,
+        data: {...}
+}
+```
+
+**Error Response:**
+```javascript
+{
+  success: false,
+  message: "Error description"
+}
+```
+
+---
+
+## Companies API
+
+### behindAPI.easyjob.V10.companies.create(name)
+Creates a new company record for the authenticated user.
+
+**Parameters:**
+- `name` (string, required) - The name of the company
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.companies.create("Tech Solutions Inc.");
+
+// Response:
+{
+  success: true,
+  data: {
+    company_id: "550e8400-e29b-41d4-a716-446655440000"
+  }
+}
+```
+
+### behindAPI.easyjob.V10.companies.delete(companyId)
+Soft deletes a company record.
+
+**Parameters:**
+- `companyId` (string, required) - The company UUID to delete
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.companies.delete("550e8400-e29b-41d4-a716-446655440000");
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.companies.update(companyId, name)
+Updates an existing company record.
+
+**Parameters:**
+- `companyId` (string, required) - The company UUID to update
+- `name` (string, required) - The new company name
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.companies.update(
+  "550e8400-e29b-41d4-a716-446655440000", 
+  "Tech Solutions Ltd."
+);
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.companies.getList()
+Retrieves all companies for the authenticated user.
+
+**Parameters:** None
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.companies.getList();
+
+// Response:
+{
+  success: true,
+  data: [
+    {
+      company_id: "550e8400-e29b-41d4-a716-446655440000",
+      name: "Tech Solutions Inc.",
+      created_at: "2024-01-15T10:30:00Z",
+      updated_at: "2024-01-15T10:30:00Z",
+      deleted: false
+    }
+  ]
+}
+```
+
+---
+
+## Departments API
+
+### behindAPI.easyjob.V10.departments.create(companyId, name)
+Creates a new department within a company.
+
+**Parameters:**
+- `companyId` (string, required) - The company UUID where the department belongs
+- `name` (string, required) - The name of the department
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.departments.create(
+  "550e8400-e29b-41d4-a716-446655440000",
+  "Engineering"
+);
+
+// Response:
+{
+  success: true,
+  data: {
+    department_id: "660e8400-e29b-41d4-a716-446655440001"
+  }
+}
+```
+
+### behindAPI.easyjob.V10.departments.delete(departmentId)
+Soft deletes a department record.
+
+**Parameters:**
+- `departmentId` (string, required) - The department UUID to delete
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.departments.delete("660e8400-e29b-41d4-a716-446655440001");
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.departments.update(departmentId, name)
+Updates an existing department record.
+
+**Parameters:**
+- `departmentId` (string, required) - The department UUID to update
+- `name` (string, required) - The new department name
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.departments.update(
+  "660e8400-e29b-41d4-a716-446655440001",
+  "Software Engineering"
+);
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.departments.getList(companyId)
+Retrieves all departments for a specific company.
+
+**Parameters:**
+- `companyId` (string, required) - The company UUID to get departments for
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.departments.getList("550e8400-e29b-41d4-a716-446655440000");
+
+// Response:
+{
+  success: true,
+  data: [
+    {
+      department_id: "660e8400-e29b-41d4-a716-446655440001",
+      company_id: "550e8400-e29b-41d4-a716-446655440000",
+      name: "Engineering",
+      created_at: "2024-01-15T10:30:00Z",
+      updated_at: "2024-01-15T10:30:00Z",
+      deleted: false
+    }
+  ]
+}
+```
+---
+
+## Job Description Artifacts API
+
+### behindAPI.easyjob.V10.jobDescriptionArtifacts.create(jobDescriptionId, content)
+Creates a new artifact for a job description.
+
+**Parameters:**
+- `jobDescriptionId` (string, required) - The job description UUID where the artifact belongs
+- `content` (string, required) - The content/text of the artifact
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.jobDescriptionArtifacts.create(
+  "770e8400-e29b-41d4-a716-446655440002",
+  "Additional requirements document content..."
+);
+
+// Response:
+{
+  success: true,
+  data: {
+    artifact_id: "880e8400-e29b-41d4-a716-446655440003"
+  }
+}
+```
+
+### behindAPI.easyjob.V10.jobDescriptionArtifacts.delete(artifactId)
+Deletes an artifact record.
+
+**Parameters:**
+- `artifactId` (string, required) - The artifact UUID to delete
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.jobDescriptionArtifacts.delete("880e8400-e29b-41d4-a716-446655440003");
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.jobDescriptionArtifacts.updateArtifactData(artifactId, data)
+Updates the processed data field of an artifact.
+
+**Parameters:**
+- `artifactId` (string, required) - The artifact UUID to update
+- `data` (object, required) - The processed data to store
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.jobDescriptionArtifacts.updateArtifactData(
+  "880e8400-e29b-41d4-a716-446655440003",
+  {
+    processed_requirements: ["React", "Node.js", "PostgreSQL"],
+    skill_level: "senior",
+    estimated_hours: 40
+  }
+);
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.jobDescriptionArtifacts.getList(jobDescriptionId)
+Retrieves all artifacts for a specific job description.
+
+**Parameters:**
+- `jobDescriptionId` (string, required) - The job description UUID to get artifacts for
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.jobDescriptionArtifacts.getList("770e8400-e29b-41d4-a716-446655440002");
+
+// Response:
+{
+  success: true,
+  data: [
+    {
+      artifact_id: "880e8400-e29b-41d4-a716-446655440003",
+      job_description_id: "770e8400-e29b-41d4-a716-446655440002",
+      content: "Additional requirements document content...",
+      processed_data: {
+        processed_requirements: ["React", "Node.js", "PostgreSQL"],
+        skill_level: "senior",
+        estimated_hours: 40
+      },
+      created_at: "2024-01-15T10:30:00Z",
+      updated_at: "2024-01-15T10:30:00Z"
+    }
+  ]
+}
+```
+
+---
+
+## Candidate Profile Artifacts API
+
+### behindAPI.easyjob.V10.candidateProfileArtifacts.create(candidateProfileId, content, source, type)
+Creates a new artifact for a candidate profile.
+
+**Parameters:**
+- `candidateProfileId` (string, required) - The candidate profile UUID where the artifact belongs
+- `content` (string, required) - The content/text of the artifact
+- `source` (string, required) - The source of the artifact (e.g., "resume", "cover_letter")
+- `type` (string, required) - The type of artifact (e.g., "pdf", "text", "docx")
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.candidateProfileArtifacts.create(
+  "aa0e8400-e29b-41d4-a716-446655440005",
+  "Resume content in text format...",
+  "resume",
+  "text"
+);
+
+// Response:
+{
+  success: true,
+  data: {
+    artifact_id: "bb0e8400-e29b-41d4-a716-446655440006"
+  }
+}
+```
+
+### behindAPI.easyjob.V10.candidateProfileArtifacts.delete(artifactId)
+Deletes a candidate profile artifact.
+
+**Parameters:**
+- `artifactId` (string, required) - The artifact UUID to delete
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.candidateProfileArtifacts.delete("bb0e8400-e29b-41d4-a716-446655440006");
+
+// Response:
+{
+  success: true
+}
+```
+
+### behindAPI.easyjob.V10.candidateProfileArtifacts.getList(candidateProfileId)
+Retrieves all artifacts for a specific candidate profile.
+
+**Parameters:**
+- `candidateProfileId` (string, required) - The candidate profile UUID to get artifacts for
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.candidateProfileArtifacts.getList("aa0e8400-e29b-41d4-a716-446655440005");
+
+// Response:
+{
+  success: true,
+  data: [
+    {
+      artifact_id: "bb0e8400-e29b-41d4-a716-446655440006",
+      candidate_profile_id: "aa0e8400-e29b-41d4-a716-446655440005",
+      content: "Resume content in text format...",
+      source: "resume",
+      type: "text",
+      created_at: "2024-01-15T10:30:00Z",
+      updated_at: "2024-01-15T10:30:00Z"
+    }
+  ]
+}
+```
+
+---
+
+## CV Parsing API
+
+### behindAPI.easyjob.V10.cv.parse(content, type)
+Parses CV/resume content and extracts structured information.
+
+**Parameters:**
+- `content` (string, required) - The content of the CV/resume to parse
+- `type` (string, required) - The type of content (e.g., "text", "pdf", "docx")
+
+**Usage:**
+```javascript
+const result = await behindAPI.easyjob.V10.cv.parse(
+  "John Doe\nSoftware Engineer\nExperience: 5+ years in full-stack development...",
+  "text"
+);
+
+// Response:
+{
+  success: true,
+  data: {
+    personal_info: {
+      name: "John Doe",
+      title: "Software Engineer"
+    },
+    experience: [...],
+    education: [...],
+    skills: [...],
+    contact_info: {...}
+  }
+}
+```
+
+---
+
+## Complete Usage Example
+
+```javascript
+// Complete workflow example for candidate management
+async function createCandidateProfile() {
+  try {
+    // 1. Create a candidate profile
+    const profile = await behindAPI.easyjob.V10.candidateProfiles.create();
+    const profileId = profile.data.profile_id;
+    
+    // 2. Update basic profile information
+    await behindAPI.easyjob.V10.candidateProfiles.update(profileId, {
+      first_name: "Jane",
+      last_name: "Smith",
+      email: "jane.smith@example.com",
+      phone: "+1-555-987-6543",
+      location: "San Francisco, CA",
+      summary: "Full-stack developer with expertise in modern web technologies"
+    });
+    
+    // 3. Add education
+    await behindAPI.easyjob.V10.candidateProfiles.updateEducation(profileId, [
+      {
+        institution: "Stanford University",
+        degree: "Master of Science",
+        field_of_study: "Computer Science",
+        start_year: 2018,
+        end_year: 2020,
+        gpa: 3.9
+      }
+    ]);
+    
+    // 4. Add job experience
+    await behindAPI.easyjob.V10.candidateProfiles.updateJobExperience(profileId, [
+      {
+        company: "Google",
+        position: "Software Engineer",
+        start_date: "2020-06-01",
+        end_date: null, // Current job
+        description: "Developed scalable web applications using React and Node.js",
+        technologies: ["React", "Node.js", "TypeScript", "MongoDB"]
+      }
+    ]);
+    
+    // 5. Add technical skills
+    await behindAPI.easyjob.V10.candidateProfiles.updateHardSkills(profileId, [
+      { skill: "React", level: "Expert", years_experience: 4 },
+      { skill: "Node.js", level: "Advanced", years_experience: 3 },
+      { skill: "TypeScript", level: "Advanced", years_experience: 3 }
+    ]);
+    
+    // 6. Add soft skills
+    await behindAPI.easyjob.V10.candidateProfiles.updateSoftSkills(profileId, [
+      { skill: "Team Leadership", level: "Advanced" },
+      { skill: "Problem Solving", level: "Expert" }
+    ]);
+    
+    // 7. Add certificates
+    await behindAPI.easyjob.V10.candidateProfiles.updateCertificates(profileId, [
+      {
+        name: "Google Cloud Professional Developer",
+        issuing_organization: "Google Cloud",
+        issue_date: "2023-03-15",
+        expiry_date: "2025-03-15",
+        credential_id: "GCP-DEV-789123"
+      }
+    ]);
+    
+    // 8. Add languages
+    await behindAPI.easyjob.V10.candidateProfiles.updateLanguages(profileId, [
+      { language: "English", proficiency: "Native" },
+      { language: "French", proficiency: "Intermediate" }
+    ]);
+    
+    // 9. Upload resume as artifact
+    const resumeContent = "Jane Smith\nFull-Stack Developer\n..."; // Resume text
+    await behindAPI.easyjob.V10.candidateProfileArtifacts.create(
+      profileId,
+      resumeContent,
+      "resume",
+      "text"
+    );
+    
+    console.log("Candidate profile created successfully!");
+    
+  } catch (error) {
+    console.error("Error creating candidate profile:", error);
+  }
+}
+
+// Complete workflow example for job posting management
+async function createJobPosting() {
+  try {
+    // 1. Create a company
+    const company = await behindAPI.easyjob.V10.companies.create("Tech Innovations LLC");
+    const companyId = company.data.company_id;
+    
+    // 2. Create a department
+    const department = await behindAPI.easyjob.V10.departments.create(companyId, "Software Development");
+    const departmentId = department.data.department_id;
+    
+    // 3. Create a job description
+    const jobDesc = await behindAPI.easyjob.V10.jobDescriptions.create(
+      departmentId,
+      "Full Stack Developer",
+      "We are seeking a talented full stack developer..."
+    );
+    const jobDescId = jobDesc.data.job_description_id;
+    
+    // 4. Update job description with detailed information
+    await behindAPI.easyjob.V10.jobDescriptions.update(
+      jobDescId,
+      "Senior Full Stack Developer", // Updated title
+      "We are seeking a talented senior full stack developer with 5+ years of experience...", // Updated description
+      "2024-02-01 09:00:00", // Published date
+      "2024-03-15 23:59:59"  // Application deadline
+    );
+    
+    // 5. Add structured job data
+    await behindAPI.easyjob.V10.jobDescriptions.updateData(jobDescId, {
+      salary_range: "90000-130000",
+      remote_work: true,
+      experience_level: "senior",
+      required_skills: ["React", "Node.js", "TypeScript", "AWS"],
+      nice_to_have: ["GraphQL", "Docker", "Kubernetes"],
+      benefits: ["Health insurance", "401k matching", "Flexible PTO"]
+    });
+    
+    // 6. Add candidate questions
+    await behindAPI.easyjob.V10.jobDescriptionCandidateQuestions.create(
+      jobDescId,
+      "Describe your experience with React and modern JavaScript frameworks"
+    );
+    
+    await behindAPI.easyjob.V10.jobDescriptionCandidateQuestions.create(
+      jobDescId,
+      "How do you approach debugging complex full-stack applications?"
+    );
+    
+    // 7. Create job description artifacts
+    const artifact = await behindAPI.easyjob.V10.jobDescriptionArtifacts.create(
+      jobDescId,
+      "Technical requirements and team structure documentation..."
+    );
+    
+    // 8. Update artifact with processed data
+    await behindAPI.easyjob.V10.jobDescriptionArtifacts.updateArtifactData(
+      artifact.data.artifact_id,
+      {
+        team_size: 8,
+        tech_stack: ["React", "Node.js", "PostgreSQL", "Redis"],
+        deployment_environment: "AWS",
+        development_methodology: "Agile/Scrum"
+      }
+    );
+    
+    console.log("Job posting created successfully!");
+    
+  } catch (error) {
+    console.error("Error creating job posting:", error);
+  }
+}
+
+// CV parsing workflow example
+async function processCandidateCV() {
+  try {
+    // 1. Parse CV content
+    const cvContent = `
+      John Doe
+      Software Engineer
+      john.doe@email.com
+      +1-555-123-4567
+      
+      EXPERIENCE
+      Senior Developer at TechCorp (2020-2024)
+      - Led development of microservices architecture
+      - Managed team of 5 developers
+      - Technologies: React, Node.js, AWS
+      
+      EDUCATION
+      B.S. Computer Science, MIT (2016-2020)
+      GPA: 3.8/4.0
+      
+      SKILLS
+      JavaScript, Python, React, Node.js, AWS, Docker
+    `;
+    
+    const parseResult = await behindAPI.easyjob.V10.cv.parse(cvContent, "text");
+    
+    if (parseResult.success) {
+      // 2. Create candidate profile
+      const profile = await behindAPI.easyjob.V10.candidateProfiles.create();
+      const profileId = profile.data.profile_id;
+      
+      // 3. Update profile with parsed data
+      const parsedData = parseResult.data;
+      
+      if (parsedData.personal_info) {
+        await behindAPI.easyjob.V10.candidateProfiles.update(profileId, {
+          first_name: parsedData.personal_info.first_name,
+          last_name: parsedData.personal_info.last_name,
+          email: parsedData.personal_info.email,
+          phone: parsedData.personal_info.phone
+        });
+      }
+      
+      if (parsedData.experience) {
+        await behindAPI.easyjob.V10.candidateProfiles.updateJobExperience(profileId, parsedData.experience);
+      }
+      
+      if (parsedData.education) {
+        await behindAPI.easyjob.V10.candidateProfiles.updateEducation(profileId, parsedData.education);
+      }
+      
+      if (parsedData.skills) {
+        await behindAPI.easyjob.V10.candidateProfiles.updateHardSkills(profileId, parsedData.skills);
+      }
+      
+      // 4. Store original CV as artifact
+      await behindAPI.easyjob.V10.candidateProfileArtifacts.create(
+        profileId,
+        cvContent,
+        "resume",
+        "text"
+      );
+      
+      console.log("CV processed and profile created successfully!");
+    }
+    
+  } catch (error) {
+    console.error("Error processing CV:", error);
+  }
+}````