brynq-sdk-recruitee 3.0.1__py3-none-any.whl

brynq_sdk_recruitee/__init__.py

@@ -0,0 +1,66 @@
+"""
+Recruitee SDK for Python
+~~~~~~~~~~~~~~~~~~~~~~~
+
+A Python SDK for interacting with the Recruitee API.
+
+This SDK provides a clean, modular interface to the Recruitee API with specialized
+modules for different aspects of the API (candidates, offers, organization, etc.).
+"""
+
+from typing import Dict, Any
+import requests
+from .recruitee import Recruitee
+from .candidates import Candidates
+from .offers import Offers
+from .organization import Organization
+from .vacancies import Vacancies
+from .applicants import Applicants
+
+__version__ = '1.0.0'
+__author__ = 'BrynQ'
+__license__ = 'BrynQ License'
+
+class RecruiteeError(Exception):
+    """Base exception for Recruitee SDK errors."""
+    pass
+
+class RecruiteeAuthError(RecruiteeError):
+    """Raised when there are authentication issues."""
+    pass
+
+class RecruiteeConfigError(RecruiteeError):
+    """Raised when there are configuration issues."""
+    pass
+
+def validate_credentials(credentials: Dict[str, Any]) -> None:
+    """
+    Validate the credentials dictionary has required fields.
+    
+    Args:
+        credentials: Dictionary containing credentials
+        
+    Raises:
+        RecruiteeConfigError: If required credentials are missing
+    """
+    required_fields = ['company_id', 'token']
+    missing_fields = [field for field in required_fields if field not in credentials]
+    
+    if missing_fields:
+        raise RecruiteeConfigError(
+            f"Missing required credentials: {', '.join(missing_fields)}"
+        )
+
+# Export all classes
+__all__ = [
+    'Recruitee',
+    'Candidates',
+    'Offers',
+    'Organization',
+    'Vacancies',
+    'Applicants',
+    'RecruiteeError',
+    'RecruiteeAuthError',
+    'RecruiteeConfigError',
+    'validate_credentials'
+]

brynq_sdk_recruitee/applicants.py

@@ -0,0 +1,74 @@
+"""
+Applicants API module for Recruitee.
+"""
+from typing import Dict, Optional, List, Union
+import requests
+
+
+class Applicants:
+    """
+    Class for interacting with Recruitee applicants API.
+    
+    This class provides methods for creating, updating, and managing applicants in Recruitee.
+    """
+    def __init__(self, recruitee_client):
+        """
+        Initialize the Applicants API client.
+        
+        Args:
+            recruitee_client: An instance of the Recruitee client
+        """
+        self.client = recruitee_client
+
+    def get_applicants(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get all applicants from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get_candidates(filters=filters)
+    
+    def get_applicant(self, candidate_id: str) -> requests.Response:
+        """
+        Get a specific applicant from Recruitee.
+        
+        Args:
+            candidate_id: The ID of the candidate
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get_candidate(candidate_id=candidate_id)
+    
+    def update_applicant_tags(self, candidate_ids: List[str], tags: List[str]) -> requests.Response:
+        """
+        Update tags for multiple applicants.
+        
+        Args:
+            candidate_ids: List of candidate IDs
+            tags: List of tags to add
+            
+        Returns:
+            Response from the API
+        """
+        data = {
+            "candidates": candidate_ids,
+            "tags": tags
+        }
+        return self.client.patch_bulk_candidates_tags(data=data)
+    
+    def get_applicant_mailbox(self, candidate_id: str) -> requests.Response:
+        """
+        Get the mailbox for a specific applicant.
+        
+        Args:
+            candidate_id: The ID of the candidate
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get_mailbox(candidate_id=candidate_id)

brynq_sdk_recruitee/candidates.py

@@ -0,0 +1,123 @@
+"""
+Candidates API module for Recruitee.
+"""
+from typing import Dict, Optional, List, Union
+import requests
+
+
+class Candidates:
+    """
+    Class for interacting with Recruitee candidates API.
+    
+    This class provides methods for managing candidates in Recruitee.
+    """
+    def __init__(self, recruitee_client):
+        """
+        Initialize the Candidates API client.
+        
+        Args:
+            recruitee_client: An instance of the Recruitee client
+        """
+        self.client = recruitee_client
+
+    def get_candidates(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get all candidates from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint="candidates",
+            params=filters
+        )
+    
+    def get_candidate(self, candidate_id: str) -> requests.Response:
+        """
+        Get a specific candidate from Recruitee.
+        
+        Args:
+            candidate_id: The ID of the candidate
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint=f"candidates/{candidate_id}"
+        )
+    
+    def get_candidate_details(self, candidate_id: str) -> requests.Response:
+        """
+        Get detailed information about a specific candidate from Recruitee.
+        This is an alias for get_candidate for backward compatibility.
+        
+        Args:
+            candidate_id: The ID of the candidate
+            
+        Returns:
+            Response from the API
+        """
+        return self.get_candidate(candidate_id)
+    
+    def patch_bulk_candidates_tags(self, data: Dict) -> requests.Response:
+        """
+        Update tags for multiple candidates.
+        
+        Args:
+            data: Dictionary containing candidates and tags
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.patch(
+            endpoint="bulk/candidates/tags",
+            json=data
+        )
+    
+    def update_candidate_tags(self, candidate_ids: List[str], tags: List[str]) -> requests.Response:
+        """
+        Update tags for multiple candidates.
+        
+        Args:
+            candidate_ids: List of candidate IDs
+            tags: List of tags to add
+            
+        Returns:
+            Response from the API
+        """
+        data = {
+            "candidates": candidate_ids,
+            "tags": tags
+        }
+        return self.patch_bulk_candidates_tags(data)
+    
+    def update_rehire_tags(self, candidate_ids: List[str], tags: List[str]) -> requests.Response:
+        """
+        Update rehire-related tags for multiple candidates.
+        This is an alias for update_candidate_tags for backward compatibility.
+        
+        Args:
+            candidate_ids: List of candidate IDs
+            tags: List of tags to add
+            
+        Returns:
+            Response from the API
+        """
+        return self.update_candidate_tags(candidate_ids, tags)
+    
+    def get_mailbox(self, candidate_id: str) -> requests.Response:
+        """
+        Get the mailbox for a specific candidate.
+        
+        Args:
+            candidate_id: The ID of the candidate
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint=f"mailbox/candidate/{candidate_id}"
+        ) 

brynq_sdk_recruitee/offers.py

@@ -0,0 +1,191 @@
+"""
+Offers API module for Recruitee.
+"""
+from typing import Dict, Optional, List, Union
+import requests
+
+
+class Offers:
+    """
+    Class for interacting with Recruitee offers API.
+    
+    This class provides methods for managing offers in Recruitee.
+    """
+    def __init__(self, recruitee_client):
+        """
+        Initialize the Offers API client.
+        
+        Args:
+            recruitee_client: An instance of the Recruitee client
+        """
+        self.client = recruitee_client
+
+    def get_offers(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get all offers from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint="offers",
+            params=filters
+        )
+    
+    def get_offer(self, offer_id: str, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get a specific offer from Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint=f"offers/{offer_id}",
+            params=filters
+        )
+    
+    def create_offer(self, title: str, description: str, **kwargs) -> requests.Response:
+        """
+        Create a new offer in Recruitee.
+        
+        Args:
+            title: The title of the offer
+            description: The description of the offer
+            **kwargs: Additional offer attributes (recruiter_id, hiring_manager_id, etc.)
+            
+        Returns:
+            Response from the API
+        """
+        data = {
+            'offer': {
+                'title': title,
+                'description': description,
+                **kwargs
+            }
+        }
+        return self.post_offer(data)
+    
+    def update_offer(self, offer_id: str, data: Dict) -> requests.Response:
+        """
+        Update an existing offer in Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            data: The data to update
+            
+        Returns:
+            Response from the API
+        """
+        return self.patch_offer(offer_id, data)
+    
+    def post_offer(self, data: Dict) -> requests.Response:
+        """
+        Create a new offer in Recruitee.
+        
+        Args:
+            data: The offer data
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.post(
+            endpoint="offers",
+            json=data
+        )
+    
+    def patch_offer(self, offer_id: str, data: Dict) -> requests.Response:
+        """
+        Update an existing offer in Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            data: The data to update
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.patch(
+            endpoint=f"offers/{offer_id}",
+            json=data
+        )
+    
+    def delete_offer(self, offer_id: str) -> requests.Response:
+        """
+        Delete an offer from Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.delete(
+            endpoint=f"offers/{offer_id}"
+        )
+    
+    def patch_offer_slug(self, offer_id: str, data: Dict) -> requests.Response:
+        """
+        Update an offer's slug in Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            data: The data to update
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.patch(
+            endpoint=f"offers/{offer_id}/change_slug",
+            json=data
+        )
+    
+    def post_add_offer_tag(self, offer_id: str, data: Dict) -> requests.Response:
+        """
+        Add a tag to an offer.
+        
+        Args:
+            offer_id: The ID of the offer
+            data: The tag data
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.post(
+            endpoint=f"offers/{offer_id}/offer_tags",
+            json=data
+        )
+    
+    def patch_publish_offer(self, offer_id: str) -> requests.Response:
+        """
+        Publish an offer.
+        
+        Args:
+            offer_id: The ID of the offer
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.patch(
+            endpoint=f"offers/{offer_id}/publish"
+        )
+    
+    def patch_unpublish_offer(self, offer_id: str) -> requests.Response:
+        """
+        Unpublish an offer.
+        
+        Args:
+            offer_id: The ID of the offer
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.patch(
+            endpoint=f"offers/{offer_id}/unpublish"
+        ) 

brynq_sdk_recruitee/organization.py

@@ -0,0 +1,86 @@
+"""
+Organization API module for Recruitee.
+"""
+from typing import Dict, Optional, List, Union
+import requests
+
+
+class Organization:
+    """
+    Class for interacting with Recruitee organization API.
+    
+    This class provides methods for managing organization entities in Recruitee,
+    including locations, departments, and companies.
+    """
+    def __init__(self, recruitee_client):
+        """
+        Initialize the Organization API client.
+        
+        Args:
+            recruitee_client: An instance of the Recruitee client
+        """
+        self.client = recruitee_client
+
+    # Locations methods
+    def get_locations(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get locations data from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint="locations",
+            params=filters
+        )
+    
+    # Departments methods
+    def get_departments(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get departments data from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint="departments",
+            params=filters
+        )
+    
+    # Companies methods
+    def get_companies(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get companies data from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint="",
+            params=filters
+        )
+    
+    # Memberships methods
+    def get_memberships(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get memberships data from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.client.get(
+            endpoint="memberships",
+            params=filters
+        ) 

brynq_sdk_recruitee/recruitee.py

@@ -0,0 +1,100 @@
+"""
+Core Recruitee API client.
+"""
+
+import requests
+from typing import Union, List, Dict, Any, Optional, Literal
+from brynq_sdk_brynq import BrynQ
+
+
+class Recruitee(BrynQ):
+    """
+    Core client for interacting with the Recruitee API.
+
+    This is the base client that provides low-level access to the Recruitee API.
+    For specific API endpoints, use the specialized classes like Candidates, Offers, and Organization.
+
+    Args:
+        label: Label or list of labels for credentials
+        api_type: Type of API to use (default: "API")
+    """
+    def __init__(self, system_type: Optional[Literal['source', 'target']] = None):
+        super().__init__()
+        self.timeout = 3600
+        credentials = self.interfaces.credentials.get(system="recruitee", system_type=system_type)
+        credentials = credentials.get('data')
+        self.base_url = f'https://api.recruitee.com/c/{credentials["company_id"]}/'
+        self.headers = {
+            "Authorization": f"Bearer {credentials['token']}",
+            "Content-Type": "application/json",
+            "x-recruitee-partner-name": "brynq",
+            "x-recruitee-partner-id": "86bza977z"
+        }
+
+    def get(self, endpoint: str, params: Optional[Dict] = None) -> requests.Response:
+        """
+        Make a GET request to the Recruitee API.
+
+        Args:
+            endpoint: API endpoint to call
+            params: Optional parameters to include in the request
+
+        Returns:
+            Response from the API
+        """
+        url = f"{self.base_url}{endpoint}"
+        response = requests.get(url=url,
+                                headers=self.headers,
+                                params=params,
+                                timeout=self.timeout)
+        response.raise_for_status()
+        return response
+
+    def post(self, endpoint: str, json: Optional[Dict] = None) -> requests.Response:
+        """
+        Make a POST request to the Recruitee API.
+
+        Args:
+            endpoint: API endpoint to call
+            json: Optional JSON data to include in the request
+
+        Returns:
+            Response from the API
+        """
+        url = f"{self.base_url}{endpoint}"
+        return requests.post(url=url,
+                             headers=self.headers,
+                             json=json,
+                             timeout=self.timeout)
+
+    def patch(self, endpoint: str, json: Optional[Dict] = None) -> requests.Response:
+        """
+        Make a PATCH request to the Recruitee API.
+
+        Args:
+            endpoint: API endpoint to call
+            json: Optional JSON data to include in the request
+
+        Returns:
+            Response from the API
+        """
+        url = f"{self.base_url}{endpoint}"
+        return requests.patch(url=url,
+                              headers=self.headers,
+                              json=json,
+                              timeout=self.timeout)
+
+    def delete(self, endpoint: str) -> requests.Response:
+        """
+        Make a DELETE request to the Recruitee API.
+
+        Args:
+            endpoint: API endpoint to call
+
+        Returns:
+            Response from the API
+        """
+        url = f"{self.base_url}{endpoint}"
+        return requests.delete(url=url,
+                               headers=self.headers,
+                               timeout=self.timeout)

brynq_sdk_recruitee/vacancies.py

@@ -0,0 +1,89 @@
+"""
+Vacancies API module for Recruitee.
+"""
+from typing import Dict, Optional, List, Union
+import requests
+
+from .offers import Offers
+
+
+class Vacancies:
+    """
+    Class for interacting with Recruitee vacancies API.
+    
+    This class provides methods for creating, updating, and managing vacancies in Recruitee.
+    Operations are delegated to the Offers class for actual API interactions.
+    """
+    def __init__(self, recruitee_client):
+        """
+        Initialize the Vacancies API client.
+        
+        Args:
+            recruitee_client: An instance of the Recruitee client
+        """
+        self.client = recruitee_client
+        self.offers = Offers(recruitee_client)
+
+    def create_vacancy(self, title: str, description: str, **kwargs) -> requests.Response:
+        """
+        Create a new vacancy in Recruitee.
+        
+        Args:
+            title: The title of the vacancy
+            description: The description of the vacancy
+            **kwargs: Additional vacancy attributes (recruiter_id, hiring_manager_id, etc.)
+            
+        Returns:
+            Response from the API
+        """
+        return self.offers.create_offer(title=title, description=description, **kwargs)
+    
+    def update_vacancy(self, offer_id: str, data: Dict) -> requests.Response:
+        """
+        Update an existing vacancy in Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            data: The data to update
+            
+        Returns:
+            Response from the API
+        """
+        return self.offers.update_offer(offer_id=offer_id, data=data)
+    
+    def delete_vacancy(self, offer_id: str) -> requests.Response:
+        """
+        Delete a vacancy from Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            
+        Returns:
+            Response from the API
+        """
+        return self.offers.delete_offer(offer_id=offer_id)
+    
+    def get_vacancies(self, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get all vacancies from Recruitee.
+        
+        Args:
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.offers.get_offers(filters=filters)
+    
+    def get_vacancy(self, offer_id: str, filters: Optional[Dict] = None) -> requests.Response:
+        """
+        Get a specific vacancy from Recruitee.
+        
+        Args:
+            offer_id: The ID of the offer
+            filters: Optional filters to apply
+            
+        Returns:
+            Response from the API
+        """
+        return self.offers.get_offer(offer_id=offer_id, filters=filters)

brynq_sdk_recruitee-3.0.1.dist-info/METADATA

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: brynq_sdk_recruitee
+Version: 3.0.1
+Summary: Recruitee API SDK from BrynQ
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Requires-Dist: brynq-sdk-brynq<5,>=4
+Requires-Dist: requests<3.0.0,>=2.31.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+A Python SDK for interacting with the Recruitee API

brynq_sdk_recruitee-3.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+brynq_sdk_recruitee/__init__.py,sha256=YhA2FLHZrDhkk98QEFjJhYdQByAfi947c-iEYx4oXQY,1728
+brynq_sdk_recruitee/applicants.py,sha256=5-XbCWN-HOJyrK8XtYtSnN955w9JU_2W5VMa2My5xzk,2102
+brynq_sdk_recruitee/candidates.py,sha256=ExqhxMHQ4J3YBucFd_zmsx0_htiludUCr3hooJMmLwI,3506
+brynq_sdk_recruitee/offers.py,sha256=oMB07DIZwiBK_jtELGTqBBSPgzlOEEgozZfKAJ3yxC0,5014
+brynq_sdk_recruitee/organization.py,sha256=ffWGpF9v3qWFrnqiyNVJ0FkK-HbG142XKtpKZo-Lzu0,2251
+brynq_sdk_recruitee/recruitee.py,sha256=iwIdQ4SEqEldwRBQ3GMCxaAxSKPzfdXjuvCgmSnFm6g,3349
+brynq_sdk_recruitee/vacancies.py,sha256=GYxQNa1DT7_E5ECqKhCBTrwX-yVM6a9twBf1DuI5gLg,2691
+brynq_sdk_recruitee-3.0.1.dist-info/METADATA,sha256=wBFCh7wunX8KlA5vitkptkvvtTU2usGY9DyW7Jy-21s,415
+brynq_sdk_recruitee-3.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+brynq_sdk_recruitee-3.0.1.dist-info/top_level.txt,sha256=vysAfrxoCaxhNaGPMZL-kF-CAyio2mEZGo6GQVK8QZ8,20
+brynq_sdk_recruitee-3.0.1.dist-info/RECORD,,

brynq_sdk_recruitee-3.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

brynq_sdk_recruitee-3.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+brynq_sdk_recruitee