aboutsummaryrefslogtreecommitdiff
path: root/lib/identity/definitions/request_msisdn_validation.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-02 16:08:13 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:00:06 +0900
commit1e6510790dab6b9141ae52993987b406399668cd (patch)
tree1a45c0ccfec8f5f7ba37eb4385cdc7f61afa0c97 /lib/identity/definitions/request_msisdn_validation.h
parent4244cee8d5e0f760cccd2b45ad587670573ef03c (diff)
downloadlibquotient-1e6510790dab6b9141ae52993987b406399668cd.tar.gz
libquotient-1e6510790dab6b9141ae52993987b406399668cd.zip
Support CS API 0.4.0
Numerous changes in CS (and now also AS) API, including compatibility-breaking ones - see the diff for details.
Diffstat (limited to 'lib/identity/definitions/request_msisdn_validation.h')
-rw-r--r--lib/identity/definitions/request_msisdn_validation.h47
1 files changed, 47 insertions, 0 deletions
diff --git a/lib/identity/definitions/request_msisdn_validation.h b/lib/identity/definitions/request_msisdn_validation.h
new file mode 100644
index 00000000..77bea2bc
--- /dev/null
+++ b/lib/identity/definitions/request_msisdn_validation.h
@@ -0,0 +1,47 @@
+/******************************************************************************
+ * 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;
+ };
+
+ QJsonObject toJson(const RequestMsisdnValidation& pod);
+
+ template <> struct FromJsonObject<RequestMsisdnValidation>
+ {
+ RequestMsisdnValidation operator()(const QJsonObject& jo) const;
+ };
+
+} // namespace QMatrixClient