aboutsummaryrefslogtreecommitdiff
path: root/lib/identity/definitions/request_msisdn_validation.h
blob: c4fe479e902aa035f0bd982f7037c1fa0b0008bf (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
43
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "converters.h"

#include "converters.h"

namespace QMatrixClient {
    // Data structures

    struct RequestMsisdnValidation {
        /// A unique string generated by the client, and used to identify the
        /// validation attempt. It must be a string consisting of the characters
        /// ``[0-9a-zA-Z.=_-]``. Its length must not exceed 255 characters and
        /// it must not be empty.
        QString clientSecret;
        /// The two-letter uppercase ISO country code that the number in
        /// ``phone_number`` should be parsed as if it were dialled from.
        QString country;
        /// The phone number to validate.
        QString phoneNumber;
        /// The server will only send an SMS if the ``send_attempt`` is a
        /// number greater than the most recent one which it has seen,
        /// scoped to that ``country`` + ``phone_number`` + ``client_secret``
        /// triple. This is to avoid repeatedly sending the same SMS in
        /// the case of request retries between the POSTing user and the
        /// identity server. The client should increment this value if
        /// they desire a new SMS (e.g. a reminder) to be sent.
        int sendAttempt;
        /// Optional. When the validation is completed, the identity
        /// server will redirect the user to this URL.
        QString nextLink;
    };
    template <> struct JsonObjectConverter<RequestMsisdnValidation> {
        static void dumpTo(QJsonObject& jo, const RequestMsisdnValidation& pod);
        static void fillFrom(const QJsonObject& jo,
                             RequestMsisdnValidation& pod);
    };

} // namespace QMatrixClient