@rockrms/obsidian-framework 17.0.43 → 17.2.4

package/types/ViewModels/Workflow/entryFormFieldBag.d.ts

@@ -0,0 +1,61 @@
+//------------------------------------------------------------------------------
+// <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 { FieldFilterGroupBag } from "@Obsidian/ViewModels/Reporting/fieldFilterGroupBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** Defines a single field to display on a workflow entry form. */
+export type EntryFormFieldBag = {
+    /** Gets or sets the attribute associated with this field. */
+    attribute?: PublicAttributeBag | null;
+
+    /** The size of the column (1-12) to use when displaying this field. */
+    columnSize?: number | null;
+
+    /**
+     * Determines if this field's value should be displayed without any
+     * label above.
+     */
+    isLabelHidden: boolean;
+
+    /**
+     * Determines if this field is required in order for the form to be
+     * submitted.
+     */
+    isRequired: boolean;
+
+    /** Contains any HTML that should be rendered after the field. */
+    postHtml?: string | null;
+
+    /** Contains any HTML that should be rendered before the field. */
+    preHtml?: string | null;
+
+    /** The identifier of the section to display this field in. */
+    sectionId?: string | null;
+
+    /**
+     * The main rule that describes if this field should be visible or not
+     * depending on the values of other fields.
+     */
+    visibilityRule?: FieldFilterGroupBag | null;
+};

package/types/ViewModels/Workflow/entryFormSectionBag.d.ts

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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 { FieldFilterGroupBag } from "@Obsidian/ViewModels/Reporting/fieldFilterGroupBag";
+
+/**
+ * Defines a single section that will wrap a number of fields on a
+ * workflow entry form.
+ */
+export type EntryFormSectionBag = {
+    /** The CSS class to apply to the div element that contains the section. */
+    cssClass?: string | null;
+
+    /** The text to display beneath the title in the section header. */
+    description?: string | null;
+
+    /** The identifier of this section. */
+    id?: string | null;
+
+    /**
+     * Determines if the separator bar should be visible between the
+     * section header and content.
+     */
+    isHeadingSeparatorVisible: boolean;
+
+    /** The title to display at the top of the section header. */
+    title?: string | null;
+
+    /**
+     * The main rule that describes if this field should be visible or not
+     * depending on the values of other fields.
+     */
+    visibilityRule?: FieldFilterGroupBag | null;
+};

package/types/ViewModels/Workflow/interactiveActionBag.d.ts

@@ -0,0 +1,99 @@
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+import { NoteBag } from "@Obsidian/ViewModels/Controls/noteBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Controls/noteTypeBag";
+import { InteractiveActionDataBag } from "@Obsidian/ViewModels/Workflow/interactiveActionDataBag";
+
+/**
+ * The details about a single Workflow action with an interactive user
+ * experience that should be displayed.
+ */
+export type InteractiveActionBag = {
+    /**
+     * The unique identifier of the component that is handling processing
+     * for the current action.
+     */
+    actionComponentGuid?: Guid | null;
+
+    /**
+     * The data that will be used to display the interactive action or
+     * the result of the action's execution.
+     */
+    actionData?: InteractiveActionDataBag | null;
+
+    /**
+     * The date and time this action was displayed. This should be passed
+     * back when submitting component data to update interaction duration.
+     */
+    actionStartDateTime?: string | null;
+
+    /**
+     * The unique identifier of the action type that will provide the
+     * user interface to display.
+     */
+    actionTypeGuid?: Guid | null;
+
+    /**
+     * The date this workflow was created. Will be null if it
+     * has not been persisted yet.
+     */
+    createdDateTime?: string | null;
+
+    /** The CSS icon class to display in the panel for this workflow. */
+    iconCssClass?: string | null;
+
+    /** Determines if the note panel should be visible and allow note entry. */
+    isNotesVisible: boolean;
+
+    /** The message to display if the UI for the action is not available. */
+    noActionMessage?: string | null;
+
+    /** The list of current notes to be displayed. */
+    notes?: NoteBag[] | null;
+
+    /** The list of note types that are valid for this workflow. */
+    noteTypes?: NoteTypeBag[] | null;
+
+    /**
+     * The prefixed identifier of this workflow. Will be null or
+     * empty if it has not been persisted yet.
+     */
+    prefixedId?: string | null;
+
+    /** The title to display in the panel for this workflow. */
+    title?: string | null;
+
+    /**
+     * The URL to use for updating the URL in the browser so that the URL
+     * can be copied by the individual if required.
+     */
+    url?: string | null;
+
+    /**
+     * The workflow unique identifier. May be null if the workflow
+     * has not been persisted yet.
+     */
+    workflowGuid?: Guid | null;
+};

package/types/ViewModels/Workflow/interactiveActionDataBag.d.ts

@@ -0,0 +1,61 @@
+//------------------------------------------------------------------------------
+// <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 { InteractiveActionExceptionBag } from "@Obsidian/ViewModels/Workflow/interactiveActionExceptionBag";
+import { InteractiveMessageBag } from "@Obsidian/ViewModels/Workflow/interactiveMessageBag";
+
+/**
+ * Describes how to construct the UI to display a workflow action or
+ * display the result of its execution.
+ */
+export type InteractiveActionDataBag = {
+    /**
+     * The custom configuration options that will be sent to the component
+     * to help it render correctly. These will not be sent back to the
+     * server.
+     */
+    componentConfiguration?: Record<string, string> | null;
+
+    /**
+     * The custom data to pass to the component as data values that will
+     * then be sent back to the server.
+     */
+    componentData?: Record<string, string> | null;
+
+    /** The URL of a component to display on the workflow entry block. */
+    componentUrl?: string | null;
+
+    /**
+     * Describes an error that occurred while processing the component
+     * action. This is only valid to be returned during the UpdateAction
+     * processing. If this is set, the component will be passed this
+     * error and allowed to handle it internally.
+     */
+    exception?: InteractiveActionExceptionBag | null;
+
+    /**
+     * The message details to display to the individual. This may be null
+     * to cause a generic message to be displayed, but that should be uncommon.
+     */
+    message?: InteractiveMessageBag | null;
+};

package/types/ViewModels/Workflow/interactiveActionExceptionBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Describes an error that occurred while processing the interactive action. */
+export type InteractiveActionExceptionBag = {
+    /**
+     * The error code that describes the error that occurred. This is
+     * specific to each component and has no meaning to Rock itself.
+     */
+    code: number;
+
+    /**
+     * The text that describes the error that occurred. This is intended
+     * to be presented to the individual.
+     */
+    message?: string | null;
+};

package/types/ViewModels/Workflow/interactiveMessageBag.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 { InteractiveMessageType } from "@Obsidian/Enums/Workflow/interactiveMessageType";
+
+/**
+ * A message that should be displayed to the person from an interactive
+ * workflow action.
+ */
+export type InteractiveMessageBag = {
+    /** The content of the message or action. */
+    content?: string | null;
+
+    /** The title of the message, this may be null or empty. */
+    title?: string | null;
+
+    /** The type of message to be displayed. */
+    type: InteractiveMessageType;
+};

package/types/ViewModels/Workflow/personEntryConfigurationBag.d.ts

@@ -0,0 +1,128 @@
+//------------------------------------------------------------------------------
+// <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 { WorkflowActionFormPersonEntryOption } from "@Obsidian/Enums/Workflow/workflowActionFormPersonEntryOption";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Defines the configuration information required to display the person entry
+ * section inside a user entry form.
+ */
+export type PersonEntryConfigurationBag = {
+    /**
+     * Determines if the address field should be hidden, optional, or
+     * required.
+     */
+    addressOption: WorkflowActionFormPersonEntryOption;
+
+    /**
+     * Determines if the birthdate field should be hidden, optional, or
+     * required.
+     */
+    birthDateOption: WorkflowActionFormPersonEntryOption;
+
+    /** The list of campuses to display in the campus picker. */
+    campuses?: ListItemBag[] | null;
+
+    /** The description to display just below the title. */
+    description?: string | null;
+
+    /**
+     * Determines if the e-mail field should be hidden, optional, or
+     * required.
+     */
+    emailOption: WorkflowActionFormPersonEntryOption;
+
+    /**
+     * Determines if the ethnicity field should be hidden, optional, or
+     * required.
+     */
+    ethnicityOption: WorkflowActionFormPersonEntryOption;
+
+    /**
+     * Determines if the gender field should be hidden, optional, or
+     * required.
+     */
+    genderOption: WorkflowActionFormPersonEntryOption;
+
+    /** If true then the campus picker will be visible. */
+    isCampusVisible: boolean;
+
+    /** Determines if the SMS opt-in field should be visible. */
+    isSmsVisible: boolean;
+
+    /**
+     * The list of marital status options to display in the marital status
+     * picker.
+     */
+    maritalStatuses?: ListItemBag[] | null;
+
+    /**
+     * Determines if the marital status field should be hidden, optional,
+     * or required.
+     */
+    maritalStatusOption: WorkflowActionFormPersonEntryOption;
+
+    /**
+     * Determines if the mobile phone field should be hidden, optional,
+     * or required.
+     */
+    mobilePhoneOption: WorkflowActionFormPersonEntryOption;
+
+    /** Custom HTML to display after the editable fields on the form. */
+    postHtml?: string | null;
+
+    /** Custom HTML to display before the editable fields on the form. */
+    preHtml?: string | null;
+
+    /**
+     * Determines if the race field should be hidden, optional, or
+     * required.
+     */
+    raceOption: WorkflowActionFormPersonEntryOption;
+
+    /** The CSS class to apply to the div that wraps the entire form. */
+    sectionCssClass?: string | null;
+
+    /**
+     * If true then a separator will be displayed between the
+     * title/description and the rest of the form.
+     */
+    showHeadingSeparator: boolean;
+
+    /**
+     * The term to use for "Spouse". This will be used in the checkbox to
+     * show/hide the spouse fields and also prefixed on the fields in the
+     * spouse area.
+     */
+    spouseLabel?: string | null;
+
+    /**
+     * Determines if the spouse panel should be hidden, optional or
+     * required.
+     */
+    spouseOption: WorkflowActionFormPersonEntryOption;
+
+    /** The title to display at the top of the person entry form. */
+    title?: string | null;
+};

package/types/ViewModels/Workflow/personEntryValuesBag.d.ts

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+import { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+import { PersonBasicEditorBag } from "@Obsidian/ViewModels/Rest/Controls/personBasicEditorBag";
+
+/** The values for the Person Entry component on a Workflow Form. */
+export type PersonEntryValuesBag = {
+    /** The address of both individuals. */
+    address?: AddressControlBag | null;
+
+    /** The campus unique identifier. */
+    campusGuid?: Guid | null;
+
+    /** The marital status between the two individuals. */
+    maritalStatusGuid?: Guid | null;
+
+    /** The primary person. */
+    person?: PersonBasicEditorBag | null;
+
+    /** The spouse of the person. */
+    spouse?: PersonBasicEditorBag | null;
+};