Merge pull request #208 from magento-south/MAGETWO-32631-by-andrii

[South] Define Public API

Author: slavvka

app/code/Magento/Customer/Api/AccountManagementInterface.php

@@ -23,6 +23,7 @@ interface AccountManagementInterface
     /**
      * Create customer account. Perform necessary business operations like sending email.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\CustomerInterface $customer
      * @param string $password
      * @param string $redirectUrl
@@ -38,6 +39,7 @@ public function createAccount(
     /**
      * Create customer account using provided hashed password. Should not be exposed as a webapi.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\CustomerInterface $customer
      * @param string $hash Password hash that we can save directly
      * @param string $redirectUrl URL fed to welcome email templates. Can be used by templates to, for example, direct
@@ -56,6 +58,7 @@ public function createAccountWithPasswordHash(
     /**
      * Validate customer data.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\CustomerInterface $customer
      * @return \Magento\Customer\Api\Data\ValidationResultsInterface
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -65,6 +68,7 @@ public function validate(\Magento\Customer\Api\Data\CustomerInterface $customer)
     /**
      * Check if customer can be deleted.
      *
+     * @api
      * @param int $customerId
      * @return bool
      * @throws \Magento\Framework\Exception\NoSuchEntityException If group is not found
@@ -75,6 +79,7 @@ public function isReadonly($customerId);
     /**
      * Activate a customer account using a key that was sent in a confirmation e-mail.
      *
+     * @api
      * @param string $email
      * @param string $confirmationKey
      * @return \Magento\Customer\Api\Data\CustomerInterface
@@ -85,6 +90,7 @@ public function activate($email, $confirmationKey);
     /**
      * Activate a customer account using a key that was sent in a confirmation e-mail.
      *
+     * @api
      * @param int $customerId
      * @param string $confirmationKey
      * @return \Magento\Customer\Api\Data\CustomerInterface
@@ -95,6 +101,7 @@ public function activateById($customerId, $confirmationKey);
     /**
      * Authenticate a customer by username and password
      *
+     * @api
      * @param string $email
      * @param string $password
      * @return \Magento\Customer\Api\Data\CustomerInterface
@@ -105,6 +112,7 @@ public function authenticate($email, $password);
     /**
      * Change customer password.
      *
+     * @api
      * @param string $email
      * @param string $currentPassword
      * @param string $newPassword
@@ -116,6 +124,7 @@ public function changePassword($email, $currentPassword, $newPassword);
     /**
      * Change customer password.
      *
+     * @api
      * @param int $customerId
      * @param string $currentPassword
      * @param string $newPassword
@@ -127,6 +136,7 @@ public function changePasswordById($customerId, $currentPassword, $newPassword);
     /**
      * Send an email to the customer with a password reset link.
      *
+     * @api
      * @param string $email
      * @param string $template
      * @param int $websiteId
@@ -138,6 +148,7 @@ public function initiatePasswordReset($email, $template, $websiteId = null);
     /**
      * Reset customer password.
      *
+     * @api
      * @param string $email
      * @param string $resetToken
      * @param string $newPassword
@@ -149,6 +160,7 @@ public function resetPassword($email, $resetToken, $newPassword);
     /**
      * Check if password reset token is valid.
      *
+     * @api
      * @param int $customerId
      * @param string $resetPasswordLinkToken
      * @return bool True if the token is valid
@@ -163,6 +175,7 @@ public function validateResetPasswordLinkToken($customerId, $resetPasswordLinkTo
     /**
      * Gets the account confirmation status.
      *
+     * @api
      * @param int $customerId
      * @return string
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -172,6 +185,7 @@ public function getConfirmationStatus($customerId);
     /**
      * Resend confirmation email.
      *
+     * @api
      * @param string $email
      * @param int $websiteId
      * @param string $redirectUrl
@@ -183,6 +197,7 @@ public function resendConfirmation($email, $websiteId, $redirectUrl = '');
     /**
      * Check if given email is associated with a customer account in given website.
      *
+     * @api
      * @param string $customerEmail
      * @param int $websiteId If not set, will use the current websiteId
      * @return bool
@@ -193,6 +208,7 @@ public function isEmailAvailable($customerEmail, $websiteId = null);
     /**
      * Check store availability for customer given the customerId.
      *
+     * @api
      * @param int $customerWebsiteId
      * @param int $storeId
      * @return bool
@@ -203,6 +219,7 @@ public function isCustomerInStore($customerWebsiteId, $storeId);
     /**
      * Retrieve default billing address for the given customerId.
      *
+     * @api
      * @param int $customerId
      * @return \Magento\Customer\Api\Data\AddressInterface
      * @throws \Magento\Framework\Exception\NoSuchEntityException If the customer Id is invalid
@@ -213,6 +230,7 @@ public function getDefaultBillingAddress($customerId);
     /**
      * Retrieve default shipping address for the given customerId.
      *
+     * @api
      * @param int $customerId
      * @return \Magento\Customer\Api\Data\AddressInterface
      * @throws \Magento\Framework\Exception\NoSuchEntityException If the customer Id is invalid
@@ -223,6 +241,7 @@ public function getDefaultShippingAddress($customerId);
     /**
      * Return hashed password, which can be directly saved to database.
      *
+     * @api
      * @param string $password
      * @return string
      */

app/code/Magento/Customer/Api/AddressRepositoryInterface.php

@@ -14,6 +14,7 @@ interface AddressRepositoryInterface
     /**
      * Save customer address.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\AddressInterface $address
      * @return \Magento\Customer\Api\Data\AddressInterface
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -23,6 +24,7 @@ public function save(\Magento\Customer\Api\Data\AddressInterface $address);
     /**
      * Retrieve customer address.
      *
+     * @api
      * @param int $addressId
      * @return \Magento\Customer\Api\Data\AddressInterface
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -32,6 +34,7 @@ public function getById($addressId);
     /**
      * Retrieve customers addresses matching the specified criteria.
      *
+     * @api
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Customer\Api\Data\AddressSearchResultsInterface
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -41,6 +44,7 @@ public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCr
     /**
      * Delete customer address.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\AddressInterface $address
      * @return bool true on success
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -50,6 +54,7 @@ public function delete(\Magento\Customer\Api\Data\AddressInterface $address);
     /**
      * Delete customer address by ID.
      *
+     * @api
      * @param int $addressId
      * @return bool true on success
      * @throws \Magento\Framework\Exception\NoSuchEntityException

app/code/Magento/Customer/Api/CustomerRepositoryInterface.php

@@ -15,6 +15,7 @@ interface CustomerRepositoryInterface
     /**
      * Create customer.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\CustomerInterface $customer
      * @param string $passwordHash
      * @return \Magento\Customer\Api\Data\CustomerInterface
@@ -27,6 +28,7 @@ public function save(\Magento\Customer\Api\Data\CustomerInterface $customer, $pa
     /**
      * Retrieve customer.
      *
+     * @api
      * @param string $email
      * @param int|null $websiteId
      * @return \Magento\Customer\Api\Data\CustomerInterface
@@ -38,6 +40,7 @@ public function get($email, $websiteId = null);
     /**
      * Retrieve customer.
      *
+     * @api
      * @param int $customerId
      * @return \Magento\Customer\Api\Data\CustomerInterface
      * @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified ID does not exist.
@@ -48,6 +51,7 @@ public function getById($customerId);
     /**
      * Retrieve customers which match a specified criteria.
      *
+     * @api
      * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
      * @return \Magento\Customer\Api\Data\CustomerSearchResultsInterface
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -57,6 +61,7 @@ public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCr
     /**
      * Delete customer.
      *
+     * @api
      * @param \Magento\Customer\Api\Data\CustomerInterface $customer
      * @return bool true on success
      * @throws \Magento\Framework\Exception\LocalizedException
@@ -66,6 +71,7 @@ public function delete(\Magento\Customer\Api\Data\CustomerInterface $customer);
     /**
      * Delete customer by ID.
      *
+     * @api
      * @param int $customerId
      * @return bool true on success
      * @throws \Magento\Framework\Exception\NoSuchEntityException