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

@@ -15,12 +15,12 @@ Using the methods in this class, you can list or retrieve a collection's details
## Methods
### list
#### list
Retrieve a list of product collections. The product collections can be filtered by fields such as `handle` or `created_at` passed in the `query` parameter.
The product collections can also be paginated.
#### Example
##### Example
To list product collections:
@@ -47,7 +47,7 @@ medusa.collections
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -190,7 +190,7 @@ medusa.collections
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -326,11 +326,11 @@ medusa.collections
___
### retrieve
#### retrieve
Retrieve a product collection's details.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -340,7 +340,7 @@ medusa.collections.retrieve(collectionId).then(({ collection }) => {
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -363,7 +363,7 @@ medusa.collections.retrieve(collectionId).then(({ collection }) => {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{