@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/ViewModels/Blocks/Core/AutomationTriggerDetail/automationEventBag.d.ts

@@ -0,0 +1,74 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Automation Event. */
+export type AutomationEventBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** The configuration settings for the event component. */
+    componentConfiguration?: Record<string, string> | null;
+
+    /**
+     * The definition of the initial component to render based on the
+     * current selection. This is read-only.
+     */
+    componentDefinition?: DynamicComponentDefinitionBag | null;
+
+    /**
+     * The description of the event. This is calculated by the component
+     * so it is considered read-only.
+     */
+    description?: string | null;
+
+    /**
+     * The type of event component that will be used to process this
+     * event.
+     */
+    eventType?: ListItemBag | null;
+
+    /** The component icon class for this event. This is read-only. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /**
+     * Indicates if this event is active. If this is set to false
+     * then the event will not be executed.
+     */
+    isActive: boolean;
+
+    /**
+     * The description of the event. This is calculated by the component
+     * so it is considered read-only.
+     */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Core/AutomationTriggerDetail/automationTriggerBag.d.ts

@@ -0,0 +1,90 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { AutomationEventBag } from "@Obsidian/ViewModels/Blocks/Core/AutomationTriggerDetail/automationEventBag";
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+import { AutomationValueDefinitionBag } from "@Obsidian/ViewModels/Core/Automation/automationValueDefinitionBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Automation Trigger Detail block. */
+export type AutomationTriggerBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** The configuration settings for the trigger component. */
+    componentConfiguration?: Record<string, string> | null;
+
+    /**
+     * The definition of the initial component to render based on the
+     * current selection. This is read-only.
+     */
+    componentDefinition?: DynamicComponentDefinitionBag | null;
+
+    /**
+     * The configuration details that will be displayed in the UI when
+     * in view mode. These provide additional context about how the component
+     * is configured. This is read-only.
+     */
+    configurationDetails?: ListItemBag[] | null;
+
+    /**
+     * The description of the trigger. This is used to provide additional
+     * details about when the trigger will execute the events and describe
+     * the purpose the trigger serves.
+     */
+    description?: string | null;
+
+    /** The events that have been created and attached to this trigger. */
+    events?: AutomationEventBag[] | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /**
+     * Indicates if this trigger is active. If this is set to false
+     * then the trigger will not be initialized and no events will execute.
+     */
+    isActive: boolean;
+
+    /**
+     * The name of the trigger. This is used to identify the trigger in the
+     * user interface and logs. It should be short, but descriptive.
+     */
+    name?: string | null;
+
+    /**
+     * The type of trigger component that will be used to process this
+     * trigger.
+     */
+    triggerType?: ListItemBag | null;
+
+    /**
+     * The definitions for what values are available on events executed by
+     * this trigger. This is only valid in view mode and is read-only.
+     */
+    valueDefinitions?: AutomationValueDefinitionBag[] | null;
+};

package/types/ViewModels/Blocks/Core/AutomationTriggerDetail/automationTriggerDetailOptionsBag.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Automation Trigger Detail block. */
+export type AutomationTriggerDetailOptionsBag = {
+    /**
+     * The list of event types that can be used to create a new
+     * automation event.
+     */
+    eventTypeItems?: ListItemBag[] | null;
+
+    /**
+     * The list of trigger types that can be used to create a new
+     * automation trigger.
+     */
+    triggerTypeItems?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Core/AutomationTriggerDetail/getComponentDefinitionResponseBag.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+
+/**
+ * The response to the GetComponentDefinition and GetEventComponentDefinition
+ * block actions.
+ */
+export type GetComponentDefinitionResponseBag = {
+    /** The configuration settings for the trigger component. */
+    componentConfiguration?: Record<string, string> | null;
+
+    /**
+     * The definition of the initial component to render based on the
+     * current selection.
+     */
+    componentDefinition?: DynamicComponentDefinitionBag | null;
+};

package/types/ViewModels/Blocks/Core/AutomationTriggerList/automationTriggerListOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the Automation Trigger List block. */
+export type AutomationTriggerListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/CampusDetail/campusBag.d.ts

@@ -37,6 +37,9 @@ export type CampusBag = {
     /** Gets or sets the attribute values. */
     attributeValues?: Record<string, string> | null;
 
+    /** Gets or sets the campus average weekend attendance. */
+    averageWeekendAttendance?: number | null;
+
     /** Gets or sets the campus schedules. */
     campusSchedules?: CampusScheduleBag[] | null;
 

package/types/ViewModels/Blocks/Core/CampusList/campusListOptionsBag.d.ts

@@ -22,4 +22,6 @@
 //
 
 export type CampusListOptionsBag = {
+    /** Gets or sets whether the Campus Phone Number column should be shown. */
+    showCampusPhoneNumber: boolean;
 };

package/types/ViewModels/Blocks/Core/DefinedTypeList/definedTypeListOptionsBag.d.ts

@@ -23,6 +23,4 @@
 
 /** The additional configuration options for the Defined Type List block. */
 export type DefinedTypeListOptionsBag = {
-    /** Determines if the category column should be displayed. */
-    showCategoryColumn: boolean;
 };

package/types/ViewModels/Blocks/Core/ServiceJobDetail/serviceJobDetailOptionsBag.d.ts

@@ -21,11 +21,12 @@
 // </copyright>
 //
 
+import { ServiceJobOptionsBag } from "@Obsidian/ViewModels/Blocks/Core/ServiceJobDetail/serviceJobOptionsBag";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 export type ServiceJobDetailOptionsBag = {
     /** Gets or sets the job type options. */
-    jobTypeOptions?: ListItemBag[] | null;
+    jobTypeOptions?: ServiceJobOptionsBag[] | null;
 
     /** Gets or sets the notification status options. */
     notificationStatusOptions?: ListItemBag[] | null;

package/types/ViewModels/Blocks/Core/ServiceJobDetail/serviceJobOptionsBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** A container class for job type options that includes basic details about a job type */
+export type ServiceJobOptionsBag = {
+    /** Gets or sets the default description for the job type. */
+    defaultDescription?: string | null;
+
+    /** Gets or sets the default name for the job type. */
+    defaultName?: string | null;
+
+    /** Gets or sets the list of available job type options. */
+    jobType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Crm/PersonDuplicateDetail/personDuplicateDetailOptionsBag.d.ts

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the Person Duplicate List block. */
+export type PersonDuplicateDetailOptionsBag = {
+    /** Gets or sets the high confidence score threshold for duplicate detection. */
+    confidenceScoreHigh: number;
+
+    /** Gets or sets the low confidence score threshold for duplicate detection. */
+    confidenceScoreLow: number;
+
+    /** Gets or sets a value indicating whether the entity has multiple campuses. */
+    hasMultipleCampuses: boolean;
+
+    /** Gets or sets a value indicating whether businesses should be included. */
+    includeBusinesses: boolean;
+
+    /** Gets or sets a value indicating whether inactive persons should be included. */
+    includeInactive: boolean;
+};

package/types/ViewModels/Blocks/Engagement/SignUp/SignUpRegister/signUpRegisterInitializationBox.d.ts

@@ -31,6 +31,9 @@ export type SignUpRegisterInitializationBox = {
     /** Gets or sets the communication preference items available for the registrant to select. */
     communicationPreferenceItems?: ListItemBag[] | null;
 
+    /** Gets or sets whether to disable captcha support for the block. */
+    disableCaptchaSupport: boolean;
+
     /**
      * Gets or sets the error message. A non-empty value indicates that
      * an error is preventing the block from being displayed.

package/types/ViewModels/Blocks/Engagement/StepProgramDetail/chartDataBag.d.ts

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { SeriesBag } from "@Obsidian/ViewModels/Blocks/Engagement/StepProgramDetail/seriesBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type ChartDataBag = {
+    /** Gets or sets the List of ListItemBags for the Campus Labels */
+    campusLabels?: ListItemBag[] | null;
+
+    /** Gets or sets the date labels for the chart data. */
+    dateLabels?: string[] | null;
+
+    /** Gets or sets the series data for the chart. */
+    series?: SeriesBag[] | null;
+
+    /** Gets or sets the string labels for the chart data. */
+    stringLabels?: string[] | null;
+
+    /** Gets or sets the time unit for the chart data (e.g. "day", "month", "year"). */
+    timeUnit?: string | null;
+};

package/types/ViewModels/Blocks/Engagement/StepProgramDetail/seriesBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+export type SeriesBag = {
+    /** Gets or sets the color for the series. */
+    color?: string | null;
+
+    /** Gets or sets the data for the series. */
+    data?: number[] | null;
+
+    /** Gets or sets the label for the series. */
+    label?: string | null;
+
+    /** Gets or sets the opacity for each data point in the series. */
+    opacity?: number[] | null;
+};

package/types/ViewModels/Blocks/Engagement/StepProgramDetail/stepProgramBag.d.ts

@@ -21,6 +21,7 @@
 // </copyright>
 //
 
+import { CompletionFlow } from "@Obsidian/Enums/Engagement/completionFlow";
 import { StepProgramWorkflowTriggerBag } from "@Obsidian/ViewModels/Blocks/Engagement/StepProgramDetail/stepProgramWorkflowTriggerBag";
 import { StepStatusBag } from "@Obsidian/ViewModels/Blocks/Engagement/StepProgramDetail/stepStatusBag";
 import { SlidingDateRangeBag } from "@Obsidian/ViewModels/Controls/slidingDateRangeBag";
@@ -45,6 +46,9 @@ export type StepProgramBag = {
     /** Gets or sets the chart data. */
     chartData?: string | null;
 
+    /** Gets or sets the Completion Flow of the Step Program. */
+    completionFlow?: CompletionFlow | null;
+
     /** Gets or sets the default date range. */
     defaultDateRange?: SlidingDateRangeBag | null;
 
@@ -54,6 +58,18 @@ export type StepProgramBag = {
     /** Gets or sets a description of the program. */
     description?: string | null;
 
+    /** Gets or sets the error message. */
+    errorMessage?: string | null;
+
+    /** Gets or sets the value indicating whter the current program contains steps with Engagement Type settings configured. */
+    hasEngagementTypeSteps: boolean;
+
+    /** Gets or sets the value indicating whter the current program contains steps with Impact Adjustment settings configured. */
+    hasImpactAdjustedStepTypes: boolean;
+
+    /** Gets or sets the value indicating whter the current program contains steps with Organization Objective settings configured. */
+    hasOrganizationObjectiveSteps: boolean;
+
     /** Gets or sets the icon CSS class. */
     iconCssClass?: string | null;
 
@@ -63,18 +79,21 @@ export type StepProgramBag = {
     /** Gets or sets a flag indicating if this item is active or not. */
     isActive: boolean;
 
+    /** Gets or sets a value indicating wheter the Step Program can be deleted. */
+    isDeletable: boolean;
+
     /** Gets or sets the kpi. */
     kpi?: string | null;
 
     /** Gets or sets the name of the program. This property is required. */
     name?: string | null;
 
-    /** Gets or sets a value indicating whether [show chart]. */
-    showChart: boolean;
-
     /** Gets or sets the statuses. */
     statuses?: StepStatusBag[] | null;
 
+    /** Gets or sets the Status filter options */
+    statusFilterOptions?: ListItemBag[] | null;
+
     /** Gets or sets the status options. */
     statusOptions?: ListItemBag[] | null;
 
@@ -84,6 +103,9 @@ export type StepProgramBag = {
     /** Gets or sets the step program attributes. */
     stepProgramAttributes?: PublicEditableAttributeBag[] | null;
 
+    /** Gets or sets a list of ListItemBags for the Step Type dropdown list filter on the Step Flow view. */
+    stepTypes?: ListItemBag[] | null;
+
     /** Gets or sets the workflow triggers. */
     workflowTriggers?: StepProgramWorkflowTriggerBag[] | null;
 };

package/types/ViewModels/Blocks/Engagement/StepProgramDetail/stepProgramDetailOptionsBag.d.ts

@@ -25,6 +25,12 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 /** The additional configuration options for the Step Program Detail block. */
 export type StepProgramDetailOptionsBag = {
+    /** Gets or sets the value indicating if the View Mode options will be displayed on the Edit page. */
+    areViewDisplayOptionsVisible?: boolean | null;
+
+    /** Gets or sets a value indicating whether the reorder column should be visible in the Step Attributes grid. */
+    isReOrderColumnVisible?: boolean | null;
+
     /** Gets or sets the trigger types. */
     triggerTypes?: ListItemBag[] | null;
 

package/types/ViewModels/Blocks/Engagement/StepProgramDetail/stepStatusBag.d.ts

@@ -26,10 +26,7 @@ import { Guid } from "@Obsidian/Types";
 /** The step status details for the Step Program Detail workflow trigger grid. */
 export type StepStatusBag = {
     /** Gets or sets the unique identifier. */
-    guid?: Guid | null;
-
-    /** Gets or sets the Step Status identifier. */
-    id: number;
+    guid: Guid;
 
     /** Gets or sets a value indicating whether this status is active. */
     isActive: boolean;
@@ -37,6 +34,9 @@ export type StepStatusBag = {
     /** Gets or sets a value indicating whether this status is complete. */
     isCompleteStatus: boolean;
 
+    /** Gets or sets the value indicating if this is a System Step Status. */
+    isSystem: boolean;
+
     /** Gets or sets the name. */
     name?: string | null;
 

package/types/ViewModels/Blocks/Engagement/StepTypeDetail/stepProgramBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { StepStatusBag } from "@Obsidian/ViewModels/Blocks/Engagement/StepTypeDetail/stepStatusBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type StepProgramBag = {
+    /** Gets or sets a Step Program. */
+    stepProgram?: ListItemBag | null;
+
+    /** Gets or sets the step statuses. */
+    stepStatuses?: StepStatusBag[] | null;
+};

package/types/ViewModels/Blocks/Engagement/StepTypeDetail/stepStatusBag.d.ts

@@ -0,0 +1,32 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type StepStatusBag = {
+    /** Gets or sets a value indicating whether this step status is a completion status. */
+    isCompletionStatus: boolean;
+
+    /** Gets or sets the List Item Bag that represents the step status. */
+    stepStatus?: ListItemBag | null;
+};