Merge pull request #9 from huntflow/INT-222_create_Response_model

[INT-222] - Create ResponseHookRequest.

Author: polina-koval

huntflow_webhook_models/common_models/hf_base.py

@@ -14,3 +14,14 @@ class AccountInfo(BaseModel):
     id: int = Field(..., description="Account ID", example=1)
     name: str = Field(..., description="Account owner name", example="John")
     email: Optional[str] = Field(..., description="Account owner email", example="[email protected]")
+
+
+class AccountSource(BaseModel):
+    id: int = Field(..., description="Resume source ID", example=1)
+    foreign: Optional[str] = Field(
+        None,
+        description="Applicant source foreign",
+        example="f2",
+    )
+    name: str = Field(..., description="Applicant source name", example="Headhunter")
+    type: str = Field(..., description="Applicant source type", example="user")

huntflow_webhook_models/common_models/response.py

@@ -0,0 +1,376 @@
+from datetime import datetime
+from typing import Any, List, Optional, Union
+
+from pydantic.fields import Field
+from pydantic.main import BaseModel
+
+from huntflow_webhook_models.common_models.hf_base import AccountSource
+from huntflow_webhook_models.common_models.vacancy import Vacancy
+from huntflow_webhook_models.consts import (
+    ApplicantResponseExternalStatus,
+    PrecisionTypes,
+    VacancyExternalPublishStatus,
+)
+
+
+class PhotoData(BaseModel):
+    small: Optional[str] = Field(
+        None,
+        description="Small image url",
+        example="https://example.com/image_small.png",
+    )
+    medium: Optional[str] = Field(
+        None,
+        description="Medium image url",
+        example="https://example.com/image_medium.png",
+    )
+    large: Optional[str] = Field(
+        None,
+        description="Large image url",
+        example="https://example.com/image_large.png",
+    )
+    external_id: Optional[str] = Field(None, description="Photo external ID", example="12")
+    description: Optional[str] = Field(
+        None,
+        description="Photo description",
+        example="Applicant's photo",
+    )
+    source: Optional[str] = Field(
+        None,
+        description="Photo's source url",
+        example="https://example.com/photo_source.png",
+    )
+    id: Optional[int] = Field(None, description="Huntflow photo ID", example=10)
+
+
+class DateWithPrecision(BaseModel):
+    year: Optional[int] = Field(None, description="Year", example=2021)
+    month: Optional[int] = Field(None, description="Month", example=12)
+    day: Optional[int] = Field(None, description="Day", example=12)
+    precision: PrecisionTypes = Field(..., description="Precision type", example=PrecisionTypes.day)
+
+
+class TextBlock(BaseModel):
+    header: Optional[str] = Field(None, description="Text block header", example="About header")
+    body: Optional[str] = Field(None, description="Text block body", example="About body")
+
+
+class PersonalInfo(BaseModel):
+    photo: Optional[PhotoData] = Field(None, description="Urls for resume photo")
+    first_name: Optional[str] = Field(None, description="First name", example="John")
+    middle_name: Optional[str] = Field(None, description="Middle name", example="Abraham")
+    last_name: Optional[str] = Field(None, description="Last name", example="Doe")
+    birth_date: Optional[DateWithPrecision] = Field(None, description="Date of birth")
+    text_block: Optional[TextBlock] = Field(None, description='Additional "About" info')
+
+
+class ExternalEntity(BaseModel):
+    id: Optional[Union[int, str]] = Field(None, description="Entity ID in Huntflow system")
+    external_id: Optional[str] = Field(None, description="Entity external ID")
+    name: Optional[str] = Field(None, description="Entity name")
+
+
+class Specialization(ExternalEntity):
+    profarea_id: Optional[str] = Field(
+        None,
+        description="Specialization ID in Huntflow system",
+        example="10",
+    )
+    external_profarea_id: Optional[str] = Field(
+        None,
+        description="Specialization external ID",
+        example="external_10",
+    )
+    prefarea_name: Optional[str] = Field(None, description="Specialization name", example="Sales")
+
+
+class Area(BaseModel):
+    country: Optional[ExternalEntity] = Field(None, description="Country")
+    city: Optional[ExternalEntity] = Field(None, description="City")
+    metro: Optional[ExternalEntity] = Field(None, description="Metro station")
+    address: Optional[str] = Field(None, description="Full address", example="Washington DC")
+    lat: Optional[float] = Field(None, description="Latitude", example=38.8951)
+    lng: Optional[float] = Field(None, description="Longitude", example=-77.0364)
+
+
+class Skill(BaseModel):
+    title: str = Field(..., description="Skill name", example="English language")
+
+
+class Experience(BaseModel):
+    position: Optional[str] = Field(None, description="Position", example="Manager")
+    date_from: Optional[DateWithPrecision] = Field(None, description="Experience start date")
+    date_to: Optional[DateWithPrecision] = Field(None, description="Experience end date")
+    company: Optional[str] = Field(None, description="Company name", example="Company")
+    url: Optional[str] = Field(None, description="Company's url", example="https://example.com")
+    area: Optional[Area] = Field(None, description="Experience area")
+    industries: Optional[List[ExternalEntity]] = Field(
+        None,
+        description="List of experience industries",
+    )
+    description: Optional[str] = Field(
+        None,
+        description="Experience description",
+        example="I worked as a manager",
+    )
+    skills: Optional[List[Skill]] = Field(None, description="List of skills")
+
+
+class BaseEducationInfo(BaseModel):
+    name: Optional[str] = Field(None, description="Education name", example="Higher")
+    description: Optional[str] = Field(
+        None,
+        description="Education description",
+        example="I have a higher education",
+    )
+    date_from: Optional[DateWithPrecision] = Field(None, description="Education start date")
+    date_to: Optional[DateWithPrecision] = Field(None, description="Education end date")
+    area: Optional[Area] = Field(None, description="Education area")
+
+
+class EducationInfoWithResult(BaseEducationInfo):
+    result: Optional[str] = Field(None, description="Education result", example="Completed")
+
+
+class ExtendedEducationInfo(BaseEducationInfo):
+    faculty: Optional[str] = Field(None, description="Faculty name", example="Mathematics")
+    form: Optional[ExternalEntity]
+
+
+class Attestation(BaseModel):
+    date: Optional[DateWithPrecision]
+    name: Optional[str]
+    organization: Optional[str]
+    description: Optional[str]
+    result: Optional[str]
+
+
+class Education(BaseModel):
+    level: Optional[ExternalEntity] = Field(None, description="Education level")
+    higher: Optional[List[ExtendedEducationInfo]] = Field(
+        None,
+        description="List of higher education institutions",
+    )
+    vocational: Optional[List[ExtendedEducationInfo]] = Field(
+        None,
+        description="List of vocational education institutions",
+    )
+    elementary: Optional[List[BaseEducationInfo]] = Field(
+        None,
+        description="List of elementary education institutions",
+    )
+    additional: Optional[List[EducationInfoWithResult]] = Field(
+        None,
+        description="List of additional education institutions",
+    )
+    attestation: Optional[List[Attestation]] = Field(None, description="List of attestations")
+
+
+class Certificate(BaseModel):
+    name: Optional[str] = Field(None, description="Name of certificate", example="Certificate")
+    organization: Optional[str] = Field(
+        None,
+        description="The organization that issued the certificate",
+        example="Certificate organnization",
+    )
+    description: Optional[str] = Field(
+        None,
+        description="Certificate description",
+        example="Certificate for John Doe",
+    )
+    url: Optional[str] = Field(
+        None,
+        description="Certificate url",
+        example="https://example.com/certificate_john_doe.pdf",
+    )
+    area: Optional[Area] = Field(None, description="Area of issue of the certificate")
+    date: Optional[DateWithPrecision] = Field(None, description="Date of issue of the certificate")
+
+
+class ContactPhone(BaseModel):
+    country: str = Field()
+    city: str = Field()
+    number: str = Field()
+    formatted: str = Field()
+
+
+class Contact(BaseModel):
+    type: Optional[ExternalEntity] = Field(None, description="Contact type")
+    value: Optional[str] = Field(None, description="Contact value", example="89999999999")
+    preferred: Optional[bool] = Field(
+        None,
+        description="This is the preferred method of communication",
+        example="true",
+    )
+    full_value: Optional[ContactPhone] = Field(
+        None,
+        description="If contact is a phone number - additional data about it",
+    )
+
+
+class Relocation(BaseModel):
+    type: Optional[ExternalEntity] = Field(None, description="Type of relocation")
+    area: Optional[List[Area]] = Field(None, description="List of areas for relocation")
+
+
+class Language(ExternalEntity):
+    level: Optional[ExternalEntity] = Field(None, description="Language proficiency level")
+
+
+class Military(BaseModel):
+    date_from: Optional[DateWithPrecision] = Field(None, description="Military service start date")
+    date_to: Optional[DateWithPrecision] = Field(None, description="Military service end date")
+    area: Optional[Area] = Field(None, description="Military service area")
+    unit: Optional[dict] = Field(
+        None,
+        description="Military service unit",
+        example={"name": "Infantry", "external_id": 3336026},
+    )
+
+
+class SocialRating(BaseModel):
+    kind: Optional[str]
+    stats: Optional[Any]
+    tags: Optional[List[str]]
+    url: Optional[str]
+    login: Optional[str]
+    registered_at: Optional[str] = Field(None, description="ISO datetime")
+
+
+class Salary(BaseModel):
+    amount: Optional[float] = Field(None, description="Salary amount")
+    currency: Optional[str] = Field(None, description="Salary currency")
+
+
+class Recommendation(BaseModel):
+    value: Optional[str] = Field(None, description="Recommendation")
+    date: Optional[DateWithPrecision] = Field(None, description="Date of recommendation")
+    name: Optional[str] = Field(None, description="Name to whom recommendation")
+    position: Optional[str] = Field(None, description="Position", example="Manager")
+    organization: Optional[str] = Field(
+        None,
+        description="Organization name",
+        example="Test organization",
+    )
+    contact: Optional[str] = Field(None, description="Contact", example="89999999999")
+
+
+class SimplePhoto(BaseModel):
+    url: Optional[str] = Field(None, description="Photo url")
+    original: Optional[str] = Field(None, description="Photo original")
+
+
+class Additional(BaseModel):
+    name: Optional[str] = Field(None, description="Name of additional info")
+    description: Optional[str] = Field(None, description="Description of additional info")
+
+
+class Resume(BaseModel):
+    personal_info: Optional[PersonalInfo] = Field(None, description="Personal info")
+    source_url: Optional[str] = Field(
+        None,
+        description="Resume url to external job site",
+        example="https://example.com/resume",
+    )
+    position: Optional[str] = Field(None, description="Resume header", example="Manager")
+    specialization: Optional[List[Specialization]] = Field(None, description="Specializations")
+    skill_set: Optional[List[str]] = Field(
+        None,
+        description="List of skills",
+        example=["English language"],
+    )
+    gender: Optional[ExternalEntity] = Field(None, description="Gender")
+    experience: Optional[List[Experience]] = Field(None, description="Work experiences")
+    education: Optional[Education] = Field(None, description="Education")
+    certificate: Optional[List[Certificate]] = Field(None, description="Certificates")
+    portfolio: Optional[List[PhotoData]] = Field(None, description="Portfolio")
+    contact: Optional[List[Contact]] = Field(None, description="List of contacts")
+    area: Optional[Area] = Field(None, description="Living area")
+    relocation: Optional[Relocation] = Field(None, description="Relocation info")
+    citizenship: Optional[List[ExternalEntity]] = Field(None, description="Citizenship")
+    work_permit: Optional[List[ExternalEntity]] = Field(
+        None,
+        description="List of countries with work permission",
+    )
+    language: Optional[List[Language]] = Field(None, description="Language proficiency")
+    wanted_salary: Optional[Salary] = Field(None, description="Desired salary")
+    work_schedule: Optional[List[ExternalEntity]] = Field(None, description="Work schedules")
+    business_trip_readiness: Optional[ExternalEntity] = Field(
+        None,
+        description="Readiness for business trips",
+    )
+    recommendations: Optional[List[Recommendation]] = Field(
+        None,
+        description="List of recommendations",
+    )
+    has_vehicle: Optional[bool] = Field(None, description="Ownership of vehicle", example="false")
+    driver_license_types: Optional[List[str]] = Field(
+        None,
+        description="List of available driver's licenses",
+        example=["A1", "B1"],
+    )
+    military: Optional[List[Military]] = Field(None, description="Military service")
+    social_ratings: Optional[List[SocialRating]] = Field(None, description="Social ratings")
+    photos: Optional[List[SimplePhoto]] = Field(None, description="Photos")
+    additionals: Optional[List[Additional]] = Field(
+        None,
+        description="Some additional info related to resume",
+    )
+    wanted_place_of_work: Optional[str] = Field(
+        None,
+        description="Desired place of work",
+        example="New York",
+    )
+    updated_on_source: Optional[DateWithPrecision] = Field(
+        None,
+        description="Date of resume update in the source",
+    )
+    travel_time: Optional[ExternalEntity] = Field(None, description="Preferred travel time")
+
+
+class ApplicantExternalResponse(BaseModel):
+    id: int = Field(..., description="Applicant source ID", example=1)
+    created: datetime = Field(
+        ...,
+        description="The datetime when the response was stored in the database",
+        example=datetime(1970, 1, 1, 1, 1, 1),
+    )
+    foreign: str = Field(..., description="Foreign applicant external ID", example="external-9-23")
+    resume: Optional[Resume] = Field(None, description="Applicant resume")
+    state: Optional[ApplicantResponseExternalStatus] = Field(
+        None,
+        description="Response state",
+        example=ApplicantResponseExternalStatus.TAKEN,
+    )
+    updated: datetime = Field(
+        ...,
+        description="Datetime of response creation/update on the career site",
+        example=datetime(1980, 1, 1, 1, 1, 1),
+    )
+
+
+class AccountVacancyExternal(BaseModel):
+    id: int = Field(..., description="Account vacancy external ID", example=1)
+    account_source: AccountSource = Field(..., description="Vacancy account source")
+    auth_type: str = Field(..., description="Authentication type", example="NATIVE")
+    name: str = Field(..., description="Account vacancy external name", example="HeadHunter")
+
+
+class VacancyExternal(BaseModel):
+    id: int = Field(..., description="Vacancy external ID", example=1)
+    account_vacancy_external: AccountVacancyExternal = Field(
+        ...,
+        description="Account vacancy external",
+    )
+    data: str = Field(
+        ...,
+        description="Additional data",
+        example="comment",
+    )
+    foreign: str = Field(..., description="Foreign vacancy external ID", example="12345")
+    state: Optional[VacancyExternalPublishStatus] = Field(
+        None,
+        description="Vacancy external publish status",
+        example=VacancyExternalPublishStatus.PUBLISHED,
+    )
+    vacancy: Vacancy = Field(..., description="Vacancy data")