Promotion (thirdwatch_api 0.0.2 API)

java.lang.Object
- ai.thirdwatch.model.Promotion

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-11-21T16:23:00.366+05:30")
public class Promotion
extends Object
```
The Promotion field type generically models different kinds of promotions such as referrals, coupons, free trials, etc. The value must be a nested JSON object which you populate with the appropriate information to describe the promotion. Not all sub-fields will likely apply to a given promotion. Populate only those that apply. A promotion can be added when creating or updating an account, creating or updating an order, or on its own using the add_promotion event. The promotion object supports both monetary (e.g. 500 coupon on first order) and non-monetary (e.g. \"100 in points to refer a friend\").

Constructor Summary

Constructors
Constructor and Description

Promotion()

Constructors
Constructor and Description
`Promotion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Promotion`	`amount(String amount)`
`Promotion`	`currencyCode(String currencyCode)`
`Promotion`	`description(String description)`
`boolean`	`equals(Object o)`
`Promotion`	`failureReason(String failureReason)`
`String`	`getAmount()` The amount or credits the promotion is worth.
`String`	`getCurrencyCode()` The [ISO-4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for the amount.
`String`	`getDescription()` Describe promotion here.
`String`	`getFailureReason()` When adding a promotion fails, use this to describe why it failed.e.g.
`String`	`getMinPurchaseAmount()` The minimum amount someone must spend in order for the promotion to be applied.
`String`	`getPercentageOff()` The percentage discount.
`String`	`getPromotionId()` The ID/Coupon Code within your system that you use to represent this promotion.
`String`	`getReferrerUserId()` The unique user ID of the user who referred the user to this promotion.
`String`	`getStatus()` The status of the addition of promotion to an account.
`String`	`getType()` Type of the promotion e.g., First Time, Refer, Diwali
`int`	`hashCode()`
`Promotion`	`minPurchaseAmount(String minPurchaseAmount)`
`Promotion`	`percentageOff(String percentageOff)`
`Promotion`	`promotionId(String promotionId)`
`Promotion`	`referrerUserId(String referrerUserId)`
`void`	`setAmount(String amount)`
`void`	`setCurrencyCode(String currencyCode)`
`void`	`setDescription(String description)`
`void`	`setFailureReason(String failureReason)`
`void`	`setMinPurchaseAmount(String minPurchaseAmount)`
`void`	`setPercentageOff(String percentageOff)`
`void`	`setPromotionId(String promotionId)`
`void`	`setReferrerUserId(String referrerUserId)`
`void`	`setStatus(String status)`
`void`	`setType(String type)`
`Promotion`	`status(String status)`
`String`	`toString()`
`Promotion`	`type(String type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Promotion
```
public Promotion()
```
- Method Detail
  - promotionId
```
public Promotion promotionId(String promotionId)
```
  - getPromotionId
```
public String getPromotionId()
```
    The ID/Coupon Code within your system that you use to represent this promotion. This ID is ideally unique to the promotion across users (e.g. \"Welcome\").
    
    Returns:
    
    promotionId
  - setPromotionId
```
public void setPromotionId(String promotionId)
```
  - status
```
public Promotion status(String status)
```
  - getStatus
```
public String getStatus()
```
    The status of the addition of promotion to an account. Best used with the add_promotion event. This way you can pass to Thirdwatch both successful and failed attempts when using a promotion. May be useful in spotting potential abuse. e.g. _success, _Failed
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(String status)
```
  - description
```
public Promotion description(String description)
```
  - getDescription
```
public String getDescription()
```
    Describe promotion here.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - amount
```
public Promotion amount(String amount)
```
  - getAmount
```
public String getAmount()
```
    The amount or credits the promotion is worth.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(String amount)
```
  - minPurchaseAmount
```
public Promotion minPurchaseAmount(String minPurchaseAmount)
```
  - getMinPurchaseAmount
```
public String getMinPurchaseAmount()
```
    The minimum amount someone must spend in order for the promotion to be applied.
    
    Returns:
    
    minPurchaseAmount
  - setMinPurchaseAmount
```
public void setMinPurchaseAmount(String minPurchaseAmount)
```
  - referrerUserId
```
public Promotion referrerUserId(String referrerUserId)
```
  - getReferrerUserId
```
public String getReferrerUserId()
```
    The unique user ID of the user who referred the user to this promotion.
    
    Returns:
    
    referrerUserId
  - setReferrerUserId
```
public void setReferrerUserId(String referrerUserId)
```
  - failureReason
```
public Promotion failureReason(String failureReason)
```
  - getFailureReason
```
public String getFailureReason()
```
    When adding a promotion fails, use this to describe why it failed.e.g. _alreadyUsed, _invalidCode, _notApplicable, _expired
    
    Returns:
    
    failureReason
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
  - percentageOff
```
public Promotion percentageOff(String percentageOff)
```
  - getPercentageOff
```
public String getPercentageOff()
```
    The percentage discount. If the discount is 10% off, you would send \"10\".
    
    Returns:
    
    percentageOff
  - setPercentageOff
```
public void setPercentageOff(String percentageOff)
```
  - currencyCode
```
public Promotion currencyCode(String currencyCode)
```
  - getCurrencyCode
```
public String getCurrencyCode()
```
    The [ISO-4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for the amount. e.g., USD, INR alternative currencies, like bitcoin or points systems.
    
    Returns:
    
    currencyCode
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
  - type
```
public Promotion type(String type)
```
  - getType
```
public String getType()
```
    Type of the promotion e.g., First Time, Refer, Diwali
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Promotion

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Promotion

Method Detail

promotionId

getPromotionId

setPromotionId

status

getStatus

setStatus

description

getDescription

setDescription

amount

getAmount

setAmount

minPurchaseAmount

getMinPurchaseAmount

setMinPurchaseAmount

referrerUserId

getReferrerUserId

setReferrerUserId

failureReason

getFailureReason

setFailureReason

percentageOff

getPercentageOff

setPercentageOff

currencyCode

getCurrencyCode

setCurrencyCode

type

getType

setType

equals

hashCode

toString