redmine-api-cpp/include/Redmine/Project.hpp

85 lines
2.4 KiB
C++

#pragma once
/*
* Copyright (C) 2024 Dominik Meyer
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "nlohmann/json_fwd.hpp"
#include <cstdint>
#include <nlohmann/json.hpp>
#include <Redmine/Object.hpp>
#include <string>
/**
* @brief The main namespace of this library for Redmine related datatypes, classes, and functions
*
*/
namespace Redmine
{
/**
* @brief This class represents a user within the redmine server.
*
*/
class Project : public Redmine::Object
{
private:
/// the data store for the issue
nlohmann::json data_;
/**
* @brief verify project data
*
* @param data - the json object containing the project data
*/
void _verify(const nlohmann::json &data);
public:
explicit Project(const nlohmann::json &project);
/**
* @brief set the project object from a json object
*
* @param data
*/
void set(const nlohmann::json &data);
/**
* @brief return a json object from the project object
*
* @return nlohmann::json
*/
nlohmann::json get() const;
/**
* @brief Get the Id of the project
*
* @return std::uint64_t
*/
std::uint64_t getId() const;
std::string getName() const;
std::string getStringID() const;
/**
* @brief convert the project object to a string
*
* @return std::string
*/
std::string to_string() const;
}; // class Project
}; // namespace Redmine