Merge pull request #1063 from vtexdocs/chore/add-faststore-schema

FastStore API schema

docs/faststore/docs/faststore-api/schema/enums.mdx

@@ -0,0 +1,195 @@
+---
+title: 'Enums'
+---
+
+### StoreCollectionType
+
+Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`.
+
+<table>
+<thead>
+<th align="left">Value</th>
+<th align="left">Description</th>
+</thead>
+<tbody>
+<tr>
+<td valign="top"><strong>Department</strong></td>
+<td>
+
+First level of product categorization.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>Category</strong></td>
+<td>
+
+Second level of product categorization.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>SubCategory</strong></td>
+<td>
+
+Third level of product categorization.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>Brand</strong></td>
+<td>
+
+Product brand.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>Cluster</strong></td>
+<td>
+
+Product cluster.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>Collection</strong></td>
+<td>
+
+Product collection.
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### StoreFacetType
+
+Search facet type.
+
+<table>
+<thead>
+<th align="left">Value</th>
+<th align="left">Description</th>
+</thead>
+<tbody>
+<tr>
+<td valign="top"><strong>BOOLEAN</strong></td>
+<td>
+
+Indicates a filter with boolean options (e.g., `yes` and `no`), for narrowing search results.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>RANGE</strong></td>
+<td>
+
+Indicates a filter to choose between a range of values (e.g., `price`, `size`, etc) to refine search results.
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### StoreSort
+
+Product search results sorting options.
+
+<table>
+<thead>
+<th align="left">Value</th>
+<th align="left">Description</th>
+</thead>
+<tbody>
+<tr>
+<td valign="top"><strong>price_desc</strong></td>
+<td>
+
+Sort by price, from highest to lowest.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>price_asc</strong></td>
+<td>
+
+Sort by price, from lowest to highest.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>orders_desc</strong></td>
+<td>
+
+Sort by orders, from highest to lowest.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>name_desc</strong></td>
+<td>
+
+Sort by name, in reverse alphabetical order.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>name_asc</strong></td>
+<td>
+
+Sort by name, in alphabetical order.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>release_desc</strong></td>
+<td>
+
+Sort by release date, from  highest to lowest.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>discount_desc</strong></td>
+<td>
+
+Sort by discount value, from highest to lowest.
+
+</td>
+</tr>
+<tr>
+<td valign="top"><strong>score_desc</strong></td>
+<td>
+
+Sort by product score, from highest to lowest.
+
+</td>
+</tr>
+</tbody>
+</table>
+
+### StoreStatus
+
+Status used to indicate a message type. For instance, a shopping cart informative or error message.
+
+<table>
+<thead>
+<th align="left">Value</th>
+<th align="left">Description</th>
+</thead>
+<tbody>
+<tr>
+<td valign="top"><strong>INFO</strong></td>
+<td>Indicates non-critical notifications or informative messages related to the user's action.</td>
+</tr>
+<tr>
+<td valign="top"><strong>WARNING</strong></td>
+<td>Indicates a potential issue or unexpected behavior that might require user attention but doesn't necessarily prevent them from continuing.</td>
+</tr>
+<tr>
+<td valign="top"><strong>ERROR</strong></td>
+<td>Indicates a critical issue that prevents the user from completing an action or indicates a problem with the system.</td>
+</tr>
+</tbody>
+</table>