1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\SalesRule\Api\Data;
/**
* Interface CouponInterface
*
* @api
* @since 100.0.2
*/
interface CouponInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
const TYPE_MANUAL = 0;
const TYPE_GENERATED = 1;
/**
* Get coupon id
*
* @return int|null
*/
public function getCouponId();
/**
* Set coupon id
*
* @param int $couponId
* @return $this
*/
public function setCouponId($couponId);
/**
* Get the id of the rule associated with the coupon
*
* @return int
*/
public function getRuleId();
/**
* Set rule id
*
* @param int $ruleId
* @return $this
*/
public function setRuleId($ruleId);
/**
* Get coupon code
*
* @return string|null
*/
public function getCode();
/**
* Set coupon code
*
* @param string $code
* @return $this
*/
public function setCode($code);
/**
* Get usage limit
*
* @return int|null
*/
public function getUsageLimit();
/**
* Set usage limit
*
* @param int $usageLimit
* @return $this
*/
public function setUsageLimit($usageLimit);
/**
* Get usage limit per customer
*
* @return int|null
*/
public function getUsagePerCustomer();
/**
* Set usage limit per customer
*
* @param int $usagePerCustomer
* @return $this
*/
public function setUsagePerCustomer($usagePerCustomer);
/**
* Get the number of times the coupon has been used
*
* @return int
*/
public function getTimesUsed();
/**
* @param int $timesUsed
* @return $this
*/
public function setTimesUsed($timesUsed);
/**
* Get expiration date
*
* @return string|null
*/
public function getExpirationDate();
/**
* Set expiration date
*
* @param string $expirationDate
* @return $this
*/
public function setExpirationDate($expirationDate);
/**
* Whether the coupon is primary coupon for the rule that it's associated with
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getIsPrimary();
/**
* Set whether the coupon is the primary coupon for the rule that it's associated with
*
* @param bool $isPrimary
* @return $this
*/
public function setIsPrimary($isPrimary);
/**
* Date when the coupon is created
*
* @return string|null
*/
public function getCreatedAt();
/**
* Set the date the coupon is created
*
* @param string $createdAt
* @return $this
*/
public function setCreatedAt($createdAt);
/**
* Type of coupon
*
* @return int|null
*/
public function getType();
/**
* @param int $type
* @return $this
*/
public function setType($type);
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\SalesRule\Api\Data\CouponExtensionInterface|null
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object.
*
* @param \Magento\SalesRule\Api\Data\CouponExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(
\Magento\SalesRule\Api\Data\CouponExtensionInterface $extensionAttributes
);
}