digitalai-release-api-client 26.3.0b1__py3-none-any.whl

com/xebialabs/xlrelease/api/v1/__init__.py

@@ -0,0 +1,63 @@
+from com.xebialabs.xlrelease.api.v1.activity_logs_api import ActivityLogsApi
+from com.xebialabs.xlrelease.api.v1.application_api import ApplicationApi
+from com.xebialabs.xlrelease.api.v1.archive_api import ArchiveApi
+from com.xebialabs.xlrelease.api.v1.attachment_api import AttachmentApi
+from com.xebialabs.xlrelease.api.v1.category_api import CategoryApi
+from com.xebialabs.xlrelease.api.v1.configuration_api import ConfigurationApi
+from com.xebialabs.xlrelease.api.v1.delivery_api import DeliveryApi
+from com.xebialabs.xlrelease.api.v1.delivery_pattern_api import DeliveryPatternApi
+from com.xebialabs.xlrelease.api.v1.dsl_api import DslApi
+from com.xebialabs.xlrelease.api.v1.environment_api import EnvironmentApi
+from com.xebialabs.xlrelease.api.v1.environment_label_api import EnvironmentLabelApi
+from com.xebialabs.xlrelease.api.v1.environment_reservation_api import (
+    EnvironmentReservationApi,
+)
+from com.xebialabs.xlrelease.api.v1.environment_stage_api import EnvironmentStageApi
+from com.xebialabs.xlrelease.api.v1.folder_api import FolderApi
+from com.xebialabs.xlrelease.api.v1.folder_versioning_api import FolderVersioningApi
+from com.xebialabs.xlrelease.api.v1.permissions_api import PermissionsApi
+from com.xebialabs.xlrelease.api.v1.phase_api import PhaseApi
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+from com.xebialabs.xlrelease.api.v1.report_api import ReportApi
+from com.xebialabs.xlrelease.api.v1.risk_api import RiskApi
+from com.xebialabs.xlrelease.api.v1.roles_api import RolesApi
+from com.xebialabs.xlrelease.api.v1.search_api import SearchApi
+from com.xebialabs.xlrelease.api.v1.task_api import TaskApi
+from com.xebialabs.xlrelease.api.v1.task_reporting_api import TaskReportingApi
+from com.xebialabs.xlrelease.api.v1.team_api import TeamApi
+from com.xebialabs.xlrelease.api.v1.template_api import TemplateApi
+from com.xebialabs.xlrelease.api.v1.triggers_api import TriggersApi
+from com.xebialabs.xlrelease.api.v1.user_api import UserApi
+from com.xebialabs.xlrelease.api.v1.variable_api import VariableApi
+
+__all__ = [
+    "ActivityLogsApi",
+    "ApplicationApi",
+    "ArchiveApi",
+    "AttachmentApi",
+    "CategoryApi",
+    "ConfigurationApi",
+    "DeliveryApi",
+    "DeliveryPatternApi",
+    "DslApi",
+    "EnvironmentApi",
+    "EnvironmentLabelApi",
+    "EnvironmentReservationApi",
+    "EnvironmentStageApi",
+    "FolderApi",
+    "FolderVersioningApi",
+    "PermissionsApi",
+    "PhaseApi",
+    "ReleaseApi",
+    "ReportApi",
+    "RiskApi",
+    "RolesApi",
+    "SearchApi",
+    "TaskApi",
+    "TaskReportingApi",
+    "TeamApi",
+    "TemplateApi",
+    "TriggersApi",
+    "UserApi",
+    "VariableApi",
+]

com/xebialabs/xlrelease/api/v1/activity_logs_api.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from digitalai.release.release_api_client import ReleaseAPIClient
+
+from com.xebialabs.xlrelease.domain.activity_log import ActivityLogEntry
+
+
+class ActivityLogsApi:
+    """Operations on activity logs."""
+
+    def __init__(self, api: ReleaseAPIClient):
+        """
+        Initializes the ActivityLogsApi.
+
+        :param api: an instance of ReleaseAPIClient used to make HTTP requests.
+        """
+        self.api = api
+
+    def getActivityLogs(self, containerId: str) -> list[ActivityLogEntry]:
+        """
+        Gets activity logs for a container (Release, Task, Delivery, or Trigger).
+
+        :param containerId: the container identifier.
+        :return: a list of activity log entries.
+        """
+        response = self.api.get(f"/api/v1/activities/{containerId}")
+        return ActivityLogEntry.from_response_to_list(response)

com/xebialabs/xlrelease/api/v1/api_base_task.py

@@ -0,0 +1,296 @@
+from typing import Dict, Type, TypeVar
+
+from digitalai.release.integration import BaseTask
+from digitalai.release.release_api_client import ReleaseAPIClient
+
+from com.xebialabs.xlrelease.domain.folder import Folder
+from com.xebialabs.xlrelease.domain.phase import Phase
+from com.xebialabs.xlrelease.domain.release import Release
+from com.xebialabs.xlrelease.domain.task import Task
+
+from com.xebialabs.xlrelease.api.v1.activity_logs_api import ActivityLogsApi
+from com.xebialabs.xlrelease.api.v1.application_api import ApplicationApi
+from com.xebialabs.xlrelease.api.v1.archive_api import ArchiveApi
+from com.xebialabs.xlrelease.api.v1.attachment_api import AttachmentApi
+from com.xebialabs.xlrelease.api.v1.category_api import CategoryApi
+from com.xebialabs.xlrelease.api.v1.configuration_api import ConfigurationApi
+from com.xebialabs.xlrelease.api.v1.delivery_api import DeliveryApi
+from com.xebialabs.xlrelease.api.v1.delivery_pattern_api import DeliveryPatternApi
+from com.xebialabs.xlrelease.api.v1.dsl_api import DslApi
+from com.xebialabs.xlrelease.api.v1.environment_api import EnvironmentApi
+from com.xebialabs.xlrelease.api.v1.environment_label_api import EnvironmentLabelApi
+from com.xebialabs.xlrelease.api.v1.environment_reservation_api import (
+    EnvironmentReservationApi,
+)
+from com.xebialabs.xlrelease.api.v1.environment_stage_api import EnvironmentStageApi
+from com.xebialabs.xlrelease.api.v1.folder_api import FolderApi
+from com.xebialabs.xlrelease.api.v1.folder_versioning_api import FolderVersioningApi
+from com.xebialabs.xlrelease.api.v1.permissions_api import PermissionsApi
+from com.xebialabs.xlrelease.api.v1.phase_api import PhaseApi
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+from com.xebialabs.xlrelease.api.v1.report_api import ReportApi
+from com.xebialabs.xlrelease.api.v1.risk_api import RiskApi
+from com.xebialabs.xlrelease.api.v1.roles_api import RolesApi
+from com.xebialabs.xlrelease.api.v1.search_api import SearchApi
+from com.xebialabs.xlrelease.api.v1.settings_api import SettingsApi
+from com.xebialabs.xlrelease.api.v1.task_api import TaskApi
+from com.xebialabs.xlrelease.api.v1.task_reporting_api import TaskReportingApi
+from com.xebialabs.xlrelease.api.v1.team_api import TeamApi
+from com.xebialabs.xlrelease.api.v1.template_api import TemplateApi
+from com.xebialabs.xlrelease.api.v1.triggers_api import TriggersApi
+from com.xebialabs.xlrelease.api.v1.user_api import UserApi
+from com.xebialabs.xlrelease.api.v1.variable_api import VariableApi
+
+T = TypeVar("T")
+
+
+class ApiBaseTask(BaseTask):
+    """
+    Base class for Release container tasks that need the v1 REST API.
+
+    Subclass this instead of :class:`BaseTask` to get a ready-to-use, lazily
+    created instance of every ``com.xebialabs.xlrelease.api.v1`` wrapper as a
+    property (``releaseApi``, ``phaseApi``, ``taskApi``, ...). All wrappers
+    share a single :class:`ReleaseAPIClient` built from the task's
+    "Run as user" context, so the client and each API object are created only
+    once and only when first accessed.
+
+    Example::
+
+        class MyTask(ApiBaseTask):
+            def execute(self) -> None:
+                release = self.releaseApi.getRelease(self.get_release_id())
+                self.add_comment(f"Working on {release.title}")
+    """
+
+    def __init__(self):
+        super().__init__()
+        self._api_client: ReleaseAPIClient = None
+        self._api_instances: Dict[Type, object] = {}
+
+    # -- client / instance management ---------------------------------------
+
+    @property
+    def apiClient(self) -> ReleaseAPIClient:
+        """The shared :class:`ReleaseAPIClient`, created on first access."""
+        if self._api_client is None:
+            self._api_client = self.get_release_api_client()
+        return self._api_client
+
+    def _api(self, api_class: Type[T]) -> T:
+        """Return a cached instance of ``api_class``, creating it on first use."""
+        instance = self._api_instances.get(api_class)
+        if instance is None:
+            instance = api_class(self.apiClient)
+            self._api_instances[api_class] = instance
+        return instance
+
+    def reset_api_clients(self) -> None:
+        """Drop the cached client and API instances (e.g. to re-authenticate)."""
+        self._api_client = None
+        self._api_instances = {}
+
+    # -- API wrappers -------------------------------------------------------
+
+    @property
+    def activityLogsApi(self) -> ActivityLogsApi:
+        return self._api(ActivityLogsApi)
+
+    @property
+    def applicationApi(self) -> ApplicationApi:
+        return self._api(ApplicationApi)
+
+    @property
+    def archiveApi(self) -> ArchiveApi:
+        return self._api(ArchiveApi)
+
+    @property
+    def attachmentApi(self) -> AttachmentApi:
+        return self._api(AttachmentApi)
+
+    @property
+    def categoryApi(self) -> CategoryApi:
+        return self._api(CategoryApi)
+
+    @property
+    def configurationApi(self) -> ConfigurationApi:
+        return self._api(ConfigurationApi)
+
+    @property
+    def deliveryApi(self) -> DeliveryApi:
+        return self._api(DeliveryApi)
+
+    @property
+    def deliveryPatternApi(self) -> DeliveryPatternApi:
+        return self._api(DeliveryPatternApi)
+
+    @property
+    def dslApi(self) -> DslApi:
+        return self._api(DslApi)
+
+    @property
+    def environmentApi(self) -> EnvironmentApi:
+        return self._api(EnvironmentApi)
+
+    @property
+    def environmentLabelApi(self) -> EnvironmentLabelApi:
+        return self._api(EnvironmentLabelApi)
+
+    @property
+    def environmentReservationApi(self) -> EnvironmentReservationApi:
+        return self._api(EnvironmentReservationApi)
+
+    @property
+    def environmentStageApi(self) -> EnvironmentStageApi:
+        return self._api(EnvironmentStageApi)
+
+    @property
+    def folderApi(self) -> FolderApi:
+        return self._api(FolderApi)
+
+    @property
+    def folderVersioningApi(self) -> FolderVersioningApi:
+        return self._api(FolderVersioningApi)
+
+    @property
+    def permissionsApi(self) -> PermissionsApi:
+        return self._api(PermissionsApi)
+
+    @property
+    def phaseApi(self) -> PhaseApi:
+        return self._api(PhaseApi)
+
+    @property
+    def releaseApi(self) -> ReleaseApi:
+        return self._api(ReleaseApi)
+
+    @property
+    def reportApi(self) -> ReportApi:
+        return self._api(ReportApi)
+
+    @property
+    def riskApi(self) -> RiskApi:
+        return self._api(RiskApi)
+
+    @property
+    def rolesApi(self) -> RolesApi:
+        return self._api(RolesApi)
+
+    @property
+    def searchApi(self) -> SearchApi:
+        return self._api(SearchApi)
+
+    @property
+    def settingsApi(self) -> SettingsApi:
+        return self._api(SettingsApi)
+
+    @property
+    def taskApi(self) -> TaskApi:
+        return self._api(TaskApi)
+
+    @property
+    def taskReportingApi(self) -> TaskReportingApi:
+        return self._api(TaskReportingApi)
+
+    @property
+    def teamApi(self) -> TeamApi:
+        return self._api(TeamApi)
+
+    @property
+    def templateApi(self) -> TemplateApi:
+        return self._api(TemplateApi)
+
+    @property
+    def triggersApi(self) -> TriggersApi:
+        return self._api(TriggersApi)
+
+    @property
+    def userApi(self) -> UserApi:
+        return self._api(UserApi)
+
+    @property
+    def variableApi(self) -> VariableApi:
+        return self._api(VariableApi)
+
+    # -- current-context helpers --------------------------------------------
+    # Convenience methods that resolve the release object the task is running
+    # in, mirroring the helpers the Jython script API offers on the server
+    # (XLReleaseApi.py). Each derives the relevant id from the task's context
+    # and fetches the object through the matching API wrapper above.
+
+    def getCurrentTask(self) -> Task:
+        """
+        Return the task that is running this code.
+
+        Fetches the task via ``taskApi`` using the task's own id.
+        """
+        return self.taskApi.getTask(self.get_task_id())
+
+    def getCurrentPhase(self) -> Phase:
+        """
+        Return the phase that contains this task.
+
+        The phase id is derived from the task id, then fetched via ``phaseApi``.
+        """
+        return self.phaseApi.getPhase(self.get_phase_id())
+
+    def getCurrentRelease(self) -> Release:
+        """
+        Return the release this task belongs to.
+
+        Fetches the release via ``releaseApi`` using the task's release id, so
+        the caller does not need to know or substitute the id itself.
+        """
+        return self.releaseApi.getRelease(self.get_release_id())
+
+    def getCurrentFolder(self) -> Folder:
+        """
+        Return the folder that contains the current release.
+
+        The folder id is derived from the release id, then fetched via
+        ``folderApi``.
+        """
+        return self.folderApi.getFolder(self.get_folder_id())
+
+    def getTasksByTitle(self, taskTitle: str, phaseTitle: str | None = None,
+                        releaseId: str | None = None) -> list[Task]:
+        """
+        Find tasks by title.
+
+        :param taskTitle: the task title to search for.
+        :param phaseTitle: optional phase title to scope the search; searches the
+            whole release when omitted.
+        :param releaseId: optional release to search; the current release when
+            omitted.
+        :return: the matching tasks.
+        """
+        return self.taskApi.searchTasksByTitle(
+            taskTitle, releaseId or self.get_release_id(), phaseTitle)
+
+    def getPhasesByTitle(self, phaseTitle: str,
+                         releaseId: str | None = None) -> list[Phase]:
+        """
+        Find phases by title.
+
+        :param phaseTitle: the phase title to search for.
+        :param releaseId: optional release to search; the current release when
+            omitted.
+        :return: the matching phases.
+        """
+        return self.phaseApi.searchPhasesByTitle(
+            phaseTitle, releaseId or self.get_release_id())
+
+    def getReleasesByTitle(self, releaseTitle: str) -> list[Release]:
+        """
+        Find releases by title.
+
+        :param releaseTitle: the release title to search for.
+        :return: the matching releases.
+        """
+        return self.releaseApi.searchReleasesByTitle(releaseTitle)
+
+    def getVersion(self) -> str | None:
+        """
+        Return the version of this Digital.ai Release instance.
+        """
+        return self.settingsApi.getInstanceInformation().get('version')

com/xebialabs/xlrelease/api/v1/application_api.py

@@ -0,0 +1,108 @@
+from __future__ import annotations
+
+from digitalai.release.release_api_client import ReleaseAPIClient
+
+from com.xebialabs.xlrelease.domain.environment import (
+    Application,
+    ApplicationFilters,
+)
+
+
+class ApplicationApi:
+    """Operations on applications."""
+
+    def __init__(self, api: ReleaseAPIClient):
+        """
+        Initializes the ApplicationApi.
+
+        :param api: an instance of ReleaseAPIClient used to make HTTP requests.
+        """
+        self.api = api
+
+    def createApplication(self, applicationForm: Application) -> Application:
+        """
+        Creates a new application.
+
+        :param applicationForm: an Application (form) describing the new application.
+        :return: the created application.
+        """
+        response = self.api.post(
+            "/api/v1/applications",
+            json=applicationForm.model_dump(exclude_none=True)
+        )
+        return Application.from_response(response)
+
+    def getApplication(self, applicationId: str) -> Application:
+        """
+        Gets an application by id.
+
+        :param applicationId: the application identifier.
+        :return: the application.
+        """
+        response = self.api.get(f"/api/v1/applications/{applicationId}")
+        return Application.from_response(response)
+
+    def updateApplication(self, applicationId: str, applicationForm: Application) -> Application:
+        """
+        Updates an existing application.
+
+        :param applicationId: the application identifier.
+        :param applicationForm: an Application (form) describing the new properties.
+        :return: the updated application.
+        """
+        response = self.api.put(
+            f"/api/v1/applications/{applicationId}",
+            json=applicationForm.model_dump(exclude_none=True)
+        )
+        return Application.from_response(response)
+
+    def searchApplications(self, applicationFilters: ApplicationFilters | None = None) -> list[Application]:
+        """
+        Searches applications by filters.
+
+        :param applicationFilters: the search criteria.
+        :return: the list of matching applications.
+        """
+        body = applicationFilters.model_dump(exclude_none=True) if applicationFilters else {}
+        response = self.api.post("/api/v1/applications/search", json=body)
+        return Application.from_response_to_list(response)
+
+    def deleteApplication(self, applicationId: str) -> None:
+        """
+        Deletes an application.
+
+        :param applicationId: the application identifier.
+        """
+        response = self.api.delete(f"/api/v1/applications/{applicationId}")
+        response.raise_for_status()
+
+    # --- Convenience aliases matching the Jython script API ---
+
+    def create(self, application: Application) -> Application:
+        """
+        Creates a new application.
+
+        :param application: an Application object describing the new application.
+        :return: the created application.
+        """
+        return self.createApplication(application)
+
+    def update(self, application: Application) -> Application:
+        """
+        Updates an existing application.
+
+        :param application: an Application object describing the new properties.
+        :return: the updated application.
+        """
+        if not application.id:
+            raise ValueError("application.id must be set to update an application")
+        return self.updateApplication(application.id, application)
+
+    def search(self, filters: ApplicationFilters | None = None) -> list[Application]:
+        """
+        Searches applications by filters.
+
+        :param filters: the search criteria.
+        :return: the list of matching applications.
+        """
+        return self.searchApplications(filters)

com/xebialabs/xlrelease/api/v1/archive_api.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from digitalai.release.release_api_client import ReleaseAPIClient
+
+from com.xebialabs.xlrelease.domain.release import Release
+
+
+class ArchiveApi:
+    """Operations on archived releases."""
+
+    def __init__(self, api: ReleaseAPIClient):
+        """
+        Initializes the ArchiveApi.
+
+        :param api: an instance of ReleaseAPIClient used to make HTTP requests.
+        """
+        self.api = api
+
+    def getArchivedRelease(self, releaseId: str) -> Release:
+        """
+        Returns the archived release for the given ID.
+
+        :param releaseId: the identifier of the release.
+        :return: the archived release.
+        """
+        response = self.api.get(f"/api/v1/releases/archived/{releaseId}")
+        return Release.from_response(response)
+
+    def searchArchivedReleases(
+            self,
+            title: str | None = None,
+            tags: list[str] | None = None,
+            page: int | None = None,
+            resultsPerPage: int | None = None
+    ) -> list[Release]:
+        """
+        Searches archived releases.
+
+        :param title: filter by release title.
+        :param tags: filter by release tags.
+        :param page: the page of results to return.
+        :param resultsPerPage: the number of results per page.
+        :return: the list of matching archived releases.
+        """
+        body = {"onlyArchived": True}
+        if title is not None:
+            body["title"] = title
+        if tags is not None:
+            body["tags"] = tags
+        params = {}
+        if page is not None:
+            params["page"] = page
+        if resultsPerPage is not None:
+            params["resultsPerPage"] = resultsPerPage
+        response = self.api.post("/api/v1/releases/search", json=body, params=params)
+        return Release.from_response_to_list(response)

com/xebialabs/xlrelease/api/v1/attachment_api.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+from digitalai.release.release_api_client import ReleaseAPIClient
+
+from com.xebialabs.xlrelease.domain.attachment import Attachment
+
+
+class AttachmentApi:
+    """Operations on attachments."""
+
+    def __init__(self, api: ReleaseAPIClient):
+        """
+        Initializes the AttachmentApi.
+
+        :param api: an instance of ReleaseAPIClient used to make HTTP requests.
+        """
+        self.api = api
+
+    def getAttachment(self, attachmentId: str) -> bytes:
+        """
+        Returns the attachment file with the given ID.
+
+        :param attachmentId: the identifier of the attachment.
+        :return: the attachment file content as bytes.
+        """
+        response = self.api.get(
+            f"/api/v1/releases/attachments/{attachmentId}",
+            headers={"Accept": "application/octet-stream"}
+        )
+        response.raise_for_status()
+        return response.content
+
+    def addAttachment(self, taskId: str, fileName: str, fileBytes: bytes) -> Attachment:
+        """
+        Adds one attachment file to a task.
+
+        :param taskId: the task identifier.
+        :param fileName: the name of the attachment file.
+        :param fileBytes: the file content as bytes.
+        :return: the domain object of the uploaded attachment.
+        """
+        files = {"file": (fileName, fileBytes)}
+        response = self.api.post(
+            f"/api/v1/tasks/{taskId}/attachments",
+            files=files
+        )
+        response.raise_for_status()
+        data = response.json()
+        if isinstance(data, list):
+            return Attachment.model_validate(data[0])
+        return Attachment.model_validate(data)
+
+    def addAttachments(self, taskId: str, fileList: list[tuple[str, bytes]]) -> list[Attachment]:
+        """
+        Adds multiple attachment files to a task.
+
+        :param taskId: the task identifier.
+        :param fileList: list of (fileName, fileBytes) tuples.
+        :return: list of uploaded Attachment domain objects.
+        """
+        files = [("file", (name, content)) for name, content in fileList]
+        response = self.api.post(
+            f"/api/v1/tasks/{taskId}/attachments",
+            files=files
+        )
+        response.raise_for_status()
+        data = response.json()
+        if isinstance(data, list):
+            return [Attachment.model_validate(item) for item in data]
+        return [Attachment.model_validate(data)]
+
+    def deleteAttachment(self, taskId: str, attachmentId: str) -> None:
+        """
+        Deletes an attachment from a task.
+
+        :param taskId: the task identifier.
+        :param attachmentId: the attachment identifier.
+        """
+        response = self.api.delete(f"/api/v1/tasks/{taskId}/attachments/{attachmentId}")
+        response.raise_for_status()