/**
 * Generated by API Builder - https://www.apibuilder.io
 * Service version: 0.1.0-SNAPSHOT
 * User agent: apibuilder app.apibuilder.io/movio/apidoc-generator-attributes/0.1.0-SNAPSHOT/http4s_0_23
 */
package movio.apidoc.generator.attributes.v0.models {

  /**
   * Additional validation options not currently in the standard apidoc spec
   *
   * @param regex Regex string to validate the field with. The field must be a `string` or
   *        `[string]`. If the field is a `[string]` all elements in the array will be
   *        validated
   * @param maximum This applies only to `[string]`, `[integer]` and `[long]`. The current apidoc
   *        spec includes maximum however for an array this the maxium size of the array.
   *        This validates the max length or number of each element of the array. The field
   *        must be a `[string]`, `[integer]` or `[long]`. All elements in the array will be
   *        validated as per standard apidoc specs
   * @param minimum This applies only to `[string]`, `[integer]` and `[long]`. The current apidoc
   *        spec includes minimum however for an array this the minimum size of the array.
   *        This validates the minimum length or number of each element of the array. The
   *        field must be a `[string]`, `[integer]` or `[long]`. All elements in the array
   *        will be validated as per standard apidoc specs
   */

  final case class FieldValidation(
    regex: _root_.scala.Option[String] = None,
    maximum: _root_.scala.Option[Long] = None,
    minimum: _root_.scala.Option[Long] = None
  )

  /**
   * Information needed for generating Kafka wrappers, consumers and producers.
   *
   * @param dataType This is the name of the model that this kafka wrapper encapsulated. Model name
   *        is the same as defined in the models section
   * @param topic [scala] This is a scala snippet that returns a string with the topic name for
   *        kafka. The generator creates a function on the kafka topic object `def
   *        topic(tenant: String) = <definition-goes-here>`
   * @param messageGenerateKey [scala] This is a scala snippet that creates a string used as the message ID.
   *        The message ID is used as the kafka message ID. The generator creates a function
   *        on the case class `def generateKey(tenant: String) = <definition-goes-here>`
   */

  final case class KafkaProps(
    dataType: String,
    topic: String,
    messageGenerateKey: String = "java.util.UUID.randomUUID().toString"
  )

  /**
   * Additional code generation information for case class fields
   *
   * @param `class` The fully qualified Scala/Java class to use during implementation. Note that
   *        this class must have a json formatter defined in the generator code. Currenly
   *        only org.joda.time.LocalDate and org.joda.time.LocalDateTime are implemented. In
   *        the future this maybe a defined list of supported classes
   * @param default Used as the default in a case class.
   * @param example Used in documentation and as a default implementation when creating example
   *        implementation's of case classes
   */

  final case class ScalaFieldProps(
    `class`: _root_.scala.Option[String] = None,
    default: _root_.scala.Option[String] = None,
    example: _root_.scala.Option[String] = None
  )

  /**
   * Additional code generation information for case classes
   *
   * @param `extends` A list of Scala/Java classes that this model extends
   */

  final case class ScalaModelProps(
    `extends`: _root_.scala.Option[Seq[String]] = None
  )

}