Merge pull request #2254 from magento-engcom/async-webapi-2

[Engcom] Async WebAPI

Author: vrann

app/code/Magento/AsynchronousOperations/Api/BulkStatusInterface.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api;
+
+/**
+ * Interface BulkStatusInterface
+ * Bulk summary data with list of operations items short data.
+ *
+ * @api
+ */
+interface BulkStatusInterface extends \Magento\Framework\Bulk\BulkStatusInterface
+{
+    /**
+     * Get Bulk summary data with list of operations items full data.
+     *
+     * @param string $bulkUuid
+     * @return \Magento\AsynchronousOperations\Api\Data\DetailedBulkOperationsStatusInterface
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    public function getBulkDetailedStatus($bulkUuid);
+
+    /**
+     * Get Bulk summary data with list of operations items short data.
+     *
+     * @param string $bulkUuid
+     * @return \Magento\AsynchronousOperations\Api\Data\BulkOperationsStatusInterface
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    public function getBulkShortStatus($bulkUuid);
+}

app/code/Magento/AsynchronousOperations/Api/Data/AsyncResponseInterface.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api\Data;
+
+/**
+ * Interface AsyncResponseInterface
+ * Temporary data object to give response from webapi async router
+ *
+ * @api
+ */
+interface AsyncResponseInterface
+{
+    const BULK_UUID = 'bulk_uuid';
+    const REQUEST_ITEMS = 'request_items';
+    const ERRORS = 'errors';
+
+    /**
+     * Gets the bulk uuid.
+     *
+     * @return string Bulk Uuid.
+     */
+    public function getBulkUuid();
+
+    /**
+     * Sets the bulk uuid.
+     *
+     * @param string $bulkUuid
+     * @return $this
+     */
+    public function setBulkUuid($bulkUuid);
+
+    /**
+     * Gets the list of request items with status data.
+     *
+     * @return \Magento\AsynchronousOperations\Api\Data\ItemStatusInterface[]
+     */
+    public function getRequestItems();
+
+    /**
+     * Sets the list of request items with status data.
+     *
+     * @param \Magento\AsynchronousOperations\Api\Data\ItemStatusInterface[] $requestItems
+     * @return $this
+     */
+    public function setRequestItems($requestItems);
+
+    /**
+     * @param bool $isErrors
+     * @return $this
+     */
+    public function setErrors($isErrors = false);
+
+    /**
+     * Is there errors during processing bulk
+     *
+     * @return boolean
+     */
+    public function isErrors();
+
+    /**
+     * Retrieve existing extension attributes object.
+     *
+     * @return \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface|null
+     */
+    public function getExtensionAttributes();
+
+    /**
+     * Set an extension attributes object.
+     *
+     * @param \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface $extensionAttributes
+     * @return $this
+     */
+    public function setExtensionAttributes(
+        \Magento\AsynchronousOperations\Api\Data\AsyncResponseExtensionInterface $extensionAttributes
+    );
+}

app/code/Magento/AsynchronousOperations/Api/Data/BulkOperationsStatusInterface.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api\Data;
+
+/**
+ * Interface BulkStatusInterface
+ *
+ * Bulk summary data with list of operations items summary data.
+ *
+ * @api
+ */
+interface BulkOperationsStatusInterface extends BulkSummaryInterface
+{
+
+    const OPERATIONS_LIST = 'operations_list';
+
+    /**
+     * Retrieve list of operation with statuses (short data).
+     *
+     * @return \Magento\AsynchronousOperations\Api\Data\SummaryOperationStatusInterface[]
+     */
+    public function getOperationsList();
+
+    /**
+     * Set operations list.
+     *
+     * @param \Magento\AsynchronousOperations\Api\Data\SummaryOperationStatusInterface[] $operationStatusList
+     * @return $this
+     */
+    public function setOperationsList($operationStatusList);
+}

app/code/Magento/AsynchronousOperations/Api/Data/DetailedBulkOperationsStatusInterface.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api\Data;
+
+/**
+ * Interface BulkStatusInterface
+ *
+ * Bulk summary data with list of operations items full data.
+ *
+ * @api
+ */
+interface DetailedBulkOperationsStatusInterface extends BulkSummaryInterface
+{
+
+    const OPERATIONS_LIST = 'operations_list';
+
+    /**
+     * Retrieve operations list.
+     *
+     * @return \Magento\AsynchronousOperations\Api\Data\DetailedOperationStatusInterface[]
+     */
+    public function getOperationsList();
+
+    /**
+     * Set operations list.
+     *
+     * @param \Magento\AsynchronousOperations\Api\Data\DetailedOperationStatusInterface[] $operationStatusList
+     * @return $this
+     */
+    public function setOperationsList($operationStatusList);
+}

app/code/Magento/AsynchronousOperations/Api/Data/DetailedOperationStatusInterface.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api\Data;
+
+/**
+ * @api
+ */
+interface DetailedOperationStatusInterface extends OperationInterface
+{
+    /**
+     * Result serialized Data
+     *
+     * @return string
+     */
+    public function getResultSerializedData();
+
+    /**
+     * Set result serialized data
+     *
+     * @param string $resultSerializedData
+     * @return $this
+     */
+    public function setResultSerializedData($resultSerializedData);
+}

app/code/Magento/AsynchronousOperations/Api/Data/ItemStatusInterface.php

@@ -0,0 +1,103 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api\Data;
+
+/**
+ * ItemStatusInterface interface
+ * Temporary object with status of requested item.
+ * Indicate if entity param was Accepted|Rejected to bulk schedule
+ *
+ * @api
+ */
+interface ItemStatusInterface
+{
+    const ENTITY_ID = 'entity_id';
+    const DATA_HASH = 'data_hash';
+    const STATUS = 'status';
+    const ERROR_MESSAGE = 'error_message';
+    const ERROR_CODE = 'error_code';
+
+    const STATUS_ACCEPTED = 'accepted';
+    const STATUS_REJECTED = 'rejected';
+
+    /**
+     * Get entity Id.
+     *
+     * @return int
+     */
+    public function getId();
+
+    /**
+     * Sets entity Id.
+     *
+     * @param int $entityId
+     * @return $this
+     */
+    public function setId($entityId);
+
+    /**
+     * Get hash of entity data.
+     *
+     * @return string md5 hash of entity params array.
+     */
+    public function getDataHash();
+
+    /**
+     * Sets hash of entity data.
+     *
+     * @param string $hash md5 hash of entity params array.
+     * @return $this
+     */
+    public function setDataHash($hash);
+
+    /**
+     * Get status.
+     *
+     * @return string accepted|rejected
+     */
+    public function getStatus();
+
+    /**
+     * Sets entity status.
+     *
+     * @param string $status accepted|rejected
+     * @return $this
+     */
+    public function setStatus($status = self::STATUS_ACCEPTED);
+
+    /**
+     * Get error information.
+     *
+     * @return string|null
+     */
+    public function getErrorMessage();
+
+    /**
+     * Sets error information.
+     *
+     * @param string|null|\Exception $error
+     * @return $this
+     */
+    public function setErrorMessage($error = null);
+
+    /**
+     * Get error code.
+     *
+     * @return int|null
+     */
+    public function getErrorCode();
+
+    /**
+     * Sets error information.
+     *
+     * @param int|null|\Exception $errorCode Default: null
+     * @return $this
+     */
+    public function setErrorCode($errorCode = null);
+}

app/code/Magento/AsynchronousOperations/Api/Data/SummaryOperationStatusInterface.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AsynchronousOperations\Api\Data;
+
+/**
+ * Getter Class OperationsStatusInterface
+ * Instead of OperationInterface this class don't provide all operation data
+ * and not responsive to set any data, just to get operation data
+ * without serialized_data and result_serialized_data
+ *
+ * @api
+ */
+interface SummaryOperationStatusInterface
+{
+    /**
+     * Operation id
+     *
+     * @return int
+     */
+    public function getId();
+
+    /**
+     * Get operation status
+     *
+     * OPEN | COMPLETE | RETRIABLY_FAILED | NOT_RETRIABLY_FAILED
+     *
+     * @return int
+     */
+    public function getStatus();
+
+    /**
+     * Get result message
+     *
+     * @return string
+     */
+    public function getResultMessage();
+
+    /**
+     * Get error code
+     *
+     * @return int
+     */
+    public function getErrorCode();
+}