9
9
10
10
/**
11
11
* Interface for managing customers accounts.
12
+ * @api
12
13
*/
13
14
interface AccountManagementInterface
14
15
{
@@ -24,7 +25,6 @@ interface AccountManagementInterface
24
25
/**
25
26
* Create customer account. Perform necessary business operations like sending email.
26
27
*
27
- * @api
28
28
* @param \Magento\Customer\Api\Data\CustomerInterface $customer
29
29
* @param string $password
30
30
* @param string $redirectUrl
@@ -59,7 +59,6 @@ public function createAccountWithPasswordHash(
59
59
/**
60
60
* Validate customer data.
61
61
*
62
- * @api
63
62
* @param \Magento\Customer\Api\Data\CustomerInterface $customer
64
63
* @return \Magento\Customer\Api\Data\ValidationResultsInterface
65
64
* @throws \Magento\Framework\Exception\LocalizedException
@@ -80,7 +79,6 @@ public function isReadonly($customerId);
80
79
/**
81
80
* Activate a customer account using a key that was sent in a confirmation email.
82
81
*
83
- * @api
84
82
* @param string $email
85
83
* @param string $confirmationKey
86
84
* @return \Magento\Customer\Api\Data\CustomerInterface
@@ -102,7 +100,6 @@ public function activateById($customerId, $confirmationKey);
102
100
/**
103
101
* Authenticate a customer by username and password
104
102
*
105
- * @api
106
103
* @param string $email
107
104
* @param string $password
108
105
* @return \Magento\Customer\Api\Data\CustomerInterface
@@ -113,7 +110,6 @@ public function authenticate($email, $password);
113
110
/**
114
111
* Change customer password.
115
112
*
116
- * @api
117
113
* @param string $email
118
114
* @param string $currentPassword
119
115
* @param string $newPassword
@@ -125,7 +121,6 @@ public function changePassword($email, $currentPassword, $newPassword);
125
121
/**
126
122
* Change customer password.
127
123
*
128
- * @api
129
124
* @param int $customerId
130
125
* @param string $currentPassword
131
126
* @param string $newPassword
@@ -137,7 +132,6 @@ public function changePasswordById($customerId, $currentPassword, $newPassword);
137
132
/**
138
133
* Send an email to the customer with a password reset link.
139
134
*
140
- * @api
141
135
* @param string $email
142
136
* @param string $template
143
137
* @param int $websiteId
@@ -149,7 +143,6 @@ public function initiatePasswordReset($email, $template, $websiteId = null);
149
143
/**
150
144
* Reset customer password.
151
145
*
152
- * @api
153
146
* @param string $email
154
147
* @param string $resetToken
155
148
* @param string $newPassword
@@ -161,7 +154,6 @@ public function resetPassword($email, $resetToken, $newPassword);
161
154
/**
162
155
* Check if password reset token is valid.
163
156
*
164
- * @api
165
157
* @param int $customerId
166
158
* @param string $resetPasswordLinkToken
167
159
* @return bool True if the token is valid
@@ -176,7 +168,6 @@ public function validateResetPasswordLinkToken($customerId, $resetPasswordLinkTo
176
168
/**
177
169
* Gets the account confirmation status.
178
170
*
179
- * @api
180
171
* @param int $customerId
181
172
* @return string
182
173
* @throws \Magento\Framework\Exception\LocalizedException
@@ -186,7 +177,6 @@ public function getConfirmationStatus($customerId);
186
177
/**
187
178
* Resend confirmation email.
188
179
*
189
- * @api
190
180
* @param string $email
191
181
* @param int $websiteId
192
182
* @param string $redirectUrl
@@ -198,7 +188,6 @@ public function resendConfirmation($email, $websiteId, $redirectUrl = '');
198
188
/**
199
189
* Check if given email is associated with a customer account in given website.
200
190
*
201
- * @api
202
191
* @param string $customerEmail
203
192
* @param int $websiteId If not set, will use the current websiteId
204
193
* @return bool
@@ -209,7 +198,6 @@ public function isEmailAvailable($customerEmail, $websiteId = null);
209
198
/**
210
199
* Check store availability for customer given the customerId.
211
200
*
212
- * @api
213
201
* @param int $customerWebsiteId
214
202
* @param int $storeId
215
203
* @return bool
@@ -220,7 +208,6 @@ public function isCustomerInStore($customerWebsiteId, $storeId);
220
208
/**
221
209
* Retrieve default billing address for the given customerId.
222
210
*
223
- * @api
224
211
* @param int $customerId
225
212
* @return \Magento\Customer\Api\Data\AddressInterface
226
213
* @throws \Magento\Framework\Exception\NoSuchEntityException If the customer Id is invalid
@@ -231,7 +218,6 @@ public function getDefaultBillingAddress($customerId);
231
218
/**
232
219
* Retrieve default shipping address for the given customerId.
233
220
*
234
- * @api
235
221
* @param int $customerId
236
222
* @return \Magento\Customer\Api\Data\AddressInterface
237
223
* @throws \Magento\Framework\Exception\NoSuchEntityException If the customer Id is invalid
@@ -242,7 +228,6 @@ public function getDefaultShippingAddress($customerId);
242
228
/**
243
229
* Return hashed password, which can be directly saved to database.
244
230
*
245
- * @api
246
231
* @param string $password
247
232
* @return string
248
233
*/
0 commit comments