com.ziqni.transformers.ZiqniApiAsync.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ziqni-transformers Show documentation
Ziqni transformers project.
The newest version!
/***
  *  Copyright (C) Ziqni Ltd - All Rights Reserved
  *  Unauthorized copying of this file, via any medium is strictly prohibited
  *  Proprietary and confidential
  *  Written by Ziqni Ltd, 2021
  */
package com.ziqni.transformers

import com.ziqni.transformers.domain._
import jdk.jfr.internal.LogLevel

import scala.concurrent.Future

trait ZiqniApiAsync {

	/** *
		* Generate a unique time based UUID, this can be used to set the batchId value if
		* a single event is transformed into multiple distinct events (facts) and a correlation
		* needs to be maintained
		*
		* @return A time based UUID as a string
		*/
	def nextId: String

	/**
		* Insert an event into your Ziqni space
		*
		* @param event The event to add
		* @return True on success, false on duplicate and exception if malformed
		*/
	def pushEvent(event: ZiqniEvent): Future[Boolean]

	/**
	  * Insert a sequence of events into your Ziqni space
	  *
	  * @param events The events to add
	  * @return True on success, false on duplicate and exception if malformed
	  */
	def pushEvents(events: Seq[ZiqniEvent]): Future[Boolean]

	/**
		* Insert a sequence of events into your Ziqni space
		* and also keep a local copy based on batch id for up to 5 minutes
		*
		* @param event The events to add
		* @return True on success, false on duplicate and exception if malformed
		*/
	def pushEventTransaction(event: ZiqniEvent): Future[Boolean]

	/**
	 * Insert an event into your Ziqni space
	 * and also keep a local copy based on batch id for up to 5 minutes
	 * Note that work is done in a single threaded executor so make sure it is fast
	 *
	 * @param event The events to push
	 * @param eventsToCache The events previously added. The result is the new stored value
	 * @return True on success, false on duplicate and exception if malformed
	 */
	def pushEventAndSetTransactionCache(event: ZiqniEvent, eventsToCache: Seq[ZiqniEvent] => Seq[ZiqniEvent]): Future[Boolean]

	def findByBatchId(batchId: String): Future[Seq[ZiqniEvent]]

	/**
	  * Get the Ziqni id for the member based on your reference id
	  *
	  * @param memberReferenceId The id used to identify this member in the sending system
	  * @return The id used in the Ziqni system or None if the user does not exist
	  */
	def memberFromMemberRefId(memberReferenceId: String): Future[ZiqniMember]

	/**
	  * Get the member reference id for the member based on Ziqni id
	  *
	  * @param memberId The id used to identify this member in the sending system
	  * @return The id used in the Ziqni system or None if the user does not exist
	  */
	def memberRefIdFromMemberId(memberId: String): Future[String]

	/**
	  * Create a member in the Ziqni system
	  *
	  * @param memberReferenceId The id used to identify this member in the sending system
	  * @param displayName       Display name
	  * @param tags            The groups to add this member to
	  * @return The id used in the Ziqni system
	  */
	def createMember(toCreate: CreateMemberRequest): Future[ZiqniMember]

	/**
		* Get or create a member
		*
		* @param referenceId Is the id the ZIQNI id or a reference id
		* @param createAs      The object to use when creating the product
		* @return The id used in the Ziqni system
		*/
	def getOrCreateMember(referenceId: String, createAs: () => CreateMemberRequest): Future[ZiqniMember]

	/**
		* Get or create a member
		*
		* @param referenceId Is the id the ZIQNI id or a reference id
		* @param createAs      The object to use when creating the product
		* @return The id used in the Ziqni system
		*/
	def getAndOnExitsOrCreateMember(referenceId: String, onExist: ZiqniMember => Future[ZiqniMember], createAs: () => CreateMemberRequest): Future[ZiqniMember]

	/**
	  *
	  * @param clMemberId     ZIQNI Member Id
	  * @param displayName    Display name
	  * @param groupsToUpdate The groups to add this member to
	  * @return The id used in the Ziqni system
	  */
	def updateMember(memberId: String, memberReferenceId: Option[String], displayName: Option[String], tagsToUpdate: Option[Seq[String]], customFields: Option[Map[String,CustomFieldEntry[_<:Any]]] = None, metadata: Option[Map[String, String]] = None): Future[ZiqniMember]

	/**
	  *
	  * @param memberId Ziqni Reward Id
	  * @return BasicMemberModel returns a basic member object
	  */
	def getMember(memberId: String): Future[ZiqniMember]

	/**
	  * Get the Ziqni id for the product based on your reference id
	  *
	  * @param productReferenceId The id used to identify this product in the sending system
	  * @return The id used in the Ziqni system or None if the product does not exist
	  */
	def productFromProductRefId(productReferenceId: String): Future[ZiqniProduct]

	/**
	  * Get the product id for the product based on your Ziqni id
	  *
	  * @param productId The id used to identify this product in the sending system
	  * @return The id used in the Ziqni system or None if the product does not exist
	  */
	def productRefIdFromProductId(productId: String): Future[String]

	/**
	  *
	  * @param productReferenceId      The id used to identify this product in the sending system
	  * @param displayName             Display name
	  * @param providers               The providers of this product
	  * @param productType             The type of product
	  * @param defaultAdjustmentFactor The default adjustment factor to apply
	  * @return The id used in the Ziqni system
	  */
	def createProduct(toCreate: CreateProductRequest): Future[ZiqniProduct]

	/**
	  * Get or create a product
	  * @param referenceId Is the id the ZIQNI id or a reference id
	  * @param createAs The object to use when creating the product
	  * @return The id used in the Ziqni system
	  */
	def getOrCreateProduct(referenceId: String, createAs: () => CreateProductRequest): Future[ZiqniProduct]
	/**
	  * Get or create a product
	  * @param referenceId Is the id the ZIQNI id or a reference id
	  * @param createAs The object to use when creating the product
	  * @return The id used in the Ziqni system
	  */
	def getAndOnExitsOrCreateProduct(referenceId: String, onExist: ZiqniProduct => Future[ZiqniProduct], createAs: () => CreateProductRequest): Future[ZiqniProduct]

	/**
	  *
	  * @param clProductId             ZIQNI Product Id
	  * @param displayName             Display name
	  * @param providers               The providers of this product
	  * @param productType             The type of product
	  * @param defaultAdjustmentFactor The default adjustment factor to apply
	  * @return The id used in the Ziqni system
	  */
	def updateProduct(productId: String, productReferenceId: Option[String], displayName: Option[String], tags: Option[Seq[String]], defaultAdjustmentFactor: Option[Double], customFields: Option[Map[String,CustomFieldEntry[_<:Any]]] = None, metadata: Option[Map[String, String]] = None): Future[ZiqniProduct]


	/**
		* Delete product by id
		*
		* @param productId - Ziqni product id
		* @return
		*/
	def deleteProduct(productId: String): Future[Boolean]

	/**
	  *
	  * @param productId Ziqni Product Id
	  * @return BasicProductModel returns a basic product object
	  */
	def getProduct(productId: String): Future[ZiqniProduct]


	/**
	  * Verify if the event action type exists in your space
	  *
	  * @param action The action
	  * @return True of the action was created
	  */
	def eventActionExists(action: String): Future[Boolean]

	/** *
	  * Create the action in your space
	  *
	  * @param action True on success false on failure
	  * @return
	  */
	def createEventAction(toCreate: CreateEventActionRequest): Future[Boolean]

	/** *
	  * Get or create the action in your space
	  *
	  * @param action True on success false on failure
	  * @return
	  */
	def getOrCreateEventAction(action: String, createAs: () => CreateEventActionRequest): Future[String]

	/** *
	  * Update the action in your space
	  *
	  * @param action True on success false on failure
	  * @return
	  */
	def updateEventAction(action: String, name: Option[String], metadata: Option[Map[String, String]], unitOfMeasureType: Option[String]): Future[Boolean]

	/**
	  *
	  * @param achievementId Ziqni Achievement Id
	  * @return BasicAchievementModel returns a basic achievement object
	  */
	def getAchievement(achievementId: String): Future[ZiqniAchievement]

	/**
	  *
	  * @param contestId Ziqni Contest Id
	  * @return BasicContestModel returns a basic contest object
	  */
	def getContest(contestId: String): Future[ZiqniContest]

	/**
	  *
	  * @param rewardId Ziqni Reward Id
	  * @return BasicRewardModel returns a basic reward object
	  */
	def getReward(rewardId: String): Future[ZiqniReward]

	/**
	  *
	  * @param awardId Ziqni Award Id
	  * @return BasicAwardModel returns a basic award object
	  */
	def getAward(awardId: String): Future[ZiqniAward]

	/**
	 * Get awards by status code and created date
	 * @param statusCodeFrom The status code from
	 * @param statusCodeTo The status code to
	 * @param skip The number of records to skip
	 * @param limit The number of records to return
	 * @param activeFrom The active from in epoch seconds
	 * @param activeUntil The active until in epoch seconds
	 * @param rewardTypeKey The reward type key
	 * @param memberId The member id
	 * @param rewardId The reward id
	 * @param entityId The entity id
	 * @return The awards
	 */
	def getAwardsBy(statusCodeFrom: Int, statusCodeTo: Int, skip: Int, limit: Int, activeFrom: Option[Long], activeUntil: Option[Long], rewardTypeKey: Option[String], memberId: Option[String], rewardId: Option[String], entityId: Option[String]): Future[ZiqniQueryResult[_<:ZiqniAward]]

	/**
	 * Update the state of an award
	 * @param awardId The award id
	 * @param action The action to take
	 * @param constraints The constraints to apply
	 * @param transactionReferenceId The transaction reference id
	 * @param reasonForChange The reason for the change
	 * @return The updated award
	 */
	def updateAwardsState(awardId: String, action: AwardStateActions, constraints: Option[Seq[String]], transactionReferenceId: Option[String], reasonForChange: Option[String]): Future[ZiqniAward]

	/**
	  *
	  * @param unitOfMeasureId Ziqni Unit of Measure Id
	  * @return BasicUnitOfMeasureModel returns a basic unit of measure object
	  */
	def getUnitOfMeasure(unitOfMeasureId: String): Future[Option[ZiqniUnitOfMeasure]]

	/**
		*
		* @param key The key used to identify this UoM
		* @param name The name to give this unit of measure
		* @param isoCode The ISO code
		* @param multiplier The points multiplier
		* @param unitOfMeasureType The type [OTHER, CURRENCY, MASS, TIME, TEMPERATURE, ELECTRICCURRENT, AMOUNTOFSUBSTANCE, LUMINOUSINTENSITY, DISTANCE]
		* @return
		*/
	def createUnitOfMeasure(toCreate: CreateUnitOfMeasureRequest): Future[String]

	/**
		* Get or create unit of measure
		* @param key The key used to identify this UoM
		* @param name The name to give this unit of measure
		* @param isoCode The ISO code
		* @param multiplier The points multiplier
		* @param unitOfMeasureType The type [OTHER, CURRENCY, MASS, TIME, TEMPERATURE, ELECTRICCURRENT, AMOUNTOFSUBSTANCE, LUMINOUSINTENSITY, DISTANCE]
		* @return
		*/
	def getOrCreateUnitOfMeasure(key: String, createAs: () => CreateUnitOfMeasureRequest): Future[ZiqniUnitOfMeasure]

	/**
	  *
	  * @param unitOfMeasureKey Ziqni UoM key
	  * @return Double returns a multiplier associated with the UoM
	  */
	def getUoMMultiplierFromKey(unitOfMeasureKey: String): Future[Double]

	/**
		* Get the goal metrics for the given member and entity
		* @param memberIds The member identifiers
		* @param entityIds The entity identifiers
	  * @return The goal metrics or an error if they could not be retrieved
		*/
	def getGoalMetrics(memberIds: Seq[String], entityIds: Seq[String]): Future[Seq[ZiqniGoalMetric]]

	/**
		* Get the goal metrics for the given member and entity
		* @param memberId The member identifier
		* @param entityId The entity identifier
	  * @return The goal metric or an error if they could not be retrieved
		*/
	def getGoalMetric(memberId: String, entityId: String): Future[ZiqniGoalMetric]
}