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

@@ -16,11 +16,11 @@ A payment can be related to an order, swap, return, or more. It can be captured
## Methods
### capturePayment
#### capturePayment
Capture a payment.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -31,7 +31,7 @@ medusa.admin.payments.capturePayment(paymentId).then(({ payment }) => {
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -54,7 +54,7 @@ medusa.admin.payments.capturePayment(paymentId).then(({ payment }) => {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -262,11 +262,11 @@ medusa.admin.payments.capturePayment(paymentId).then(({ payment }) => {
___
### refundPayment
#### refundPayment
Refund a payment. The payment must be captured first.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -283,7 +283,7 @@ medusa.admin.payments
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -389,7 +389,7 @@ medusa.admin.payments
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{
@@ -534,11 +534,11 @@ medusa.admin.payments
___
### retrieve
#### retrieve
Retrieve a payment's details.
#### Example
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -549,7 +549,7 @@ medusa.admin.payments.retrieve(paymentId).then(({ payment }) => {
})
```
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -600,7 +600,7 @@ medusa.admin.payments.retrieve(paymentId).then(({ payment }) => {
}
]} />
#### Returns
##### Returns
<ParameterTypes parameters={[
{