Package app.kntrl.client.openapi.model

Class EmailAuthCfg

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

    • 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_SERVER

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

      • SERIALIZED_NAME_SENDER

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

      • SERIALIZED_NAME_USERNAME

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

      • SERIALIZED_NAME_PASSWORD

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

      • SERIALIZED_NAME_CONFIRMATION_URL

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

      • SERIALIZED_NAME_TEMPLATES

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

      • SERIALIZED_NAME_TEMPLATE_PARAMS

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

      • SERIALIZED_NAME_CODE

        public static final java.lang.String SERIALIZED_NAME_CODE
        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

      • EmailAuthCfg

        public EmailAuthCfg()

    • Method Detail

      • requiresAuth

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

      • addRequiresAuthItem

        public EmailAuthCfg 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 EmailAuthCfg 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 EmailAuthCfg 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)

      • burnQuota

        public EmailAuthCfg burnQuota​(java.lang.Double burnQuota)

      • 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)

      • server

        public EmailAuthCfg server​(java.lang.String server)

      • getServer

        @Nonnull
public java.lang.String getServer()
        Email server address/IP.
        Returns:
        server

      • setServer

        public void setServer​(java.lang.String server)

      • sender

        public EmailAuthCfg sender​(java.lang.String sender)

      • getSender

        @Nonnull
public java.lang.String getSender()
        Email address of sender.
        Returns:
        sender

      • setSender

        public void setSender​(java.lang.String sender)

      • username

        public EmailAuthCfg username​(java.lang.String username)

      • getUsername

        @Nullable
public java.lang.String getUsername()
        SMTP username.
        Returns:
        username

      • setUsername

        public void setUsername​(java.lang.String username)

      • password

        public EmailAuthCfg password​(java.lang.String password)

      • getPassword

        @Nullable
public java.lang.String getPassword()
        SMTP password.
        Returns:
        password

      • setPassword

        public void setPassword​(java.lang.String password)

      • confirmationUrl

        public EmailAuthCfg confirmationUrl​(java.lang.String confirmationUrl)

      • getConfirmationUrl

        @Nullable
public java.lang.String getConfirmationUrl()
        If not null, server will create template param `confirmationUrl` that will contain query parameters with confirmation code, session id, etc.
        Returns:
        confirmationUrl

      • setConfirmationUrl

        public void setConfirmationUrl​(java.lang.String confirmationUrl)

      • templates

        public EmailAuthCfg templates​(java.util.Map<java.lang.String,​java.lang.String> templates)

      • putTemplatesItem

        public EmailAuthCfg putTemplatesItem​(java.lang.String key,
                                     java.lang.String templatesItem)

      • getTemplates

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getTemplates()
        List of email templates. Key - is name of a template (can be used lately on frontend), value - is path to the template. App uses handlebars templates to generate emails. See docs here https://handlebarsjs.com Email templates receives `confirmationUrl`, `action`, `user`, `session`, `codeId`, `code`, `codeExpiresInMinutes`, `lang`, `headers` as template params, e.g. you can print user id as `{{user.id}}`. Template engine also provides `i18n` helper for localisation. E.g. `{{i18n 'confirmationButton' default='Confirm'}}` searches key `confirmationButton` in files specified by `i18n.dir` config. Use `{{err ERR_CODE msg='Localised message (if null, will be taken from i18n file)' devMsg='dev message'}}` to raise an error in a template. It allows setting subject of email using `title` html tag, e.g. `<title>Email subject</title>`.
        Returns:
        templates

      • setTemplates

        public void setTemplates​(java.util.Map<java.lang.String,​java.lang.String> templates)

      • templateParams

        public EmailAuthCfg templateParams​(java.util.Map<java.lang.String,​java.lang.Object> templateParams)

      • putTemplateParamsItem

        public EmailAuthCfg putTemplateParamsItem​(java.lang.String key,
                                          java.lang.Object templateParamsItem)

      • getTemplateParams

        @Nullable
public java.util.Map<java.lang.String,​java.lang.Object> getTemplateParams()
        Additional params for templates that can be passed in request. Key - is a name of additional parameter, value - is a default value for this parameter (when no value present in request)
        Returns:
        templateParams

      • setTemplateParams

        public void setTemplateParams​(java.util.Map<java.lang.String,​java.lang.Object> templateParams)

      • getCode

        @Nullable
public CodeCfg getCode()
        Get code
        Returns:
        code

      • setCode

        public void setCode​(CodeCfg code)

      • putAdditionalProperty

        public EmailAuthCfg 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 EmailAuthCfg

      • fromJson

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

      • toJson

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