Packages

class AdminApi extends CirceSchema

Linear Supertypes
CirceSchema, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdminApi
  2. CirceSchema
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AdminApi(baseUrl: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val AnyFormat: Encoder[Any] with Decoder[Any]
    Definition Classes
    CirceSchema
  5. implicit val ConfigFormat: Encoder[MongoCampConfiguration]
    Definition Classes
    CirceSchema
  6. implicit val DateFormat: Encoder[Date] with Decoder[Date]
    Definition Classes
    CirceSchema
  7. implicit val DateTimeFormat: Encoder[DateTime] with Decoder[DateTime]
    Definition Classes
    CirceSchema
  8. implicit val MapStringAnyFormat: Encoder[Map[String, Any]] with Decoder[Map[String, Any]]
    Definition Classes
    CirceSchema
  9. implicit val ObjectIdFormat: Encoder[ObjectId] with Decoder[ObjectId]
    Definition Classes
    CirceSchema
  10. def addRole(username: String, password: String, bearerToken: String, apiKey: String)(role: Role): RequestT[Identity, Either[ResponseException[String, Error], Role], Any with Any]

    Add a new Role

    Add a new Role

    Expected answers: code 200 : Role () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

  11. def addUser(username: String, password: String, bearerToken: String, apiKey: String)(userInformation: UserInformation): RequestT[Identity, Either[ResponseException[String, Error], UserProfile], Any with Any]

    Add a new User

    Add a new User

    Expected answers: code 200 : UserProfile () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  14. def decodeFromJson(json: Json): Any
    Definition Classes
    CirceSchema
  15. def deleteRole(username: String, password: String, bearerToken: String, apiKey: String)(roleName: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Delete Role

    Delete Role

    Expected answers: code 200 : JsonValueBoolean () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    roleName

    RoleKey

  16. def deleteUser(username: String, password: String, bearerToken: String, apiKey: String)(userId: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Delete User

    Delete User

    Expected answers: code 200 : JsonValueBoolean () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    userId

    UserId to Delete

  17. def encodeAnyToJson(a: Any, deepth: Int): Json
    Definition Classes
    CirceSchema
  18. def encodeMapStringAny(a: Map[String, Any]): Json
    Definition Classes
    CirceSchema
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  22. def getRole(username: String, password: String, bearerToken: String, apiKey: String)(roleName: String): RequestT[Identity, Either[ResponseException[String, Error], Role], Any with Any]

    Get Role by RoleKey

    Get Role by RoleKey

    Expected answers: code 200 : Role () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    roleName

    RoleKey to search

  23. def getUser(username: String, password: String, bearerToken: String, apiKey: String)(userId: String): RequestT[Identity, Either[ResponseException[String, Error], UserProfile], Any with Any]

    Get UserProfile for user

    Get UserProfile for user

    Expected answers: code 200 : UserProfile () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    userId

    UserId to search

  24. def gnerateNewApiKeyForUser(username: String, password: String, bearerToken: String, apiKey: String)(userId: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueString], Any with Any]

    Generate an new APIkey for the user

    Generate an new APIkey for the user

    Expected answers: code 200 : JsonValueString () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    userId

    UserId to Update

  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def listRoles(username: String, password: String, bearerToken: String, apiKey: String)(filter: Option[String] = None, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[Role]], Any with Any]

    List all Roles or filtered

    List all Roles or filtered

    Expected answers: code 200 : Seq[Role] () Headers : x-pagination-count-rows - count all elements x-pagination-rows-per-page - Count elements per page x-pagination-current-page - Current page x-pagination-count-pages - Count pages code 400 : String (Invalid value for: query parameter filter, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    filter

    filter after userId by contains

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  28. def listUsers(username: String, password: String, bearerToken: String, apiKey: String)(filter: Option[String] = None, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[UserProfile]], Any with Any]

    List all Users or filtered

    List all Users or filtered

    Expected answers: code 200 : Seq[UserProfile] () Headers : x-pagination-count-rows - count all elements x-pagination-rows-per-page - Count elements per page x-pagination-current-page - Current page x-pagination-count-pages - Count pages code 400 : String (Invalid value for: query parameter filter, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    filter

    filter after userId by contains

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def updatePasswordForUser(username: String, password: String, bearerToken: String, apiKey: String)(userId: String, passwordUpdateRequest: PasswordUpdateRequest): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Change Password of User

    Change Password of User

    Expected answers: code 200 : JsonValueBoolean () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    userId

    UserId to Update

  35. def updateRole(username: String, password: String, bearerToken: String, apiKey: String)(roleName: String, updateRoleRequest: UpdateRoleRequest): RequestT[Identity, Either[ResponseException[String, Error], Role], Any with Any]

    Update Role

    Update Role

    Expected answers: code 200 : Role () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    roleName

    RoleKey

  36. def updateRolesForUser(username: String, password: String, bearerToken: String, apiKey: String)(userId: String, requestBody: Seq[String]): RequestT[Identity, Either[ResponseException[String, Error], UserProfile], Any with Any]

    Update Roles of User

    Update Roles of User

    Expected answers: code 200 : UserProfile () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    userId

    UserId to Update

  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from CirceSchema

Inherited from AnyRef

Inherited from Any

Ungrouped