aboutsummaryrefslogtreecommitdiff
path: root/lib/identity/definitions
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2020-04-17 07:42:13 +0200
committerKitsune Ral <Kitsune-Ral@users.sf.net>2020-04-17 07:49:41 +0200
commit7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424 (patch)
treefa9e37d8874303bf56d5381b0844738bd516a79b /lib/identity/definitions
parent906699cc525e9e0be231a58cabffc31ad1f5193c (diff)
downloadlibquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.tar.gz
libquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.zip
Regenerate API files using new GTAD and refreshed templates
No functional changes.
Diffstat (limited to 'lib/identity/definitions')
-rw-r--r--lib/identity/definitions/request_email_validation.h37
-rw-r--r--lib/identity/definitions/request_msisdn_validation.h43
-rw-r--r--lib/identity/definitions/sid.h17
3 files changed, 48 insertions, 49 deletions
diff --git a/lib/identity/definitions/request_email_validation.h b/lib/identity/definitions/request_email_validation.h
index 99487073..32c6eaaf 100644
--- a/lib/identity/definitions/request_email_validation.h
+++ b/lib/identity/definitions/request_email_validation.h
@@ -6,35 +6,36 @@
#include "converters.h"
-namespace Quotient
-{
+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.
+struct RequestEmailValidation {
+ /// 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 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.
+
+ /// 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 to
+ /// avoid repeatedly sending the same email 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
+ /// email (e.g. a reminder) to be sent.
int sendAttempt;
- /// Optional. When the validation is completed, the identityserver will
- /// redirect the user to this URL.
+
+ /// Optional. When the validation is completed, the identity
+ /// server will redirect the user to this URL.
QString nextLink;
};
template <>
-struct JsonObjectConverter<RequestEmailValidation>
-{
+struct JsonObjectConverter<RequestEmailValidation> {
static void dumpTo(QJsonObject& jo, const RequestEmailValidation& pod);
static void fillFrom(const QJsonObject& jo, RequestEmailValidation& pod);
};
diff --git a/lib/identity/definitions/request_msisdn_validation.h b/lib/identity/definitions/request_msisdn_validation.h
index ecccf567..90aed7b8 100644
--- a/lib/identity/definitions/request_msisdn_validation.h
+++ b/lib/identity/definitions/request_msisdn_validation.h
@@ -6,39 +6,40 @@
#include "converters.h"
-namespace Quotient
-{
+namespace Quotient {
// Data structures
-struct RequestMsisdnValidation
-{
- /// 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.
+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.
+
+ /// 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 anumber
- /// 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 inthe case of request retries
- /// between the POSTing user and theidentity server. The client should
- /// increment this value ifthey desire a new SMS (e.g. a reminder) to be
- /// sent.
+
+ /// 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 identityserver will
- /// redirect the user to this URL.
+
+ /// Optional. When the validation is completed, the identity
+ /// server will redirect the user to this URL.
QString nextLink;
};
template <>
-struct JsonObjectConverter<RequestMsisdnValidation>
-{
+struct JsonObjectConverter<RequestMsisdnValidation> {
static void dumpTo(QJsonObject& jo, const RequestMsisdnValidation& pod);
static void fillFrom(const QJsonObject& jo, RequestMsisdnValidation& pod);
};
diff --git a/lib/identity/definitions/sid.h b/lib/identity/definitions/sid.h
index 0f7ce58a..981826f6 100644
--- a/lib/identity/definitions/sid.h
+++ b/lib/identity/definitions/sid.h
@@ -6,23 +6,20 @@
#include "converters.h"
-namespace Quotient
-{
+namespace Quotient {
// Data structures
-struct Sid
-{
- /// The session ID. Session IDs are opaque strings generated by the
- /// identityserver. They must consist entirely of the
- /// characters``[0-9a-zA-Z.=_-]``. Their length must not exceed 255
- /// characters and theymust not be empty.
+struct Sid {
+ /// The session ID. Session IDs are opaque strings generated by the identity
+ /// server. They must consist entirely of the characters
+ /// ``[0-9a-zA-Z.=_-]``. Their length must not exceed 255 characters and
+ /// they must not be empty.
QString sid;
};
template <>
-struct JsonObjectConverter<Sid>
-{
+struct JsonObjectConverter<Sid> {
static void dumpTo(QJsonObject& jo, const Sid& pod);
static void fillFrom(const QJsonObject& jo, Sid& pod);
};