chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

View File

@@ -22,13 +22,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Methods
### addDocuments
#### addDocuments
`**addDocuments**(indexName, documents, type): unknown`
Used to index documents by the search engine provider
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -60,7 +60,7 @@ Used to index documents by the search engine provider
}
]} />
#### Returns
##### Returns
`unknown`
@@ -78,13 +78,13 @@ Used to index documents by the search engine provider
___
### createIndex
#### createIndex
`**createIndex**(indexName, options): unknown`
Used to create an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -107,7 +107,7 @@ Used to create an index
}
]} />
#### Returns
##### Returns
`unknown`
@@ -125,13 +125,13 @@ Used to create an index
___
### deleteAllDocuments
#### deleteAllDocuments
`**deleteAllDocuments**(indexName): unknown`
Used to delete all documents
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -145,7 +145,7 @@ Used to delete all documents
}
]} />
#### Returns
##### Returns
`unknown`
@@ -163,13 +163,13 @@ Used to delete all documents
___
### deleteDocument
#### deleteDocument
`**deleteDocument**(indexName, document_id): unknown`
Used to delete document
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +192,7 @@ Used to delete document
}
]} />
#### Returns
##### Returns
`unknown`
@@ -210,13 +210,13 @@ Used to delete document
___
### getIndex
#### getIndex
`**getIndex**(indexName): unknown`
Used to get an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -230,7 +230,7 @@ Used to get an index
}
]} />
#### Returns
##### Returns
`unknown`
@@ -248,13 +248,13 @@ Used to get an index
___
### replaceDocuments
#### replaceDocuments
`**replaceDocuments**(indexName, documents, type): unknown`
Used to replace documents
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -286,7 +286,7 @@ Used to replace documents
}
]} />
#### Returns
##### Returns
`unknown`
@@ -304,13 +304,13 @@ Used to replace documents
___
### search
#### search
`**search**(indexName, query, options): unknown`
Used to search for a document in an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -342,7 +342,7 @@ Used to search for a document in an index
}
]} />
#### Returns
##### Returns
`unknown`
@@ -360,13 +360,13 @@ Used to search for a document in an index
___
### updateSettings
#### updateSettings
`**updateSettings**(indexName, settings): unknown`
Used to update the settings of an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -389,7 +389,7 @@ Used to update the settings of an index
}
]} />
#### Returns
##### Returns
`unknown`