docs: TSDoc + reference of fulfillment service (#5761)

This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions

View File

@@ -16,11 +16,11 @@ A payment collection is useful for managing additional payments, such as for Ord
## Methods
#### delete
### delete
Delete a payment collection. Only payment collections with the statuses `canceled` or `not_paid` can be deleted.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -33,7 +33,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -110,11 +110,11 @@ medusa.admin.paymentCollections
___
#### markAsAuthorized
### markAsAuthorized
Set the status of a payment collection as `authorized`. This will also change the `authorized_amount` of the payment collection.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -127,7 +127,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -150,7 +150,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -340,11 +340,11 @@ medusa.admin.paymentCollections
___
#### retrieve
### retrieve
Retrieve a Payment Collection's details.
##### Example
#### Example
A simple example that retrieves a payment collection by its ID:
@@ -374,7 +374,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -425,7 +425,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -615,11 +615,11 @@ medusa.admin.paymentCollections
___
#### update
### update
Update a payment collection's details.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -634,7 +634,7 @@ medusa.admin.paymentCollections
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -685,7 +685,7 @@ medusa.admin.paymentCollections
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{