JSDoc: Class: Coupon

Class: Coupon

Model~Coupon(data) → {void}

Coupon data model.

Constructor

new Coupon(data) → {void}

Coupon Constructor.

Parameters:

Name	Type	Description
`data`	Object

Source:

models.js, line 658

Returns:

Type: void

Members

(static, constant) CUSTOMER_SCOPE_ALL_LOGGED_IN

Constant CUSTOMER_SCOPE_ALL_LOGGED_IN

Source:

models.js, line 688

(static, constant) CUSTOMER_SCOPE_ALL_SHOPPERS

Constant CUSTOMER_SCOPE_ALL_SHOPPERS

Source:

models.js, line 668

(static, constant) CUSTOMER_SCOPE_SPECIFIC_CUSTOMERS

Constant CUSTOMER_SCOPE_SPECIFIC_CUSTOMERS

Source:

models.js, line 678

Methods

getActive() → {boolean}

Get active.

Source:

models.js, line 760

Returns:

Type: boolean

getCode() → {string}

Get code.

Source:

models.js, line 704

Returns:

Type: string

getCustomerScope() → {string}

Get custscope.

Source:

models.js, line 720

Returns:

Type: string

getDateTimeEnd() → {number}

Get dt_end.

Source:

models.js, line 736

Returns:

Type: number

getDateTimeStart() → {number}

Get dt_start.

Source:

models.js, line 728

Returns:

Type: number

getDescription() → {string}

Get descrip.

Source:

models.js, line 712

Returns:

Type: string

getId() → {number}

Get id.

Source:

models.js, line 696

Returns:

Type: number

getMaxPer() → {number}

Get max_per.

Source:

models.js, line 752

Returns:

Type: number

getMaxUse() → {number}

Get max_use.

Source:

models.js, line 744

Returns:

Type: number

getUseCount() → {number}

Get use_count.

Source:

models.js, line 768

Returns:

Type: number

setActive(active) → {Coupon}

Set active.

Parameters:

Name	Type	Description
`active`	boolean

Source:

models.js, line 848

Returns:

Type: Coupon

setCode(code) → {Coupon}

Set code.

Parameters:

Name	Type	Description
`code`	string

Source:

models.js, line 777

Returns:

Type: Coupon

setCustomerScope(customerScope) → {Coupon}

Set custscope.

Parameters:

Name	Type	Description
`customerScope`	string

Source:

models.js, line 795

Returns:

Type: Coupon

setDateTimeEnd(dateTimeEnd) → {Coupon}

Set dt_end.

Parameters:

Name	Type	Description
`dateTimeEnd`	Date \| number

Source:

models.js, line 817

Returns:

Type: Coupon

setDateTimeStart(dateTimeStart) → {Coupon}

Set dt_start.

Parameters:

Name	Type	Description
`dateTimeStart`	Date \| number

Source:

models.js, line 804

Returns:

Type: Coupon

setDescription(description) → {Coupon}

Set descrip.

Parameters:

Name	Type	Description
`description`	string

Source:

models.js, line 786

Returns:

Type: Coupon

setMaxPer(maxPer) → {Coupon}

Set max_per.

Parameters:

Name	Type	Description
`maxPer`	number

Source:

models.js, line 839

Returns:

Type: Coupon

setMaxUse(maxUse) → {Coupon}

Set max_use.

Parameters:

Name	Type	Description
`maxUse`	number

Source:

models.js, line 830

Returns:

Type: Coupon