bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
66 lines
1.2 KiB
Plaintext
66 lines
1.2 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
---
|
|
|
|
import TypeList from "@site/src/components/TypeList"
|
|
|
|
# SwapPaymentStatus
|
|
|
|
The swap's payment status.
|
|
|
|
## Enumeration Members
|
|
|
|
### NOT\_PAID
|
|
|
|
**NOT\_PAID** = `"not_paid"`
|
|
|
|
The swap's additional payment isn't paid.
|
|
|
|
### AWAITING
|
|
|
|
**AWAITING** = `"awaiting"`
|
|
|
|
The swap is additional awaiting payment.
|
|
|
|
### CAPTURED
|
|
|
|
**CAPTURED** = `"captured"`
|
|
|
|
The swap's additional payment is captured.
|
|
|
|
### CONFIRMED
|
|
|
|
**CONFIRMED** = `"confirmed"`
|
|
|
|
The swap's additional payment is confirmed.
|
|
|
|
### CANCELED
|
|
|
|
**CANCELED** = `"canceled"`
|
|
|
|
The swap's additional payment is canceled.
|
|
|
|
### DIFFERENCE\_REFUNDED
|
|
|
|
**DIFFERENCE\_REFUNDED** = `"difference_refunded"`
|
|
|
|
The negative difference amount between the returned item(s) and the new one(s) has been refuneded.
|
|
|
|
### PARTIALLY\_REFUNDED
|
|
|
|
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
|
|
|
Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.
|
|
|
|
### REFUNDED
|
|
|
|
**REFUNDED** = `"refunded"`
|
|
|
|
The amount in the associated order has been refunded.
|
|
|
|
### REQUIRES\_ACTION
|
|
|
|
**REQUIRES\_ACTION** = `"requires_action"`
|
|
|
|
The swap's payment requires an action.
|