feat(booking): wip booking

Author: vmscw

Makefile

@@ -40,4 +40,7 @@ install-test:
 
 .PHONY: test
 test:
-	pytest -s --showprogress -vv tests/
+	pytest -s --showprogress -vv tests/
+
+.PHONY: all
+all: v1alpha1

openapi/scaleway.qaas.v1alpha1.Api.yml

@@ -863,11 +863,30 @@ components:
                 can be booked in the future. (in seconds)
               example: 2.5s
               nullable: true
+            min_planification_duration:
+              type: string
+              description: Minimum planification time before a platform can be booked.
+                (in seconds)
+              example: 2.5s
+              nullable: true
+            max_booking_per_week:
+              type: integer
+              description: Maximum amount of booking allowed for one organization
+                per week.
+              format: uint32
+            max_booking_per_day:
+              type: integer
+              description: Maximum amount of booking allowed for one organization
+                per day.
+              format: uint32
           x-properties-order:
           - min_duration
           - max_duration
           - max_cancellation_duration
           - max_planification_duration
+          - min_planification_duration
+          - max_booking_per_week
+          - max_booking_per_day
         description:
           type: string
           description: English description of the platform.

scaleway_qaas_client/v1alpha1/__init__.py

@@ -65,3 +65,9 @@
 from .quantum_as_a_service_api_client.models import (
     ScalewayQaasV1Alpha1SessionStatus as QaaSSessionStatus,
 )
+from quantum_as_a_service_api_client.models import (
+    ScalewayQaasV1Alpha1PlatformBookingRequirement as QaaSBookingRequirements,
+)
+from quantum_as_a_service_api_client.models import (
+    ScalewayQaasV1Alpha1Booking as QaaSBooking,
+)

scaleway_qaas_client/v1alpha1/client.py

@@ -89,6 +89,12 @@
 from scaleway_qaas_client.v1alpha1.quantum_as_a_service_api_client.api.sessions.terminate_session import (
     sync_detailed as _terminate_session_sync,
 )
+from scaleway_qaas_client.v1alpha1.quantum_as_a_service_api_client.api.bookings.get_booking import (
+    sync_detailed as _get_booking_sync,
+)
+from scaleway_qaas_client.v1alpha1.quantum_as_a_service_api_client.api.bookings.list_bookings import (
+    sync_detailed as _list_bookings_sync,
+)
 from scaleway_qaas_client.v1alpha1.quantum_as_a_service_api_client.client import (
     AuthenticatedClient,
 )
@@ -100,12 +106,14 @@
     CreateModelBody,
     CreateProcessBody,
     CreateSessionBody,
+    CreateSessionBodyBookingDemand,
     ListPlatformsPlatformTechnology,
     ListPlatformsPlatformType,
     ScalewayQaasV1Alpha1Application,
     ScalewayQaasV1Alpha1Job,
     ScalewayQaasV1Alpha1JobResult,
     ScalewayQaasV1Alpha1Model,
+    ScalewayQaasV1Alpha1Booking,
     ScalewayQaasV1Alpha1Platform,
     ScalewayQaasV1Alpha1Process,
     ScalewayQaasV1Alpha1ProcessResult,
@@ -239,6 +247,9 @@ def create_session(
         name: Optional[str] = None,
         model_id: Optional[str] = None,
         parameters: Optional[Union[Dict, List, str]] = None,
+        booking_demand_started_at: Optional[str] = None,
+        booking_demand_finished_at: Optional[str] = None,
+        booking_demand_description: Optional[str] = None,
     ) -> ScalewayQaasV1Alpha1Session:
         """Create a session
 
@@ -261,6 +272,16 @@ def create_session(
             ScalewayQaasV1Alpha1Session
         """
 
+        if not booking_demand_started_at and booking_demand_finished_at:
+            raise Exception(
+                "booking_demand_started_at and booking_demand_finished_at must be set"
+            )
+
+        if booking_demand_started_at and not booking_demand_finished_at:
+            raise Exception(
+                "booking_demand_started_at and booking_demand_finished_at must be set"
+            )
+
         if not platform_id:
             raise Exception("create_session: platform_id cannot be None")
 
@@ -277,6 +298,15 @@ def create_session(
         if isinstance(max_idle_duration, str):
             max_idle_duration = f"{timeparse(max_idle_duration)}s"
 
+        booking_demand = UNSET
+
+        if booking_demand_started_at and booking_demand_finished_at:
+            booking_demand = CreateSessionBodyBookingDemand(
+                started_at=booking_demand_started_at,
+                finished_at=booking_demand_finished_at,
+                description=booking_demand_description,
+            )
+
         response = _create_session_sync(
             client=self.__client,
             body=CreateSessionBody(
@@ -288,6 +318,7 @@ def create_session(
                 max_idle_duration=max_idle_duration,
                 model_id=model_id,
                 parameters=parameters,
+                booking_demand=booking_demand,
             ),
         )
 
@@ -890,3 +921,85 @@ def list_models(self) -> List[ScalewayQaasV1Alpha1Model]:
         _raise_on_error(response)
 
         return response.parsed.models
+
+    def get_booking(self, booking_id: str) -> ScalewayQaasV1Alpha1Booking:
+        """Get booking information
+
+        Retrieve information about the provided **booking ID**, such as description, status and progress
+        message.
+
+        Args:
+            booking_id (str): Unique ID of the booking.
+
+        Raises:
+            errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+            httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+        Returns:
+            Response[ScalewayQaasV1Alpha1Booking]
+        """
+
+        if not booking_id:
+            raise Exception("get_booking: booking_id cannot be None")
+
+        response = _get_booking_sync(client=self.__client, booking_id=booking_id)
+
+        _raise_on_error(response)
+
+        return response.parsed
+
+    def list_platform_bookings(
+        self, platform_id: str
+    ) -> List[ScalewayQaasV1Alpha1Booking]:
+        """List all bookings according of the target platform
+
+        Retrieve information about all bookings of the provided ** platform ID**.
+
+        Args:
+            platform_id (Union[Unset, str]): List bookings attached to this platform ID.
+
+        Raises:
+            errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+            httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+        Returns:
+            Response[ScalewayQaasV1Alpha1ListBookingsResponse]
+        """
+
+        response = _list_bookings_sync(client=self.__client, platform_id=platform_id)
+
+        _raise_on_error(response)
+
+        return response.parsed.bookings
+
+    def list_bookings(
+        self, platform_id: Optional[str] = None
+    ) -> List[ScalewayQaasV1Alpha1Booking]:
+        """List all bookings according the filter of the current project.
+
+        Retrieve information about all bookings of the project ID.
+
+        Args:
+            platform_id (Union[Unset, str]): Will list only bookings attached to this platform ID.
+
+        Raises:
+            errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+            httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+        Returns:
+            Response[ScalewayQaasV1Alpha1ListBookingsResponse]
+        """
+        if platform_id:
+            response = _list_bookings_sync(
+                client=self.__client,
+                platform_id=platform_id,
+                project_id=self.__project_id,
+            )
+        else:
+            response = _list_bookings_sync(
+                client=self.__client, project_id=self.__project_id
+            )
+
+        _raise_on_error(response)
+
+        return response.parsed.bookings

scaleway_qaas_client/v1alpha1/quantum_as_a_service_api_client/models/scaleway_qaas_v1_alpha_1_platform_booking_requirement.py

@@ -22,12 +22,19 @@ class ScalewayQaasV1Alpha1PlatformBookingRequirement:
             before the beginning of the session. (in seconds) Example: 2.5s.
         max_planification_duration (Union[None, Unset, str]): Allowed planification time from now where the platform can
             be booked in the future. (in seconds) Example: 2.5s.
+        min_planification_duration (Union[None, Unset, str]): Minimum planification time before a platform can be
+            booked. (in seconds) Example: 2.5s.
+        max_booking_per_week (Union[Unset, int]): Maximum amount of booking allowed for one organization per week.
+        max_booking_per_day (Union[Unset, int]): Maximum amount of booking allowed for one organization per day.
     """
 
     min_duration: Union[None, Unset, str] = UNSET
     max_duration: Union[None, Unset, str] = UNSET
     max_cancellation_duration: Union[None, Unset, str] = UNSET
     max_planification_duration: Union[None, Unset, str] = UNSET
+    min_planification_duration: Union[None, Unset, str] = UNSET
+    max_booking_per_week: Union[Unset, int] = UNSET
+    max_booking_per_day: Union[Unset, int] = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -55,6 +62,16 @@ def to_dict(self) -> dict[str, Any]:
         else:
             max_planification_duration = self.max_planification_duration
 
+        min_planification_duration: Union[None, Unset, str]
+        if isinstance(self.min_planification_duration, Unset):
+            min_planification_duration = UNSET
+        else:
+            min_planification_duration = self.min_planification_duration
+
+        max_booking_per_week = self.max_booking_per_week
+
+        max_booking_per_day = self.max_booking_per_day
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update({})
@@ -66,6 +83,12 @@ def to_dict(self) -> dict[str, Any]:
             field_dict["max_cancellation_duration"] = max_cancellation_duration
         if max_planification_duration is not UNSET:
             field_dict["max_planification_duration"] = max_planification_duration
+        if min_planification_duration is not UNSET:
+            field_dict["min_planification_duration"] = min_planification_duration
+        if max_booking_per_week is not UNSET:
+            field_dict["max_booking_per_week"] = max_booking_per_week
+        if max_booking_per_day is not UNSET:
+            field_dict["max_booking_per_day"] = max_booking_per_day
 
         return field_dict
 
@@ -113,11 +136,29 @@ def _parse_max_planification_duration(data: object) -> Union[None, Unset, str]:
             d.pop("max_planification_duration", UNSET)
         )
 
+        def _parse_min_planification_duration(data: object) -> Union[None, Unset, str]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, str], data)
+
+        min_planification_duration = _parse_min_planification_duration(
+            d.pop("min_planification_duration", UNSET)
+        )
+
+        max_booking_per_week = d.pop("max_booking_per_week", UNSET)
+
+        max_booking_per_day = d.pop("max_booking_per_day", UNSET)
+
         scaleway_qaas_v1_alpha_1_platform_booking_requirement = cls(
             min_duration=min_duration,
             max_duration=max_duration,
             max_cancellation_duration=max_cancellation_duration,
             max_planification_duration=max_planification_duration,
+            min_planification_duration=min_planification_duration,
+            max_booking_per_week=max_booking_per_week,
+            max_booking_per_day=max_booking_per_day,
         )
 
         scaleway_qaas_v1_alpha_1_platform_booking_requirement.additional_properties = d

setup.py

@@ -22,7 +22,7 @@
 
 setup(
     name="scaleway_qaas_client",
-    version="0.1.22",
+    version="0.1.23",
     project_urls={
         "Documentation": "https://www.scaleway.com/en/quantum-as-a-service/",
         "Source": "https://github.com/scaleway/scaleway-qaas-client-pythom",

tests/test_api.py

@@ -152,6 +152,10 @@ def test_create_delete_session():
         client.delete_session(session.id)
 
 
+def test_platform_bookings():
+    client = _get_client()
+
+
 def test_create_session_same_deduplication_id():
     client = _get_client()