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
@@ -14,11 +14,11 @@ A payment collection is useful for managing additional payments, such as for Ord
|
||||
|
||||
## Methods
|
||||
|
||||
### authorizePaymentSession
|
||||
#### authorizePaymentSession
|
||||
|
||||
Authorize a Payment Session of a Payment Collection.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -31,7 +31,7 @@ medusa.paymentCollections
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -63,7 +63,7 @@ medusa.paymentCollections
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -253,11 +253,11 @@ medusa.paymentCollections
|
||||
|
||||
___
|
||||
|
||||
### authorizePaymentSessionsBatch
|
||||
#### authorizePaymentSessionsBatch
|
||||
|
||||
Authorize the Payment Sessions of a Payment Collection.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -270,7 +270,7 @@ medusa.paymentCollections
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -312,7 +312,7 @@ medusa.paymentCollections
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -502,11 +502,11 @@ medusa.paymentCollections
|
||||
|
||||
___
|
||||
|
||||
### managePaymentSession
|
||||
#### managePaymentSession
|
||||
|
||||
Create a Payment Session for a payment provider in a Payment Collection.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -519,7 +519,7 @@ medusa.paymentCollections
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -561,7 +561,7 @@ medusa.paymentCollections
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -751,11 +751,11 @@ medusa.paymentCollections
|
||||
|
||||
___
|
||||
|
||||
### managePaymentSessionsBatch
|
||||
#### managePaymentSessionsBatch
|
||||
|
||||
Create, update, or delete a list of payment sessions of a Payment Collections. If a payment session is not provided in the `sessions` array, it's deleted.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
To add two new payment sessions:
|
||||
|
||||
@@ -801,7 +801,7 @@ medusa.paymentCollections
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -871,7 +871,7 @@ medusa.paymentCollections
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1061,11 +1061,11 @@ medusa.paymentCollections
|
||||
|
||||
___
|
||||
|
||||
### refreshPaymentSession
|
||||
#### refreshPaymentSession
|
||||
|
||||
Refresh a Payment Session's data to ensure that it is in sync with the Payment Collection.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
```ts
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
@@ -1077,7 +1077,7 @@ medusa.paymentCollections
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1109,7 +1109,7 @@ medusa.paymentCollections
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1263,11 +1263,11 @@ medusa.paymentCollections
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
#### retrieve
|
||||
|
||||
Retrieve a Payment Collection's details.
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
A simple example that retrieves a payment collection by its ID:
|
||||
|
||||
@@ -1297,7 +1297,7 @@ medusa.paymentCollections
|
||||
})
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -1348,7 +1348,7 @@ medusa.paymentCollections
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user