From a607b8e800d0a2af9074cfd9fa43d1723a736a32 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 10 Jan 2025 10:25:17 +0200 Subject: [PATCH] docs-util: fix hook input type showing as __type (#10905) --- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../page.mdx | 2 +- .../references/modules/core_flows/page.mdx | 76 ++++++------ .../typedoc-json-output/core-flows.json | 114 ++++++------------ .../typedoc-plugin-workflows/src/plugin.ts | 1 + www/utils/packages/utils/src/get-type-str.ts | 32 +++-- 42 files changed, 139 insertions(+), 160 deletions(-) diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx index 889a4ad13af48..f1551c0af02a4 100644 --- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.createCartWorkflow/page.mdx @@ -58,4 +58,4 @@ createCartWorkflow.hooks.cartCreated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the cart was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the cart was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`string` \\| `Date`","description":"When the cart was completed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the cart was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the cart was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartCreated"/> diff --git a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx index 7453cc1d3b65b..26bccdb302c7d 100644 --- a/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.updateCartWorkflow/page.mdx @@ -52,4 +52,4 @@ updateCartWorkflow.hooks.cartUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cartUpdated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx index ec9c07fdb8fe6..6c33eabee80e6 100644 --- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx @@ -46,4 +46,4 @@ createCustomerAddressesWorkflow.hooks.addressesCreated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx index 0d3f82e70d885..49387bc93778e 100644 --- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx @@ -47,4 +47,4 @@ createCustomersWorkflow.hooks.customersCreated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx index b29340d3d6f5b..70025eff927d6 100644 --- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx @@ -42,4 +42,4 @@ deleteCustomerAddressesWorkflow.hooks.addressesDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx index 664d90b6b6138..91b01463c6646 100644 --- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx @@ -43,4 +43,4 @@ deleteCustomersWorkflow.hooks.customersDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx index ed894fefdb7fb..41fa810ccd1db 100644 --- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx @@ -46,4 +46,4 @@ updateCustomerAddressesWorkflow.hooks.addressesUpdated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx index 42a2eb35113d0..64b524182d6fb 100644 --- a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx @@ -47,4 +47,4 @@ updateCustomersWorkflow.hooks.customersUpdated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/> +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/> diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx index a83c5708bf895..50537a14ecb36 100644 --- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderFulfillmentWorkflow/page.mdx @@ -50,4 +50,4 @@ cancelOrderFulfillmentWorkflow.hooks.orderFulfillmentCanceled( Handlers consuming this hook accept the following input. -`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/> +`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/> diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx index 077c1e888dc2f..dc5200e7d0ea6 100644 --- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.cancelOrderWorkflow/page.mdx @@ -51,4 +51,4 @@ cancelOrderWorkflow.hooks.orderCanceled( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx index 1411dc300202c..91dad5f6daaca 100644 --- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.completeOrderWorkflow/page.mdx @@ -47,4 +47,4 @@ completeOrderWorkflow.hooks.ordersCompleted( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ordersCompleted"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ordersCompleted"/> diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx index 569102a2598d2..11ff14edf2e2d 100644 --- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderFulfillmentWorkflow/page.mdx @@ -51,4 +51,4 @@ createOrderFulfillmentWorkflow.hooks.fulfillmentCreated( Handlers consuming this hook accept the following input. -`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fulfillmentCreated"/> +`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fulfillmentCreated"/> diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx index feecd2f6f5bcb..956b4f36749cf 100644 --- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderShipmentWorkflow/page.mdx @@ -49,4 +49,4 @@ createOrderShipmentWorkflow.hooks.shipmentCreated( Handlers consuming this hook accept the following input. -`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="shipmentCreated"/> +`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="shipmentCreated"/> diff --git a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx index 0c7d68adeff52..73ded609c41a4 100644 --- a/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Order/Workflows_Order/functions/core_flows.Order.Workflows_Order.createOrderWorkflow/page.mdx @@ -53,4 +53,4 @@ createOrderWorkflow.hooks.orderCreated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx index b3e858209185c..c343b5be04855 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createCollectionsWorkflow/page.mdx @@ -47,4 +47,4 @@ createCollectionsWorkflow.hooks.collectionsCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx index e5cce236510eb..b2024eb272720 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductOptionsWorkflow/page.mdx @@ -47,4 +47,4 @@ createProductOptionsWorkflow.hooks.productOptionsCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx index 6a528003ee3e7..2e07d9cc70e10 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTagsWorkflow/page.mdx @@ -47,4 +47,4 @@ createProductTagsWorkflow.hooks.productTagsCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx index a800d619717da..4b01b858ef90a 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductTypesWorkflow/page.mdx @@ -47,4 +47,4 @@ createProductTypesWorkflow.hooks.productTypesCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx index 11243b71193d3..5b8fb90c71413 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductVariantsWorkflow/page.mdx @@ -51,4 +51,4 @@ createProductVariantsWorkflow.hooks.productVariantsCreated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx index 71fb2196803e6..11aff0ded61a6 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.createProductsWorkflow/page.mdx @@ -51,4 +51,4 @@ createProductsWorkflow.hooks.productsCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsCreated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx index 6c53097e1019f..d49de671753de 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteCollectionsWorkflow/page.mdx @@ -43,4 +43,4 @@ deleteCollectionsWorkflow.hooks.collectionsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx index d45f0a4486d72..69efc370be0a8 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductOptionsWorkflow/page.mdx @@ -43,4 +43,4 @@ deleteProductOptionsWorkflow.hooks.productOptionsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx index dfcc2981ebca1..1e8eaac673992 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTagsWorkflow/page.mdx @@ -43,4 +43,4 @@ deleteProductTagsWorkflow.hooks.productTagsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx index 355b14e5193c7..502b42ff78b8f 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductTypesWorkflow/page.mdx @@ -43,4 +43,4 @@ deleteProductTypesWorkflow.hooks.productTypesDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx index eb39dc42679a5..f3e3c18c6ae2a 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductVariantsWorkflow/page.mdx @@ -46,4 +46,4 @@ deleteProductVariantsWorkflow.hooks.productVariantsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx index d5dcf1337b9a5..e72ef1c79fa24 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.deleteProductsWorkflow/page.mdx @@ -46,4 +46,4 @@ deleteProductsWorkflow.hooks.productsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx index 48568f9665a08..1b1a1e2510abf 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateCollectionsWorkflow/page.mdx @@ -47,4 +47,4 @@ updateCollectionsWorkflow.hooks.collectionsUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collections","type":"[ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"collections","type":"[ProductCollectionDTO](../../../../../product/interfaces/product.ProductCollectionDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the product collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The handle of the product collection. The handle can be used to create slug URL paths.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product collection was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product collection was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../product/types/product.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product collection was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)[]","description":"The associated products.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="collectionsUpdated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx index c933de889ffd5..0c537002c8805 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductOptionsWorkflow/page.mdx @@ -47,4 +47,4 @@ updateProductOptionsWorkflow.hooks.productOptionsUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productOptionsUpdated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx index 815d0abfdfa26..780c6008add85 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTagsWorkflow/page.mdx @@ -47,4 +47,4 @@ updateProductTagsWorkflow.hooks.productTagsUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTagsUpdated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx index 16ba94d550201..4765a40e10bc8 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductTypesWorkflow/page.mdx @@ -47,4 +47,4 @@ updateProductTypesWorkflow.hooks.productTypesUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productTypesUpdated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx index e5973dc4f307f..05e27ec016b9c 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductVariantsWorkflow/page.mdx @@ -48,4 +48,4 @@ updateProductVariantsWorkflow.hooks.productVariantsUpdated( Handlers consuming this hook accept the following input. -`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsUpdated"/> +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"The associated product id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the product variant was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the product variant was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date`","description":"When the product variant was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"`null` \\| [ProductDTO](../../../../../product/interfaces/product.ProductDTO/page.mdx)","description":"The associated product.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"he ranking of the variant among other variants associated with the product.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productVariantsUpdated"/> diff --git a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx index 667134e68610c..56cd0157b7e2f 100644 --- a/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Product/Workflows_Product/functions/core_flows.Product.Workflows_Product.updateProductsWorkflow/page.mdx @@ -50,4 +50,4 @@ updateProductsWorkflow.hooks.productsUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="productsUpdated"/> diff --git a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createCampaignsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createCampaignsWorkflow/page.mdx index be50fa446c828..9df999cd90315 100644 --- a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createCampaignsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createCampaignsWorkflow/page.mdx @@ -46,4 +46,4 @@ createCampaignsWorkflow.hooks.campaignsCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsCreated"/> diff --git a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createPromotionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createPromotionsWorkflow/page.mdx index bb8674aa1a97c..243df5e4d4c16 100644 --- a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createPromotionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.createPromotionsWorkflow/page.mdx @@ -46,4 +46,4 @@ createPromotionsWorkflow.hooks.promotionsCreated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsCreated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsCreated"/> diff --git a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deleteCampaignsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deleteCampaignsWorkflow/page.mdx index f7da290df1569..474a153a343a3 100644 --- a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deleteCampaignsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deleteCampaignsWorkflow/page.mdx @@ -42,4 +42,4 @@ deleteCampaignsWorkflow.hooks.campaignsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deletePromotionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deletePromotionsWorkflow/page.mdx index c1c1eb25e7317..2f9868e2b2796 100644 --- a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deletePromotionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.deletePromotionsWorkflow/page.mdx @@ -42,4 +42,4 @@ deletePromotionsWorkflow.hooks.promotionsDeleted( Handlers consuming this hook accept the following input. - + diff --git a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updateCampaignsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updateCampaignsWorkflow/page.mdx index bda77faaca7da..5847820525d98 100644 --- a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updateCampaignsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updateCampaignsWorkflow/page.mdx @@ -46,4 +46,4 @@ updateCampaignsWorkflow.hooks.campaignsUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="campaignsUpdated"/> diff --git a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsWorkflow/page.mdx index 1f87d85d2cdcc..b4e1187cc204e 100644 --- a/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsWorkflow/page.mdx +++ b/www/apps/resources/references/core_flows/Promotion/Workflows_Promotion/functions/core_flows.Promotion.Workflows_Promotion.updatePromotionsWorkflow/page.mdx @@ -46,4 +46,4 @@ updatePromotionsWorkflow.hooks.promotionsUpdated( Handlers consuming this hook accept the following input. - | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsUpdated"/> + | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="promotionsUpdated"/> diff --git a/www/apps/resources/references/modules/core_flows/page.mdx b/www/apps/resources/references/modules/core_flows/page.mdx index 3897d31189bc6..eda583ab1bb57 100644 --- a/www/apps/resources/references/modules/core_flows/page.mdx +++ b/www/apps/resources/references/modules/core_flows/page.mdx @@ -277,226 +277,226 @@ import { TypeList } from "docs-ui" #### Parameters -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/> ### addressesDeleted #### Parameters - + ### addressesUpdated #### Parameters -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/> ### campaignsCreated #### Parameters - + ### campaignsDeleted #### Parameters - + ### campaignsUpdated #### Parameters - + ### cartCreated #### Parameters - + ### cartUpdated #### Parameters - + ### collectionsCreated #### Parameters - + ### collectionsDeleted #### Parameters - + ### collectionsUpdated #### Parameters - + ### customersCreated #### Parameters -`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/> +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/> ### customersDeleted #### Parameters - + ### customersUpdated #### Parameters -`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/> +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/> ### fulfillmentCreated #### Parameters -` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]>","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]>","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fulfillmentCreated"/> +` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]>","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]>","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="fulfillmentCreated"/> ### orderCanceled #### Parameters - + ### orderCreated #### Parameters - + ### orderFulfillmentCanceled #### Parameters - + ### ordersCompleted #### Parameters -`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ordersCompleted"/> +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ordersCompleted"/> ### productOptionsCreated #### Parameters - + ### productOptionsDeleted #### Parameters - + ### productOptionsUpdated #### Parameters - + ### productsCreated #### Parameters - + ### productsDeleted #### Parameters - + ### productsUpdated #### Parameters - + ### productTagsCreated #### Parameters - + ### productTagsDeleted #### Parameters - + ### productTagsUpdated #### Parameters - + ### productTypesCreated #### Parameters - + ### productTypesDeleted #### Parameters - + ### productTypesUpdated #### Parameters - + ### productVariantsCreated #### Parameters - + ### productVariantsDeleted #### Parameters - + ### productVariantsUpdated #### Parameters - + ### promotionsCreated #### Parameters - + ### promotionsDeleted #### Parameters - + ### promotionsUpdated #### Parameters - + ### shipmentCreated #### Parameters -` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]>","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]>","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="shipmentCreated"/> +` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<string>","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| string>","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)>","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<boolean>","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)>","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx) \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)>","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]>","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[] \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]>","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<Date>","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<null \\| Date>","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__step__","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string` \\| [WorkflowData](../../workflows/types/workflows.WorkflowData/page.mdx)<undefined \\| null \\| string>","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"`null` \\| `string`","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`undefined` \\| (Record<string, unknown> \\| WorkflowData<Record<string, unknown> \\| undefined>) & Record<string, unknown>","description":"","optional":false,"defaultValue":"input.additional_data","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="shipmentCreated"/> diff --git a/www/utils/generated/typedoc-json-output/core-flows.json b/www/utils/generated/typedoc-json-output/core-flows.json index 7ec012ddea613..1f30903c8ffab 100644 --- a/www/utils/generated/typedoc-json-output/core-flows.json +++ b/www/utils/generated/typedoc-json-output/core-flows.json @@ -675885,8 +675885,7 @@ "type": "reference", "target": 1384, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -675945,8 +675944,7 @@ "type": "reference", "target": 1706, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676005,8 +676003,7 @@ "type": "reference", "target": 2428, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676065,8 +676062,7 @@ "type": "reference", "target": 2545, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676125,8 +676121,7 @@ "type": "reference", "target": 2594, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676185,8 +676180,7 @@ "type": "reference", "target": 2636, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676245,8 +676239,7 @@ "type": "reference", "target": 2723, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676305,8 +676298,7 @@ "type": "reference", "target": 2779, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676365,8 +676357,7 @@ "type": "reference", "target": 5693, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676425,8 +676416,7 @@ "type": "reference", "target": 5797, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676485,8 +676475,7 @@ "type": "reference", "target": 7527, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676545,8 +676534,7 @@ "type": "reference", "target": 7618, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676605,8 +676593,7 @@ "type": "reference", "target": 7902, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676665,8 +676652,7 @@ "type": "reference", "target": 8071, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676725,8 +676711,7 @@ "type": "reference", "target": 16136, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676785,8 +676770,7 @@ "type": "reference", "target": 16191, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676845,8 +676829,7 @@ "type": "reference", "target": 16246, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676905,8 +676888,7 @@ "type": "reference", "target": 16301, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -676965,8 +676947,7 @@ "type": "reference", "target": 16579, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677025,8 +677006,7 @@ "type": "reference", "target": 16655, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677085,8 +677065,7 @@ "type": "reference", "target": 16698, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677145,8 +677124,7 @@ "type": "reference", "target": 16740, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677205,8 +677183,7 @@ "type": "reference", "target": 16782, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677265,8 +677242,7 @@ "type": "reference", "target": 16824, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677325,8 +677301,7 @@ "type": "reference", "target": 16866, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677385,8 +677360,7 @@ "type": "reference", "target": 16908, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677445,8 +677419,7 @@ "type": "reference", "target": 16957, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677505,8 +677478,7 @@ "type": "reference", "target": 17013, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677565,8 +677537,7 @@ "type": "reference", "target": 17065, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677625,8 +677596,7 @@ "type": "reference", "target": 17121, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677685,8 +677655,7 @@ "type": "reference", "target": 17399, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677745,8 +677714,7 @@ "type": "reference", "target": 17490, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677805,8 +677773,7 @@ "type": "reference", "target": 18012, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677865,8 +677832,7 @@ "type": "reference", "target": 18102, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677925,8 +677891,7 @@ "type": "reference", "target": 18151, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -677985,8 +677950,7 @@ "type": "reference", "target": 18237, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -678045,8 +678009,7 @@ "type": "reference", "target": 18285, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] @@ -678105,8 +678068,7 @@ "type": "reference", "target": 18375, "name": "object", - "package": "@medusajs/core-flows", - "qualifiedName": "__object" + "package": "@medusajs/core-flows" } } ] diff --git a/www/utils/packages/typedoc-plugin-workflows/src/plugin.ts b/www/utils/packages/typedoc-plugin-workflows/src/plugin.ts index 620106e7d6b18..d61a53d05d1a7 100644 --- a/www/utils/packages/typedoc-plugin-workflows/src/plugin.ts +++ b/www/utils/packages/typedoc-plugin-workflows/src/plugin.ts @@ -511,6 +511,7 @@ class WorkflowsPlugin { if (parameter.type.name === "__object") { parameter.type.name = "object" + parameter.type.qualifiedName = "object" } signatureReflection.parameters = [] diff --git a/www/utils/packages/utils/src/get-type-str.ts b/www/utils/packages/utils/src/get-type-str.ts index 2478bc50676f7..b85318c4a8e2d 100644 --- a/www/utils/packages/utils/src/get-type-str.ts +++ b/www/utils/packages/utils/src/get-type-str.ts @@ -146,7 +146,9 @@ export function getType({ reflectionType, ...options }: TypeOptions): string { }) } - return reflectionType ? escapeChars(reflectionType.toString()) : "" + return reflectionType + ? escapeChars(normalizeTypeName(reflectionType.toString())) + : "" } export function getReflectionType({ @@ -324,20 +326,26 @@ export function getReferenceType({ const reflection: string[] = [wrappedInBackticks ? "`" : ""] if (modelReflection?.url) { + const reflectionName = normalizeTypeName(modelReflection.name || "") + const reflectionUrl = + modelReflection.name === "__type" ? undefined : modelReflection.url reflection.push( - shouldShowLink - ? `[${modelReflection.name}](${ + shouldShowLink && reflectionUrl + ? `[${reflectionName}](${ getRelativeUrlMethod?.(modelReflection.url) || modelReflection.url })` - : getFormattedStr(modelReflection.name, false, escape) + : getFormattedStr(reflectionName, false, escape) ) } else { + const reflectionName = normalizeTypeName(model.name) + const reflectionUrl = + model.name === "__type" ? undefined : model.externalUrl reflection.push( - shouldShowLink + shouldShowLink && reflectionUrl ? model.externalUrl - ? `[${model.name}]( ${model.externalUrl} )` - : model.name - : getFormattedStr(model.name, false, escape) + ? `[${reflectionName}](${model.externalUrl})` + : reflectionName + : getFormattedStr(reflectionName, false, escape) ) } if (model.typeArguments && model.typeArguments.length > 0) { @@ -578,3 +586,11 @@ function getFormattedStr( ) { return wrapBackticks ? `\`${str}\`` : escape ? escapeChars(str) : str } + +function normalizeTypeName(name: string) { + if (name !== "__type") { + return name + } + + return "object" +}