Class: CouponUpdate

Request~CouponUpdate(clientnullable, couponnullable)

Handles API Request Coupon_Update. Scope: Store.

Constructor

new CouponUpdate(clientnullable, couponnullable)

CouponUpdate Constructor.

CouponUpdate Constructor.

Parameters:
Name Type Attributes Default Description
client Client <nullable>
coupon Coupon <nullable>
null
Source:
See:

Methods

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getActive() → {boolean}

Get Active.

Get Active.

Source:
Returns:
Type
boolean

getCode() → {string}

Get Code.

Get Code.

Source:
Returns:
Type
string

getCouponCode() → {string}

Get Coupon_Code.

Get Coupon_Code.

Source:
Returns:
Type
string

getCouponId() → {number}

Get Coupon_ID.

Get Coupon_ID.

Source:
Returns:
Type
number

getCustomerScope() → {string}

Get CustomerScope.

Get CustomerScope.

Source:
Returns:
Type
string

getDateTimeEnd() → {number}

Get DateTime_End.

Get DateTime_End.

Source:
Returns:
Type
number

getDateTimeStart() → {number}

Get DateTime_Start.

Get DateTime_Start.

Source:
Returns:
Type
number

getDescription() → {string}

Get Description.

Get Description.

Source:
Returns:
Type
string

getEditCoupon() → {string}

Get Edit_Coupon.

Get Edit_Coupon.

Source:
Returns:
Type
string

getMaxPer() → {number}

Get Max_Per.

Get Max_Per.

Source:
Returns:
Type
number

getMaxUse() → {number}

Get Max_Use.

Get Max_Use.

Source:
Returns:
Type
number

setActive(active) → {CouponUpdate}

Set Active.

Set Active.

Parameters:
Name Type Description
active boolean
Source:
Returns:
Type
CouponUpdate

setCode(code) → {CouponUpdate}

Set Code.

Set Code.

Parameters:
Name Type Description
code string
Source:
Returns:
Type
CouponUpdate

setCouponCode(couponCode) → {CouponUpdate}

Set Coupon_Code.

Set Coupon_Code.

Parameters:
Name Type Description
couponCode string
Source:
Returns:
Type
CouponUpdate

setCouponId(couponId) → {CouponUpdate}

Set Coupon_ID.

Set Coupon_ID.

Parameters:
Name Type Description
couponId number
Source:
Returns:
Type
CouponUpdate

setCustomerScope(customerScope) → {CouponUpdate}

Set CustomerScope.

Set CustomerScope.

Parameters:
Name Type Description
customerScope string
Source:
Returns:
Type
CouponUpdate

setDateTimeEnd(dateTimeEnd) → {CouponUpdate}

Set DateTime_End.

Set DateTime_End.

Parameters:
Name Type Description
dateTimeEnd number | Date
Source:
Returns:
Type
CouponUpdate

setDateTimeStart(dateTimeStart) → {CouponUpdate}

Set DateTime_Start.

Set DateTime_Start.

Parameters:
Name Type Description
dateTimeStart number | Date
Source:
Returns:
Type
CouponUpdate

setDescription(description) → {CouponUpdate}

Set Description.

Set Description.

Parameters:
Name Type Description
description string
Source:
Returns:
Type
CouponUpdate

setEditCoupon(editCoupon) → {CouponUpdate}

Set Edit_Coupon.

Set Edit_Coupon.

Parameters:
Name Type Description
editCoupon string
Source:
Returns:
Type
CouponUpdate

setMaxPer(maxPer) → {CouponUpdate}

Set Max_Per.

Set Max_Per.

Parameters:
Name Type Description
maxPer number
Source:
Returns:
Type
CouponUpdate

setMaxUse(maxUse) → {CouponUpdate}

Set Max_Use.

Set Max_Use.

Parameters:
Name Type Description
maxUse number
Source:
Returns:
Type
CouponUpdate

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object