brynq-sdk-vplan 1.0.1__tar.gz → 1.2.0__tar.gz

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_vplan
-Version: 1.0.1
+Version: 1.2.0
 Summary: vPlan wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/brynq_sdk_vplan/__init__.py

@@ -8,6 +8,7 @@ from .project import Project
 from .resource import Resource
 from .time_tracking import TimeTracking
 from .user import User
+from .leave import Leave
 
 
 class VPlan(BrynQ):
@@ -27,6 +28,7 @@ class VPlan(BrynQ):
         self.resource = Resource(self)
         self.time_tracking = TimeTracking(self)
         self.user = User(self)
+        self.leave = Leave(self)
 
     def _get_credentials(self, label) -> dict:
         """

brynq_sdk_vplan-1.2.0/brynq_sdk_vplan/leave.py

@@ -0,0 +1,110 @@
+import requests
+from typing import Union, List, Any
+import warnings
+import json
+from .get_data import GetData
+
+
+class Leave:
+    def __init__(self, vplan):
+        """
+        Initialize the GetData class.
+        Args: vplan: contains the vplan object with the headers and base_url
+        """
+        self.vplan = vplan
+        self.get_data = GetData(vplan)
+
+    def get_leave(self, resource_id: str) -> requests.Response:
+        """
+        There is no documentation for this method available
+
+        This method constructs a request URL based on the endpoint and sends a GET request
+        to the vPlan API.
+
+        Args: resource_id (str): The id of the resource to get the leave from
+
+        Returns: requests.Response: The response from the vPlan API.
+        """
+        url = f"{self.vplan.base_url}resource/{resource_id}/schedule_deviation"
+        response = requests.request('GET', url, headers=self.vplan.headers)
+        return response
+
+    def post_leave(self, resource_id: str, data: dict) -> requests.Response:
+        """
+        There is no documentation for this method available
+
+        This method constructs a request URL based on the endpoint and sends a POST request
+        to the vPlan API with the provided data.
+
+        Args:   resource_id (str): The resource id of the employee to add the leave to
+                data (dict): The data to create the new order with.
+
+        Returns: requests.Response: The response from the vPlan API.
+        """
+        required_fields = ['type', 'time', 'description', 'start_date', 'end_date']
+        allowed_fields = []
+        self.__check_fields(data=data, required_fields=required_fields, allowed_fields=allowed_fields)
+
+        url = f"{self.vplan.base_url}resource/{resource_id}/schedule_deviation"
+        base_body = json.dumps({
+            "type": data['type'],
+            "time": data['time'],
+            "description": data['description'],
+            "start_date": data['start_date'],
+            "end_date": data['end_date']
+        })
+        response = requests.request('POST', url, headers=self.vplan.post_headers, data=base_body)
+        return response
+
+    def update_leave(self, resource_id: str, leave_id: str, data: dict) -> requests.Response:
+        """
+        There is no documentation for this method available
+
+        This method constructs a request URL based on the endpoint and sends a POST request
+        to the vPlan API with the provided data.
+
+        Args:   resource_id (str): The resource id of the employee to add the leave to
+                leave_id (str): The id of the leave to update
+                data (dict): The data to create the new order with.
+
+        Returns: requests.Response: The response from the vPlan API.
+        """
+        required_fields = ['type', 'time', 'description', 'start_date', 'end_date']
+        allowed_fields = []
+        self.__check_fields(data=data, required_fields=required_fields, allowed_fields=allowed_fields)
+
+        url = f"{self.vplan.base_url}resource/{resource_id}/schedule_deviation/{leave_id}"
+        base_body = json.dumps({
+            "type": data['type'],
+            "time": data['time'],
+            "description": data['description'],
+            "start_date": data['start_date'],
+            "end_date": data['end_date']
+        })
+        response = requests.request('PUT', url, headers=self.vplan.post_headers, json=base_body)
+        return response
+
+    def delete_leave(self, resource_id: str, leave_id: str):
+        """
+        There is no documentation for this method available
+        This method constructs a request URL based on the endpoint and sends a DELETE request to the vPlan API.
+        :param resource_id: The resource id of the employee to delete the the leave to
+        :param leave_id: The id of the leave to delete
+        """
+        url = f"{self.vplan.base_url}resource/{resource_id}/schedule_deviation/{leave_id}"
+        response = requests.request('DELETE', url, headers=self.vplan.headers)
+        return response
+
+
+    @staticmethod
+    def __check_fields(data: Union[dict, List], required_fields: List, allowed_fields: List):
+        if isinstance(data, dict):
+            data = data.keys()
+
+        for field in data:
+            if field not in allowed_fields and field not in required_fields:
+                warnings.warn('Field {field} is not implemented. Optional fields are: {allowed_fields}'.format(field=field, allowed_fields=tuple(allowed_fields)))
+
+        for field in required_fields:
+            if field not in data:
+                raise ValueError('Field {field} is required. Required fields are: {required_fields}'.format(field=field, required_fields=tuple(required_fields)))

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/brynq_sdk_vplan/order.py

@@ -92,7 +92,7 @@ class Order:
         base_body.update({"external_ref": data['external_ref']}) if 'external_ref' in data else base_body
         base_body.update({"board_id": data['board_id']}) if 'board_id' in data else base_body
 
-        response = requests.request('POST', url, headers=self.vplan.post_headers, data=base_body)
+        response = requests.request('POST', url, headers=self.vplan.post_headers, data=json.dumps(base_body))
         return response
 
     def update_order(self, order_id: str, data: dict) -> requests.Response:

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/brynq_sdk_vplan/project.py

@@ -74,7 +74,7 @@ class Project:
         base_body.update({"description": data['description']}) if 'description' in data else base_body
         base_body.update({"external_ref": data['external_ref']}) if 'external_ref' in data else base_body
 
-        response = requests.request('POST', url, headers=self.vplan.post_headers, data=base_body)
+        response = requests.request('POST', url, headers=self.vplan.post_headers, data=json.dumps(base_body))
         return response
 
     def update_project(self, project_id: str, data: dict) -> requests.Response:
@@ -103,7 +103,7 @@ class Project:
         base_body.update({"description": data['description']}) if 'description' in data else base_body
         base_body.update({"external_ref": data['external_ref']}) if 'external_ref' in data else base_body
 
-        response = requests.request('PUT', url, headers=self.vplan.post_headers, json=base_body)
+        response = requests.request('PUT', url, headers=self.vplan.post_headers, json=json.dumps(base_body))
         return response
 
     def delete_project(self, project_id):

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/brynq_sdk_vplan.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-vplan
-Version: 1.0.1
+Version: 1.2.0
 Summary: vPlan wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/brynq_sdk_vplan.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ brynq_sdk_vplan/__init__.py
 brynq_sdk_vplan/activity.py
 brynq_sdk_vplan/get_data.py
 brynq_sdk_vplan/item.py
+brynq_sdk_vplan/leave.py
 brynq_sdk_vplan/order.py
 brynq_sdk_vplan/project.py
 brynq_sdk_vplan/resource.py

{brynq_sdk_vplan-1.0.1 → brynq_sdk_vplan-1.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_vplan',
-    version='1.0.1',
+    version='1.2.0',
     description='vPlan wrapper from BrynQ',
     long_description='vPlan wrapper from BrynQ',
     author='BrynQ',