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:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -18,11 +18,11 @@ Related Guide: [How to manage customers](https://docs.medusajs.com/modules/custo
|
||||
|
||||
## Methods
|
||||
|
||||
### create
|
||||
#### create
|
||||
|
||||
Create a customer as an admin.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -40,7 +40,7 @@ medusa.admin.customers
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -118,7 +118,7 @@ medusa.admin.customers
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -290,11 +290,11 @@ medusa.admin.customers
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
#### list
|
||||
|
||||
Retrieve a list of Customers. The customers can be filtered by fields such as `q` or `groups`. The customers can also be paginated.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
To list customers:
|
||||
|
||||
@@ -339,7 +339,7 @@ medusa.admin.customers
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -417,7 +417,7 @@ medusa.admin.customers
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -616,11 +616,11 @@ medusa.admin.customers
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
#### retrieve
|
||||
|
||||
Retrieve the details of a customer.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -631,7 +631,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -654,7 +654,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -826,11 +826,11 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
#### update
|
||||
|
||||
Update a customer's details.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -845,7 +845,7 @@ medusa.admin.customers
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -951,7 +951,7 @@ medusa.admin.customers
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user