chore(docs): Generated References (automated) (#12672)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
1 parent
e4f791ac84
commit
f8c0bd887e
675 files changed
+320670
-309515
No files matched your search
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentEvents
|
||||
|
||||
`Const` **PaymentEvents**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"CAPTURED","type":"`string`","description":"Emitted when a payment is captured.","optional":false,"defaultValue":"\"payment.captured\"","expandable":false,"children":[]},{"name":"REFUNDED","type":"`string`","description":"Emitted when a payment is refunded.","optional":false,"defaultValue":"\"payment.refunded\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PaymentEvents"/>
|
||||
+21
-1
@@ -12,16 +12,36 @@ the required fields in the normalized output.
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"rows","type":"`Record<string, string \\| number \\| boolean>`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CSVNormalizer"/>
|
||||
<TypeList types={[{"name":"rows","type":"[NormalizedRow](../../../types/utils.NormalizedRow/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"product handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CSVNormalizer"/>
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### preProcess
|
||||
|
||||
Normalizes a row by converting all keys to lowercase and removing
|
||||
the leading "\r" from the keys and the values.
|
||||
|
||||
Also, it values the row to contain unknown columns and must contain
|
||||
the "product id" or "product handle" columns.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"row","type":"`Record<string, string \\| number \\| boolean>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rowNumber","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="preProcess"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"product id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product handle","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="preProcess"/>
|
||||
|
||||
### proccess
|
||||
|
||||
Process CSV rows. The return value is a tree of products
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"resumingFromIndex","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="proccess"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"toCreate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"toUpdate","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="proccess"/>
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# NormalizedRow
|
||||
|
||||
**NormalizedRow**: `Record<string, string \| number \| boolean>` & `object` \| `object` \| `object`
|
||||
@@ -11,6 +11,7 @@ import { TypeList } from "docs-ui"
|
||||
- [InviteWorkflowEvents](../User/variables/utils.User.InviteWorkflowEvents/page.mdx)
|
||||
- [OrderEditWorkflowEvents](../Order/variables/utils.Order.OrderEditWorkflowEvents/page.mdx)
|
||||
- [OrderWorkflowEvents](../Order/variables/utils.Order.OrderWorkflowEvents/page.mdx)
|
||||
- [PaymentEvents](../Payment/variables/utils.Payment.PaymentEvents/page.mdx)
|
||||
- [ProductCategoryWorkflowEvents](../Product/variables/utils.Product.ProductCategoryWorkflowEvents/page.mdx)
|
||||
- [ProductCollectionWorkflowEvents](../Product/variables/utils.Product.ProductCollectionWorkflowEvents/page.mdx)
|
||||
- [ProductOptionWorkflowEvents](../Product/variables/utils.Product.ProductOptionWorkflowEvents/page.mdx)
|
||||
@@ -53,3 +54,5 @@ ___
|
||||
___
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Payment
|
||||
|
||||
## Variables
|
||||
|
||||
- [PaymentEvents](../Payment/variables/utils.Payment.PaymentEvents/page.mdx)
|
||||
Reference in new issue
Block a user