Skip to content

Commit e95f08c

Browse files
authored
docs: add TSDocs for 965adfe (#15044)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
1 parent 41a721d commit e95f08c

File tree

4 files changed

+50
-3
lines changed

4 files changed

+50
-3
lines changed

packages/core/core-flows/src/settings/steps/create-property-label.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ import { SettingsTypes } from "@medusajs/framework/types"
22
import { Modules } from "@medusajs/framework/utils"
33
import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
44

5+
/**
6+
* Input data for creating property labels step.
7+
*
8+
* @since 2.13.7
9+
*/
510
export interface CreatePropertyLabelsStepInput {
611
property_labels: {
712
entity: string
@@ -11,10 +16,17 @@ export interface CreatePropertyLabelsStepInput {
1116
}[]
1217
}
1318

19+
/**
20+
* Step ID for creating property labels step.
21+
*
22+
* @since 2.13.7
23+
*/
1424
export const createPropertyLabelsStepId = "create-property-labels"
1525

1626
/**
17-
* @since 2.13.2
27+
* Workflow step to create property labels.
28+
*
29+
* @since 2.13.7
1830
* @featureFlag view_configurations
1931
*/
2032
export const createPropertyLabelsStep = createStep(

packages/core/core-flows/src/settings/steps/delete-property-labels.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,26 @@ import { SettingsTypes } from "@medusajs/framework/types"
22
import { Modules } from "@medusajs/framework/utils"
33
import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
44

5+
/**
6+
* Input data for deleting property labels step.
7+
*
8+
* @since 2.13.7
9+
*/
510
export interface DeletePropertyLabelsStepInput {
611
ids: string[]
712
}
813

14+
/**
15+
* Step ID for deleting property labels step.
16+
*
17+
* @since 2.13.7
18+
*/
919
export const deletePropertyLabelsStepId = "delete-property-labels"
1020

1121
/**
12-
* @since 2.13.2
22+
* Workflow step to delete property labels.
23+
*
24+
* @since 2.13.7
1325
* @featureFlag view_configurations
1426
*/
1527
export const deletePropertyLabelsStep = createStep(

packages/core/core-flows/src/settings/steps/update-property-label.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ import { SettingsTypes } from "@medusajs/framework/types"
22
import { Modules } from "@medusajs/framework/utils"
33
import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
44

5+
/**
6+
* Input data for updating property labels step.
7+
*
8+
* @since 2.13.7
9+
*/
510
export interface UpdatePropertyLabelsStepInput {
611
property_labels: {
712
id: string
@@ -14,10 +19,17 @@ interface UpdatePropertyLabelsCompensateData {
1419
previous: { id: string; label: string; description: string | null }[]
1520
}
1621

22+
/**
23+
* Step ID for updating property labels step.
24+
*
25+
* @since 2.13.7
26+
*/
1727
export const updatePropertyLabelsStepId = "update-property-labels"
1828

1929
/**
20-
* @since 2.13.2
30+
* Workflow step to update property labels.
31+
*
32+
* @since 2.13.7
2133
* @featureFlag view_configurations
2234
*/
2335
export const updatePropertyLabelsStep = createStep(

packages/core/core-flows/src/settings/workflows/batch-property-labels.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ import { updatePropertyLabelsWorkflow } from "./update-property-label"
1717

1818
/**
1919
* Input type for creating a property label in batch.
20+
*
21+
* @since 2.13.7
2022
*/
2123
export interface BatchPropertyLabelCreateInput {
2224
entity: string
@@ -27,6 +29,8 @@ export interface BatchPropertyLabelCreateInput {
2729

2830
/**
2931
* Input type for updating a property label in batch.
32+
*
33+
* @since 2.13.7
3034
*/
3135
export interface BatchPropertyLabelUpdateInput {
3236
id: string
@@ -36,13 +40,20 @@ export interface BatchPropertyLabelUpdateInput {
3640

3741
/**
3842
* The property labels to manage.
43+
*
44+
* @since 2.13.7
3945
*/
4046
export interface BatchPropertyLabelsWorkflowInput
4147
extends BatchWorkflowInput<
4248
BatchPropertyLabelCreateInput,
4349
BatchPropertyLabelUpdateInput
4450
> {}
4551

52+
/**
53+
* Output type for batch property labels workflow.
54+
*
55+
* @since 2.13.7
56+
*/
4657
export type BatchPropertyLabelsWorkflowOutput =
4758
BatchWorkflowOutput<SettingsTypes.PropertyLabelDTO>
4859

0 commit comments

Comments
 (0)