Merge pull request #23 from huntflow/INT-663_fix_models

[INT-663] - Fix models.

Author: polina-koval

huntflow_webhook_models/base.py

@@ -29,6 +29,7 @@ class WebhookMetaInfoBase(BaseModel):
     version: str = Field(..., description="Webhook version", examples=["2.0"])
     retry: int = Field(..., description="Webhook retry count", examples=[1])
     event_id: str = Field(..., description="Event ID", examples=["1"])
+    domain: str = Field(..., description="Domain", examples=["huntflow.ai"])
 
 
 class BaseHuntflowWebhookRequest(BaseModel):

huntflow_webhook_models/common_models/applicant.py

@@ -4,7 +4,7 @@
 from pydantic import BaseModel, Field
 
 from huntflow_webhook_models.common_models.calendar_event import ApplicantLogCalendarEvent
-from huntflow_webhook_models.common_models.hf_base import AccountFile
+from huntflow_webhook_models.common_models.hf_base import AccountFile, VacancyQuotaItem
 from huntflow_webhook_models.common_models.survey_questionary import SurveyQuestionary
 from huntflow_webhook_models.common_models.vacancy import Vacancy
 from huntflow_webhook_models.consts import AgreementState, ApplicantLogType, SurveyType
@@ -37,13 +37,35 @@ class ApplicantPDAgreement(BaseModel):
 
 class VacancyApplicantStatus(BaseModel):
     id: int = Field(..., description="Status ID", examples=[1])
-    name: str = Field(..., description="Status name", examples=["hired"])
 
 
 class ApplicantPhoto(AccountFile):
     pass
 
 
+class ApplicantExternalAccountSource(BaseModel):
+    id: int = Field(..., description="Applicant external account source ID", examples=[1])
+    name: Optional[str] = Field(
+        ...,
+        description="Applicant external account source name",
+        examples=["Headhunter"],
+    )
+
+
+class ApplicantExternalAccount(BaseModel):
+    id: int = Field(..., description="External ID", examples=[1])
+    auth_type: str = Field(..., description="Authentication type", examples=["NATIVE"])
+    account_source: Optional[ApplicantExternalAccountSource] = Field(
+        None,
+        description="Applicant external account source",
+    )
+    updated: Optional[datetime] = Field(
+        None,
+        description="Date the applicant external account was modified",
+        examples=[datetime(1970, 1, 1, 1, 1, 1)],
+    )
+
+
 class Applicant(BaseModel):
     id: int = Field(..., description="Applicant ID", examples=[1])
     email: Optional[str] = Field(
@@ -81,6 +103,7 @@ class Applicant(BaseModel):
     phone: Optional[str] = Field(None, description="Applicant's phone", examples=["+99999999"])
     skype: Optional[str] = Field(None, description="Applicant's skype", examples=["test_skype"])
     photo: Optional[ApplicantPhoto] = Field(None, description="Applicant's photo")
+    has_photo: bool = Field(..., description="Does the applicant have a photo?", examples=[False])
     social: List[ApplicantSocial] = Field([], description="Applicant social media list")
     questionary: Optional[datetime] = Field(
         None,
@@ -96,6 +119,7 @@ class Applicant(BaseModel):
         description="Additional fields",
         examples=[{"favorite_language": "python"}],
     )
+    externals: Optional[List[ApplicantExternalAccount]] = None
 
 
 class Respondent(BaseModel):
@@ -191,6 +215,10 @@ class ApplicantLog(BaseModel):
         description="Calendar event data",
     )
     vacancy: Optional[Vacancy] = Field(None, description="Vacancy data")
+    hired_in_fill_quota: Optional[VacancyQuotaItem] = Field(
+        None,
+        description="Quota data by which applicant was hired",
+    )
 
 
 class ApplicantTag(BaseModel):

huntflow_webhook_models/common_models/hf_base.py

@@ -1,3 +1,4 @@
+from datetime import date, datetime
 from typing import Optional
 
 from pydantic import BaseModel, Field
@@ -29,3 +30,33 @@ class AccountSource(BaseModel):
     )
     name: str = Field(..., description="Applicant source name", examples=["Headhunter"])
     type: str = Field(..., description="Applicant source type", examples=["user"])
+
+
+class VacancyQuotaBase(BaseModel):
+    id: int = Field(..., description="Fill quota ID")
+    vacancy_frame: int = Field(..., description="Vacancy frame ID")
+    vacancy_request: Optional[int] = Field(None, description="Vacancy request ID")
+    created: datetime = Field(..., description="Date and time of creating a vacancy quota")
+    changed: Optional[datetime] = Field(
+        None,
+        description="Date and time of updating a vacancy quota",
+    )
+    applicants_to_hire: int = Field(
+        ...,
+        description="Number of applicants should be hired on the quota",
+    )
+    already_hired: int = Field(..., description="Number of applicants already hired on the quota")
+    deadline: Optional[date] = Field(None, description="Date when the quota should be filled")
+    closed: Optional[datetime] = Field(None, description="Date and time when the quota was closed")
+    work_days_in_work: Optional[int] = Field(
+        None,
+        description="How many working days the vacancy is in work",
+    )
+    work_days_after_deadline: Optional[int] = Field(
+        None,
+        description="How many working days the vacancy is in work after deadline",
+    )
+
+
+class VacancyQuotaItem(VacancyQuotaBase):
+    account_info: AccountInfo

huntflow_webhook_models/common_models/recruitment_evaluation.py

@@ -25,3 +25,4 @@ class RecruitmentEvaluation(BaseModel):
     stars: Optional[int] = Field(None, description="Evaluation level", examples=[10])
     applicant: Applicant = Field(..., description="Applicant data")
     vacancy: Vacancy = Field(..., description="Vacancy data")
+    applicant_log_id: int = Field(..., description="Applicant log ID")

huntflow_webhook_models/common_models/survey_answer.py

@@ -20,7 +20,7 @@ class SurveyAnswerRespondent(BaseModel):
 
 class SurveyAnswerRequest(BaseModel):
     id: int = Field(..., description="Recruitment evaluation request ID", examples=[1])
-    respondent: SurveyAnswerRespondent
+    respondent: Optional[SurveyAnswerRespondent] = None
     created: datetime = Field(
         ...,
         description="Date of creation",

huntflow_webhook_models/common_models/vacancy.py

@@ -95,6 +95,16 @@ class Vacancy(BaseModel):
     )
 
 
+class VacancyCloseReason(BaseModel):
+    id: int = Field(..., description="Vacancy close reason ID", examples=[1])
+    name: str = Field(..., description="Vacancy close reason name", examples=["All hired"])
+
+
+class VacancyHoldReason(BaseModel):
+    id: int = Field(..., description="Vacancy hold reason ID", examples=[1])
+    name: str = Field(..., description="Vacancy hold reason name", examples=["Cancel budget"])
+
+
 class VacancyLog(BaseModel):
     id: int = Field(..., description="Vacancy log ID", examples=[1])
     state: VacancyState = Field(
@@ -107,4 +117,13 @@ class VacancyLog(BaseModel):
         description="Date time the vacancy log created",
         examples=[datetime(1970, 1, 1, 1, 1, 1)],
     )
-    # TODO: Solve close reason field problem (field exists with another name)
+    close_reason: Optional[VacancyCloseReason] = Field(
+        None,
+        description="Vacancy close reason",
+        examples=[""],
+    )
+    hold_reason: Optional[VacancyHoldReason] = Field(
+        None,
+        description="Vacancy hold reason",
+        examples=[""],
+    )

pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "huntflow-webhook-models"
-version = "0.1.7"
+version = "0.1.8"
 description = "Huntflow webhooks requests data models"
 authors = [
     {name = "Developers huntflow", email = "[email protected]"},