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

js7/client/action/inventory/get_changes_action.py

@@ -0,0 +1,59 @@
+from typing import List
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.changes import Change
+from ....model.public.client.enum.object_types import ObjectType
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ShowChangesFilter as ShowChangesFilter_V_2_8_2, 
+    ShowChangesResponse as ShowChangesResponse_V_2_8_2,
+    ChangeItem as ChangeItem_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_changes_action(*, context: Context, names: List[str]) -> List[Change]:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = ShowChangesFilter_V_2_8_2(
+            details=True,
+            names=names
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    result = context.joc_api.dispatch(endpoint_id="inventory/changes", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+
+    if isinstance(result, ShowChangesResponse_V_2_8_2):
+        return _build_v_2_8_2_response(result)
+        
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#----------------------#
+# Build 2.8.2 response #
+#----------------------#
+def _build_v_2_8_2_response(response: ShowChangesResponse_V_2_8_2) -> List[Change]:
+    if not response.changes:
+        return []
+
+    change_items: List[ChangeItem_V_2_8_2] = []
+    for change in response.changes:
+        if not change.configurations:
+            continue
+
+        for cfg in change.configurations:
+            change_items.append(cfg)
+
+    return [
+        Change(
+            path=item.path or "",
+            name=item.name,
+            object_type=ObjectType(item.object_type.value if item.object_type else "")
+        )
+        for item in change_items
+    ]

js7/client/action/inventory/get_git_credentials_action.py

@@ -0,0 +1,29 @@
+from ...context import Context
+from ....model.public.client.common.git_credentials import GitCredentials
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    GitCredentials as GitCredentials_V_2_8_2
+)
+
+
+def get_git_credentials_action(*, context: Context) -> GitCredentials:
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/repository/git/credentials", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=None,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCredentials_V_2_8_2):
+        return GitCredentials(
+            email=result.email,
+            git_account=result.git_account,
+            git_server=result.git_server,
+            keyfile_path=result.keyfile_path,
+            password=result.password,
+            personal_access_token=result.personal_access_token,
+            username=result.username
+        )
+
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")

js7/client/action/inventory/git_add_action.py

@@ -0,0 +1,72 @@
+from typing import Literal, 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,
+    Category as Category_V_2_8_2,
+    GitCommandResponse as GitCommandResponse_V_2_8_2,
+    CommonFilter as CommonFilter_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def git_add_action(
+    *, 
+    context: Context,
+    folder_path: str, 
+    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(folder_path=folder_path, 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/git/add", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCommandResponse_V_2_8_2):
+        return bool(result.exit_code == 0)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    folder_path: str, 
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog]
+) -> CommonFilter_V_2_8_2:
+
+    # Validates folder path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+
+    # 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 CommonFilter_V_2_8_2(
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/git_checkout_action.py

@@ -0,0 +1,88 @@
+from typing import Literal, 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,
+    CheckoutFilter as CheckoutFilter_V_2_8_2,
+    Category as Category_V_2_8_2,
+    GitCommandResponse as GitCommandResponse_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def git_checkout_action(
+    *, 
+    context: Context, 
+    branch: Optional[str], 
+    tag: Optional[str], 
+    folder_path: str, 
+    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(
+            branch=branch,
+            tag=tag,
+            folder_path=folder_path,
+            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/git/checkout", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCommandResponse_V_2_8_2):
+        return bool(result.exit_code == 0)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    branch: Optional[str], 
+    tag: Optional[str], 
+    folder_path: str, 
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog]
+) -> CheckoutFilter_V_2_8_2:
+
+    # Validates one of branch or tag
+    if sum([branch is not None, tag is not None]) != 1:
+        raise ValueError("Exactly one of 'branch' or 'tag' must be specified.")
+    
+    # Validates folder_path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+
+    # 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 CheckoutFilter_V_2_8_2(
+        branch=branch,
+        tag=tag,
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/git_clone_action.py

@@ -0,0 +1,84 @@
+from typing import Literal, 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,
+    GitCommandResponse as GitCommandResponse_V_2_8_2,
+    CloneFilter as CloneFilter_V_2_8_2,
+    Category as Category_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def git_clone_action(
+    *, 
+    context: Context, 
+    remote_url: str,
+    folder_path: str,
+    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(
+            remote_url=remote_url,
+            folder_path=folder_path,
+            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/git/clone", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCommandResponse_V_2_8_2):
+        return bool(result.exit_code == 0)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    remote_url: str,
+    folder_path: str,
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog],
+) -> CloneFilter_V_2_8_2:
+    
+    # Validates remote URL
+    if not remote_url:
+        raise ValueError("'remote_url' is required.")
+
+    # Validates folder path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+    
+    # 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 CloneFilter_V_2_8_2(
+        remote_url=remote_url,
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log
+    )

js7/client/action/inventory/git_commit_action.py

@@ -0,0 +1,80 @@
+from typing import Literal, 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,
+    CommitFilter as CommitFilter_V_2_8_2,
+    Category as Category_V_2_8_2,
+    GitCommandResponse as GitCommandResponse_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def git_commit_action(
+    *, 
+    context: Context, 
+    message: Optional[str],
+    folder_path: str,
+    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(
+            message=message,
+            folder_path=folder_path,
+            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/git/commit", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCommandResponse_V_2_8_2):
+        return bool(result.exit_code == 0)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    message: Optional[str],
+    folder_path: str,
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog],
+) -> CommitFilter_V_2_8_2:
+
+    # Validates folder path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+    
+    # 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 CommitFilter_V_2_8_2(
+        message=message,
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log
+    )

js7/client/action/inventory/git_pull_action.py

@@ -0,0 +1,72 @@
+from typing import Literal, 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,
+    Category as Category_V_2_8_2,
+    GitCommandResponse as GitCommandResponse_V_2_8_2,
+    CommonFilter as CommonFilter_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def git_pull_action(
+    *, 
+    context: Context,
+    folder_path: str, 
+    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(folder_path=folder_path, 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/git/pull", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCommandResponse_V_2_8_2):
+        return bool(result.exit_code == 0)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    folder_path: str, 
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog]
+) -> CommonFilter_V_2_8_2:
+
+    # Validates folder path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+
+    # 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 CommonFilter_V_2_8_2(
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/git_push_action.py

@@ -0,0 +1,76 @@
+from typing import Literal, 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,
+    CommonFilter as CommonFilter_V_2_8_2,
+    Category as Category_V_2_8_2,
+    GitCommandResponse as GitCommandResponse_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def git_push_action(
+    *,
+    context: Context,
+    folder_path: str,
+    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(
+            folder_path=folder_path,
+            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/git/push", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, GitCommandResponse_V_2_8_2):
+        return bool(result.exit_code == 0)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    folder_path: str,
+    category: Literal["LOCAL", "ROLLOUT"],
+    audit_log: Optional[AuditLog],
+) -> CommonFilter_V_2_8_2:
+
+    # Validates folder path
+    if not folder_path:
+        raise ValueError("'folder_path' is required.")
+    
+    # Validate: category
+    if category not in ("LOCAL", "ROLLOUT"):
+        raise ValueError("'category' must be one of 'LOCAL' or 'ROLLOUT'.")
+    
+    # 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 CommonFilter_V_2_8_2(
+        folder=folder_path,
+        category=Category_V_2_8_2(category), # Raises ValueError() if invalid.
+        audit_log=res_audit_log
+    )