Packages

class DocumentApi extends CirceSchema

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

Instance Constructors

  1. new DocumentApi(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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  12. def decodeFromJson(json: Json): Any
    Definition Classes
    CirceSchema
  13. def delete(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, documentId: String): RequestT[Identity, Either[ResponseException[String, Error], DeleteResponse], Any with Any]

    Delete one Document from given Collection

    Delete one Document from given Collection

    Expected answers: code 200 : DeleteResponse () 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)

    collectionName

    The name of your MongoDb Collection

    documentId

    DocumentId to delete

  14. def deleteMany(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, requestBody: Map[String, Any]): RequestT[Identity, Either[ResponseException[String, Error], DeleteResponse], Any with Any]

    Delete many Document in given Collection

    Delete many Document in given Collection

    Expected answers: code 200 : DeleteResponse () 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)

    collectionName

    The name of your MongoDb Collection

  15. def encodeAnyToJson(a: Any, deepth: Int): Json
    Definition Classes
    CirceSchema
  16. def encodeMapStringAny(a: Map[String, Any]): Json
    Definition Classes
    CirceSchema
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def find(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, mongoFindRequest: MongoFindRequest, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[Map[String, Any]]], Any with Any]

    Alternative to GET Route for more complex queries and URL max.

    Alternative to GET Route for more complex queries and URL max. Length

    Expected answers: code 200 : Seq[Map[String, Any]] () 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: body, 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)

    collectionName

    The name of your MongoDb Collection

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. def getDocument(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, documentId: String): RequestT[Identity, Either[ResponseException[String, Error], Map[String, Any]], Any with Any]

    Get one Document from given Collection

    Get one Document from given Collection

    Expected answers: code 200 : Map[String, Any] () 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)

    collectionName

    The name of your MongoDb Collection

    documentId

    DocumentId to read

  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. def insert(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, requestBody: Map[String, Any]): RequestT[Identity, Either[ResponseException[String, Error], InsertResponse], Any with Any]

    Insert one Document in given Collection

    Insert one Document in given Collection

    Expected answers: code 200 : InsertResponse () 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)

    collectionName

    The name of your MongoDb Collection

    requestBody

    JSON Representation for your Document.

  24. def insertMany(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, requestBody: Seq[Map[String, Any]]): RequestT[Identity, Either[ResponseException[String, Error], InsertResponse], Any with Any]

    Insert many documents in given Collection

    Insert many documents in given Collection

    Expected answers: code 200 : InsertResponse () 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)

    collectionName

    The name of your MongoDb Collection

  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def listDocuments(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, filter: Option[String] = None, sort: Seq[String], projection: Seq[String], rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[Map[String, Any]]], Any with Any]

    Get Documents paginated from given Collection

    Get Documents paginated from given Collection

    Expected answers: code 200 : Seq[Map[String, Any]] () 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 sort, Invalid value for: query parameter projection, 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)

    collectionName

    The name of your MongoDb Collection

    filter

    Lucene Query by all filter. More Information: Lucene Query

    sort

    Sorting by with an list of keys. Leading minus (-) means desc.

    projection

    MongoDB projection

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def update(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, documentId: String, requestBody: Map[String, Any]): RequestT[Identity, Either[ResponseException[String, Error], UpdateResponse], Any with Any]

    'Replace' one Document with the new document from Request in Collection

    'Replace' one Document with the new document from Request in Collection

    Expected answers: code 200 : UpdateResponse () 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)

    collectionName

    The name of your MongoDb Collection

    documentId

    DocumentId to update

  33. def updateDocumentPartial(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, documentId: String, requestBody: Map[String, Any]): RequestT[Identity, Either[ResponseException[String, Error], UpdateResponse], Any with Any]

    Update the document Parts with the values from the Request

    Update the document Parts with the values from the Request

    Expected answers: code 200 : UpdateResponse () 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)

    collectionName

    The name of your MongoDb Collection

    documentId

    DocumentId to update

  34. def updateMany(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, updateRequest: UpdateRequest): RequestT[Identity, Either[ResponseException[String, Error], UpdateResponse], Any with Any]

    Update many Document in given Collection

    Update many Document in given Collection

    Expected answers: code 200 : UpdateResponse () 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)

    collectionName

    The name of your MongoDb Collection

  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. 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