1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\SalesRule\Api;
- /**
- * Coupon CRUD interface
- *
- * @api
- * @since 100.0.2
- */
- interface CouponRepositoryInterface
- {
- /**
- * Save a coupon.
- *
- * @param \Magento\SalesRule\Api\Data\CouponInterface $coupon
- * @return \Magento\SalesRule\Api\Data\CouponInterface
- * @throws \Magento\Framework\Exception\InputException If there is a problem with the input
- * @throws \Magento\Framework\Exception\NoSuchEntityException If a coupon ID is sent but the coupon does not exist
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function save(\Magento\SalesRule\Api\Data\CouponInterface $coupon);
- /**
- * Get coupon by coupon id.
- *
- * @param int $couponId
- * @return \Magento\SalesRule\Api\Data\CouponInterface
- * @throws \Magento\Framework\Exception\NoSuchEntityException If $couponId is not found
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getById($couponId);
- /**
- * Retrieve a coupon using the specified search criteria.
- *
- * This call returns an array of objects, but detailed information about each object’s attributes might not be
- * included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to
- * determine which call to use to get detailed information about all attributes for an object.
- *
- * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
- * @return \Magento\SalesRule\Api\Data\CouponSearchResultInterface
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
- /**
- * Delete coupon by coupon id.
- *
- * @param int $couponId
- * @return bool true on success
- * @throws \Magento\Framework\Exception\NoSuchEntityException
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function deleteById($couponId);
- }
|