aboutsummaryrefslogtreecommitdiff
path: root/lib/identity/definitions/request_email_validation.h
blob: 99487073b16bab116ca8983fa47597ce57bcff59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "converters.h"

namespace Quotient
{

// Data structures

struct RequestEmailValidation
{
    /// A unique string generated by the client, and used to identify
    /// thevalidation attempt. It must be a string consisting of the
    /// characters``[0-9a-zA-Z.=_-]``. Its length must not exceed 255 characters
    /// and itmust not be empty.
    QString clientSecret;
    /// The email address to validate.
    QString email;
    /// The server will only send an email if the ``send_attempt``is a number
    /// greater than the most recent one which it has seen,scoped to that
    /// ``email`` + ``client_secret`` pair. This is toavoid repeatedly sending
    /// the same email in the case of requestretries between the POSTing user
    /// and the identity server.The client should increment this value if they
    /// desire a newemail (e.g. a reminder) to be sent.
    int sendAttempt;
    /// Optional. When the validation is completed, the identityserver will
    /// redirect the user to this URL.
    QString nextLink;
};

template <>
struct JsonObjectConverter<RequestEmailValidation>
{
    static void dumpTo(QJsonObject& jo, const RequestEmailValidation& pod);
    static void fillFrom(const QJsonObject& jo, RequestEmailValidation& pod);
};

} // namespace Quotient