Package app.kntrl.client.openapi.model

Class QuestionsAuthCfg

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class QuestionsAuthCfg
extends java.lang.Object
    QuestionsAuthCfg

    • Field Detail

      • SERIALIZED_NAME_REQUIRES_AUTH

        public static final java.lang.String SERIALIZED_NAME_REQUIRES_AUTH
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SKIP_ON_FAIL

        public static final java.lang.String SERIALIZED_NAME_SKIP_ON_FAIL
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RATE_LIMITER

        public static final java.lang.String SERIALIZED_NAME_RATE_LIMITER
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_BURN_QUOTA

        public static final java.lang.String SERIALIZED_NAME_BURN_QUOTA
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LOWERCASE

        public static final java.lang.String SERIALIZED_NAME_LOWERCASE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REMOVE_SYMBOLS

        public static final java.lang.String SERIALIZED_NAME_REMOVE_SYMBOLS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REMOVE_SPACES

        public static final java.lang.String SERIALIZED_NAME_REMOVE_SPACES
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MIN_LENGTH

        public static final java.lang.String SERIALIZED_NAME_MIN_LENGTH
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MAX_LENGTH

        public static final java.lang.String SERIALIZED_NAME_MAX_LENGTH
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ANSWERS_REQUIRED

        public static final java.lang.String SERIALIZED_NAME_ANSWERS_REQUIRED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MAX_ANSWERS

        public static final java.lang.String SERIALIZED_NAME_MAX_ANSWERS
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • QuestionsAuthCfg

        public QuestionsAuthCfg()

    • Method Detail

      • requiresAuth

        public QuestionsAuthCfg requiresAuth​(java.util.List<java.util.List<java.lang.String>> requiresAuth)

      • addRequiresAuthItem

        public QuestionsAuthCfg addRequiresAuthItem​(java.util.List<java.lang.String> requiresAuthItem)

      • getRequiresAuth

        @Nullable
public java.util.List<java.util.List<java.lang.String>> getRequiresAuth()
        If this is not null, app forbids to add this auth until listed auth enabled. - if this a string -> require specified auth to be enabled before this. - array of strings -> require any of listed auths to be enabled - array of arrays of strings -> works as `[ [ \"auth1\" and \"auth2\" ] or [ \"auth1\" and \"auth2\" ] ]`
        Returns:
        requiresAuth

      • setRequiresAuth

        public void setRequiresAuth​(java.util.List<java.util.List<java.lang.String>> requiresAuth)

      • skipOnFail

        public QuestionsAuthCfg skipOnFail​(java.lang.Boolean skipOnFail)

      • getSkipOnFail

        @Nullable
public java.lang.Boolean getSkipOnFail()
        When this is set to true app will attempt next auth in case of error on current. It's works good with IP auth. User can provide both IP auth request and SMS auth request. And SMS will be executed only when IP auth is failed. If set to false any error on this auth will stop the whole request execution.
        Returns:
        skipOnFail

      • setSkipOnFail

        public void setSkipOnFail​(java.lang.Boolean skipOnFail)

      • rateLimiter

        public QuestionsAuthCfg rateLimiter​(java.lang.String rateLimiter)

      • getRateLimiter

        @Nullable
public java.lang.String getRateLimiter()
        Apply rate limiter for this auth.
        Returns:
        rateLimiter

      • setRateLimiter

        public void setRateLimiter​(java.lang.String rateLimiter)

      • getBurnQuota

        @Nullable
public java.lang.Double getBurnQuota()
        Every auth execution will burn this amount of quota. Takes place only when rate limiter is specified
        Returns:
        burnQuota

      • setBurnQuota

        public void setBurnQuota​(java.lang.Double burnQuota)

      • lowercase

        public QuestionsAuthCfg lowercase​(java.lang.Boolean lowercase)

      • getLowercase

        @Nullable
public java.lang.Boolean getLowercase()
        Transform user answer to lowercase letters. This allows user still pass a check when he wrote name or city with different cases. `false` means strict match, so \"John\" != \"john\"
        Returns:
        lowercase

      • setLowercase

        public void setLowercase​(java.lang.Boolean lowercase)

      • removeSymbols

        public QuestionsAuthCfg removeSymbols​(java.lang.Boolean removeSymbols)

      • getRemoveSymbols

        @Nullable
public java.lang.Boolean getRemoveSymbols()
        Remove all non-letters from user answer.
        Returns:
        removeSymbols

      • setRemoveSymbols

        public void setRemoveSymbols​(java.lang.Boolean removeSymbols)

      • removeSpaces

        public QuestionsAuthCfg removeSpaces​(java.lang.Boolean removeSpaces)

      • getRemoveSpaces

        @Nullable
public java.lang.Boolean getRemoveSpaces()
        Remove all spaces from user answer.
        Returns:
        removeSpaces

      • setRemoveSpaces

        public void setRemoveSpaces​(java.lang.Boolean removeSpaces)

      • minLength

        public QuestionsAuthCfg minLength​(java.lang.Integer minLength)

      • getMinLength

        @Nullable
public java.lang.Integer getMinLength()
        Min length of answer. Length are checked after all answer transformation.
        Returns:
        minLength

      • setMinLength

        public void setMinLength​(java.lang.Integer minLength)

      • maxLength

        public QuestionsAuthCfg maxLength​(java.lang.Integer maxLength)

      • getMaxLength

        @Nullable
public java.lang.Integer getMaxLength()
        Max length of answer.
        Returns:
        maxLength

      • setMaxLength

        public void setMaxLength​(java.lang.Integer maxLength)

      • answersRequired

        public QuestionsAuthCfg answersRequired​(java.lang.Integer answersRequired)

      • getAnswersRequired

        @Nullable
public java.lang.Integer getAnswersRequired()
        Min number of answers required to pass this check.
        Returns:
        answersRequired

      • setAnswersRequired

        public void setAnswersRequired​(java.lang.Integer answersRequired)

      • maxAnswers

        public QuestionsAuthCfg maxAnswers​(java.lang.Integer maxAnswers)

      • getMaxAnswers

        @Nullable
public java.lang.Integer getMaxAnswers()
        Max answers that user can save.
        Returns:
        maxAnswers

      • setMaxAnswers

        public void setMaxAnswers​(java.lang.Integer maxAnswers)

      • putAdditionalProperty

        public QuestionsAuthCfg putAdditionalProperty​(java.lang.String key,
                                              java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to QuestionsAuthCfg

      • fromJson

        public static QuestionsAuthCfg fromJson​(java.lang.String jsonString)
                                 throws java.io.IOException
        Create an instance of QuestionsAuthCfg given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of QuestionsAuthCfg
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to QuestionsAuthCfg

      • toJson

        public java.lang.String toJson()
        Convert an instance of QuestionsAuthCfg to an JSON string
        Returns:
        JSON string