docs: update docusaurus to v3 (#5625)
* 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:
@@ -12,7 +12,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
|
||||
### constructor
|
||||
|
||||
**new Fulfillment**()
|
||||
`**new Fulfillment**()`
|
||||
|
||||
A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.
|
||||
|
||||
@@ -30,7 +30,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "claim_order",
|
||||
"type": "[`ClaimOrder`](ClaimOrder.mdx)",
|
||||
"type": "[ClaimOrder](ClaimOrder.mdx)",
|
||||
"description": "The details of the claim that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -57,7 +57,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -84,7 +84,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]",
|
||||
"type": "[FulfillmentItem](FulfillmentItem.mdx)[]",
|
||||
"description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -102,7 +102,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -120,7 +120,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"type": "[`Order`](Order.mdx)",
|
||||
"type": "[Order](Order.mdx)",
|
||||
"description": "The details of the order that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -138,7 +138,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "provider",
|
||||
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
|
||||
"type": "[FulfillmentProvider](FulfillmentProvider.mdx)",
|
||||
"description": "The details of the fulfillment provider responsible for handling the fulfillment.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -165,7 +165,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "swap",
|
||||
"type": "[`Swap`](Swap.mdx)",
|
||||
"type": "[Swap](Swap.mdx)",
|
||||
"description": "The details of the swap that the fulfillment may belong to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -183,7 +183,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
},
|
||||
{
|
||||
"name": "tracking_links",
|
||||
"type": "[`TrackingLink`](TrackingLink.mdx)[]",
|
||||
"type": "[TrackingLink](TrackingLink.mdx)[]",
|
||||
"description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -214,7 +214,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
|
||||
|
||||
### beforeInsert
|
||||
|
||||
`Private` **beforeInsert**(): `void`
|
||||
`Private **beforeInsert**(): void`
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
Reference in New Issue
Block a user