@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Engagement/SignUp/SignUpFinder/signUpFinderSelectedFiltersBag.d.ts

@@ -0,0 +1,57 @@
+//------------------------------------------------------------------------------
+// <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 { PublicComparisonValueBag } from "@Obsidian/ViewModels/Utility/publicComparisonValueBag";
+
+/** Class SignUpFinderSelectedFiltersBag */
+export type SignUpFinderSelectedFiltersBag = {
+    /** Gets or sets the group attribute filters that should be used to limit the search results, grouped by project type [guid]. */
+    attributeFiltersByProjectType?: Record<string, Record<string, PublicComparisonValueBag>> | null;
+
+    /** Gets or sets the campus guid strings that should be used to limit the search results. */
+    campuses?: string[] | null;
+
+    /** Gets or sets the end date that should be used to limit the search results. */
+    endDate?: string | null;
+
+    /** Gets or sets the location range (in miles) that should be used to limit the search results. */
+    locationRange?: number | null;
+
+    /** Gets or sets the location sort (zip code or city, state) that should be used to order the search results. */
+    locationSort?: string | null;
+
+    /** Gets or sets the named schedule guid strings that should be used to limit the search results. */
+    namedSchedules?: string[] | null;
+
+    /** Gets or sets the sign-up project group type guid strings that should be used to limit the search results. */
+    projectTypes?: string[] | null;
+
+    /** Gets or sets the slots available count that should be used to limit the search results. */
+    slotsAvailable?: number | null;
+
+    /** Gets or sets the type of comparison ("at least" or "no more than") to be used along with the Rock.ViewModels.Blocks.Engagement.SignUp.SignUpFinder.SignUpFinderSelectedFiltersBag.SlotsAvailable value, that should be used to limit the search results. */
+    slotsAvailableComparisonType?: string | null;
+
+    /** Gets or sets the start date that should be used to limit the search results. */
+    startDate?: string | null;
+};

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

@@ -0,0 +1,66 @@
+//------------------------------------------------------------------------------
+// <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 { RegisterMode } from "@Obsidian/Enums/Blocks/Engagement/SignUp/registerMode";
+import { SignUpRegistrantBag } from "@Obsidian/ViewModels/Blocks/Engagement/SignUp/SignUpRegister/signUpRegistrantBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The box that contains all the initialization information for the Sign-Up Register block. */
+export type SignUpRegisterInitializationBox = {
+    /** Gets or sets the communication preference items available for the registrant to select. */
+    communicationPreferenceItems?: ListItemBag[] | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the registration mode the block is in. */
+    mode: RegisterMode;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets whether this project has required group requirements. */
+    projectHasRequiredGroupRequirements: boolean;
+
+    /**
+     * Gets or sets the list of existing or possible registrants, including the registrar.
+     * 
+     * Each <see cref="P:Rock.ViewModels.Blocks.Engagement.SignUp.SignUpRegister.SignUpRegistrantBag.WillAttend" /> value indicates whether they're already registered (<see langword="true" />) or available to be registered (<see langword="false" />).
+     */
+    registrants?: SignUpRegistrantBag[] | null;
+
+    /** Gets or sets whether to require that a value be entered for email when registering in Anonymous mode. */
+    requireEmail: boolean;
+
+    /** Gets or sets whether to require that a value be entered for mobile phone when registering in Anonymous mode. */
+    requireMobilePhone: boolean;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the optional title to display above the register form. */
+    title?: string | null;
+};

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

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <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 { SignUpRegistrantBag } from "@Obsidian/ViewModels/Blocks/Engagement/SignUp/SignUpRegister/signUpRegistrantBag";
+
+/** The information about registrants to be registered, updated or unregistered when registering for a sign-up project occurrence. */
+export type SignUpRegisterRequestBag = {
+    /** Gets or sets the registrants to be registered, updated or unregistered. */
+    registrants?: SignUpRegistrantBag[] | null;
+};

package/types/ViewModels/Blocks/Engagement/SignUp/SignUpRegister/signUpRegisterResponseBag.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>
+//
+
+/** The information about registrants that were successfully registered, unregistered or unable to be registered, for a given register request. */
+export type SignUpRegisterResponseBag = {
+    /** Gets or sets the full names of individuals who were successfully registered for a sign-up project. */
+    registeredRegistrantNames?: string[] | null;
+
+    /** Gets or sets the full names of individuals who were unregistered for a sign-up project. */
+    unregisteredRegistrantNames?: string[] | null;
+
+    /** Gets or sets the full names of individuals who were unable to be registered for a sign-up project. */
+    unsuccessfulRegistrantNames?: string[] | null;
+
+    /** Gets or sets the warning message for this registration attempt. */
+    warningMessage?: string | null;
+};

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

@@ -0,0 +1,67 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Information about a sign-up registrant. */
+export type SignUpRegistrantBag = {
+    /** Gets or sets whether to allow SMS messages to be sent to the registrant's mobile phone. */
+    allowSms: boolean;
+
+    /** Gets or sets the registrant's communication preference. */
+    communicationPreference: number;
+
+    /** Gets or sets the registrant's email. */
+    email?: string | null;
+
+    /** Gets or sets the registrant's first name. */
+    firstName?: string | null;
+
+    /** Gets or sets the registrant's full name. */
+    fullName?: string | null;
+
+    /** Gets or sets whether this Rock.ViewModels.Blocks.Engagement.SignUp.SignUpRegister.SignUpRegistrantBag instance represents a child. */
+    isChild: boolean;
+
+    /** Gets or sets whether this Rock.ViewModels.Blocks.Engagement.SignUp.SignUpRegister.SignUpRegistrantBag instance represents the registrar. */
+    isRegistrar: boolean;
+
+    /** Gets or sets the registrant's last name. */
+    lastName?: string | null;
+
+    /** Gets or sets the registrant's mobile phone country code. */
+    mobilePhoneCountryCode?: string | null;
+
+    /** Gets or sets the registrant's mobile phone number. */
+    mobilePhoneNumber?: string | null;
+
+    /** Gets or sets the registrant's formatted mobile phone number. */
+    mobilePhoneNumberFormatted?: string | null;
+
+    /** Gets or sets the registrant's hashed person identifier key. */
+    personIdKey?: string | null;
+
+    /** Gets or sets the registrant's unmet group requirements, if any. */
+    unmetGroupRequirements?: string[] | null;
+
+    /** Gets or sets whether the registrant will attend. */
+    willAttend: boolean;
+};

package/types/ViewModels/Blocks/Engagement/Steps/flowNodeDiagramEdgeBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/**
+ * A description of the number of items flowing from a Node on
+ * one level to a node on the next level
+ */
+export type FlowNodeDiagramEdgeBag = {
+    /** Gets or sets the level */
+    level: number;
+
+    /** Gets or sets the source ID */
+    sourceId?: number | null;
+
+    /** Gets or sets the target ID */
+    targetId: number;
+
+    /** Gets or sets the tooltip */
+    tooltip?: string | null;
+
+    /** Gets or sets the units */
+    units: number;
+};

package/types/ViewModels/Blocks/Engagement/Steps/flowNodeDiagramNodeBag.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>
+//
+
+/**
+ * Type for a Flow Node Diagram's Node definitions.
+ * For Step Flow diagrams, this represents a Step
+ */
+export type FlowNodeDiagramNodeBag = {
+    /** Gets or sets the color */
+    color?: string | null;
+
+    /** Gets or sets the id */
+    id: number;
+
+    /** Gets or sets the name */
+    name?: string | null;
+
+    /** Gets or sets the order */
+    order: number;
+};

package/types/ViewModels/Blocks/Engagement/Steps/flowNodeDiagramSettingsBag.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>
+//
+
+/** Model of the settings for the Flow Node Diagram */
+export type FlowNodeDiagramSettingsBag = {
+    /** Gets or sets the chart height */
+    chartHeight?: number | null;
+
+    /** Gets or sets the chart width */
+    chartWidth?: number | null;
+
+    /** Gets or sets the legend HTML */
+    legendHtml?: string | null;
+
+    /** Gets or sets the Node vertical spacing */
+    nodeVerticalSpacing?: number | null;
+
+    /** Gets or sets the Node width */
+    nodeWidth?: number | null;
+};

package/types/ViewModels/Blocks/Engagement/Steps/stepFlowGetDataBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 { FlowNodeDiagramEdgeBag } from "@Obsidian/ViewModels/Blocks/Engagement/Steps/flowNodeDiagramEdgeBag";
+import { FlowNodeDiagramNodeBag } from "@Obsidian/ViewModels/Blocks/Engagement/Steps/flowNodeDiagramNodeBag";
+
+/** Class StepFlowGetDataBag. */
+export type StepFlowGetDataBag = {
+    /** Gets or sets the list of edges */
+    edges?: FlowNodeDiagramEdgeBag[] | null;
+
+    /** Gets or sets the list of nodes */
+    nodes?: FlowNodeDiagramNodeBag[] | null;
+};

package/types/ViewModels/Blocks/Engagement/Steps/stepFlowInitializationBox.d.ts

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Box of properties for initializing the StepNode block */
+export type StepFlowInitializationBox = {
+    /** Gets or sets the list of campuses */
+    campuses?: ListItemBag[] | null;
+
+    /** Gets or sets the chart height */
+    chartHeight?: number | null;
+
+    /** Gets or sets the chart width */
+    chartWidth?: number | null;
+
+    /** Gets or sets the legend HTML */
+    legendHtml?: string | null;
+
+    /** Gets or sets the Node vertical spacing */
+    nodeVerticalSpacing?: number | null;
+
+    /** Gets or sets the Node width */
+    nodeWidth?: number | null;
+
+    /** Gets or sets the name of the step program */
+    programName?: string | null;
+
+    /** Gets or sets the step type count */
+    stepTypeCount?: number | null;
+};

package/types/ViewModels/Blocks/Engagement/StreakDetail/streakBag.d.ts

@@ -0,0 +1,69 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type StreakBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** The current number of non excluded occurrences attended in a row */
+    currentStreakCount: number;
+
+    /** The date that the current streak began */
+    currentStreakStartDate?: string | null;
+
+    /**
+     * Gets or sets the System.DateTime when the person was enrolled in the streak type.
+     * This is not the Streak Type start date.
+     */
+    enrollmentDate?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the IsActive. */
+    isActive: boolean;
+
+    /** Gets or sets the Rock.Model.Location. */
+    location?: ListItemBag | null;
+
+    /** The longest number of non excluded occurrences attended in a row */
+    longestStreakCount: number;
+
+    /** The date the longest streak ended */
+    longestStreakEndDate?: string | null;
+
+    /** The date the longest streak began */
+    longestStreakStartDate?: string | null;
+
+    /** Gets or sets the Rock.Model.PersonAlias. */
+    personAlias?: ListItemBag | null;
+
+    /** Gets or sets the Rock.Model.StreakType. */
+    streakType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Engagement/StreakDetail/streakDetailOptionsBag.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 StreakDetailOptionsBag = {
+    /** The HTML of the Streak Chart that needs to be displayed on the frontend */
+    chartHTML?: string | null;
+
+    /** The current streak details text that needs to be displayed on the frontend */
+    currentStreak?: string | null;
+
+    /** The longest streak details text that needs to be displayed on the frontend */
+    longestStreak?: string | null;
+
+    /** The person HTML to be displayed on the front end  */
+    personHTML?: string | null;
+};