Merge branch 'v2' into INT-950

KlochkovHF · web-flow · commit a72e831f8041 · 2025-04-14T16:03:12.000+03:00
diff --git a/.github/workflows/autorelease.yml b/.github/workflows/autorelease.yml
@@ -18,6 +18,9 @@ jobs:
           python-version: 3.8
       - name: Set up PDM
         uses: pdm-project/setup-pdm@v3
+        with:
+          python-version: 3.8
+          version: 2.20.1
 
       - name: Install dependencies
         run: pdm install -dG release
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -13,6 +13,8 @@ jobs:
       - uses: actions/checkout@v3
       - name: Set up PDM
         uses: pdm-project/setup-pdm@v3
+        with:
+          version: 2.20.1
 
       - name: Publish package distributions to PyPI
         run: pdm publish
diff --git a/.github/workflows/python-linters.yml b/.github/workflows/python-linters.yml
@@ -18,6 +18,7 @@ jobs:
         uses: pdm-project/setup-pdm@v3
         with:
           python-version: ${{ matrix.python-version }}
+          version: 2.20.1
 
       - name: Install dependencies
         run: |
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
@@ -19,6 +19,7 @@ jobs:
         uses: pdm-project/setup-pdm@v3
         with:
           python-version: ${{ matrix.python-version }}
+          version: 2.20.1
 
       - name: Install dependencies
         run: |
diff --git a/huntflow_api_client/entities/__init__.py b/huntflow_api_client/entities/__init__.py
@@ -21,6 +21,7 @@
 from huntflow_api_client.entities.regions import Region
 from huntflow_api_client.entities.rejection_reason import RejectionReason
 from huntflow_api_client.entities.resume import Resume
+from huntflow_api_client.entities.survey_type_a import SurveyTypeA
 from huntflow_api_client.entities.survey_type_q import SurveyTypeQ
 from huntflow_api_client.entities.tags import AccountTag, ApplicantTag
 from huntflow_api_client.entities.user_settings import UserSettings
@@ -56,11 +57,12 @@
     "Region",
     "RejectionReason",
     "Resume",
+    "SurveyTypeA",
+    "SurveyTypeQ",
     "User",
     "UsersManagement",
     "UserSettings",
     "Vacancy",
     "VacancyRequest",
     "Webhook",
-    "SurveyTypeQ",
 )
diff --git a/huntflow_api_client/entities/organization_settings.py b/huntflow_api_client/entities/organization_settings.py
@@ -1,4 +1,5 @@
 from huntflow_api_client.entities.base import BaseEntity
+from huntflow_api_client.models.response.interview_types import InterviewTypesListResponse
 from huntflow_api_client.models.response.organization_settings import (
     BaseSurveySchemaTypeWithSchemas,
     CloseReasonsListResponse,
@@ -53,3 +54,15 @@ async def get_applicant_survey_form(
             f"/accounts/{account_id}/surveys/type_a/{survey_id}",
         )
         return BaseSurveySchemaTypeWithSchemas.model_validate(response.json())
+
+    async def get_interview_types(self, account_id: int) -> InterviewTypesListResponse:
+        """
+        API method reference
+           https://api.huntflow.ai/v2/docs#get-/accounts/-account_id-/interview_types
+
+        :param account_id: Organization ID
+
+        :return: List of interview types
+        """
+        response = await self._api.request("GET", f"/accounts/{account_id}/interview_types")
+        return InterviewTypesListResponse.model_validate(response.json())
diff --git a/huntflow_api_client/entities/survey_type_a.py b/huntflow_api_client/entities/survey_type_a.py
@@ -0,0 +1,65 @@
+from huntflow_api_client.entities.base import BaseEntity, GetEntityMixin, ListEntityMixin
+from huntflow_api_client.models.response.survey import (
+    SurveyAnswerTypeAResponse,
+    SurveySchemasTypeAListResponse,
+    SurveySchemaTypeAResponse,
+)
+
+
+class SurveyTypeA(BaseEntity, GetEntityMixin, ListEntityMixin):
+    async def list(
+        self,
+        account_id: int,
+        active: bool = True,
+    ) -> SurveySchemasTypeAListResponse:
+        """
+        API method reference
+            https://api.huntflow.ai/v2/docs#get-/accounts/-account_id-/surveys/type_a
+
+        :param account_id: Organization ID
+        :param active: Shows only active schemas
+        :return: List of all applicant feedback forms in organization.
+        """
+        params = {"active": active}
+        response = await self._api.request(
+            "GET",
+            f"/accounts/{account_id}/surveys/type_a",
+            params=params,
+        )
+        return SurveySchemasTypeAListResponse.model_validate(response.json())
+
+    async def get(self, account_id: int, survey_id: int) -> SurveySchemaTypeAResponse:
+        """
+        API method reference
+            https://api.huntflow.ai/v2/docs#get-/accounts/-account_id-/surveys/type_a/-survey_id-
+
+        :param account_id: Organization ID
+        :param survey_id: Survey ID
+        :return: An applicant feedback forms in organization.
+        """
+        response = await self._api.request(
+            "GET",
+            f"/accounts/{account_id}/surveys/type_a/{survey_id}",
+        )
+        return SurveySchemaTypeAResponse.model_validate(response.json())
+
+    async def get_applicant_answer(
+        self,
+        account_id: int,
+        survey_id: int,
+        answer_id: int,
+    ) -> SurveyAnswerTypeAResponse:
+        """
+        API method reference
+            https://api.huntflow.ai/v2/docs#get-/accounts/-account_id-/surveys/type_a/-survey_id-/answers/-answer_id-
+
+        :param account_id: Organization ID
+        :param survey_id: Survey ID
+        :param answer_id: Answer ID
+        :return: Returns answer of applicant feedback form.
+        """
+        response = await self._api.request(
+            "GET",
+            f"/accounts/{account_id}/surveys/type_a/{survey_id}/answers/{answer_id}",
+        )
+        return SurveyAnswerTypeAResponse.model_validate(response.json())
diff --git a/huntflow_api_client/entities/users_management.py b/huntflow_api_client/entities/users_management.py
@@ -1,6 +1,7 @@
-from typing import Any, Dict, Optional
+from typing import Any, Dict, List, Optional
 
 from huntflow_api_client.entities.base import BaseEntity
+from huntflow_api_client.models.consts import MemberType
 from huntflow_api_client.models.request.users_management import ForeignUserRequest
 from huntflow_api_client.models.response.users_management import (
     CreatedUserControlTaskResponse,
@@ -15,6 +16,7 @@ class UsersManagement(BaseEntity):
     async def get_users_with_foreign(
         self,
         account_id: int,
+        member_types: Optional[List[MemberType]] = None,
         count: Optional[int] = 30,
         page: Optional[int] = 1,
     ) -> ForeignUsersListResponse:
@@ -23,6 +25,7 @@ async def get_users_with_foreign(
             https://api.huntflow.ai/v2/docs#get-/accounts/-account_id-/users/foreign
 
         :param account_id: Organization ID
+        :param member_types: Array of member types
         :param count: Number of items per page
         :param page: Page number
 
@@ -32,6 +35,8 @@ async def get_users_with_foreign(
             All identifiers in response are foreign.
         """
         params: Dict[str, Any] = {"count": count, "page": page}
+        if member_types:
+            params["member_types"] = [member_type.value for member_type in member_types]
         response = await self._api.request(
             "GET",
             f"/accounts/{account_id}/users/foreign",
diff --git a/huntflow_api_client/entities/webhooks.py b/huntflow_api_client/entities/webhooks.py
@@ -1,23 +1,35 @@
+from typing import Any, Dict, Optional
+
 from huntflow_api_client.entities.base import (
     BaseEntity,
     CreateEntityMixin,
     DeleteEntityMixin,
     ListEntityMixin,
 )
+from huntflow_api_client.models.consts import WebhookType
 from huntflow_api_client.models.request.webhooks import WebhookRequest
 from huntflow_api_client.models.response.webhooks import WebhookResponse, WebhooksListResponse
 
 
 class Webhook(BaseEntity, ListEntityMixin, CreateEntityMixin, DeleteEntityMixin):
-    async def list(self, account_id: int) -> WebhooksListResponse:
+    async def list(
+        self,
+        account_id: int,
+        webhook_type: Optional[WebhookType] = None,
+    ) -> WebhooksListResponse:
         """
         API method reference https://api.huntflow.ai/v2/docs#get-/accounts/-account_id-/hooks
 
         :param account_id: Organization ID
+        :param webhook_type: Webhook type. If no value provided, webhooks of all types will be
+            returned.
         :return: List of webhooks
         """
         path = f"/accounts/{account_id}/hooks"
-        response = await self._api.request("GET", path)
+        params: Dict[str, Any] = {}
+        if webhook_type:
+            params["webhook_type"] = webhook_type.value
+        response = await self._api.request("GET", path, params=params)
         return WebhooksListResponse.model_validate(response.json())
 
     async def create(self, account_id: int, data: WebhookRequest) -> WebhookResponse:
diff --git a/huntflow_api_client/models/consts.py b/huntflow_api_client/models/consts.py
@@ -7,6 +7,13 @@ class WebhookEvent(str, Enum):
     RESPONSE = "RESPONSE"
     OFFER = "OFFER"
     VACANCY_REQUEST = "VACANCY-REQUEST"
+    RECRUITMENT_EVALUATION = "RECRUITMENT-EVALUATION"
+    SURVEY_QUESTIONARY = "SURVEY-QUESTIONARY"
+
+
+class WebhookType(str, Enum):
+    USER = "USER"
+    APPLICATION = "APPLICATION"
 
 
 class MemberType(str, Enum):
@@ -154,6 +161,7 @@ class ActionLogType(str, Enum):
     VACANCY_EXTERNAL = "VACANCY_EXTERNAL"
     ACCOUNT_MEMBER = "ACCOUNT_MEMBER"
     DOWNLOAD_APPLICANTS = "DOWNLOAD_APPLICANTS"
+    PASSWORD_CHANGE = "PASSWORD_CHANGE"
 
 
 class SurveyType(str, Enum):
@@ -172,7 +180,6 @@ class UserControlTaskStatus(str, Enum):
     SUCCESS = "SUCCESS"
     FAILED = "FAILED"
 
-
 class RecommendationProcessingStatus(str, Enum):
     ALL = "ALL"
     PROCESSED = "PROCESSED"
@@ -183,3 +190,8 @@ class RecommendationStatus(str, Enum):
     TAKEN = "TAKEN"
     TAKEN_OTHER = "TAKEN_OTHER"
     DECLINED = "DECLINED"
+
+    
+class InterviewType(str, Enum):
+    USER = "user"
+    INTERVIEW = "interview"
diff --git a/huntflow_api_client/models/request/webhooks.py b/huntflow_api_client/models/request/webhooks.py
@@ -3,11 +3,12 @@
 from pydantic import Field
 
 from huntflow_api_client.models.common import JsonRequestModel
-from huntflow_api_client.models.consts import WebhookEvent
+from huntflow_api_client.models.consts import WebhookEvent, WebhookType
 
 
 class WebhookRequest(JsonRequestModel):
     secret: str = Field(..., description="Secret key")
     url: str = Field(..., description="Webhook URL")
     active: bool = Field(..., description="Webhook activity flag")
     webhook_events: List[WebhookEvent] = Field(..., description="List of webhook events")
+    type: WebhookType = Field(default=WebhookType.USER, description="Webhook type")
diff --git a/huntflow_api_client/models/response/delayed_tasks.py b/huntflow_api_client/models/response/delayed_tasks.py
@@ -38,3 +38,4 @@ class DelayedTaskResponse(BaseModel):
         description="Date and time of the last task update (ISO 8601)",
     )
     states_log: t.List[TaskLog] = Field(..., description="Task change log")
+    result: t.Optional[t.Dict] = Field(None, description="Task execution result")
diff --git a/huntflow_api_client/models/response/interview_types.py b/huntflow_api_client/models/response/interview_types.py
@@ -0,0 +1,21 @@
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from huntflow_api_client.models.consts import InterviewType as InterviewTypeEnum
+
+
+class InterviewType(BaseModel):
+    id: int = Field(..., description="Interview type ID", examples=[20])
+    name: str = Field(..., description="Interview type name", examples=["Phone interview"])
+    account: int = Field(..., description="Organization ID", examples=[42])
+    order: int = Field(..., description="Order number")
+    type: InterviewTypeEnum = Field(
+        ...,
+        description="Type of the interview",
+        examples=[InterviewTypeEnum.USER],
+    )
+
+
+class InterviewTypesListResponse(BaseModel):
+    items: List[InterviewType]
diff --git a/huntflow_api_client/models/response/survey.py b/huntflow_api_client/models/response/survey.py
@@ -65,3 +65,28 @@ class SurveyQuestionaryAnswerResponse(BaseModel):
     respondent: SurveyQuestionaryRespondentWithName
     survey_questionary: SurveyQuestionaryCreatedInfo
     data: dict = Field(..., description="Answer data")
+
+
+class SurveySchemasTypeAListResponse(BaseModel):
+    items: List[BaseSurveySchemaType] = Field(..., description="List of type a survey schemas")
+
+
+class SurveySchemaTypeAResponse(BaseSurveySchemaTypeWithSchemas):
+    type: SurveyType = Field(
+        SurveyType.TYPE_A,
+        description="Type of survey",
+        frozen=True,
+    )
+
+
+class SurveyTypeARespondent(BaseModel):
+    account_id: int = Field(..., description="Account ID")
+    name: str = Field(..., description="Name of the user who created the survey answer")
+
+
+class SurveyAnswerTypeAResponse(BaseModel):
+    id: int = Field(..., description="Survey answer of type A ID")
+    created: datetime.datetime = Field(..., description="Date and time of creating an answer")
+    survey: SurveySchemaTypeAResponse = Field(..., description="Survey schema")
+    respondent: SurveyTypeARespondent = Field(..., description="Who created the survey answer")
+    data: dict = Field(..., description="Answer data")
diff --git a/huntflow_api_client/models/response/webhooks.py b/huntflow_api_client/models/response/webhooks.py
@@ -3,7 +3,7 @@
 
 from pydantic import AnyHttpUrl, BaseModel, Field, PositiveInt
 
-from huntflow_api_client.models.consts import WebhookEvent
+from huntflow_api_client.models.consts import WebhookEvent, WebhookType
 
 
 class WebhookResponse(BaseModel):
@@ -13,6 +13,7 @@ class WebhookResponse(BaseModel):
     created: datetime = Field(..., description="Date and time of creating a webhook")
     active: bool = Field(..., description="Webhook activity flag")
     webhook_events: List[WebhookEvent] = Field(..., description="List of webhook events")
+    type: WebhookType = Field(..., description="Webhook type")
 
 
 class WebhooksListResponse(BaseModel):
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 
 [project]
 name = "huntflow-api-client"
-version = "0.1.4"
+version = "2.6.0"
 description = "Huntflow API Client for Python"
 authors = [
     {name = "Developers huntflow", email = "developer@huntflow.ru"},
diff --git a/tests/test_entities/test_organization_settings.py b/tests/test_entities/test_organization_settings.py
@@ -4,6 +4,7 @@
 
 from huntflow_api_client import HuntflowAPI
 from huntflow_api_client.entities.organization_settings import OrganizationSettings
+from huntflow_api_client.models.response.interview_types import InterviewTypesListResponse
 from huntflow_api_client.models.response.organization_settings import (
     BaseSurveySchemaTypeWithSchemas,
     CloseReasonsListResponse,
@@ -27,6 +28,17 @@
     "schema": {},
     "ui_schema": {},
 }
+INTERVIEW_TYPES_RESPONSE: Dict[str, Any] = {
+    "items": [
+        {
+            "id": 20,
+            "name": "Phone interview",
+            "account": 42,
+            "order": 0,
+            "type": "user",
+        },
+    ],
+}
 
 
 async def test_get_hold_reasons(
@@ -72,3 +84,18 @@ async def test_get_applicant_survey_form(
 
     response = await settings.get_applicant_survey_form(ACCOUNT_ID, SURVEY_ID)
     assert response == BaseSurveySchemaTypeWithSchemas(**SURVEY_FORM_RESPONSE)
+
+
+async def test_get_interview_types(
+    httpx_mock: HTTPXMock,
+    token_proxy: HuntflowTokenProxy,
+) -> None:
+    httpx_mock.add_response(
+        url=f"{VERSIONED_BASE_URL}/accounts/{ACCOUNT_ID}/interview_types",
+        json=INTERVIEW_TYPES_RESPONSE,
+    )
+    api_client = HuntflowAPI(BASE_URL, token_proxy=token_proxy)
+    settings = OrganizationSettings(api_client)
+
+    response = await settings.get_interview_types(ACCOUNT_ID)
+    assert response == InterviewTypesListResponse(**INTERVIEW_TYPES_RESPONSE)
diff --git a/tests/test_entities/test_survey_type_a.py b/tests/test_entities/test_survey_type_a.py
diff --git a/tests/test_entities/test_users_management.py b/tests/test_entities/test_users_management.py
diff --git a/tests/test_entities/test_webhooks.py b/tests/test_entities/test_webhooks.py
