asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
www/apps/docs/content/references/entities/classes/PaymentCollection.mdx
View File

@@ -49,7 +49,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_sessions",
"type": "[`PaymentSession`](PaymentSession.mdx)[]",
"type": "[PaymentSession](PaymentSession.mdx)[]",
"description": "The details of the payment sessions created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -258,7 +258,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
{
"name": "status",
"type": "`string`",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.",
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -277,7 +277,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payments",
"type": "[`Payment`](Payment.mdx)[]",
"type": "[Payment](Payment.mdx)[]",
"description": "The details of the payments created as part of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart",
"type": "[`Cart`](Cart.mdx)",
"type": "[Cart](Cart.mdx)",
"description": "The details of the cart that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -348,7 +348,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency of the payment.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"optional": false,
"defaultValue": "",
@@ -393,7 +393,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -402,7 +402,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "order",
"type": "[`Order`](Order.mdx)",
"type": "[Order](Order.mdx)",
"description": "The details of the order that the payment session was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "swap",
"type": "[`Swap`](Swap.mdx)",
"type": "[Swap](Swap.mdx)",
"description": "The details of the swap that this payment was potentially created for.",
"optional": false,
"defaultValue": "",
@@ -458,7 +458,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "region",
"type": "[`Region`](Region.mdx)",
"type": "[Region](Region.mdx)",
"description": "The details of the region this payment collection is associated with.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "countries",
"type": "[`Country`](Country.mdx)[]",
"type": "[Country](Country.mdx)[]",
"description": "The details of the countries included in this region.",
"optional": false,
"defaultValue": "",
@@ -493,7 +493,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "currency",
"type": "[`Currency`](Currency.mdx)",
"type": "[Currency](Currency.mdx)",
"description": "The details of the currency used in the region.",
"optional": false,
"defaultValue": "",
@@ -520,7 +520,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "fulfillment_providers",
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)[]",
"description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
"optional": false,
"defaultValue": "",
@@ -557,7 +557,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -575,7 +575,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "payment_providers",
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
"type": "[PaymentProvider](PaymentProvider.mdx)[]",
"description": "The details of the payment providers that can be used to process payments in the region.",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_provider",
"type": "[`TaxProvider`](TaxProvider.mdx)",
"type": "[TaxProvider](TaxProvider.mdx)",
"description": "The details of the tax provider used in the region.",
"optional": false,
"defaultValue": "",
@@ -620,7 +620,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_rates",
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -649,7 +649,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "status",
"type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)",
"type": "[PaymentCollectionStatus](../enums/PaymentCollectionStatus.mdx)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",
@@ -704,7 +704,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "type",
"type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)",
"type": "[ORDER_EDIT](../enums/PaymentCollectionType.mdx#order_edit)",
"description": "The type of the payment collection",
"optional": false,
"defaultValue": "",