casos

Proxy para operações relacionadas a casos na API PLDPro.

Caso

Proxy para operações relacionadas a casos na API PLDPro.

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/casos.py

class Caso:
    """Proxy para operações relacionadas a casos na API PLDPro.

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

    def __init__(self, api_client: ApiClient) -> None:
        self._caso_api = pldpro_sdk.api_client.CasosApi(api_client)

    def create_caso(self, name: str) -> Union[CasoResponse, None]:
        """
        Cria um novo caso vazio.

        :param name: Nome do caso a ser criado.
        :type name: str
        :return: Resposta da API com os detalhes do caso criado ou None em caso de erro.
        :rtype: Union[CasoResponse, None]
        """
        try:
            api_response = self._caso_api.create_empty_caso(name)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro durante a criação do caso:\n\t {error_msg}",
                exc_info=False,
            )

    def associar_cortes_to_caso(
        self,caso_uuid:UUID, cortes_request: CortesRequest
    ) -> Union[CasoResponse, None]:
        """
        Associar ao caso o nome do cortes que será usado na execução .

        :param cortes_request: Objeto contendo os detalhes do tipo do cortes para ser criado
        :type cortes_request: CortesRequest
        :return: Resposta da API com os detalhes do caso ou None em caso de erro.
        :rtype: Union[CasoResponse, None]
        """
        try:
            api_response = self._caso_api.associar_cortes_to_caso(uuid=caso_uuid,cortes_request=cortes_request)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro durante a associacao do cortes no caso:\n\t {error_msg}",
                exc_info=False,
            )

    def create_caso_attach(
        self, caso_request: CasoRequest
    ) -> Union[CasoResponse, None]:
        """
        Cria um novo caso associado a um host remoto.

        :param caso_request: Objeto contendo os detalhes do caso a ser criado.
        :type caso_request: CasoRequest
        :return: Resposta da API com os detalhes do caso criado ou None em caso de erro.
        :rtype: Union[CasoResponse, None]
        """
        try:
            api_response = self._caso_api.create_caso(caso_request)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro durante a criação do caso:\n\t {error_msg}",
                exc_info=False,
            )

    def clone_caso(self, caso_id: Union[UUID, str]) -> Union[CasoResponse, None]:
        """
        Clona um caso existente.

        :param caso_id: Identificador único do caso a ser clonado.
        :type caso_id: Union[UUID, str]
        :return: Resposta da API com os detalhes do caso clonado ou None em caso de erro.
        :rtype: Union[CasoResponse, None]
        """
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        try:
            api_response = self._caso_api.clonar_caso(caso_id)
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro durante a clonagem do caso:\n\t {error_msg}",
                exc_info=False,
            )

    def list_casos(
        self,
        nome: Optional[str] = None,
        created_at: Optional[datetime] = None,
        page: Optional[int] = None,
        size: Optional[int] = None,
        sort: Optional[str] = None,
    ) -> PaginatedCasoResponse:
        """
        Lista ou filtra casos existentes.

        :param nome: Nome do caso para filtro opcional.
        :type nome: Optional[str]
        :param created_at: Data de criação para filtro opcional.
        :type created_at: Optional[datetime]
        :param page: Número da página para paginação.
        :type page: Optional[int]
        :param size: Tamanho da página para paginação.
        :type size: Optional[int]
        :param sort: Critério de ordenação.
        :type sort: Optional[str]
        :return: Resposta paginada contendo os casos filtrados.
        :rtype: PaginatedCasoResponse
        """
        try:
            api_response = self._caso_api.filter_casos(
                nome=nome, created_at=created_at, page=page, size=size, sort=sort
            )
            return api_response
        except ApiException as e:
            error_msg = get_error_message(e)
            logger.error(
                f"Ocorreu o seguinte erro durante listar os casos:\n\t {error_msg}",
                exc_info=False,
            )
        return PaginatedCasoResponse(elements=[], page=0, totalPages=0, totalElements=0)

    def get_caso(self, caso_id: Union[UUID, str]) -> Union[CasoResponse, None]:
        """
        Obtém informações detalhadas de um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :return: Resposta da API com os detalhes do caso ou None em caso de erro.
        :rtype: Union[CasoResponse, None]
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            api_response = self._caso_api.get_caso(caso_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 obter o caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )

    def get_status_caso(self, caso_id: Union[UUID, str]) -> Union[StatusEnum, None]:
        """
        Obtém o status atual de um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :return: Status do caso ou None em caso de erro.
        :rtype: Union[StatusEnum, None]
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            api_response = self._caso_api.status_caso(caso_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 obter o status do caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )

    def delete_caso(self, caso_id: Union[UUID, str]) -> bool:
        """
        Remove um caso existente.

        :param caso_id: Identificador único do caso a ser removido.
        :type caso_id: Union[UUID, str]
        :return: True se a remoção for bem-sucedida, False caso contrário.
        :rtype: bool
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            self._caso_api.delete_caso(caso_id)
            return True
        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 remover o caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )
        return False

    def upload_files(
        self,
        caso_id: Union[UUID, str],
        files: Union[List[Path], List[str], Path, str],
        save_zip: bool = False,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de arquivos ou diretórios para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param files: Arquivo(s) ou diretório a ser enviado.
        :type files: Union[List[Path], List[str], Path, str]
        :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
        :type save_zip: bool
        :return: Lista de respostas da API com os detalhes dos arquivos enviados.
        :rtype: List[FileUploadResponse]
        """
        return upload(
            self._caso_api.upload_files,
            "de arquivo(s) do caso",
            caso_id,
            files,
            save_zip,
        )

    def upload_entrada(
        self, caso_id: Union[UUID, str], filename: Union[Path, str]
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo de entrada para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param filename: Caminho do arquivo a ser enviado.
        :type filename: Union[Path, str]
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """
        ret = upload(
            self._caso_api.upload_file_entrada,
            "de arquivo de entrada",
            caso_id,
            filename,
            use_full_path=False,
            should_zip=False
        )
        return ret

    def upload_prevs(
        self,
        caso_id: Union[UUID, str],
        files: Union[List[Path], List[str], Path, str],
        encadeamento: Optional[TipoEncadeamentoSemanal] = None,
        save_zip: bool = False,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de arquivos de previsões para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param files: Arquivo(s) de previsões a ser(em) enviado(s).
        :type files: Union[List[Path], List[str], Path, str]
        :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
        :type save_zip: bool
        :return: Lista de respostas da API com os detalhes dos arquivos de previsões enviados.
        :rtype: List[FileUploadResponse]
        """
        return upload(
            self._caso_api.upload_prevs_files,
            "de arquivo(s) de previsões",
            caso_id,
            files,
            save_zip=save_zip,
            should_zip=False,
            encadeamento=encadeamento
        )

    def upload_cenarios_dessem(
        self,
        caso_id: Union[UUID, str],
        files: Union[List[Path], List[str], Path, str],
        save_zip: bool = False,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de arquivos de cenários do DESSEM para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param files: Arquivo(s) de cenários do DESSEM a ser(em) enviado(s).
        :type files: Union[List[Path], List[str], Path, str]
        :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
        :type save_zip: bool
        :return: Lista de respostas da API com os detalhes dos arquivos de cenários do DESSEM enviados.
        :rtype: List[FileUploadResponse]
        """
        # NOTE: O método upload espera uma lista de arquivos, mesmo que seja um único arquivo
        if isinstance(files, str) or isinstance(files, Path):
            files = [files]  # type: ignore

        return upload(
            self._caso_api.upload_cenarios_dessem,
            "de arquivo(s) de cenários do DESSEM",
            caso_id,
            files,
            should_zip=False,
            save_zip=save_zip,
        )

    def upload_deck_partida(
        self,
        caso_id: Union[UUID, str],
        file_path: Union[Path, str],
        partida_config: PartidaConfig,
        save_zip=False,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo de deck de partida para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param file_path: Caminho do arquivo de deck de partida a ser enviado.
        :type file_path: Union[Path, str]
        :param partida_config: Configuração da partida associada ao deck.
        :type partida_config: PartidaConfig
        :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
        :type save_zip: bool
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """

        return upload(
            method=self._caso_api.upload_deck_partida,
            error_context="de arquivo de deck de partida",
            caso_id=caso_id,
            files=file_path,
            save_zip=save_zip,
            partida_config=partida_config,
        )

    def upload_deck_partida_semanal(
        self,
        caso_id: Union[UUID, str],
        file_path: Union[Path, str],
        partida_semanal_config: PartidaSemanalConfig,
        save_zip=False,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo de deck de partida semanal para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param file_path: Caminho do arquivo de deck de partida semanal a ser enviado.
        :type file_path: Union[Path, str]
        :param partida_semanal_config: Configuração da partida semanal associada ao deck.
        :type partida_semanal_config: PartidaSemanalConfig
        :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo
        :type save_zip: bool
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """

        return upload(
            method=self._caso_api.upload_deck_partida_semanal,
            error_context="de arquivo de deck de partida semanal",
            caso_id=caso_id,
            files=file_path,
            save_zip=save_zip,
            partida_semanal_config=partida_semanal_config,
        )

    def attach_caso_remote(
        self, caso_id: Union[UUID, str], node_id: Union[UUID, str], path_remote: str
    ) -> Union[CasoResponse, None]:
        """
        Anexa um caminho remoto a um caso existente.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param node_id: Identificador único do node remoto.
        :type node_id: Union[UUID, str]
        :param path_remote: Caminho remoto a ser anexado.
        :type path_remote: str
        :return: Resposta da API com os detalhes do caso atualizado ou None em caso de erro.
        :rtype: Union[CasoResponse, None]
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            if isinstance(node_id, str):
                node_id = UUID(node_id)

            case_update_request = CasoUpdateRequest(
                uuidAuthHost=node_id, pathRemote=path_remote
            )
            api_response = self._caso_api.associar_caminho_remoto(
                caso_id, case_update_request
            )
            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 anexar o caminho remoto ao caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )

    def upload_ena_ree(
        self,
        caso_id: Union[UUID, str],
        filename: Union[Path, str],
        data_prevs: Union[datetime, str],
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo ENA-REE para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param filename: Caminho do arquivo ENA-REE a ser enviado.
        :type filename: Union[Path, str]
        :param data_prevs: Data de previsão utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD
        :type data_prevs: Union[datetime, str]
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """
        if isinstance(data_prevs, datetime):
            data_prevs = data_prevs.strftime("%Y-%m-%d")
        elif isinstance(data_prevs, str):
            try:
                datetime.strptime(data_prevs, "%Y-%m-%d")
            except ValueError:
                logger.error(
                    "O formato da data_prevs está incorreto. Use o formato YYYY-MM-DD.",
                    exc_info=False,
                )
                return None

        ret = upload(
            self._caso_api.upload_ena_ree,
            "de arquivo ENA-REE",
            caso_id,
            filename,
            use_full_path=False,
            data_prevs=data_prevs,
            should_zip=False
        )
        return ret

    def upload_regras_ana(
        self,
        caso_id: Union[UUID, str],
        filename: Union[Path, str],
        apaga_regras: Optional[TipoApagaRegrasEnum] = TipoApagaRegrasEnum.N,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo de regras ANA para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param filename: Caminho do arquivo de regras ANA a ser enviado.
        :type filename: Union[Path, str]
        :param apaga_regras: Indica se as regras existentes devem ser apagadas antes do upload.
        :type apaga_regras: Optional[TipoApagaRegrasEnum]
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """
        ret = upload(
            self._caso_api.upload_regras_ana,
            "de arquivo de regras ANA",
            caso_id,
            filename,
            use_full_path=False,
            apaga_regras=apaga_regras,
        )
        return ret

    def upload_volume_final_decomp(
        self,
        caso_id: Union[UUID, str],
        filename: Union[Path, str],
        tipo_alteracao: TipoAlteracaoEnum,
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo de volume final DECOMP para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param filename: Caminho do arquivo de volume final DECOMP a ser enviado.
        :type filename: Union[Path, str]
        :param tipo_alteracao: Tipo de alteração para o upload do arquivo.
        :type tipo_alteracao: TipoAlteracaoEnum
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """
        ret = upload(
            self._caso_api.upload_volume_final_decomp,
            "de arquivo de volume final DECOMP",
            caso_id,
            filename,
            use_full_path=False,
            tipo_alteracao=tipo_alteracao,
            should_zip=False
        )
        return ret

    def upload_volume_partida_decomp(
        self,
        caso_id: Union[UUID, str],
        filename: Union[Path, str],
        data_volume_partida: Union[datetime, str],
    ) -> Union[FileUploadResponse, None]:
        """
        Faz o upload de um arquivo de volume parcial DECOMP para um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param filename: Caminho do arquivo de volume parcial DECOMP a ser enviado.
        :type filename: Union[Path, str]
        :param data_volume_partida: Data do volume de partida utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD
        :type data_volume_partida: Union[datetime, str]
        :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
        :rtype: Union[FileUploadResponse, None]
        """
        if isinstance(data_volume_partida, datetime):
            data_volume_partida = data_volume_partida.strftime("%Y-%m-%d")
        elif isinstance(data_volume_partida, str):
            try:
                datetime.strptime(data_volume_partida, "%Y-%m-%d")
            except ValueError:
                logger.error(
                    "O formato da data_volume_partida está incorreto. Use o formato YYYY-MM-DD.",
                    exc_info=False,
                )
                return None

        ret = upload(
            self._caso_api.upload_volume_partida_decomp,
            "de arquivo de volume parcial DECOMP",
            caso_id,
            filename,
            use_full_path=False,
            data_volume_partida=data_volume_partida,
            should_zip=False
        )
        return ret

    def list_caso_files(self, caso_id: Union[UUID, str]) -> Union[FileNode, None]:
        """
        Lista os arquivos associados a um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :return: Resposta da API com a lista de arquivos do caso ou None em caso de erro.
        :rtype: Union[FileNode, None]
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            api_response = self._caso_api.get_casos_files(caso_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 arquivos do caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )

    def download_caso_all(
        self, caso_id: Union[UUID, str], save_path: Union[Path, str] = ""
    ) -> str:
        """
        Faz o download de todos os arquivos de um caso como um arquivo zip.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param save_path: Caminho onde o arquivo zip deve ser salvo.
        :type save_path: Union[Path, str]
        :return: Caminho completo do arquivo zip salvo.
        :rtype: str
        """
        filename = f"caso_{caso_id}_all_files.zip"
        return download(self._caso_api.download_inputs, caso_id, filename, save_path)

    def download_caso_inputs(
        self, caso_id: Union[UUID, str], save_path: Union[Path, str] = ""
    ) -> str:
        """
        Faz o download dos arquivos de entrada de um caso como um arquivo zip.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param save_path: Caminho onde o arquivo zip deve ser salvo.
        :type save_path: Union[Path, str]
        :return: Caminho completo do arquivo zip salvo.
        :rtype: str
        """
        filename = f"caso_{caso_id}_inputs.zip"
        return download(
            self._caso_api.download_inputs_file, caso_id, filename, save_path
        )

    def download_input_file(
        self,
        caso_id: Union[UUID, str],
        filename: Union[Path, str],
        save_path: Union[Path, str] = "",
    ) -> str:
        """
        Faz o download de um arquivo específico de entrada de um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param filename: Nome do arquivo a ser baixado.
        :type filename: Union[Path, str]
        :param save_path: Caminho onde o arquivo deve ser salvo.
        :type save_path: Union[Path, str]
        :return: Caminho completo do arquivo salvo.
        :rtype: str
        """
        return download(
            self._caso_api.download_specific_file,
            caso_id,
            filename,
            save_path,
            specific_file=True,
            as_zip=True,
        )

    def delete_caso_files(
        self, caso_id: Union[UUID, str], files: Union[List[Path], List[str]]
    ) -> bool:
        """
        Remove arquivos de um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param files: Lista de arquivos a serem removidos.
        :type files: Union[List[Path], List[str]]
        :return: True se a remoção dos arquivos for bem-sucedida, False caso contrário.
        :rtype: bool
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            file_paths = [str(Path(f)) for f in files]
            self._caso_api.delete_files(caso_id, file_paths)
            return True
        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 remover os arquivos do caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )
            return False

    def config_informacoes_iniciais(
        self, caso_id: Union[UUID, str], initial_info: CasoInitialDataRequest
    ) -> bool:
        """
        Configura as informações iniciais de um caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param initial_info: Objeto contendo as informações iniciais a serem configuradas.
        :type initial_info: CasoInitialDataRequest
        :return: Resposta da API com os detalhes do caso atualizado ou None em caso de erro.
        :rtype: bool
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            self._caso_api.configure_initial_data(caso_id, initial_info)
            return True
        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 configurar as informações iniciais do caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )
            return False

    def escrever_cortes_path(self, caso_id: Union[UUID, str], new_path: str) -> str:
        """
        Escreve o caminho dos cortes no arquivo de entrada do caso.

        :param caso_id: Identificador único do caso.
        :type caso_id: Union[UUID, str]
        :param new_path: Novo caminho dos arquivos de cortes.
        :type new_path: str
        :return: Caminho dos arquivos de cortes.
        :rtype: str
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            api_response = self._caso_api.escrever_cortes_path(
                caso_id,
                new_path,
                _content_type="text/plain",
                _headers={"Accept": "text/plain"},
            )

            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 obter o caminho dos cortes do caso {caso_id}:\n\t {error_msg}",
                exc_info=False,
            )
            return ""

    def change_files_newave(
        self,
        caso_id: Union[UUID, str],
        builder: NewaveChangeFilesBuilder,
    ) -> Union[UploadTrocasArquivosResponse, None]:
        """
        Registra trocas de arquivos do NEWAVE para um caso.

        O SDK recebe um builder de alto nível, serializa o metadata esperado pela API
        e envia os arquivos físicos em multipart utilizando fileKey dinâmico.

       :param caso_id: Identificador único do caso.
        :param builder: Builder de alto nível para montagem de trocas de arquivos do caso.
        """
        return self._change_files(caso_id, builder, TIPO_NEWAVE)

    def change_files_decomp(
        self,
        caso_id: Union[UUID, str],
        builder: DecompChangeFilesBuilder,
    ) -> Union[UploadTrocasArquivosResponse, None]:
        """
        Registra trocas de arquivos do DECOMP para um caso.

        O SDK recebe um builder de alto nível, serializa o metadata esperado pela API
        e envia os arquivos físicos em multipart utilizando fileKey dinâmico.

        :param caso_id: Identificador único do caso.
        :param builder: Builder de alto nível para montagem de trocas de arquivos do caso.
        """
        return self._change_files(caso_id, builder, TIPO_DECOMP)

    def _change_files(
        self,
        caso_id: Union[UUID, str],
        builder: Union[NewaveChangeFilesBuilder, DecompChangeFilesBuilder],
        tipo: str,
    ) -> Union[UploadTrocasArquivosResponse, None]:
        """
        Implementação interna para envio de trocas NEWAVE/DECOMP.

        Usa o ApiClient.param_serialize + call_api para suportar multipart dinâmico,
        já que o low-level gerado atualmente serializa apenas o campo metadata e não
        envia as parts dos arquivos físicos.

        :param caso_id: Identificador único do caso.
        :param builder: Builder de alto nível para montagem de trocas de arquivos do caso.
        :tipo: Enum do tipo de troca do modelo NEWAVE/DECOMP
        """
        try:
            if isinstance(caso_id, str):
                caso_id = UUID(caso_id)

            items = builder.build()
            metadata_json, files = build_metadata_and_files(tipo, items)

            resource_path = (
                "/casos/{uuid}/change-files/newave"
                if tipo == TIPO_NEWAVE
                else "/casos/{uuid}/change-files/decomp"
            )

            serialized_request = self._caso_api.api_client.param_serialize(
                method="PUT",
                resource_path=resource_path,
                path_params={"uuid": caso_id},
                query_params=[],
                header_params={
                    "Accept": "application/json",
                    "Content-Type": "multipart/form-data",
                },
                body=None,
                post_params=[("metadata", metadata_json)],
                files=files,
                auth_settings=["TenantIdAuth", "ApiKeyAuth"],
                collection_formats={},
                _host=None,
                _request_auth=None,
            )

            response_types_map = {
                "200": "UploadTrocasArquivosResponse",
                "400": "ErrorResponse",
            }

            response_data = self._caso_api.api_client.call_api(*serialized_request)
            response_data.read()

            return self._caso_api.api_client.response_deserialize(
                response_data=response_data,
                response_types_map=response_types_map,
            ).data

        except (ApiException, ValueError, FileNotFoundError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Ocorreu o seguinte erro ao registrar trocas de arquivos "
                f"{tipo} para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def change_versions_newave(
            self,
            caso_id: UUID | str,
            builder: BaseChangeVersionsBuilder,
    ) -> "TrocaVersaoResponse | None":
        """
        Registra trocas de versão do NEWAVE para um caso.

        :param caso_id: Identificador único do caso.
        :param builder: Builder com as trocas a registrar. Lista vazia gera
                        o card TROCAVRSNWV com indicativo 'n'.

        Exemplo::

            from pldpro_sdk.models import NewaveChangeVersionsBuilder

            response = client.casos.change_versions_newave(
                caso_id,
                NewaveChangeVersionsBuilder()
                .add_version(mes=1, ano=2025, versao="newave_v1")
                .add_version(mes=3, ano=2025, versao="newave_v2"),
            )
        """
        try:
            return self._caso_api.change_versions_newave(UUID(str(caso_id)), builder.build())
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao registrar trocas de versão do NEWAVE para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def change_versions_decomp(
            self,
            caso_id: UUID | str,
            builder: BaseChangeVersionsBuilder,
    ) -> "TrocaVersaoResponse | None":
        """
        Registra trocas de versão do DECOMP para um caso.

        :param caso_id: Identificador único do caso.
        :param builder: Builder com as trocas a registrar. Lista vazia gera
                        o card TROCAVRSDC com indicativo 'n'.

        Exemplo::

            from pldpro_sdk.models import DecompChangeVersionsBuilder

            response = client.casos.change_versions_decomp(
                caso_id,
                DecompChangeVersionsBuilder()
                .add_version(mes=2, ano=2025, versao="decomp_v1"),
            )
        """
        try:
            return self._caso_api.change_versions_decomp(UUID(str(caso_id)), builder.build())
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao registrar trocas de versão do DECOMP para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def change_versions_gevazp(
            self,
            caso_id: UUID | str,
            builder: BaseChangeVersionsBuilder,
    ) -> "TrocaVersaoResponse | None":
        """
        Registra trocas de versão do GEVAZP para um caso.

        :param caso_id: Identificador único do caso.
        :param builder: Builder com as trocas a registrar. Lista vazia gera
                        o card TROCAVRSGV com indicativo 'n'.

        Exemplo::

            from pldpro_sdk.models import GevazpChangeVersionsBuilder

            response = client.casos.change_versions_gevazp(
                caso_id,
                GevazpChangeVersionsBuilder()
                .add_version(mes=5, ano=2025, versao="gevazp_v1"),
            )
        """
        try:
            return self._caso_api.change_versions_gevazp(UUID(str(caso_id)), builder.build())
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao registrar trocas de versão do GEVAZP para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def change_processors_newave(
        self,
        caso_id: UUID | str,
        quantidade_processadores: int,
    ) -> "NumeroProcessadoresResponse | None":
        """
        Registra o número de processadores do NEWAVE para um caso.

        :param caso_id: Identificador único do caso.
        :param quantidade_processadores: Quantidade inteira de processadores do NEWAVE.
        """
        return self._change_processors(caso_id, quantidade_processadores, TIPO_NEWAVE)

    def change_processors_decomp(
        self,
        caso_id: UUID | str,
        quantidade_processadores: int,
    ) -> "NumeroProcessadoresResponse | None":
        """
        Registra o número de processadores do DECOMP para um caso.

        :param caso_id: Identificador único do caso.
        :param quantidade_processadores: Quantidade inteira de processadores do DECOMP.
        """
        return self._change_processors(caso_id, quantidade_processadores, TIPO_DECOMP)

    def _change_processors(
        self,
        caso_id: UUID | str,
        quantidade_processadores: int,
        tipo: str,
    ) -> "NumeroProcessadoresResponse | None":
        """
        Implementação interna para registro do número de processadores via API.

        O SDK recebe apenas a quantidade lógica por modelo e monta o payload
        esperado pela API, sem expor os cards do ENTRADA parar o consumidor.
        """
        try:
            caso_uuid = UUID(str(caso_id))
            request = self._build_numero_processadores_request(
                quantidade_processadores,
                tipo,
            )

            if tipo == TIPO_NEWAVE:
                return self._caso_api.change_processors_newave(caso_uuid, request)

            return self._caso_api.change_processors_decomp(caso_uuid, request)

        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao registrar número de processadores do {tipo.upper()} "
                f"para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def _build_numero_processadores_request(
        self,
        quantidade_processadores: int,
        tipo: str,
    ) -> NumeroProcessadoresRequest:
        if not isinstance(quantidade_processadores, int) or isinstance(quantidade_processadores, bool):
            raise ValueError("quantidade_processadores deve ser um inteiro.")

        if quantidade_processadores < 0:
            raise ValueError("quantidade_processadores não pode ser negativa.")

        limite = 999 if tipo == TIPO_NEWAVE else 99
        if quantidade_processadores > limite:
            raise ValueError(f"quantidade_processadores excede o limite permitido para {tipo.upper()}: {limite}.")

        return NumeroProcessadoresRequest(quantidadeProcessadores=quantidade_processadores)

    def configure_dadger(
        self,
        caso_id: UUID | str,
        builder: DadgerConfigBuilder,
    ) -> "ConfiguracaoDadgerResponse | None":
        """
        Configura a geração do DADGER e a seleção de registros para um caso.

        :param caso_id: Identificador único do caso.
        :param builder: Builder de alto nível com a configuração lógica do DADGER.
        """
        try:
            caso_uuid = UUID(str(caso_id))
            return self._caso_api.configure_dadger(caso_uuid, builder.build())
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao configurar o DADGER para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def configure_execution_with_partida(
        self,
        caso_id: UUID | str,
        builder: ExecutionWithPartidaBuilder,
    ) -> "ConfiguracaoExecucaoPartidaResponse | None":
        """
        Configura a execução com partida para um caso.

        :param caso_id: Identificador único do caso.
        :param builder: Builder de alto nível com a configuração lógica da execução com partida.
        """
        try:
            caso_uuid = UUID(str(caso_id))
            return self._caso_api.configure_execution_with_partida(caso_uuid, builder.build())
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao configurar execução com partida para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

    def configure_execution_models(
        self,
        caso_id: UUID | str,
        builder: ModelExecutionConfigBuilder,
    ) -> "ConfiguracaoExecucaoModelosResponse | None":
        """
        Configura a execucao dos modelos, versoes, revisao de parada e viabilizacao do DECOMP.

        :param caso_id: Identificador unico do caso.
        :param builder: Builder de alto nivel com a configuracao logica da execucao dos modelos.
        """
        try:
            caso_uuid = UUID(str(caso_id))
            return self._caso_api.configure_execution_models(caso_uuid, builder.build())
        except (ApiException, ValueError) as e:
            error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
            logger.error(
                f"Erro ao configurar a execucao dos modelos para o caso {caso_id}:\n\t{error_msg}",
                exc_info=False,
            )
            return None

associar_cortes_to_caso(caso_uuid, cortes_request)

Associar ao caso o nome do cortes que será usado na execução .

Parameters:

Name	Type	Description	Default
cortes_request	CortesRequest	Objeto contendo os detalhes do tipo do cortes para ser criado	required

Returns:

Type	Description
Union[CasoResponse, None]	Resposta da API com os detalhes do caso ou None em caso de erro.

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

def associar_cortes_to_caso(
    self,caso_uuid:UUID, cortes_request: CortesRequest
) -> Union[CasoResponse, None]:
    """
    Associar ao caso o nome do cortes que será usado na execução .

    :param cortes_request: Objeto contendo os detalhes do tipo do cortes para ser criado
    :type cortes_request: CortesRequest
    :return: Resposta da API com os detalhes do caso ou None em caso de erro.
    :rtype: Union[CasoResponse, None]
    """
    try:
        api_response = self._caso_api.associar_cortes_to_caso(uuid=caso_uuid,cortes_request=cortes_request)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro durante a associacao do cortes no caso:\n\t {error_msg}",
            exc_info=False,
        )

attach_caso_remote(caso_id, node_id, path_remote)

Anexa um caminho remoto a um caso existente.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
node_id	Union[UUID, str]	Identificador único do node remoto.	required
path_remote	str	Caminho remoto a ser anexado.	required

Returns:

Type	Description
Union[CasoResponse, None]	Resposta da API com os detalhes do caso atualizado ou None em caso de erro.

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

def attach_caso_remote(
    self, caso_id: Union[UUID, str], node_id: Union[UUID, str], path_remote: str
) -> Union[CasoResponse, None]:
    """
    Anexa um caminho remoto a um caso existente.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param node_id: Identificador único do node remoto.
    :type node_id: Union[UUID, str]
    :param path_remote: Caminho remoto a ser anexado.
    :type path_remote: str
    :return: Resposta da API com os detalhes do caso atualizado ou None em caso de erro.
    :rtype: Union[CasoResponse, None]
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        if isinstance(node_id, str):
            node_id = UUID(node_id)

        case_update_request = CasoUpdateRequest(
            uuidAuthHost=node_id, pathRemote=path_remote
        )
        api_response = self._caso_api.associar_caminho_remoto(
            caso_id, case_update_request
        )
        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 anexar o caminho remoto ao caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )

change_files_decomp(caso_id, builder)

Registra trocas de arquivos do DECOMP para um caso.

O SDK recebe um builder de alto nível, serializa o metadata esperado pela API e envia os arquivos físicos em multipart utilizando fileKey dinâmico.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
builder	DecompChangeFilesBuilder	Builder de alto nível para montagem de trocas de arquivos do caso.	required

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

def change_files_decomp(
    self,
    caso_id: Union[UUID, str],
    builder: DecompChangeFilesBuilder,
) -> Union[UploadTrocasArquivosResponse, None]:
    """
    Registra trocas de arquivos do DECOMP para um caso.

    O SDK recebe um builder de alto nível, serializa o metadata esperado pela API
    e envia os arquivos físicos em multipart utilizando fileKey dinâmico.

    :param caso_id: Identificador único do caso.
    :param builder: Builder de alto nível para montagem de trocas de arquivos do caso.
    """
    return self._change_files(caso_id, builder, TIPO_DECOMP)

change_files_newave(caso_id, builder)

Registra trocas de arquivos do NEWAVE para um caso.

O SDK recebe um builder de alto nível, serializa o metadata esperado pela API e envia os arquivos físicos em multipart utilizando fileKey dinâmico.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso. :param builder: Builder de alto nível para montagem de trocas de arquivos do caso.	required

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

def change_files_newave(
    self,
    caso_id: Union[UUID, str],
    builder: NewaveChangeFilesBuilder,
) -> Union[UploadTrocasArquivosResponse, None]:
    """
    Registra trocas de arquivos do NEWAVE para um caso.

    O SDK recebe um builder de alto nível, serializa o metadata esperado pela API
    e envia os arquivos físicos em multipart utilizando fileKey dinâmico.

   :param caso_id: Identificador único do caso.
    :param builder: Builder de alto nível para montagem de trocas de arquivos do caso.
    """
    return self._change_files(caso_id, builder, TIPO_NEWAVE)

change_processors_decomp(caso_id, quantidade_processadores)

Registra o número de processadores do DECOMP para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
quantidade_processadores	int	Quantidade inteira de processadores do DECOMP.	required

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

def change_processors_decomp(
    self,
    caso_id: UUID | str,
    quantidade_processadores: int,
) -> "NumeroProcessadoresResponse | None":
    """
    Registra o número de processadores do DECOMP para um caso.

    :param caso_id: Identificador único do caso.
    :param quantidade_processadores: Quantidade inteira de processadores do DECOMP.
    """
    return self._change_processors(caso_id, quantidade_processadores, TIPO_DECOMP)

change_processors_newave(caso_id, quantidade_processadores)

Registra o número de processadores do NEWAVE para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
quantidade_processadores	int	Quantidade inteira de processadores do NEWAVE.	required

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

def change_processors_newave(
    self,
    caso_id: UUID | str,
    quantidade_processadores: int,
) -> "NumeroProcessadoresResponse | None":
    """
    Registra o número de processadores do NEWAVE para um caso.

    :param caso_id: Identificador único do caso.
    :param quantidade_processadores: Quantidade inteira de processadores do NEWAVE.
    """
    return self._change_processors(caso_id, quantidade_processadores, TIPO_NEWAVE)

change_versions_decomp(caso_id, builder)

Registra trocas de versão do DECOMP para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
builder	BaseChangeVersionsBuilder	Builder com as trocas a registrar. Lista vazia gera o card TROCAVRSDC com indicativo 'n'. Exemplo:: from pldpro_sdk.models import DecompChangeVersionsBuilder response = client.casos.change_versions_decomp( caso_id, DecompChangeVersionsBuilder() .add_version(mes=2, ano=2025, versao="decomp_v1"), )	required

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

def change_versions_decomp(
        self,
        caso_id: UUID | str,
        builder: BaseChangeVersionsBuilder,
) -> "TrocaVersaoResponse | None":
    """
    Registra trocas de versão do DECOMP para um caso.

    :param caso_id: Identificador único do caso.
    :param builder: Builder com as trocas a registrar. Lista vazia gera
                    o card TROCAVRSDC com indicativo 'n'.

    Exemplo::

        from pldpro_sdk.models import DecompChangeVersionsBuilder

        response = client.casos.change_versions_decomp(
            caso_id,
            DecompChangeVersionsBuilder()
            .add_version(mes=2, ano=2025, versao="decomp_v1"),
        )
    """
    try:
        return self._caso_api.change_versions_decomp(UUID(str(caso_id)), builder.build())
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Erro ao registrar trocas de versão do DECOMP para o caso {caso_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

change_versions_gevazp(caso_id, builder)

Registra trocas de versão do GEVAZP para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
builder	BaseChangeVersionsBuilder	Builder com as trocas a registrar. Lista vazia gera o card TROCAVRSGV com indicativo 'n'. Exemplo:: from pldpro_sdk.models import GevazpChangeVersionsBuilder response = client.casos.change_versions_gevazp( caso_id, GevazpChangeVersionsBuilder() .add_version(mes=5, ano=2025, versao="gevazp_v1"), )	required

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

def change_versions_gevazp(
        self,
        caso_id: UUID | str,
        builder: BaseChangeVersionsBuilder,
) -> "TrocaVersaoResponse | None":
    """
    Registra trocas de versão do GEVAZP para um caso.

    :param caso_id: Identificador único do caso.
    :param builder: Builder com as trocas a registrar. Lista vazia gera
                    o card TROCAVRSGV com indicativo 'n'.

    Exemplo::

        from pldpro_sdk.models import GevazpChangeVersionsBuilder

        response = client.casos.change_versions_gevazp(
            caso_id,
            GevazpChangeVersionsBuilder()
            .add_version(mes=5, ano=2025, versao="gevazp_v1"),
        )
    """
    try:
        return self._caso_api.change_versions_gevazp(UUID(str(caso_id)), builder.build())
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Erro ao registrar trocas de versão do GEVAZP para o caso {caso_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

change_versions_newave(caso_id, builder)

Registra trocas de versão do NEWAVE para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
builder	BaseChangeVersionsBuilder	Builder com as trocas a registrar. Lista vazia gera o card TROCAVRSNWV com indicativo 'n'. Exemplo:: from pldpro_sdk.models import NewaveChangeVersionsBuilder response = client.casos.change_versions_newave( caso_id, NewaveChangeVersionsBuilder() .add_version(mes=1, ano=2025, versao="newave_v1") .add_version(mes=3, ano=2025, versao="newave_v2"), )	required

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

def change_versions_newave(
        self,
        caso_id: UUID | str,
        builder: BaseChangeVersionsBuilder,
) -> "TrocaVersaoResponse | None":
    """
    Registra trocas de versão do NEWAVE para um caso.

    :param caso_id: Identificador único do caso.
    :param builder: Builder com as trocas a registrar. Lista vazia gera
                    o card TROCAVRSNWV com indicativo 'n'.

    Exemplo::

        from pldpro_sdk.models import NewaveChangeVersionsBuilder

        response = client.casos.change_versions_newave(
            caso_id,
            NewaveChangeVersionsBuilder()
            .add_version(mes=1, ano=2025, versao="newave_v1")
            .add_version(mes=3, ano=2025, versao="newave_v2"),
        )
    """
    try:
        return self._caso_api.change_versions_newave(UUID(str(caso_id)), builder.build())
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Erro ao registrar trocas de versão do NEWAVE para o caso {caso_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

clone_caso(caso_id)

Clona um caso existente.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso a ser clonado.	required

Returns:

Type	Description
Union[CasoResponse, None]	Resposta da API com os detalhes do caso clonado ou None em caso de erro.

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

def clone_caso(self, caso_id: Union[UUID, str]) -> Union[CasoResponse, None]:
    """
    Clona um caso existente.

    :param caso_id: Identificador único do caso a ser clonado.
    :type caso_id: Union[UUID, str]
    :return: Resposta da API com os detalhes do caso clonado ou None em caso de erro.
    :rtype: Union[CasoResponse, None]
    """
    if isinstance(caso_id, str):
        caso_id = UUID(caso_id)

    try:
        api_response = self._caso_api.clonar_caso(caso_id)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro durante a clonagem do caso:\n\t {error_msg}",
            exc_info=False,
        )

config_informacoes_iniciais(caso_id, initial_info)

Configura as informações iniciais de um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
initial_info	CasoInitialDataRequest	Objeto contendo as informações iniciais a serem configuradas.	required

Returns:

Type	Description
bool	Resposta da API com os detalhes do caso atualizado ou None em caso de erro.

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

def config_informacoes_iniciais(
    self, caso_id: Union[UUID, str], initial_info: CasoInitialDataRequest
) -> bool:
    """
    Configura as informações iniciais de um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param initial_info: Objeto contendo as informações iniciais a serem configuradas.
    :type initial_info: CasoInitialDataRequest
    :return: Resposta da API com os detalhes do caso atualizado ou None em caso de erro.
    :rtype: bool
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        self._caso_api.configure_initial_data(caso_id, initial_info)
        return True
    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 configurar as informações iniciais do caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )
        return False

configure_dadger(caso_id, builder)

Configura a geração do DADGER e a seleção de registros para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
builder	DadgerConfigBuilder	Builder de alto nível com a configuração lógica do DADGER.	required

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

def configure_dadger(
    self,
    caso_id: UUID | str,
    builder: DadgerConfigBuilder,
) -> "ConfiguracaoDadgerResponse | None":
    """
    Configura a geração do DADGER e a seleção de registros para um caso.

    :param caso_id: Identificador único do caso.
    :param builder: Builder de alto nível com a configuração lógica do DADGER.
    """
    try:
        caso_uuid = UUID(str(caso_id))
        return self._caso_api.configure_dadger(caso_uuid, builder.build())
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Erro ao configurar o DADGER para o caso {caso_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

configure_execution_models(caso_id, builder)

Configura a execucao dos modelos, versoes, revisao de parada e viabilizacao do DECOMP.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador unico do caso.	required
builder	ModelExecutionConfigBuilder	Builder de alto nivel com a configuracao logica da execucao dos modelos.	required

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

def configure_execution_models(
    self,
    caso_id: UUID | str,
    builder: ModelExecutionConfigBuilder,
) -> "ConfiguracaoExecucaoModelosResponse | None":
    """
    Configura a execucao dos modelos, versoes, revisao de parada e viabilizacao do DECOMP.

    :param caso_id: Identificador unico do caso.
    :param builder: Builder de alto nivel com a configuracao logica da execucao dos modelos.
    """
    try:
        caso_uuid = UUID(str(caso_id))
        return self._caso_api.configure_execution_models(caso_uuid, builder.build())
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Erro ao configurar a execucao dos modelos para o caso {caso_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

configure_execution_with_partida(caso_id, builder)

Configura a execução com partida para um caso.

Parameters:

Name	Type	Description	Default
caso_id	UUID | str	Identificador único do caso.	required
builder	ExecutionWithPartidaBuilder	Builder de alto nível com a configuração lógica da execução com partida.	required

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

def configure_execution_with_partida(
    self,
    caso_id: UUID | str,
    builder: ExecutionWithPartidaBuilder,
) -> "ConfiguracaoExecucaoPartidaResponse | None":
    """
    Configura a execução com partida para um caso.

    :param caso_id: Identificador único do caso.
    :param builder: Builder de alto nível com a configuração lógica da execução com partida.
    """
    try:
        caso_uuid = UUID(str(caso_id))
        return self._caso_api.configure_execution_with_partida(caso_uuid, builder.build())
    except (ApiException, ValueError) as e:
        error_msg = get_error_message(e) if isinstance(e, ApiException) else str(e)
        logger.error(
            f"Erro ao configurar execução com partida para o caso {caso_id}:\n\t{error_msg}",
            exc_info=False,
        )
        return None

create_caso(name)

Cria um novo caso vazio.

Parameters:

Name	Type	Description	Default
name	str	Nome do caso a ser criado.	required

Returns:

Type	Description
Union[CasoResponse, None]	Resposta da API com os detalhes do caso criado ou None em caso de erro.

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

def create_caso(self, name: str) -> Union[CasoResponse, None]:
    """
    Cria um novo caso vazio.

    :param name: Nome do caso a ser criado.
    :type name: str
    :return: Resposta da API com os detalhes do caso criado ou None em caso de erro.
    :rtype: Union[CasoResponse, None]
    """
    try:
        api_response = self._caso_api.create_empty_caso(name)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro durante a criação do caso:\n\t {error_msg}",
            exc_info=False,
        )

create_caso_attach(caso_request)

Cria um novo caso associado a um host remoto.

Parameters:

Name	Type	Description	Default
caso_request	CasoRequest	Objeto contendo os detalhes do caso a ser criado.	required

Returns:

Type	Description
Union[CasoResponse, None]	Resposta da API com os detalhes do caso criado ou None em caso de erro.

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

def create_caso_attach(
    self, caso_request: CasoRequest
) -> Union[CasoResponse, None]:
    """
    Cria um novo caso associado a um host remoto.

    :param caso_request: Objeto contendo os detalhes do caso a ser criado.
    :type caso_request: CasoRequest
    :return: Resposta da API com os detalhes do caso criado ou None em caso de erro.
    :rtype: Union[CasoResponse, None]
    """
    try:
        api_response = self._caso_api.create_caso(caso_request)
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro durante a criação do caso:\n\t {error_msg}",
            exc_info=False,
        )

delete_caso(caso_id)

Remove um caso existente.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso a ser removido.	required

Returns:

Type	Description
bool	True se a remoção for bem-sucedida, False caso contrário.

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

def delete_caso(self, caso_id: Union[UUID, str]) -> bool:
    """
    Remove um caso existente.

    :param caso_id: Identificador único do caso a ser removido.
    :type caso_id: Union[UUID, str]
    :return: True se a remoção for bem-sucedida, False caso contrário.
    :rtype: bool
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        self._caso_api.delete_caso(caso_id)
        return True
    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 remover o caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )
    return False

delete_caso_files(caso_id, files)

Remove arquivos de um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
files	Union[List[Path], List[str]]	Lista de arquivos a serem removidos.	required

Returns:

Type	Description
bool	True se a remoção dos arquivos for bem-sucedida, False caso contrário.

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

def delete_caso_files(
    self, caso_id: Union[UUID, str], files: Union[List[Path], List[str]]
) -> bool:
    """
    Remove arquivos de um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param files: Lista de arquivos a serem removidos.
    :type files: Union[List[Path], List[str]]
    :return: True se a remoção dos arquivos for bem-sucedida, False caso contrário.
    :rtype: bool
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        file_paths = [str(Path(f)) for f in files]
        self._caso_api.delete_files(caso_id, file_paths)
        return True
    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 remover os arquivos do caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )
        return False

download_caso_all(caso_id, save_path='')

Faz o download de todos os arquivos de um caso como um arquivo zip.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
save_path	Union[Path, str]	Caminho onde o arquivo zip deve ser salvo.	''

Returns:

Type	Description
str	Caminho completo do arquivo zip salvo.

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

def download_caso_all(
    self, caso_id: Union[UUID, str], save_path: Union[Path, str] = ""
) -> str:
    """
    Faz o download de todos os arquivos de um caso como um arquivo zip.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param save_path: Caminho onde o arquivo zip deve ser salvo.
    :type save_path: Union[Path, str]
    :return: Caminho completo do arquivo zip salvo.
    :rtype: str
    """
    filename = f"caso_{caso_id}_all_files.zip"
    return download(self._caso_api.download_inputs, caso_id, filename, save_path)

download_caso_inputs(caso_id, save_path='')

Faz o download dos arquivos de entrada de um caso como um arquivo zip.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
save_path	Union[Path, str]	Caminho onde o arquivo zip deve ser salvo.	''

Returns:

Type	Description
str	Caminho completo do arquivo zip salvo.

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

def download_caso_inputs(
    self, caso_id: Union[UUID, str], save_path: Union[Path, str] = ""
) -> str:
    """
    Faz o download dos arquivos de entrada de um caso como um arquivo zip.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param save_path: Caminho onde o arquivo zip deve ser salvo.
    :type save_path: Union[Path, str]
    :return: Caminho completo do arquivo zip salvo.
    :rtype: str
    """
    filename = f"caso_{caso_id}_inputs.zip"
    return download(
        self._caso_api.download_inputs_file, caso_id, filename, save_path
    )

download_input_file(caso_id, filename, save_path='')

Faz o download de um arquivo específico de entrada de um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
filename	Union[Path, str]	Nome do arquivo a ser baixado.	required
save_path	Union[Path, str]	Caminho onde o arquivo deve ser salvo.	''

Returns:

Type	Description
str	Caminho completo do arquivo salvo.

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

def download_input_file(
    self,
    caso_id: Union[UUID, str],
    filename: Union[Path, str],
    save_path: Union[Path, str] = "",
) -> str:
    """
    Faz o download de um arquivo específico de entrada de um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param filename: Nome do arquivo a ser baixado.
    :type filename: Union[Path, str]
    :param save_path: Caminho onde o arquivo deve ser salvo.
    :type save_path: Union[Path, str]
    :return: Caminho completo do arquivo salvo.
    :rtype: str
    """
    return download(
        self._caso_api.download_specific_file,
        caso_id,
        filename,
        save_path,
        specific_file=True,
        as_zip=True,
    )

escrever_cortes_path(caso_id, new_path)

Escreve o caminho dos cortes no arquivo de entrada do caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
new_path	str	Novo caminho dos arquivos de cortes.	required

Returns:

Type	Description
str	Caminho dos arquivos de cortes.

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

def escrever_cortes_path(self, caso_id: Union[UUID, str], new_path: str) -> str:
    """
    Escreve o caminho dos cortes no arquivo de entrada do caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param new_path: Novo caminho dos arquivos de cortes.
    :type new_path: str
    :return: Caminho dos arquivos de cortes.
    :rtype: str
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        api_response = self._caso_api.escrever_cortes_path(
            caso_id,
            new_path,
            _content_type="text/plain",
            _headers={"Accept": "text/plain"},
        )

        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 obter o caminho dos cortes do caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )
        return ""

get_caso(caso_id)

Obtém informações detalhadas de um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required

Returns:

Type	Description
Union[CasoResponse, None]	Resposta da API com os detalhes do caso ou None em caso de erro.

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

def get_caso(self, caso_id: Union[UUID, str]) -> Union[CasoResponse, None]:
    """
    Obtém informações detalhadas de um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :return: Resposta da API com os detalhes do caso ou None em caso de erro.
    :rtype: Union[CasoResponse, None]
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        api_response = self._caso_api.get_caso(caso_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 obter o caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )

get_status_caso(caso_id)

Obtém o status atual de um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required

Returns:

Type	Description
Union[StatusEnum, None]	Status do caso ou None em caso de erro.

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

def get_status_caso(self, caso_id: Union[UUID, str]) -> Union[StatusEnum, None]:
    """
    Obtém o status atual de um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :return: Status do caso ou None em caso de erro.
    :rtype: Union[StatusEnum, None]
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        api_response = self._caso_api.status_caso(caso_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 obter o status do caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )

list_caso_files(caso_id)

Lista os arquivos associados a um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required

Returns:

Type	Description
Union[FileNode, None]	Resposta da API com a lista de arquivos do caso ou None em caso de erro.

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

def list_caso_files(self, caso_id: Union[UUID, str]) -> Union[FileNode, None]:
    """
    Lista os arquivos associados a um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :return: Resposta da API com a lista de arquivos do caso ou None em caso de erro.
    :rtype: Union[FileNode, None]
    """
    try:
        if isinstance(caso_id, str):
            caso_id = UUID(caso_id)

        api_response = self._caso_api.get_casos_files(caso_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 arquivos do caso {caso_id}:\n\t {error_msg}",
            exc_info=False,
        )

list_casos(nome=None, created_at=None, page=None, size=None, sort=None)

Lista ou filtra casos existentes.

Parameters:

Name	Type	Description	Default
nome	Optional[str]	Nome do caso para filtro opcional.	None
created_at	Optional[datetime]	Data de criação para filtro opcional.	None
page	Optional[int]	Número da página para paginação.	None
size	Optional[int]	Tamanho da página para paginação.	None
sort	Optional[str]	Critério de ordenação.	None

Returns:

Type	Description
PaginatedCasoResponse	Resposta paginada contendo os casos filtrados.

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

def list_casos(
    self,
    nome: Optional[str] = None,
    created_at: Optional[datetime] = None,
    page: Optional[int] = None,
    size: Optional[int] = None,
    sort: Optional[str] = None,
) -> PaginatedCasoResponse:
    """
    Lista ou filtra casos existentes.

    :param nome: Nome do caso para filtro opcional.
    :type nome: Optional[str]
    :param created_at: Data de criação para filtro opcional.
    :type created_at: Optional[datetime]
    :param page: Número da página para paginação.
    :type page: Optional[int]
    :param size: Tamanho da página para paginação.
    :type size: Optional[int]
    :param sort: Critério de ordenação.
    :type sort: Optional[str]
    :return: Resposta paginada contendo os casos filtrados.
    :rtype: PaginatedCasoResponse
    """
    try:
        api_response = self._caso_api.filter_casos(
            nome=nome, created_at=created_at, page=page, size=size, sort=sort
        )
        return api_response
    except ApiException as e:
        error_msg = get_error_message(e)
        logger.error(
            f"Ocorreu o seguinte erro durante listar os casos:\n\t {error_msg}",
            exc_info=False,
        )
    return PaginatedCasoResponse(elements=[], page=0, totalPages=0, totalElements=0)

upload_cenarios_dessem(caso_id, files, save_zip=False)

Faz o upload de arquivos de cenários do DESSEM para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
files	Union[List[Path], List[str], Path, str]	Arquivo(s) de cenários do DESSEM a ser(em) enviado(s).	required
save_zip	bool	Indica se o arquivo zip gerado em memória deve ser salvo localmente.	False

Returns:

Type	Description
List[FileUploadResponse]	Lista de respostas da API com os detalhes dos arquivos de cenários do DESSEM enviados.

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

def upload_cenarios_dessem(
    self,
    caso_id: Union[UUID, str],
    files: Union[List[Path], List[str], Path, str],
    save_zip: bool = False,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de arquivos de cenários do DESSEM para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param files: Arquivo(s) de cenários do DESSEM a ser(em) enviado(s).
    :type files: Union[List[Path], List[str], Path, str]
    :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
    :type save_zip: bool
    :return: Lista de respostas da API com os detalhes dos arquivos de cenários do DESSEM enviados.
    :rtype: List[FileUploadResponse]
    """
    # NOTE: O método upload espera uma lista de arquivos, mesmo que seja um único arquivo
    if isinstance(files, str) or isinstance(files, Path):
        files = [files]  # type: ignore

    return upload(
        self._caso_api.upload_cenarios_dessem,
        "de arquivo(s) de cenários do DESSEM",
        caso_id,
        files,
        should_zip=False,
        save_zip=save_zip,
    )

upload_deck_partida(caso_id, file_path, partida_config, save_zip=False)

Faz o upload de um arquivo de deck de partida para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
file_path	Union[Path, str]	Caminho do arquivo de deck de partida a ser enviado.	required
partida_config	PartidaConfig	Configuração da partida associada ao deck.	required
save_zip	bool	Indica se o arquivo zip gerado em memória deve ser salvo localmente.	False

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_deck_partida(
    self,
    caso_id: Union[UUID, str],
    file_path: Union[Path, str],
    partida_config: PartidaConfig,
    save_zip=False,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo de deck de partida para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param file_path: Caminho do arquivo de deck de partida a ser enviado.
    :type file_path: Union[Path, str]
    :param partida_config: Configuração da partida associada ao deck.
    :type partida_config: PartidaConfig
    :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
    :type save_zip: bool
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """

    return upload(
        method=self._caso_api.upload_deck_partida,
        error_context="de arquivo de deck de partida",
        caso_id=caso_id,
        files=file_path,
        save_zip=save_zip,
        partida_config=partida_config,
    )

upload_deck_partida_semanal(caso_id, file_path, partida_semanal_config, save_zip=False)

Faz o upload de um arquivo de deck de partida semanal para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
file_path	Union[Path, str]	Caminho do arquivo de deck de partida semanal a ser enviado.	required
partida_semanal_config	PartidaSemanalConfig	Configuração da partida semanal associada ao deck.	required
save_zip	bool	Indica se o arquivo zip gerado em memória deve ser salvo	False

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_deck_partida_semanal(
    self,
    caso_id: Union[UUID, str],
    file_path: Union[Path, str],
    partida_semanal_config: PartidaSemanalConfig,
    save_zip=False,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo de deck de partida semanal para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param file_path: Caminho do arquivo de deck de partida semanal a ser enviado.
    :type file_path: Union[Path, str]
    :param partida_semanal_config: Configuração da partida semanal associada ao deck.
    :type partida_semanal_config: PartidaSemanalConfig
    :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo
    :type save_zip: bool
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """

    return upload(
        method=self._caso_api.upload_deck_partida_semanal,
        error_context="de arquivo de deck de partida semanal",
        caso_id=caso_id,
        files=file_path,
        save_zip=save_zip,
        partida_semanal_config=partida_semanal_config,
    )

upload_ena_ree(caso_id, filename, data_prevs)

Faz o upload de um arquivo ENA-REE para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
filename	Union[Path, str]	Caminho do arquivo ENA-REE a ser enviado.	required
data_prevs	Union[datetime, str]	Data de previsão utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD	required

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_ena_ree(
    self,
    caso_id: Union[UUID, str],
    filename: Union[Path, str],
    data_prevs: Union[datetime, str],
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo ENA-REE para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param filename: Caminho do arquivo ENA-REE a ser enviado.
    :type filename: Union[Path, str]
    :param data_prevs: Data de previsão utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD
    :type data_prevs: Union[datetime, str]
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """
    if isinstance(data_prevs, datetime):
        data_prevs = data_prevs.strftime("%Y-%m-%d")
    elif isinstance(data_prevs, str):
        try:
            datetime.strptime(data_prevs, "%Y-%m-%d")
        except ValueError:
            logger.error(
                "O formato da data_prevs está incorreto. Use o formato YYYY-MM-DD.",
                exc_info=False,
            )
            return None

    ret = upload(
        self._caso_api.upload_ena_ree,
        "de arquivo ENA-REE",
        caso_id,
        filename,
        use_full_path=False,
        data_prevs=data_prevs,
        should_zip=False
    )
    return ret

upload_entrada(caso_id, filename)

Faz o upload de um arquivo de entrada para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
filename	Union[Path, str]	Caminho do arquivo a ser enviado.	required

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_entrada(
    self, caso_id: Union[UUID, str], filename: Union[Path, str]
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo de entrada para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param filename: Caminho do arquivo a ser enviado.
    :type filename: Union[Path, str]
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """
    ret = upload(
        self._caso_api.upload_file_entrada,
        "de arquivo de entrada",
        caso_id,
        filename,
        use_full_path=False,
        should_zip=False
    )
    return ret

upload_files(caso_id, files, save_zip=False)

Faz o upload de arquivos ou diretórios para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
files	Union[List[Path], List[str], Path, str]	Arquivo(s) ou diretório a ser enviado.	required
save_zip	bool	Indica se o arquivo zip gerado em memória deve ser salvo localmente.	False

Returns:

Type	Description
List[FileUploadResponse]	Lista de respostas da API com os detalhes dos arquivos enviados.

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

def upload_files(
    self,
    caso_id: Union[UUID, str],
    files: Union[List[Path], List[str], Path, str],
    save_zip: bool = False,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de arquivos ou diretórios para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param files: Arquivo(s) ou diretório a ser enviado.
    :type files: Union[List[Path], List[str], Path, str]
    :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
    :type save_zip: bool
    :return: Lista de respostas da API com os detalhes dos arquivos enviados.
    :rtype: List[FileUploadResponse]
    """
    return upload(
        self._caso_api.upload_files,
        "de arquivo(s) do caso",
        caso_id,
        files,
        save_zip,
    )

upload_prevs(caso_id, files, encadeamento=None, save_zip=False)

Faz o upload de arquivos de previsões para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
files	Union[List[Path], List[str], Path, str]	Arquivo(s) de previsões a ser(em) enviado(s).	required
save_zip	bool	Indica se o arquivo zip gerado em memória deve ser salvo localmente.	False

Returns:

Type	Description
List[FileUploadResponse]	Lista de respostas da API com os detalhes dos arquivos de previsões enviados.

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

def upload_prevs(
    self,
    caso_id: Union[UUID, str],
    files: Union[List[Path], List[str], Path, str],
    encadeamento: Optional[TipoEncadeamentoSemanal] = None,
    save_zip: bool = False,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de arquivos de previsões para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param files: Arquivo(s) de previsões a ser(em) enviado(s).
    :type files: Union[List[Path], List[str], Path, str]
    :param save_zip: Indica se o arquivo zip gerado em memória deve ser salvo localmente.
    :type save_zip: bool
    :return: Lista de respostas da API com os detalhes dos arquivos de previsões enviados.
    :rtype: List[FileUploadResponse]
    """
    return upload(
        self._caso_api.upload_prevs_files,
        "de arquivo(s) de previsões",
        caso_id,
        files,
        save_zip=save_zip,
        should_zip=False,
        encadeamento=encadeamento
    )

upload_regras_ana(caso_id, filename, apaga_regras=TipoApagaRegrasEnum.N)

Faz o upload de um arquivo de regras ANA para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
filename	Union[Path, str]	Caminho do arquivo de regras ANA a ser enviado.	required
apaga_regras	Optional[TipoApagaRegrasEnum]	Indica se as regras existentes devem ser apagadas antes do upload.	N

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_regras_ana(
    self,
    caso_id: Union[UUID, str],
    filename: Union[Path, str],
    apaga_regras: Optional[TipoApagaRegrasEnum] = TipoApagaRegrasEnum.N,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo de regras ANA para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param filename: Caminho do arquivo de regras ANA a ser enviado.
    :type filename: Union[Path, str]
    :param apaga_regras: Indica se as regras existentes devem ser apagadas antes do upload.
    :type apaga_regras: Optional[TipoApagaRegrasEnum]
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """
    ret = upload(
        self._caso_api.upload_regras_ana,
        "de arquivo de regras ANA",
        caso_id,
        filename,
        use_full_path=False,
        apaga_regras=apaga_regras,
    )
    return ret

upload_volume_final_decomp(caso_id, filename, tipo_alteracao)

Faz o upload de um arquivo de volume final DECOMP para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
filename	Union[Path, str]	Caminho do arquivo de volume final DECOMP a ser enviado.	required
tipo_alteracao	TipoAlteracaoEnum	Tipo de alteração para o upload do arquivo.	required

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_volume_final_decomp(
    self,
    caso_id: Union[UUID, str],
    filename: Union[Path, str],
    tipo_alteracao: TipoAlteracaoEnum,
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo de volume final DECOMP para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param filename: Caminho do arquivo de volume final DECOMP a ser enviado.
    :type filename: Union[Path, str]
    :param tipo_alteracao: Tipo de alteração para o upload do arquivo.
    :type tipo_alteracao: TipoAlteracaoEnum
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """
    ret = upload(
        self._caso_api.upload_volume_final_decomp,
        "de arquivo de volume final DECOMP",
        caso_id,
        filename,
        use_full_path=False,
        tipo_alteracao=tipo_alteracao,
        should_zip=False
    )
    return ret

upload_volume_partida_decomp(caso_id, filename, data_volume_partida)

Faz o upload de um arquivo de volume parcial DECOMP para um caso.

Parameters:

Name	Type	Description	Default
caso_id	Union[UUID, str]	Identificador único do caso.	required
filename	Union[Path, str]	Caminho do arquivo de volume parcial DECOMP a ser enviado.	required
data_volume_partida	Union[datetime, str]	Data do volume de partida utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD	required

Returns:

Type	Description
Union[FileUploadResponse, None]	Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.

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

def upload_volume_partida_decomp(
    self,
    caso_id: Union[UUID, str],
    filename: Union[Path, str],
    data_volume_partida: Union[datetime, str],
) -> Union[FileUploadResponse, None]:
    """
    Faz o upload de um arquivo de volume parcial DECOMP para um caso.

    :param caso_id: Identificador único do caso.
    :type caso_id: Union[UUID, str]
    :param filename: Caminho do arquivo de volume parcial DECOMP a ser enviado.
    :type filename: Union[Path, str]
    :param data_volume_partida: Data do volume de partida utilizada na configuração do arquivo. Formato obrigatório: YYYY-MM-DD
    :type data_volume_partida: Union[datetime, str]
    :return: Resposta da API com os detalhes do arquivo enviado ou None em caso de erro.
    :rtype: Union[FileUploadResponse, None]
    """
    if isinstance(data_volume_partida, datetime):
        data_volume_partida = data_volume_partida.strftime("%Y-%m-%d")
    elif isinstance(data_volume_partida, str):
        try:
            datetime.strptime(data_volume_partida, "%Y-%m-%d")
        except ValueError:
            logger.error(
                "O formato da data_volume_partida está incorreto. Use o formato YYYY-MM-DD.",
                exc_info=False,
            )
            return None

    ret = upload(
        self._caso_api.upload_volume_partida_decomp,
        "de arquivo de volume parcial DECOMP",
        caso_id,
        filename,
        use_full_path=False,
        data_volume_partida=data_volume_partida,
        should_zip=False
    )
    return ret