com.snowplowanalytics.snowplow.enrich.common.enrichments.registry

CurrencyConversionEnrichment

case class CurrencyConversionEnrichment(accountType: AccountType, apiKey: String, baseCurrency: String, rateAt: String) extends Enrichment with Product with Serializable

Configuration for a currency_conversion enrichment

apiKey

OER authentication

baseCurrency

Currency to which to convert

rateAt

Which exchange rate to use - "EOD_PRIOR" for "end of previous day".

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CurrencyConversionEnrichment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Enrichment
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CurrencyConversionEnrichment(accountType: AccountType, apiKey: String, baseCurrency: String, rateAt: String)

    apiKey

    OER authentication

    baseCurrency

    Currency to which to convert

    rateAt

    Which exchange rate to use - "EOD_PRIOR" for "end of previous day".

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val accountType: AccountType

  7. val apiKey: String

    OER authentication

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. val baseCurrency: String

    Currency to which to convert

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def convertCurrencies(trCurrency: Option[String], trTotal: Option[Double], trTax: Option[Double], trShipping: Option[Double], tiCurrency: Option[String], tiPrice: Option[Double], collectorTstamp: Option[DateTime]): ValidationNel[String, (Option[String], Option[String], Option[String], Option[String])]

    Converts currency using Scala Forex

    Converts currency using Scala Forex

    trCurrency

    Initial transaction currency

    trTotal

    Total transaction value

    trTax

    Transaction tax

    trShipping

    Transaction shipping cost

    tiCurrency

    Initial transaction item currency

    tiPrice

    Initial transaction item price

    collectorTstamp

    Collector timestamp

    returns

    Validation[Tuple] containing all input amounts converted to the base currency

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. val fx: Forex

  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  20. val rateAt: String

    Which exchange rate to use - "EOD_PRIOR" for "end of previous day".

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  22. val version: DefaultArtifactVersion

    Definition Classes
    CurrencyConversionEnrichment → Enrichment

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Enrichment

Inherited from AnyRef

Inherited from Any

Ungrouped