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

chore(utils): fixes to events TSDocs (#12395)

Browse Source 
* chore(utils): fixes to events TSDocs

* more fixes
This commit is contained in:
Shahed Nasser
2025-05-07 14:25:11 +03:00
committed by GitHub
parent 2dd885ebc1
commit 0dd4572964
3 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/types/src/cart/workflows.ts
+2
View File
@@ -218,6 +218,8 @@ export interface CreateCartAddressDTO {
export interface CreateCartWorkflowInputDTO { export interface CreateCartWorkflowInputDTO {
/** /**
* The ID of the region that the cart belongs to. * The ID of the region that the cart belongs to.
* If not provided, the default region of the store is used.
* If the store doesn't have a default region, an error is thrown.
*/ */
region_id?: string region_id?: string
packages/core/types/src/http/cart/store/payloads.ts
+2
View File
@@ -1,6 +1,8 @@
export interface StoreCreateCart { export interface StoreCreateCart {
/** /**
* The ID of the region that the cart is created in. * The ID of the region that the cart is created in.
* If not provided, the default region of the store is used.
* If the store doesn't have a default region, an error is thrown.
*/ */
region_id?: string region_id?: string
/** /**
packages/core/utils/src/core-flows/events.ts
+6 -7
View File
@@ -162,7 +162,7 @@ export const OrderWorkflowEvents = {
* { * {
* order_id, // The ID of the order * order_id, // The ID of the order
* fulfillment_id, // The ID of the fulfillment * fulfillment_id, // The ID of the fulfillment
* no_notification, // Whether to notify the customer * no_notification, // (boolean) Whether to notify the customer
* } * }
* ``` * ```
*/ */
@@ -175,7 +175,7 @@ export const OrderWorkflowEvents = {
* { * {
* order_id, // The ID of the order * order_id, // The ID of the order
* fulfillment_id, // The ID of the fulfillment * fulfillment_id, // The ID of the fulfillment
* no_notification, // Whether to notify the customer * no_notification, // (boolean) Whether to notify the customer
* } * }
* ``` * ```
*/ */
@@ -258,7 +258,7 @@ export const OrderEditWorkflowEvents = {
* ```ts * ```ts
* { * {
* order_id, // The ID of the order * order_id, // The ID of the order
* actions, // The actions to edit the order * actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
* } * }
* ``` * ```
*/ */
@@ -270,8 +270,7 @@ export const OrderEditWorkflowEvents = {
* ```ts * ```ts
* { * {
* order_id, // The ID of the order * order_id, // The ID of the order
* actions, // The actions to edit the order * actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
* }
* ``` * ```
*/ */
CONFIRMED: "order-edit.confirmed", CONFIRMED: "order-edit.confirmed",
@@ -282,7 +281,7 @@ export const OrderEditWorkflowEvents = {
* ```ts * ```ts
* { * {
* order_id, // The ID of the order * order_id, // The ID of the order
* actions, // The actions to edit the order * actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
* } * }
* ``` * ```
*/ */
@@ -776,7 +775,7 @@ export const FulfillmentWorkflowEvents = {
* ```ts * ```ts
* { * {
* id, // the ID of the shipment * id, // the ID of the shipment
* no_notification, // whether to notify the customer * no_notification, // (boolean) whether to notify the customer
* } * }
* ``` * ```
*/ */