camundala-domain
API
Generated with
camundala-domain/camundala/camundala.domain

camundala.domain

package camundala.domain

Members list

Type members

Classlikes

object CanceledStatus

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class FileInOut(fileName: String, content: Array[Byte], mimeType: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileInOut

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
FileInOut.type
case class FileRefInOut(fileName: String, ref: String, mimeType: Option[String])

In Camunda 8 only json is allowed!

In Camunda 8 only json is allowed!

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileRefInOut

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object GenericServiceIn

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class MockedServiceResponse[ServiceOut](respStatus: Int, respBody: Either[Option[Json], ServiceOut], respHeaders: Seq[Seq[String]])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MockedServiceResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class NoConfig()

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NoConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
NoConfig.type
case class NoInput()

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NoInput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
NoInput.type
case class NoOutput()

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NoOutput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
NoOutput.type
object NotValidStatus

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Optable[Out](value: Option[Out])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Optable

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Optable.type
object ProcessEndStatus

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ProcessStatus

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ProcessStatus

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Deprecated classlikes

enum CanceledStatus

Attributes

Companion
object
Deprecated
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait GenericServiceIn

Attributes

Companion
object
Deprecated
true
Supertypes
class Object
trait Matchable
class Any
enum NotValidStatus

Attributes

Companion
object
Deprecated
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum ProcessEndStatus

Attributes

Companion
object
Deprecated
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type ApiSchema[T] = Schema[T]
type CronExpr = IronType[String, DescribedAs[Match["^\\s*($|#|\\w+\\s*=|(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[01]?\\d|2[0-3])(?:(?:-|\\/|\\,)(?:[01]?\\d|2[0-3]))?(?:,(?:[01]?\\d|2[0-3])(?:(?:-|\\/|\\,)(?:[01]?\\d|2[0-3]))?)*)\\s+(\\?|\\*|(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?(?:,(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?)*)\\s+(\\?|\\*|(?:[1-9]|1[012])(?:(?:-|\\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?(?:,(?:[1-9]|1[012])(?:(?:-|\\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?)*|\\?|\\*|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?(?:,(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?)*)\\s+(\\?|\\*|(?:[0-6])(?:(?:-|\\/|\\,|#)(?:[0-6]))?(?:L)?(?:,(?:[0-6])(?:(?:-|\\/|\\,|#)(?:[0-6]))?(?:L)?)*|\\?|\\*|(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?(?:,(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?)*)(|\\s)+(\\?|\\*|(?:|\\d{4})(?:(?:-|\\/|\\,)(?:|\\d{4}))?(?:,(?:|\\d{4})(?:(?:-|\\/|\\,)(?:|\\d{4}))?)*))$"], "This must be a valid Cron Expression, like `0 0 7,11,15 ? * MON-FRI`"]]
type Iban = IronType[String, DescribedAs[Match["\\b[A-Z]{2}[0-9]{2}(?:[ ]?[0-9]{4}){4}(?!(?:[ ]?[0-9]){3})(?:[ ]?[0-9]{1,2})?\\b"], "This must be a valid IBAN"]]
type InOutCodec[T] = Codec[T]
type InOutDecoder[T] = Decoder[T]
type InOutEncoder[T] = Encoder[T]
type IntOrBoolean = Int | Boolean
type IntOrString = Int | String
type Iso8601DateTime = IronType[String, DescribedAs[Match["^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$"], "This must be a valid Iso8601 Date Time, like `2011-03-11T12:13:14Z`"]]
type Iso8601Day = IronType[String, DescribedAs[Match["^([0-9]{4})-?(1[0-2]|0[1-9])-?(3[01]|0[1-9]|[12][0-9])$"], "Day in ISO Format, like `yyyy-MM-dd` for example `2003-12-23`"]]
type Iso8601Duration = IronType[String, DescribedAs[Match["^P(?!$)(?:(? \\d+(?:\\.\\d+)?)Y)?(?:(? \\d+(?:\\.\\d+)?)M)?(?:(? \\d+(?:\\.\\d+)?)W)?(?:(? \\d+(?:\\.\\d+)?)D)?(T(?=\\d)(?:(? \\d+(?:\\.\\d+)?)H)?(?:(? \\d+(?:\\.\\d+)?)M)?(?:(? \\d+(?:\\.\\d+)?)S)?)?$"], "This must be a valid Iso8601 Duration Expression, like `PT3S`"]]
type Iso8601Interval = IronType[String, DescribedAs[Match["^(R\\d*\\/)P(\\d+([\\.,]\\d+)?Y)?(\\d+([\\.,]\\d+)?M)?(\\d+([\\.,]\\d+)?W)?(\\d+([\\.,]\\d+)?D)?((?!.$)T(\\d+([\\.,]\\d+)?H)?(\\d+([\\.,]\\d+)?M)?(\\d+(\\.\\d+)?S)?)?$"], "This must be a valid Iso8601 Repeating Interval Expression, like `R2/PT3S`"]]
type Percentage = IronType[Int, DescribedAs[GreaterEqual[0] & LessEqual[100], "This must be a valid Percentage 0-100 as an integer."]]
type PostcodeStr = IronType[String, DescribedAs[Match["(?i)^[a-z0-9][a-z0-9\\- ]{0,10}[a-z0-9]$"], "This must be a valid Postcode"]]

Value members

Concrete methods

def customDecodeAccumulating[T](c: HCursor)(using Decoder[T]): Either[DecodingFailure, T]

Decodes a JSON value into a value of type T. It will collect all DecodingFailures and create a nice error message. This is not the case when using ..as[MyType]

Decodes a JSON value into a value of type T. It will collect all DecodingFailures and create a nice error message. This is not the case when using ..as[MyType]

Attributes

inline def deriveApiSchema[T](using m: Of[T]): Schema[T]
inline def deriveEnumApiSchema[T](using m: Of[T]): Schema[T]
inline def deriveEnumInOutCodec[A](using inline A: SumOf[A]): Codec[A]
inline def deriveEnumValueInOutCodec[A]: Codec[A]
inline def deriveEnumValueInOutDecoder[A]: Decoder[A]
inline def deriveEnumValueInOutEncoder[A]: Encoder[A]
inline def deriveInOutCodec[A](using inline A: Of[A]): Codec[A]
inline def deriveInOutCodec[A](discriminator: String)(using inline A: Of[A]): Codec[A]
inline def deriveInOutDecoder[A](using inline A: Of[A]): Decoder[A]
inline def deriveInOutDecoder[A](discriminator: String)(using inline A: Of[A]): Decoder[A]
inline def deriveInOutEncoder[A](using inline A: Of[A]): Encoder[A]
inline def deriveInOutEncoder[A](discriminator: String)(using inline A: Of[A]): Encoder[A]
inline def deriveUnionApiSchema[T](using m: Of[T]): Schema[T]
def prettyString(obj: Any, depth: Int, paramName: Option[String]): String
def prettyUriString(uri: Uri): String
def serviceOrProcessMockDescr[Out : Encoder](mock: Out): String
def throwErr(err: String): Nothing
def toJson(json: String): Json

Deprecated methods

def outputMockDescr[Out : Encoder](mock: Out): String

Attributes

Deprecated
true
def outputServiceMockDescr[ServiceOut : Encoder](mock: ServiceOut): String

Attributes

Deprecated
true
def serviceNameDescr(serviceName: String): String

Attributes

Deprecated
true

Concrete fields

val cronExprDescr: String
val deprecatedDescr: String
val ibanDescr: String
val iso8601DateTimeDescr: String
val iso8601DayDescr: String
val iso8601DurationDescr: String
val iso8601IntervalDescr: String
val percentageDescr: String
val postcodeDescr: String
val testModeDescr: String

Deprecated fields

val defaultMockedDescr: String

Attributes

Deprecated
true
val handledErrorsDescr: String

Attributes

Deprecated
true

Givens

Givens

Extensions

Extensions

extension (headers: Map[String, String])
def toHeaders: Seq[Seq[String]]
extension (str: String)
def niceName: String

Exports

Defined exports

final val CirceCodec: Codec
Exported from circe
final type CirceCodec = Codec
Exported from circe
final val Decoder: Decoder
Exported from circe
final type Decoder = Decoder
Exported from circe
final val HCursor: HCursor
Exported from circe
final type HCursor = HCursor
Exported from circe
final val Json: Json
Exported from circe
final type Json = Json
Exported from circe
final type description = description
Exported from annotations$
Generated with