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.
212 lines
6.0 KiB
C++
212 lines
6.0 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.
|
|
*/
|
|
|
|
/*
|
|
* EsignDocument.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_EsignDocument_H_
|
|
#define HANZO_MODEL_EsignDocument_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include "hanzo/model/EsignRecipient.h"
|
|
#include <cpprest/details/basic_types.h>
|
|
#include <vector>
|
|
#include "hanzo/model/EsignField.h"
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
class EsignField;
|
|
class EsignRecipient;
|
|
|
|
|
|
class EsignDocument
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
EsignDocument();
|
|
virtual ~EsignDocument();
|
|
|
|
/////////////////////////////////////////////
|
|
/// 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;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// EsignDocument members
|
|
|
|
|
|
/// <summary>
|
|
/// CompletedAt is when the document sealed, in unix milliseconds; null until it does.
|
|
/// </summary>
|
|
int64_t getCompletedAt() const;
|
|
bool completedAtIsSet() const;
|
|
void unsetCompletedAt();
|
|
void setCompletedAt(int64_t value);
|
|
|
|
/// <summary>
|
|
/// CreatedAt is when the document was uploaded, in unix milliseconds.
|
|
/// </summary>
|
|
int64_t getCreatedAt() const;
|
|
bool createdAtIsSet() const;
|
|
void unsetCreatedAt();
|
|
void setCreatedAt(int64_t value);
|
|
|
|
/// <summary>
|
|
/// ExternalID is the caller's own identifier for this document, echoed back as it was given; null when none was.
|
|
/// </summary>
|
|
utility::string_t getExternalId() const;
|
|
bool externalIdIsSet() const;
|
|
void unsetExternalId();
|
|
void setExternalId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Fields is every field on the document, ordered by page and then by when it was placed.
|
|
/// </summary>
|
|
std::vector<std::shared_ptr<EsignField>> getFields() const;
|
|
bool fieldsIsSet() const;
|
|
void unsetFields();
|
|
void setFields(const std::vector<std::shared_ptr<EsignField>>& value);
|
|
|
|
/// <summary>
|
|
/// ID is the document id.
|
|
/// </summary>
|
|
utility::string_t getId() const;
|
|
bool idIsSet() const;
|
|
void unsetId();
|
|
void setId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Message is the covering message stored with the document; null when none was given. Nothing in this surface sends it.
|
|
/// </summary>
|
|
utility::string_t getMessage() const;
|
|
bool messageIsSet() const;
|
|
void unsetMessage();
|
|
void setMessage(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Recipients is everyone on the document, ordered by signing order and then by when they were added — which is also the order a SEQUENTIAL document enforces.
|
|
/// </summary>
|
|
std::vector<std::shared_ptr<EsignRecipient>> getRecipients() const;
|
|
bool recipientsIsSet() const;
|
|
void unsetRecipients();
|
|
void setRecipients(const std::vector<std::shared_ptr<EsignRecipient>>& value);
|
|
|
|
/// <summary>
|
|
/// SigningOrder is PARALLEL or SEQUENTIAL, fixed when the document was created.
|
|
/// </summary>
|
|
utility::string_t getSigningOrder() const;
|
|
bool signingOrderIsSet() const;
|
|
void unsetSigningOrder();
|
|
void setSigningOrder(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Source is how the document came to exist. It is DOCUMENT for everything this surface creates.
|
|
/// </summary>
|
|
utility::string_t getSource() const;
|
|
bool sourceIsSet() const;
|
|
void unsetSource();
|
|
void setSource(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Status is DRAFT while recipients and fields may still be added, PENDING once it has gone out, then COMPLETED when every signer has finished or REJECTED if any one of them declined.
|
|
/// </summary>
|
|
utility::string_t getStatus() const;
|
|
bool statusIsSet() const;
|
|
void unsetStatus();
|
|
void setStatus(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Subject is the covering subject line stored with the document; null when none was given.
|
|
/// </summary>
|
|
utility::string_t getSubject() const;
|
|
bool subjectIsSet() const;
|
|
void unsetSubject();
|
|
void setSubject(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Title is the document's name, and the stem of the download filename.
|
|
/// </summary>
|
|
utility::string_t getTitle() const;
|
|
bool titleIsSet() const;
|
|
void unsetTitle();
|
|
void setTitle(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// UpdatedAt is when the document last changed, in unix milliseconds.
|
|
/// </summary>
|
|
int64_t getUpdatedAt() const;
|
|
bool updatedAtIsSet() const;
|
|
void unsetUpdatedAt();
|
|
void setUpdatedAt(int64_t value);
|
|
|
|
|
|
protected:
|
|
int64_t m_CompletedAt;
|
|
bool m_CompletedAtIsSet;
|
|
|
|
int64_t m_CreatedAt;
|
|
bool m_CreatedAtIsSet;
|
|
|
|
utility::string_t m_ExternalId;
|
|
bool m_ExternalIdIsSet;
|
|
|
|
std::vector<std::shared_ptr<EsignField>> m_Fields;
|
|
bool m_FieldsIsSet;
|
|
|
|
utility::string_t m_Id;
|
|
bool m_IdIsSet;
|
|
|
|
utility::string_t m_Message;
|
|
bool m_MessageIsSet;
|
|
|
|
std::vector<std::shared_ptr<EsignRecipient>> m_Recipients;
|
|
bool m_RecipientsIsSet;
|
|
|
|
utility::string_t m_SigningOrder;
|
|
bool m_SigningOrderIsSet;
|
|
|
|
utility::string_t m_Source;
|
|
bool m_SourceIsSet;
|
|
|
|
utility::string_t m_Status;
|
|
bool m_StatusIsSet;
|
|
|
|
utility::string_t m_Subject;
|
|
bool m_SubjectIsSet;
|
|
|
|
utility::string_t m_Title;
|
|
bool m_TitleIsSet;
|
|
|
|
int64_t m_UpdatedAt;
|
|
bool m_UpdatedAtIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_EsignDocument_H_ */
|