js7-client-python 2.0.1__py3-none-any.whl

js7/client/action/inventory/remove_configurations_action.py

@@ -0,0 +1,77 @@
+from typing import List, Optional
+
+from ....model.public.client.common.audit_log import AuditLog
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.configurations import Configuration
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    RequestFilters as RequestFilters_V_2_8_2,
+    OK as OK_V_2_8_2,
+    CommonRequestFilter as CommonRequestFilter_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_configurations_action(
+    *, 
+    context: Context, 
+    configurations: List[Configuration],
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(configurations=configurations, audit_log=audit_log) 
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/remove", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    configurations: List[Configuration],
+    audit_log: Optional[AuditLog]
+) -> RequestFilters_V_2_8_2:
+
+    # Validate: configurations
+    if not configurations:
+        raise ValueError("'configurations' are required.")
+    
+    # Build: res_object
+    res_object = [
+        CommonRequestFilter_V_2_8_2(
+            path=c.path,
+            object_type=ConfigurationType_V_2_8_2(c.object_type.value) # Raises ValueError() if invalid.
+        )
+        for c in configurations
+    ]
+    
+    # Build: Audit log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    return RequestFilters_V_2_8_2(
+        objects=res_object,
+        audit_log=res_audit_log,
+        
+        cancel_orders_date_from=None, # Not the correct domain
+    )

js7/client/action/inventory/remove_configurations_from_trash_action.py

@@ -0,0 +1,80 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.configurations import Configuration
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2, 
+    CommonRequestFilter as CommonRequestFilter_V_2_8_2,
+    OK as OK_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    RequestFilters as RequestFilters_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_configurations_from_trash_action(
+    *, 
+    context: Context,
+    configurations: List[Configuration],
+    audit_log: Optional[AuditLog]
+) -> bool:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            configurations=configurations,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/trash/delete", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    configurations: List[Configuration],
+    audit_log: Optional[AuditLog]
+) -> RequestFilters_V_2_8_2:
+    
+    # Validate: configurations
+    if not configurations:
+        raise ValueError("'configurations' are required.")
+    
+    # Build: res_objects
+    res_objects = [
+        CommonRequestFilter_V_2_8_2(
+            path=c.path,
+            object_type=ConfigurationType_V_2_8_2(c.object_type.value) # Raises ValueError() if invalid.
+        )
+        for c in configurations
+    ]
+    
+    # Build: Audit Log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return RequestFilters_V_2_8_2(
+        objects=res_objects,
+        audit_log=res_audit_log,
+        
+        cancel_orders_date_from=None, # Wrong domain
+    )

js7/client/action/inventory/remove_folder_action.py

@@ -0,0 +1,67 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    RequestFolder as RequestFolder_V_2_8_2,
+    OK as OK_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_folder_action(
+    *, 
+    context: Context, 
+    folder_path: str,
+    audit_log: Optional[AuditLog]
+) -> bool:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(folder_path=folder_path, audit_log=audit_log) 
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/remove/folder", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    folder_path: str,
+    audit_log: Optional[AuditLog]
+) -> RequestFolder_V_2_8_2:
+    
+    # Validate: folder_path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.") 
+    
+    # Build: Audit log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    return RequestFolder_V_2_8_2(
+        path=folder_path,
+        audit_log=res_audit_log,
+        
+        cancel_orders_date_from=None, # Not the right domain here.
+        controller_id=None,
+        recursive=True,
+        object_types=None,
+        only_valid_objects=False,
+    )

js7/client/action/inventory/remove_folder_from_trash_action.py

@@ -0,0 +1,69 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2, 
+    CommonRequestFolder as CommonRequestFolder_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_folder_from_trash_action(
+    *, 
+    context: Context, 
+    folder_path: str,
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(folder_path=folder_path, audit_log=audit_log)
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/trash/delete/folder", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    folder_path: str,
+    audit_log: Optional[AuditLog]
+) -> CommonRequestFolder_V_2_8_2:
+
+    # Validate: folder_path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.") 
+    
+    # Build: Audit log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return CommonRequestFolder_V_2_8_2(
+        path=folder_path,
+        audit_log=res_audit_log,
+        recursive=True,
+        
+        controller_id=None,
+        object_types=None,
+        only_valid_objects=None,
+    )

js7/client/action/inventory/remove_git_credentials_action.py

@@ -0,0 +1,53 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    RemoveCredentialsFilter as RemoveCredentialsFilter_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_git_credentials_action(*, context: Context, git_server: str, audit_log: Optional[AuditLog]) -> bool:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(git_server=git_server, audit_log=audit_log)
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/repository/git/credentials/remove", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(*, git_server: str, audit_log: Optional[AuditLog]) -> RemoveCredentialsFilter_V_2_8_2:    
+    # Validates git_server
+    if not git_server:
+        raise ValueError("'git_server' is required.")
+    
+    # Build: Audit Log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return RemoveCredentialsFilter_V_2_8_2(
+        git_servers=[git_server],
+        audit_log=res_audit_log
+    )

js7/client/action/inventory/remove_repository_configuration_action.py

@@ -0,0 +1,84 @@
+from typing import List, Literal, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.configurations import Configuration
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2, 
+    OK as OK_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    DeleteFromFilter as DeleteFromFilter_V_2_8_2,
+    Category as Category_V_2_8_2,
+    PublishConfiguration as Configuration_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_repository_configuration_action(
+    *, 
+    context: Context, 
+    configurations: List[Configuration],
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(configurations=configurations, category=category, audit_log=audit_log)
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/repository/delete", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    configurations: List[Configuration],
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog]
+) -> DeleteFromFilter_V_2_8_2:
+    
+    # Validates configurations
+    if not configurations:
+        raise ValueError("At least one configuration in 'configurations' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+    
+    # Build: Configurations
+    res_configurations: List[Configuration_V_2_8_2] = [
+        Configuration_V_2_8_2(
+            object_type=ConfigurationType_V_2_8_2(c.object_type.value), # Raises ValueError() if invalid.
+            path=c.path,
+        )
+        for c in configurations
+    ]
+
+    # Build: Audit Log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+
+    # Result
+    return DeleteFromFilter_V_2_8_2(
+        configurations=res_configurations,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/restore_configuration_from_trash_action.py

@@ -0,0 +1,84 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.configurations import Configuration
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    RequestFilter as RequestFilter_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    ResponseNewPath as ResponseNewPath_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+# Returns: new configuration path
+def restore_configuration_from_trash_action(
+    *, 
+    context: Context, 
+    configuration: Configuration,
+    new_path: str,
+    add_prefix: Optional[str],
+    add_suffix: Optional[str],
+    audit_log: Optional[AuditLog]
+) -> str:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            configuration=configuration,
+            new_path=new_path,
+            add_prefix=add_prefix,
+            add_suffix=add_suffix,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/trash/restore", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, ResponseNewPath_V_2_8_2):
+        if result.path:
+            return result.path
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    configuration: Configuration,
+    new_path: str,
+    add_prefix: Optional[str],
+    add_suffix: Optional[str],
+    audit_log: Optional[AuditLog]
+) -> RequestFilter_V_2_8_2:
+
+    # Validate: new_path
+    if not new_path:
+        raise ValueError("'new_path' is required.")
+    
+    # Build: Audit log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+
+    # Result
+    return RequestFilter_V_2_8_2(
+        path=configuration.path,
+        object_type=ConfigurationType_V_2_8_2(configuration.object_type.value), # Raises ValueError() if invalid.
+        new_path=new_path,
+        prefix=add_prefix,
+        suffix=add_suffix,
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/revalidate_folder_action.py

@@ -0,0 +1,46 @@
+from ....model.public.client.common.audit_log import AuditLog
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ValidateRequestFolder as ValidateRequestFolder_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    Report as Report_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def revalidate_folder_action(*, context: Context, path: str, audit_log: AuditLog) -> bool:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(path=path, audit_log=audit_log)
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/revalidate/folder", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, Report_V_2_8_2):
+        if not result.valid_objs:
+            return False
+        return True
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(*, path: str, audit_log: AuditLog) -> ValidateRequestFolder_V_2_8_2:
+    return ValidateRequestFolder_V_2_8_2(
+        path=path,
+        recursive=True,
+        audit_log=AuditParams_V_2_8_2(
+            ticket_link=audit_log.ticket_link,
+            comment=audit_log.comment,
+            time_spent=audit_log.time_spent
+        )
+    )

js7/client/action/inventory/revoke_configurations_action.py

@@ -0,0 +1,86 @@
+from typing import List, Optional
+
+from ....model.public.client.common.audit_log import AuditLog
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.configurations import DeployConfiguration
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    Config as Config_V_2_8_2,
+    PublishConfiguration as Configuration_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    RevokeFilter as RevokeFilter_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def revoke_configurations_action(
+    *, 
+    context: Context, 
+    controller_ids: List[str], 
+    configurations: List[DeployConfiguration], 
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_ids=controller_ids, 
+            configurations=configurations, 
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/deployment/revoke", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    controller_ids: List[str], 
+    configurations: List[DeployConfiguration], 
+    audit_log: Optional[AuditLog]
+) -> RevokeFilter_V_2_8_2:
+    
+    # Build: Audit log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    if not configurations:
+        raise ValueError("At least one entry is required in 'deploy_configurations'.")
+    
+    # Build: res_configs
+    res_configs = [
+        Config_V_2_8_2(configuration=Configuration_V_2_8_2(
+            commit_id=c.commit_id,
+            path=c.path,
+            recursive=c.recursive,
+            object_type=ConfigurationType_V_2_8_2(c.object_type), # Raises ValueError() if invalid
+        ))
+        for c in configurations
+    ]
+    
+    # Result
+    return RevokeFilter_V_2_8_2(
+        audit_log=res_audit_log,
+        controller_ids=controller_ids,
+        deploy_configurations=res_configs,
+        cancel_orders_date_from=None, # Wrong domain
+    )