asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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
www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx
+96 -96
View File
@@ -53,7 +53,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderShippingMethodsReq`](../internal/classes/internal.AdminPostOrdersOrderShippingMethodsReq.mdx)",
"type": "[AdminPostOrdersOrderShippingMethodsReq](../internal/classes/internal.AdminPostOrdersOrderShippingMethodsReq.mdx)",
"description": "The shipping method to be added.",
"optional": false,
"defaultValue": "",
@@ -61,7 +61,7 @@ medusa.admin.orders
"children": [
{
"name": "data",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider.",
"optional": true,
"defaultValue": "",
@@ -90,7 +90,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -104,7 +104,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -154,7 +154,7 @@ medusa.admin.orders.archive(orderId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -168,7 +168,7 @@ medusa.admin.orders.archive(orderId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -219,7 +219,7 @@ medusa.admin.orders.cancel(orderId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -233,7 +233,7 @@ medusa.admin.orders.cancel(orderId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -292,7 +292,7 @@ medusa.admin.orders.cancelClaim(orderId, claimId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -306,7 +306,7 @@ medusa.admin.orders.cancelClaim(orderId, claimId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `claims` property.",
@@ -376,7 +376,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -390,7 +390,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -451,7 +451,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -465,7 +465,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -524,7 +524,7 @@ medusa.admin.orders.cancelSwap(orderId, swapId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -538,7 +538,7 @@ medusa.admin.orders.cancelSwap(orderId, swapId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `swaps` property.",
@@ -608,7 +608,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -622,7 +622,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -672,7 +672,7 @@ medusa.admin.orders.capturePayment(orderId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -686,7 +686,7 @@ medusa.admin.orders.capturePayment(orderId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -736,7 +736,7 @@ medusa.admin.orders.complete(orderId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -750,7 +750,7 @@ medusa.admin.orders.complete(orderId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -811,7 +811,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderClaimsReq`](../internal/classes/internal.AdminPostOrdersOrderClaimsReq.mdx)",
"type": "[AdminPostOrdersOrderClaimsReq](../internal/classes/internal.AdminPostOrdersOrderClaimsReq.mdx)",
"description": "The claim to be created.",
"optional": false,
"defaultValue": "",
@@ -819,7 +819,7 @@ medusa.admin.orders
"children": [
{
"name": "additional_items",
"type": "[`AdditionalItem`](../internal/classes/internal.AdditionalItem-2.mdx)[]",
"type": "[AdditionalItem](../internal/classes/internal.AdditionalItem-2.mdx)[]",
"description": "The new items to send to the Customer. This is only used if the claim's type is `replace`.",
"optional": true,
"defaultValue": "",
@@ -828,7 +828,7 @@ medusa.admin.orders
},
{
"name": "claim_items",
"type": "[`Item`](../internal/classes/internal.Item-5.mdx)[]",
"type": "[Item](../internal/classes/internal.Item-5.mdx)[]",
"description": "The Claim Items that the Claim will consist of.",
"optional": false,
"defaultValue": "",
@@ -837,7 +837,7 @@ medusa.admin.orders
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -873,7 +873,7 @@ medusa.admin.orders
},
{
"name": "return_shipping",
"type": "[`ReturnShipping`](../internal/classes/internal.ReturnShipping-3.mdx)",
"type": "[ReturnShipping](../internal/classes/internal.ReturnShipping-3.mdx)",
"description": "Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim.",
"optional": true,
"defaultValue": "",
@@ -882,7 +882,7 @@ medusa.admin.orders
},
{
"name": "shipping_address",
"type": "[`AddressPayload`](../internal/classes/internal.AddressPayload.mdx)",
"type": "[AddressPayload](../internal/classes/internal.AddressPayload.mdx)",
"description": "An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.",
"optional": true,
"defaultValue": "",
@@ -891,7 +891,7 @@ medusa.admin.orders
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-2.mdx)[]",
"type": "[ShippingMethod](../internal/classes/internal.ShippingMethod-2.mdx)[]",
"description": "The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`.",
"optional": true,
"defaultValue": "",
@@ -911,7 +911,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -925,7 +925,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `claims` property.",
@@ -989,7 +989,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderClaimsClaimShipmentsReq`](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx)",
"type": "[AdminPostOrdersOrderClaimsClaimShipmentsReq](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx)",
"description": "The shipment to create.",
"optional": false,
"defaultValue": "",
@@ -1017,7 +1017,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1031,7 +1031,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `claims` property.",
@@ -1091,7 +1091,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderFulfillmentsReq`](../internal/classes/internal.AdminPostOrdersOrderFulfillmentsReq.mdx)",
"type": "[AdminPostOrdersOrderFulfillmentsReq](../internal/classes/internal.AdminPostOrdersOrderFulfillmentsReq.mdx)",
"description": "The fulfillment to be created.",
"optional": false,
"defaultValue": "",
@@ -1099,7 +1099,7 @@ medusa.admin.orders
"children": [
{
"name": "items",
"type": "[`Item`](../internal/classes/internal.Item-4.mdx)[]",
"type": "[Item](../internal/classes/internal.Item-4.mdx)[]",
"description": "The Line Items to include in the Fulfillment.",
"optional": false,
"defaultValue": "",
@@ -1117,7 +1117,7 @@ medusa.admin.orders
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -1137,7 +1137,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1151,7 +1151,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -1206,7 +1206,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderShipmentReq`](../internal/classes/internal.AdminPostOrdersOrderShipmentReq.mdx)",
"type": "[AdminPostOrdersOrderShipmentReq](../internal/classes/internal.AdminPostOrdersOrderShipmentReq.mdx)",
"description": "The shipment to be created.",
"optional": false,
"defaultValue": "",
@@ -1243,7 +1243,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1257,7 +1257,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -1316,7 +1316,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderSwapsReq`](../internal/classes/internal.AdminPostOrdersOrderSwapsReq.mdx)",
"type": "[AdminPostOrdersOrderSwapsReq](../internal/classes/internal.AdminPostOrdersOrderSwapsReq.mdx)",
"description": "The swap to be created.",
"optional": false,
"defaultValue": "",
@@ -1324,7 +1324,7 @@ medusa.admin.orders
"children": [
{
"name": "additional_items",
"type": "[`AdditionalItem`](../internal/classes/internal.AdditionalItem-1.mdx)[]",
"type": "[AdditionalItem](../internal/classes/internal.AdditionalItem-1.mdx)[]",
"description": "The new items to send to the Customer.",
"optional": true,
"defaultValue": "",
@@ -1342,7 +1342,7 @@ medusa.admin.orders
},
{
"name": "custom_shipping_options",
"type": "[`CustomShippingOption`](../internal/classes/internal.CustomShippingOption.mdx)[]",
"type": "[CustomShippingOption](../internal/classes/internal.CustomShippingOption.mdx)[]",
"description": "An array of custom shipping options to potentially create a Shipping Method from to send the additional items.",
"optional": true,
"defaultValue": "",
@@ -1360,7 +1360,7 @@ medusa.admin.orders
},
{
"name": "return_items",
"type": "[`ReturnItem`](../internal/classes/internal.ReturnItem.mdx)[]",
"type": "[ReturnItem](../internal/classes/internal.ReturnItem.mdx)[]",
"description": "The Line Items to associate with the swap's return.",
"optional": false,
"defaultValue": "",
@@ -1378,7 +1378,7 @@ medusa.admin.orders
},
{
"name": "return_shipping",
"type": "[`ReturnShipping`](../internal/classes/internal.ReturnShipping-2.mdx)",
"type": "[ReturnShipping](../internal/classes/internal.ReturnShipping-2.mdx)",
"description": "The shipping method associated with the swap's return.",
"optional": true,
"defaultValue": "",
@@ -1398,7 +1398,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1412,7 +1412,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `swaps` property.",
@@ -1476,7 +1476,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderSwapsSwapShipmentsReq`](../internal/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx)",
"type": "[AdminPostOrdersOrderSwapsSwapShipmentsReq](../internal/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx)",
"description": "The shipment to be created.",
"optional": false,
"defaultValue": "",
@@ -1513,7 +1513,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1527,7 +1527,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `swaps` property.",
@@ -1587,7 +1587,7 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx)",
"type": "[AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx)",
"description": "The fulfillment to be created.",
"optional": false,
"defaultValue": "",
@@ -1604,7 +1604,7 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -1624,7 +1624,7 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1638,7 +1638,7 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {}).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `claims` property.",
@@ -1702,7 +1702,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](../internal/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx)",
"type": "[AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../internal/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx)",
"description": "The fulfillment to be created.",
"optional": false,
"defaultValue": "",
@@ -1719,7 +1719,7 @@ medusa.admin.orders
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -1739,7 +1739,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -1753,7 +1753,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `swaps` property.",
@@ -1828,7 +1828,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetOrdersParams`](../internal/classes/internal.AdminGetOrdersParams.mdx)",
"type": "[AdminGetOrdersParams](../internal/classes/internal.AdminGetOrdersParams.mdx)",
"description": "Filters and pagination configurations applied on the retrieved orders.",
"optional": true,
"defaultValue": "",
@@ -1836,7 +1836,7 @@ medusa.admin.orders
"children": [
{
"name": "canceled_at",
"type": "[`DateComparisonOperator`](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "[DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the orders' `canceled_at` date.",
"optional": true,
"defaultValue": "",
@@ -1854,7 +1854,7 @@ medusa.admin.orders
},
{
"name": "created_at",
"type": "[`DateComparisonOperator`](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "[DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the orders' `created_at` date.",
"optional": true,
"defaultValue": "",
@@ -2007,7 +2007,7 @@ medusa.admin.orders
},
{
"name": "updated_at",
"type": "[`DateComparisonOperator`](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "[DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the orders' `updated_at` date.",
"optional": true,
"defaultValue": "",
@@ -2018,7 +2018,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2032,7 +2032,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersListRes`](../internal/types/internal.AdminOrdersListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersListRes](../internal/types/internal.AdminOrdersListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of orders with pagination fields.",
@@ -2040,7 +2040,7 @@ medusa.admin.orders
"children": [
{
"name": "AdminOrdersListRes",
"type": "[`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `orders`: [`Order`](../internal/classes/internal.Order.mdx)[] }",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; orders: [Order](../internal/classes/internal.Order.mdx)[] &#125;`",
"description": "The list of orders with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -2092,7 +2092,7 @@ medusa.admin.orders.processSwapPayment(orderId, swapId).then(({ order }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2106,7 +2106,7 @@ medusa.admin.orders.processSwapPayment(orderId, swapId).then(({ order }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `swaps` property.",
@@ -2161,7 +2161,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderRefundsReq`](../internal/classes/internal.AdminPostOrdersOrderRefundsReq.mdx)",
"type": "[AdminPostOrdersOrderRefundsReq](../internal/classes/internal.AdminPostOrdersOrderRefundsReq.mdx)",
"description": "The refund's details.",
"optional": false,
"defaultValue": "",
@@ -2170,7 +2170,7 @@ medusa.admin.orders
{
"name": "amount",
"type": "`number`",
"description": "The amount to refund. It should be less than or equal the `refundable_amount` of the order.",
"description": "The amount to refund. It should be less than or equal the `refundable\\_amount` of the order.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -2207,7 +2207,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2221,7 +2221,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -2280,7 +2280,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderReturnsReq`](../internal/classes/internal.AdminPostOrdersOrderReturnsReq.mdx)",
"type": "[AdminPostOrdersOrderReturnsReq](../internal/classes/internal.AdminPostOrdersOrderReturnsReq.mdx)",
"description": "The return to be created.",
"optional": false,
"defaultValue": "",
@@ -2288,7 +2288,7 @@ medusa.admin.orders
"children": [
{
"name": "items",
"type": "[`OrdersReturnItem`](../internal/classes/internal.OrdersReturnItem.mdx)[]",
"type": "[OrdersReturnItem](../internal/classes/internal.OrdersReturnItem.mdx)[]",
"description": "The line items that will be returned.",
"optional": false,
"defaultValue": "",
@@ -2342,7 +2342,7 @@ medusa.admin.orders
},
{
"name": "return_shipping",
"type": "[`ReturnShipping`](../internal/classes/internal.ReturnShipping-1.mdx)",
"type": "[ReturnShipping](../internal/classes/internal.ReturnShipping-1.mdx)",
"description": "The Shipping Method to be used to handle the return shipment.",
"optional": true,
"defaultValue": "",
@@ -2353,7 +2353,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2367,7 +2367,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the return under the `returns` property.",
@@ -2434,7 +2434,7 @@ medusa.admin.orders
},
{
"name": "query",
"type": "[`FindParams`](../internal/classes/internal.FindParams.mdx)",
"type": "[FindParams](../internal/classes/internal.FindParams.mdx)",
"description": "Configurations to apply on the retrieved order.",
"optional": true,
"defaultValue": "",
@@ -2462,7 +2462,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2476,7 +2476,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -2530,7 +2530,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderReq`](../internal/classes/internal.AdminPostOrdersOrderReq.mdx)",
"type": "[AdminPostOrdersOrderReq](../internal/classes/internal.AdminPostOrdersOrderReq.mdx)",
"description": "The attributes to update in the order.",
"optional": false,
"defaultValue": "",
@@ -2538,7 +2538,7 @@ medusa.admin.orders
"children": [
{
"name": "billing_address",
"type": "[`AddressPayload`](../internal/classes/internal.AddressPayload.mdx)",
"type": "[AddressPayload](../internal/classes/internal.AddressPayload.mdx)",
"description": "The order's billing address",
"optional": true,
"defaultValue": "",
@@ -2556,7 +2556,7 @@ medusa.admin.orders
},
{
"name": "discounts",
"type": "Record<`string`, `unknown`\\>[]",
"type": "`Record<string, unknown>`[]",
"description": "The discounts applied to the order",
"optional": true,
"defaultValue": "",
@@ -2574,7 +2574,7 @@ medusa.admin.orders
},
{
"name": "items",
"type": "Record<`string`, `unknown`\\>[]",
"type": "`Record<string, unknown>`[]",
"description": "The line items of the order",
"optional": true,
"defaultValue": "",
@@ -2592,7 +2592,7 @@ medusa.admin.orders
},
{
"name": "payment_method",
"type": "[`PaymentMethod`](../internal/classes/internal.PaymentMethod.mdx)",
"type": "[PaymentMethod](../internal/classes/internal.PaymentMethod.mdx)",
"description": "The payment method chosen for the order.",
"optional": true,
"defaultValue": "",
@@ -2610,7 +2610,7 @@ medusa.admin.orders
},
{
"name": "shipping_address",
"type": "[`AddressPayload`](../internal/classes/internal.AddressPayload.mdx)",
"type": "[AddressPayload](../internal/classes/internal.AddressPayload.mdx)",
"description": "The order's shipping address",
"optional": true,
"defaultValue": "",
@@ -2619,7 +2619,7 @@ medusa.admin.orders
},
{
"name": "shipping_method",
"type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-1.mdx)[]",
"type": "[ShippingMethod](../internal/classes/internal.ShippingMethod-1.mdx)[]",
"description": "The Shipping Method used for shipping the order.",
"optional": true,
"defaultValue": "",
@@ -2630,7 +2630,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2644,7 +2644,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details.",
@@ -2707,7 +2707,7 @@ medusa.admin.orders
},
{
"name": "payload",
"type": "[`AdminPostOrdersOrderClaimsClaimReq`](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimReq.mdx)",
"type": "[AdminPostOrdersOrderClaimsClaimReq](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimReq.mdx)",
"description": "The attributes to update in the claim.",
"optional": false,
"defaultValue": "",
@@ -2715,7 +2715,7 @@ medusa.admin.orders
"children": [
{
"name": "claim_items",
"type": "[`Item`](../internal/classes/internal.Item-6.mdx)[]",
"type": "[Item](../internal/classes/internal.Item-6.mdx)[]",
"description": "The Claim Items that the Claim will consist of.",
"optional": true,
"defaultValue": "",
@@ -2724,7 +2724,7 @@ medusa.admin.orders
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional set of key-value pairs to hold additional information.",
"optional": true,
"defaultValue": "",
@@ -2742,7 +2742,7 @@ medusa.admin.orders
},
{
"name": "shipping_methods",
"type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-3.mdx)[]",
"type": "[ShippingMethod](../internal/classes/internal.ShippingMethod-3.mdx)[]",
"description": "The Shipping Methods to send the additional Line Items with.",
"optional": true,
"defaultValue": "",
@@ -2753,7 +2753,7 @@ medusa.admin.orders
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -2767,7 +2767,7 @@ medusa.admin.orders
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminOrdersRes`](../internal/types/internal.AdminOrdersRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminOrdersRes](../internal/types/internal.AdminOrdersRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the order's details. You can access the swap under the `claims` property.",