nodes

Proxy para operações relacionadas a nodes e auth-nodes na API PLDPro.

Nodes

Proxy de alto nível para operações relacionadas a:

• Nodes (máquinas/servidores)
• AuthNodes (credenciais/usuários remotos por node)

Parameters:

Name	Type	Description	Default
api_client	ApiClient	Cliente de API para comunicação com o backend.	required

Source code in pldpro_sdk/core/proxies/nodes.py

class Nodes:
    """
    Proxy de alto nível para operações relacionadas a:

    - Nodes (máquinas/servidores)
    - AuthNodes (credenciais/usuários remotos por node)

    :param api_client: Cliente de API para comunicação com o backend.
    """

    def __init__(self, api_client: ApiClient) -> None:
        self._nodes_api = pldpro_sdk.api_client.NodesApi(api_client)

    def register(self, node_request: NodeRequest) -> Optional[NodeResponse]:
        """
        Registra um novo node no sistema.

        :param node_request: Dados do node a ser criado.
        :return: NodeResponse em caso de sucesso, None em erro.
        """
        try:
            api_response = self._nodes_api.create_node(node_request)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro durante o registro do node:\n\t{error_msg}",
                exc_info=False,
            )

    def unregister(self, node_id: Union[UUID, str]) -> bool:
        """
        Remove um node do sistema.

        :param node_id: UUID do node.
        :return: True em sucesso, False em erro.
        """
        if isinstance(node_id, str):
            node_id = UUID(node_id)

        try:
            self._nodes_api.delete_node(node_id)
            logger.info(f"Node {node_id} removido com sucesso!")
            return True
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"O node {node_id} não pôde ser removido, pelo seguinte motivo: {error_msg}",
                exc_info=False,
            )
            return False

    def list_nodes(self) -> List[NodeResponse]:
        """
        Lista todos os nodes registrados.

        :return: Lista de NodeResponse ou lista vazia em erro.
        """
        try:
            api_response = self._nodes_api.get_all_nodes()
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao listar os nodes:\n\t{error_msg}",
                exc_info=True,
            )
            return []

    def get_node(self, node_id: Union[UUID, str]) -> Union[NodeResponse, None]:
        """
        Obtém os detalhes de um node.

        :param node_id: UUID do node.
        :return: NodeResponse ou None em erro.
        """
        if isinstance(node_id, str):
            node_id = UUID(node_id)

        try:
            api_response = self._nodes_api.get_node(node_id)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao obter o node {node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def get_node_from_name(self, node_name: str) -> Union[NodeResponse, None]:
        """
        Obtém os detalhes de um node.

        :param node_id: UUID do node.
        :return: NodeResponse ou None em erro.
        """

        try:
            api_response = self._nodes_api.get_node_from_name(node_name)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao obter o node {node_name}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def list_node_casos(self, node_id: Union[UUID, str]) -> List[CasoResponse]:
        """
        Lista os casos associados a um node.

        :param node_id: UUID do node.
        :return: Lista de CasoResponse ou lista vazia em erro.
        """
        if isinstance(node_id, str):
            node_id = UUID(node_id)

        try:
            api_response = self._nodes_api.get_casos_node(node_id)
            return api_response
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Ocorreu o seguinte erro ao listar os casos do node {node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return []

    def list_auth_nodes(self, node_id: Union[UUID, str]) -> List[AuthNodeResponse]:
        """
        Lista os AuthNodes (credenciais) associados a um node.

        :param node_id: UUID do node.
        :return: Lista de AuthNodeResponse ou lista vazia em erro.
        """
        if isinstance(node_id, str):
            node_id = UUID(node_id)

        try:
            api_response = self._nodes_api.list_auth_nodes_by_node(node_id)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao listar AuthNodes do node {node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return []

    def create_auth_node(
        self,
        node_id: Union[UUID, str],
        usuario: str,
        workdir: str,
        password: Optional[str] = None,
    ) -> Union[AuthNodeResponse, None]:
        """
        Cria um novo AuthNode para um node.

        OBS: No backend, o uuidNode é inferido a partir do {uuid} do path.

        :param node_id: UUID do node.
        :param usuario: Usuário remoto.
        :param workdir: Diretório de trabalho remoto.
        :param password: Senha (opcional) para provisionar chaves.
        :return: AuthNodeResponse ou None em erro.
        """
        if isinstance(node_id, str):
            node_id = UUID(node_id)

        body = AuthNodeRequest(
            usuario=usuario, workdir=workdir, password=password, uuidNode=node_id
        )

        try:
            return self._nodes_api.create_auth_node_for_node(node_id, body)
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao criar AuthNode para o node {node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def create_auth_node_and_download_key(
            self,
            node_uuid: Union[UUID, str],
            usuario: str,
            workdir: str,
            output_path: Optional[str] = None,
    ) -> Union[str, None]:
        """
        Cria um novo AuthNode para um node e faz o download da chave pública SSH.

        :param node_uuid: UUID do node.
        :param usuario: Usuário remoto.
        :param workdir: Diretório de trabalho remoto.
        :param password: Senha (opcional) para provisionar chaves.
        :return: AuthNodeResponse ou None em erro.
        """
        if isinstance(node_uuid, str):
            node_uuid = UUID(node_uuid)

        try:
            filename = f"{usuario}_key.pub"

            return download_api_pub_key(
                method=self._nodes_api.create_auth_node_pub_key,
                usuario=usuario,
                workdir=workdir,
                node_uuid=node_uuid,
                filename=filename,
                save_path=output_path,
                )
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao criar AuthNode para o node {node_uuid}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def get_auth_node_file_public_key(
        self,
        node_name: str,
        usuario: str,
        output_path: Optional[str] = None
    )-> str:
        try:
            filename = f"{usuario}_key.pub"

            api_response = self._nodes_api.download_auth_node_user_public_key(
                node=node_name,
                usuario=usuario
            )

            save_path = Path(output_path)/filename

            with open(save_path, "wb") as f:
                f.write(api_response)

            return str(save_path)
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao baixar a chave pública do AuthNode para o node {node_name}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def get_auth_node(
        self, auth_node_id: Union[UUID, str]
    ) -> Union[AuthNodeResponse, None]:
        """
        Obtém os detalhes de um AuthNode.

        :param auth_node_id: UUID do AuthNode.
        :return: AuthNodeResponse ou None em erro.
        """
        if isinstance(auth_node_id, str):
            auth_node_id = UUID(auth_node_id)

        try:
            return self._nodes_api.get_auth_node(auth_node_id)
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao obter o AuthNode {auth_node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def get_auth_node_from_user(
        self, node_uuid: Union[UUID, str], auth_node_user: str
    ) -> Optional[AuthNodeResponse]:
        """
        Obtém os detalhes de um AuthNode.

        :param node_uuid: UUID do AuthNode.
        :param auth_node_user: Usuário associado ao node
        :return: AuthNodeResponse ou None em erro.
        """
        if isinstance(node_uuid, str):
            node_uuid = UUID(node_uuid)

        try:
            return self._nodes_api.get_auth_node_for_user_in_node(
                node_uuid, auth_node_user
            )
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao obter o AuthNode {node_uuid}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def delete_auth_node(self, auth_node_id: Union[UUID, str]) -> bool:
        """
        Remove um AuthNode e suas credenciais.

        :param auth_node_id: UUID do AuthNode.
        :return: True em sucesso, False em erro.
        """
        if isinstance(auth_node_id, str):
            auth_node_id = UUID(auth_node_id)

        try:
            self._nodes_api.delete_auth_node(auth_node_id)
            logger.info(f"AuthNode {auth_node_id} removido com sucesso!")
            return True
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"O AuthNode {auth_node_id} não pôde ser removido: {error_msg}",
                exc_info=False,
            )
            return False

    def test_node_connection(
        self, auth_node_id: Union[UUID, str]
    ) -> Union[HostCheckResult, None]:
        """
        Verifica a saúde/conectividade de um AuthNode.

        :param auth_node_id: UUID do AuthNode.
        :return: HostCheckResult ou None em erro.
        """
        if isinstance(auth_node_id, str):
            auth_node_id = UUID(auth_node_id)

        try:
            return self._nodes_api.check_auth_node_health(auth_node_id)
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao verificar o estado do AuthNode {auth_node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def list_versions(self, auth_node_id: Union[UUID, str]) -> List[str]:
        """
        Lista as versões do PLDPro disponíveis para um AuthNode.

        :param auth_node_id: UUID do AuthNode.
        :return: Lista de versões ou lista vazia em erro.
        """
        if isinstance(auth_node_id, str):
            auth_node_id = UUID(auth_node_id)

        try:
            return self._nodes_api.get_versoes_container(auth_node_id)
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Ocorreu o seguinte erro ao obter versões do PLDPro para o AuthNode {auth_node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return []

    def update_auth_node_credentials(
        self,
        auth_node_id: Union[UUID, str],
        password: str,
    ) -> Union[HostCheckResult, None]:
        """
        Atualiza a senha do AuthNode e recria as chaves.

        :param auth_node_id: UUID do AuthNode.
        :param password: Nova senha.
        :return: HostCheckResult ou None em erro.
        """
        if isinstance(auth_node_id, str):
            auth_node_id = UUID(auth_node_id)

        body = CredentialsUpdateRequest(password=password)

        try:
            return self._nodes_api.update_auth_node_credentials(auth_node_id, body)
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro ao atualizar as credenciais do AuthNode {auth_node_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def get_auth_node_public_key(self, auth_node_id: Union[UUID, str]) -> str:
        """
        Obtém a chave pública SSH do AuthNode.

        :param auth_node_id: UUID do AuthNode.
        :return: String com o conteúdo da chave pública ou string vazia em erro.
        """
        if isinstance(auth_node_id, str):
            auth_node_id = UUID(auth_node_id)

        try:
            lines = self._nodes_api.get_auth_node_public_key(auth_node_id)

            if lines:
                return "\n".join(lines)

        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Ocorreu o seguinte erro ao obter a chave pública do AuthNode {auth_node_id}:\n\t{error_msg}",
                exc_info=False,
            )
        return ""

create_auth_node(node_id, usuario, workdir, password=None)

Cria um novo AuthNode para um node.

OBS: No backend, o uuidNode é inferido a partir do {uuid} do path.

Parameters:

Name	Type	Description	Default
node_id	Union[UUID, str]	UUID do node.	required
usuario	str	Usuário remoto.	required
workdir	str	Diretório de trabalho remoto.	required
password	Optional[str]	Senha (opcional) para provisionar chaves.	None

Returns:

Type	Description
Union[AuthNodeResponse, None]	AuthNodeResponse ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def create_auth_node(
    self,
    node_id: Union[UUID, str],
    usuario: str,
    workdir: str,
    password: Optional[str] = None,
) -> Union[AuthNodeResponse, None]:
    """
    Cria um novo AuthNode para um node.

    OBS: No backend, o uuidNode é inferido a partir do {uuid} do path.

    :param node_id: UUID do node.
    :param usuario: Usuário remoto.
    :param workdir: Diretório de trabalho remoto.
    :param password: Senha (opcional) para provisionar chaves.
    :return: AuthNodeResponse ou None em erro.
    """
    if isinstance(node_id, str):
        node_id = UUID(node_id)

    body = AuthNodeRequest(
        usuario=usuario, workdir=workdir, password=password, uuidNode=node_id
    )

    try:
        return self._nodes_api.create_auth_node_for_node(node_id, body)
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao criar AuthNode para o node {node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

create_auth_node_and_download_key(node_uuid, usuario, workdir, output_path=None)

Cria um novo AuthNode para um node e faz o download da chave pública SSH.

Parameters:

Name	Type	Description	Default
node_uuid	Union[UUID, str]	UUID do node.	required
usuario	str	Usuário remoto.	required
workdir	str	Diretório de trabalho remoto.	required
password		Senha (opcional) para provisionar chaves.	required

Returns:

Type	Description
Union[str, None]	AuthNodeResponse ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def create_auth_node_and_download_key(
        self,
        node_uuid: Union[UUID, str],
        usuario: str,
        workdir: str,
        output_path: Optional[str] = None,
) -> Union[str, None]:
    """
    Cria um novo AuthNode para um node e faz o download da chave pública SSH.

    :param node_uuid: UUID do node.
    :param usuario: Usuário remoto.
    :param workdir: Diretório de trabalho remoto.
    :param password: Senha (opcional) para provisionar chaves.
    :return: AuthNodeResponse ou None em erro.
    """
    if isinstance(node_uuid, str):
        node_uuid = UUID(node_uuid)

    try:
        filename = f"{usuario}_key.pub"

        return download_api_pub_key(
            method=self._nodes_api.create_auth_node_pub_key,
            usuario=usuario,
            workdir=workdir,
            node_uuid=node_uuid,
            filename=filename,
            save_path=output_path,
            )
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao criar AuthNode para o node {node_uuid}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

delete_auth_node(auth_node_id)

Remove um AuthNode e suas credenciais.

Parameters:

Name	Type	Description	Default
auth_node_id	Union[UUID, str]	UUID do AuthNode.	required

Returns:

Type	Description
bool	True em sucesso, False em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def delete_auth_node(self, auth_node_id: Union[UUID, str]) -> bool:
    """
    Remove um AuthNode e suas credenciais.

    :param auth_node_id: UUID do AuthNode.
    :return: True em sucesso, False em erro.
    """
    if isinstance(auth_node_id, str):
        auth_node_id = UUID(auth_node_id)

    try:
        self._nodes_api.delete_auth_node(auth_node_id)
        logger.info(f"AuthNode {auth_node_id} removido com sucesso!")
        return True
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"O AuthNode {auth_node_id} não pôde ser removido: {error_msg}",
            exc_info=False,
        )
        return False

get_auth_node(auth_node_id)

Obtém os detalhes de um AuthNode.

Parameters:

Name	Type	Description	Default
auth_node_id	Union[UUID, str]	UUID do AuthNode.	required

Returns:

Type	Description
Union[AuthNodeResponse, None]	AuthNodeResponse ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def get_auth_node(
    self, auth_node_id: Union[UUID, str]
) -> Union[AuthNodeResponse, None]:
    """
    Obtém os detalhes de um AuthNode.

    :param auth_node_id: UUID do AuthNode.
    :return: AuthNodeResponse ou None em erro.
    """
    if isinstance(auth_node_id, str):
        auth_node_id = UUID(auth_node_id)

    try:
        return self._nodes_api.get_auth_node(auth_node_id)
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao obter o AuthNode {auth_node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

get_auth_node_from_user(node_uuid, auth_node_user)

Obtém os detalhes de um AuthNode.

Parameters:

Name	Type	Description	Default
node_uuid	Union[UUID, str]	UUID do AuthNode.	required
auth_node_user	str	Usuário associado ao node	required

Returns:

Type	Description
Optional[AuthNodeResponse]	AuthNodeResponse ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def get_auth_node_from_user(
    self, node_uuid: Union[UUID, str], auth_node_user: str
) -> Optional[AuthNodeResponse]:
    """
    Obtém os detalhes de um AuthNode.

    :param node_uuid: UUID do AuthNode.
    :param auth_node_user: Usuário associado ao node
    :return: AuthNodeResponse ou None em erro.
    """
    if isinstance(node_uuid, str):
        node_uuid = UUID(node_uuid)

    try:
        return self._nodes_api.get_auth_node_for_user_in_node(
            node_uuid, auth_node_user
        )
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao obter o AuthNode {node_uuid}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

get_auth_node_public_key(auth_node_id)

Obtém a chave pública SSH do AuthNode.

Parameters:

Name	Type	Description	Default
auth_node_id	Union[UUID, str]	UUID do AuthNode.	required

Returns:

Type	Description
str	String com o conteúdo da chave pública ou string vazia em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def get_auth_node_public_key(self, auth_node_id: Union[UUID, str]) -> str:
    """
    Obtém a chave pública SSH do AuthNode.

    :param auth_node_id: UUID do AuthNode.
    :return: String com o conteúdo da chave pública ou string vazia em erro.
    """
    if isinstance(auth_node_id, str):
        auth_node_id = UUID(auth_node_id)

    try:
        lines = self._nodes_api.get_auth_node_public_key(auth_node_id)

        if lines:
            return "\n".join(lines)

    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Ocorreu o seguinte erro ao obter a chave pública do AuthNode {auth_node_id}:\n\t{error_msg}",
            exc_info=False,
        )
    return ""

get_node(node_id)

Obtém os detalhes de um node.

Parameters:

Name	Type	Description	Default
node_id	Union[UUID, str]	UUID do node.	required

Returns:

Type	Description
Union[NodeResponse, None]	NodeResponse ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def get_node(self, node_id: Union[UUID, str]) -> Union[NodeResponse, None]:
    """
    Obtém os detalhes de um node.

    :param node_id: UUID do node.
    :return: NodeResponse ou None em erro.
    """
    if isinstance(node_id, str):
        node_id = UUID(node_id)

    try:
        api_response = self._nodes_api.get_node(node_id)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao obter o node {node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

get_node_from_name(node_name)

Obtém os detalhes de um node.

Parameters:

Name	Type	Description	Default
node_id		UUID do node.	required

Returns:

Type	Description
Union[NodeResponse, None]	NodeResponse ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def get_node_from_name(self, node_name: str) -> Union[NodeResponse, None]:
    """
    Obtém os detalhes de um node.

    :param node_id: UUID do node.
    :return: NodeResponse ou None em erro.
    """

    try:
        api_response = self._nodes_api.get_node_from_name(node_name)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao obter o node {node_name}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

list_auth_nodes(node_id)

Lista os AuthNodes (credenciais) associados a um node.

Parameters:

Name	Type	Description	Default
node_id	Union[UUID, str]	UUID do node.	required

Returns:

Type	Description
List[AuthNodeResponse]	Lista de AuthNodeResponse ou lista vazia em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def list_auth_nodes(self, node_id: Union[UUID, str]) -> List[AuthNodeResponse]:
    """
    Lista os AuthNodes (credenciais) associados a um node.

    :param node_id: UUID do node.
    :return: Lista de AuthNodeResponse ou lista vazia em erro.
    """
    if isinstance(node_id, str):
        node_id = UUID(node_id)

    try:
        api_response = self._nodes_api.list_auth_nodes_by_node(node_id)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao listar AuthNodes do node {node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return []

list_node_casos(node_id)

Lista os casos associados a um node.

Parameters:

Name	Type	Description	Default
node_id	Union[UUID, str]	UUID do node.	required

Returns:

Type	Description
List[CasoResponse]	Lista de CasoResponse ou lista vazia em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def list_node_casos(self, node_id: Union[UUID, str]) -> List[CasoResponse]:
    """
    Lista os casos associados a um node.

    :param node_id: UUID do node.
    :return: Lista de CasoResponse ou lista vazia em erro.
    """
    if isinstance(node_id, str):
        node_id = UUID(node_id)

    try:
        api_response = self._nodes_api.get_casos_node(node_id)
        return api_response
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Ocorreu o seguinte erro ao listar os casos do node {node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return []

list_nodes()

Lista todos os nodes registrados.

Returns:

Type	Description
List[NodeResponse]	Lista de NodeResponse ou lista vazia em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def list_nodes(self) -> List[NodeResponse]:
    """
    Lista todos os nodes registrados.

    :return: Lista de NodeResponse ou lista vazia em erro.
    """
    try:
        api_response = self._nodes_api.get_all_nodes()
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao listar os nodes:\n\t{error_msg}",
            exc_info=True,
        )
        return []

list_versions(auth_node_id)

Lista as versões do PLDPro disponíveis para um AuthNode.

Parameters:

Name	Type	Description	Default
auth_node_id	Union[UUID, str]	UUID do AuthNode.	required

Returns:

Type	Description
List[str]	Lista de versões ou lista vazia em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def list_versions(self, auth_node_id: Union[UUID, str]) -> List[str]:
    """
    Lista as versões do PLDPro disponíveis para um AuthNode.

    :param auth_node_id: UUID do AuthNode.
    :return: Lista de versões ou lista vazia em erro.
    """
    if isinstance(auth_node_id, str):
        auth_node_id = UUID(auth_node_id)

    try:
        return self._nodes_api.get_versoes_container(auth_node_id)
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Ocorreu o seguinte erro ao obter versões do PLDPro para o AuthNode {auth_node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return []

register(node_request)

Registra um novo node no sistema.

Parameters:

Name	Type	Description	Default
node_request	NodeRequest	Dados do node a ser criado.	required

Returns:

Type	Description
Optional[NodeResponse]	NodeResponse em caso de sucesso, None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def register(self, node_request: NodeRequest) -> Optional[NodeResponse]:
    """
    Registra um novo node no sistema.

    :param node_request: Dados do node a ser criado.
    :return: NodeResponse em caso de sucesso, None em erro.
    """
    try:
        api_response = self._nodes_api.create_node(node_request)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro durante o registro do node:\n\t{error_msg}",
            exc_info=False,
        )

test_node_connection(auth_node_id)

Verifica a saúde/conectividade de um AuthNode.

Parameters:

Name	Type	Description	Default
auth_node_id	Union[UUID, str]	UUID do AuthNode.	required

Returns:

Type	Description
Union[HostCheckResult, None]	HostCheckResult ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def test_node_connection(
    self, auth_node_id: Union[UUID, str]
) -> Union[HostCheckResult, None]:
    """
    Verifica a saúde/conectividade de um AuthNode.

    :param auth_node_id: UUID do AuthNode.
    :return: HostCheckResult ou None em erro.
    """
    if isinstance(auth_node_id, str):
        auth_node_id = UUID(auth_node_id)

    try:
        return self._nodes_api.check_auth_node_health(auth_node_id)
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao verificar o estado do AuthNode {auth_node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

unregister(node_id)

Remove um node do sistema.

Parameters:

Name	Type	Description	Default
node_id	Union[UUID, str]	UUID do node.	required

Returns:

Type	Description
bool	True em sucesso, False em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def unregister(self, node_id: Union[UUID, str]) -> bool:
    """
    Remove um node do sistema.

    :param node_id: UUID do node.
    :return: True em sucesso, False em erro.
    """
    if isinstance(node_id, str):
        node_id = UUID(node_id)

    try:
        self._nodes_api.delete_node(node_id)
        logger.info(f"Node {node_id} removido com sucesso!")
        return True
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"O node {node_id} não pôde ser removido, pelo seguinte motivo: {error_msg}",
            exc_info=False,
        )
        return False

update_auth_node_credentials(auth_node_id, password)

Atualiza a senha do AuthNode e recria as chaves.

Parameters:

Name	Type	Description	Default
auth_node_id	Union[UUID, str]	UUID do AuthNode.	required
password	str	Nova senha.	required

Returns:

Type	Description
Union[HostCheckResult, None]	HostCheckResult ou None em erro.

Source code in pldpro_sdk/core/proxies/nodes.py

def update_auth_node_credentials(
    self,
    auth_node_id: Union[UUID, str],
    password: str,
) -> Union[HostCheckResult, None]:
    """
    Atualiza a senha do AuthNode e recria as chaves.

    :param auth_node_id: UUID do AuthNode.
    :param password: Nova senha.
    :return: HostCheckResult ou None em erro.
    """
    if isinstance(auth_node_id, str):
        auth_node_id = UUID(auth_node_id)

    body = CredentialsUpdateRequest(password=password)

    try:
        return self._nodes_api.update_auth_node_credentials(auth_node_id, body)
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro ao atualizar as credenciais do AuthNode {auth_node_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None