MAGE-1170: add new IndexOptions model

Author: damcou

Api/Data/IndexOptionsInterface.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Data;
+
+interface IndexOptionsInterface
+{
+    const STORE_ID = 'store_id';
+
+    const INDEX_SUFFIX = 'index_suffix';
+
+    const IS_TMP = 'is_tmp';
+
+    const ENFORCED_INDEX_NAME = 'enforced_index_name';
+
+    /**
+     * Get field: store_id
+     *
+     * @return int|null
+     */
+    public function getStoreId(): ?int;
+
+    /**
+     * Get field: index_suffix
+     *
+     * @return string|null
+     */
+    public function getIndexSuffix(): ?string;
+
+    /**
+     * Get field: is_tmp
+     *
+     * @return bool
+     */
+    public function isTmp(): bool;
+
+    /**
+     * Get field: enforced_index_name
+     *
+     * @return string|null
+     */
+    public function getEnforcedIndexName(): ?string;
+}

Model/IndexOptions.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Model;
+
+use Algolia\AlgoliaSearch\Api\Data\IndexOptionsInterface;
+use Magento\Framework\DataObject;
+
+class IndexOptions extends DataObject implements IndexOptionsInterface
+{
+    public function getStoreId(): ?int
+    {
+        return $this->hasData(IndexOptionsInterface::STORE_ID) ?
+            (int) $this->getData(IndexOptionsInterface::STORE_ID) :
+            null;
+    }
+
+    public function getIndexSuffix(): ?string
+    {
+        return $this->hasData(IndexOptionsInterface::INDEX_SUFFIX) ?
+            (string) $this->getData(IndexOptionsInterface::INDEX_SUFFIX) :
+            null;
+    }
+
+    public function isTmp(): bool
+    {
+        return $this->hasData(IndexOptionsInterface::IS_TMP) ?
+            (string) $this->getData(IndexOptionsInterface::IS_TMP) :
+            false;
+    }
+
+    public function getEnforcedIndexName(): ?string
+    {
+        return $this->hasData(IndexOptionsInterface::ENFORCED_INDEX_NAME) ?
+            (string) $this->getData(IndexOptionsInterface::ENFORCED_INDEX_NAME) :
+            null;
+    }
+}

Service/IndexNameFetcher.php

@@ -21,6 +21,8 @@ public function __construct(
     public const INDEX_QUERY_SUGGESTIONS_SUFFIX = '_query_suggestions';
 
     /**
+     * Ex: magento2_default_products
+     *
      * @param string $indexSuffix
      * @param int|null $storeId
      * @param bool $tmp
@@ -33,6 +35,8 @@ public function getIndexName(string $indexSuffix, ?int $storeId = null, bool $tm
     }
 
     /**
+     * Ex: magento2_default
+     *
      * @param int|null $storeId
      * @return string
      * @throws NoSuchEntityException