mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
The projection these were generated from was a month old and predated the compute migration, so every one of them described /v1/visor — which the API serves at zero paths now. That is why a hand-written console client and a generated one had drifted the same way at the same time. No /v1/visor path survives here. The word still appears as a source-plane value and inside gvisor and supervisor, which are not this rename.
263 lines
9.1 KiB
C++
263 lines
9.1 KiB
C++
/**
|
|
* Hanzo Cloud API
|
|
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
|
|
*
|
|
* The version of the OpenAPI document: v1
|
|
*
|
|
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
/*
|
|
* IssueView.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_IssueView_H_
|
|
#define HANZO_MODEL_IssueView_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
#include <vector>
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class IssueView
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
IssueView();
|
|
virtual ~IssueView();
|
|
|
|
/////////////////////////////////////////////
|
|
/// ModelBase overrides
|
|
|
|
void validate() override;
|
|
|
|
web::json::value toJson() const override;
|
|
bool fromJson(const web::json::value& json) override;
|
|
|
|
void toMultipart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) const override;
|
|
bool fromMultiPart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) override;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// IssueView members
|
|
|
|
|
|
/// <summary>
|
|
/// Assignee is who holds the work — an IAM username, or the login of the FIRST assignee when a forge issue has several. Absent when nobody holds it, which is exactly the state a claim needs.
|
|
/// </summary>
|
|
utility::string_t getAssignee() const;
|
|
bool assigneeIsSet() const;
|
|
void unsetAssignee();
|
|
void setAssignee(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// CreatedAt is when the item was opened, in unix seconds. 0 when the source gave no parseable timestamp.
|
|
/// </summary>
|
|
int64_t getCreatedAt() const;
|
|
bool createdAtIsSet() const;
|
|
void unsetCreatedAt();
|
|
void setCreatedAt(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Description is the body, markdown as its author wrote it. Absent when empty.
|
|
/// </summary>
|
|
utility::string_t getDescription() const;
|
|
bool descriptionIsSet() const;
|
|
void unsetDescription();
|
|
void setDescription(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// DueAt is when the work is due, in unix seconds; absent means no due date. A forge row takes it from its MILESTONE's due date, since a forge issue has no deadline of its own. Never before StartAt, and never past 2200-01-01.
|
|
/// </summary>
|
|
int64_t getDueAt() const;
|
|
bool dueAtIsSet() const;
|
|
void unsetDueAt();
|
|
void setDueAt(int64_t value);
|
|
|
|
/// <summary>
|
|
/// ExtRef anchors the item to something outside the todo — a mirrored issue (\"github:owner/repo#123\"), a pushed PR branch, or a record on another plane. It is the idempotency key the mirror upsert matches on. Absent when the item has no external origin.
|
|
/// </summary>
|
|
utility::string_t getExtRef() const;
|
|
bool extRefIsSet() const;
|
|
void unsetExtRef();
|
|
void setExtRef(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// ID is the work item's opaque handle, and it is NOT how you address it — ProjectKey plus Number is. Its shape says which source answered: a forge issue's is the forge's own numeric id in decimal, an index row's a minted \"issue_\" id.
|
|
/// </summary>
|
|
utility::string_t getId() const;
|
|
bool idIsSet() const;
|
|
void unsetId();
|
|
void setId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Identifier is the human handle, \"<key>#<number>\" — the board and the number on it, joined. ONE spelling whichever source answered, because a list where forge rows read cli#1 and index rows read OPS-3 is two products in one list.
|
|
/// </summary>
|
|
utility::string_t getIdentifier() const;
|
|
bool identifierIsSet() const;
|
|
void unsetIdentifier();
|
|
void setIdentifier(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Kind is what the item IS: issue, pr or epic. Set once at create and never changed, so a row does not migrate between surfaces. Deliberately not \"task\" — that word is the async plane (contract.go).
|
|
/// </summary>
|
|
utility::string_t getKind() const;
|
|
bool kindIsSet() const;
|
|
void unsetKind();
|
|
void setKind(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Labels are the item's remaining tags, with the status and priority labels lifted OUT — a column that stayed here would render twice, once as the card's column and once as a chip on the card. Always present; empty is [].
|
|
/// </summary>
|
|
std::vector<utility::string_t> getLabels() const;
|
|
bool labelsIsSet() const;
|
|
void unsetLabels();
|
|
void setLabels(const std::vector<utility::string_t>& value);
|
|
|
|
/// <summary>
|
|
/// Number is the item's number ON ITS BOARD, from 1 and monotonic there — the forge's own issue number for a forge row, allocated inside the create transaction for an index row so it cannot race. Unique per board, never across the org.
|
|
/// </summary>
|
|
int64_t getNumber() const;
|
|
bool numberIsSet() const;
|
|
void unsetnumber();
|
|
void setNumber(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Priority is urgent, high, medium, low or none. Also a label on a forge row. Never empty: \"none\" when nothing names one, so callers compare a value rather than test for absence.
|
|
/// </summary>
|
|
utility::string_t getPriority() const;
|
|
bool priorityIsSet() const;
|
|
void unsetPriority();
|
|
void setPriority(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// ProjectKey is the board this item is on: the repository name for a forge issue, the index board's key otherwise. With Number it is the item's address in every other route.
|
|
/// </summary>
|
|
utility::string_t getProjectKey() const;
|
|
bool projectKeyIsSet() const;
|
|
void unsetProjectKey();
|
|
void setProjectKey(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Repo is the git repository the item is bound to, so a repository's Issues and PRs tabs are filters over this one table. Absent when the item is not repo-bound.
|
|
/// </summary>
|
|
utility::string_t getRepo() const;
|
|
bool repoIsSet() const;
|
|
void unsetRepo();
|
|
void setRepo(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Source is which surface OPENED it: team, git, crm, helpdesk, cms or agent. Also set once. It is the ORIGIN, not the subject — source=helpdesk is an engineering issue opened from a support escalation, not a support ticket.
|
|
/// </summary>
|
|
utility::string_t getSource() const;
|
|
bool sourceIsSet() const;
|
|
void unsetSource();
|
|
void setSource(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// StartAt is when the work starts, in unix seconds; absent means unscheduled. A forge row takes it from when the issue was opened, but only once the issue has a due date — an interval needs both ends.
|
|
/// </summary>
|
|
int64_t getStartAt() const;
|
|
bool startAtIsSet() const;
|
|
void unsetStartAt();
|
|
void setStartAt(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Status is the board column: backlog, todo, in_progress, done or canceled, and nothing else. On a forge row it is read off a LABEL, so relabelling in the forge web UI moves the card here and vice versa — and a CLOSED forge issue reads done whatever its labels say. Never empty: \"backlog\" when nothing names a column.
|
|
/// </summary>
|
|
utility::string_t getStatus() const;
|
|
bool statusIsSet() const;
|
|
void unsetStatus();
|
|
void setStatus(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Title is the item's one-line summary.
|
|
/// </summary>
|
|
utility::string_t getTitle() const;
|
|
bool titleIsSet() const;
|
|
void unsetTitle();
|
|
void setTitle(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// UpdatedAt is when it last changed, in unix seconds.
|
|
/// </summary>
|
|
int64_t getUpdatedAt() const;
|
|
bool updatedAtIsSet() const;
|
|
void unsetUpdatedAt();
|
|
void setUpdatedAt(int64_t value);
|
|
|
|
|
|
protected:
|
|
utility::string_t m_Assignee;
|
|
bool m_AssigneeIsSet;
|
|
|
|
int64_t m_CreatedAt;
|
|
bool m_CreatedAtIsSet;
|
|
|
|
utility::string_t m_Description;
|
|
bool m_DescriptionIsSet;
|
|
|
|
int64_t m_DueAt;
|
|
bool m_DueAtIsSet;
|
|
|
|
utility::string_t m_ExtRef;
|
|
bool m_ExtRefIsSet;
|
|
|
|
utility::string_t m_Id;
|
|
bool m_IdIsSet;
|
|
|
|
utility::string_t m_Identifier;
|
|
bool m_IdentifierIsSet;
|
|
|
|
utility::string_t m_Kind;
|
|
bool m_KindIsSet;
|
|
|
|
std::vector<utility::string_t> m_Labels;
|
|
bool m_LabelsIsSet;
|
|
|
|
int64_t m_number;
|
|
bool m_numberIsSet;
|
|
|
|
utility::string_t m_Priority;
|
|
bool m_PriorityIsSet;
|
|
|
|
utility::string_t m_ProjectKey;
|
|
bool m_ProjectKeyIsSet;
|
|
|
|
utility::string_t m_Repo;
|
|
bool m_RepoIsSet;
|
|
|
|
utility::string_t m_Source;
|
|
bool m_SourceIsSet;
|
|
|
|
int64_t m_StartAt;
|
|
bool m_StartAtIsSet;
|
|
|
|
utility::string_t m_Status;
|
|
bool m_StatusIsSet;
|
|
|
|
utility::string_t m_Title;
|
|
bool m_TitleIsSet;
|
|
|
|
int64_t m_UpdatedAt;
|
|
bool m_UpdatedAtIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_IssueView_H_ */
|