@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Engagement/StreakTypeDetail/streakTypeBag.d.ts

@@ -0,0 +1,96 @@
+//------------------------------------------------------------------------------
+// <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 StreakTypeBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets a description of the Streak Type. */
+    description?: string | null;
+
+    /**
+     * This determines whether the streak type will write attendance records when marking someone as present or
+     * if it will just update the enrolled individual’s map.
+     */
+    enableAttendance: boolean;
+
+    /** Gets or sets the first day of the week when the frequency is set to weekly */
+    firstDayOfWeek: number;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the structure settings JSON. */
+    includeChildAccounts: boolean;
+
+    /**
+     * The Guid for the Interaction Channel associated with the Interaction Component.
+     * This is set only if the linked activity is Interaction Component
+     */
+    interactionComponentInteractionChannel?: ListItemBag | null;
+
+    /** Gets or sets a flag indicating if this item is active or not. */
+    isActive: boolean;
+
+    /** Gets or sets the name of the Streak Type. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the timespan that each map bit represents (Rock.Model.StreakOccurrenceFrequency). */
+    occurrenceFrequency: number;
+
+    /**
+     * Gets or sets a flag indicating if this streak type requires explicit enrollment. If not set, a person can be
+     * implicitly enrolled through attendance.
+     */
+    requiresEnrollment: boolean;
+
+    /** Gets or sets the System.DateTime associated with the least significant bit of all maps in this streak type. */
+    startDate?: string | null;
+
+    /** Gets or sets a collection containing the Streaks that are of this streak type. */
+    streaks?: ListItemBag[] | null;
+
+    /**
+     * Gets or sets a collection containing the StreakTypeExclusions
+     * that are of this streak type.
+     */
+    streakTypeExclusions?: ListItemBag[] | null;
+
+    /**
+     * Gets or sets the Id of the Entity associated with attendance for this streak type. If not set, this streak type
+     * will account for any attendance record.
+     */
+    structureEntity?: ListItemBag | null;
+
+    /** Gets or sets the attendance association */
+    structureType?: number | null;
+
+    /** The text display of structure type in view mode in the frontend */
+    structureTypeDisplay?: string | null;
+};

package/types/ViewModels/Blocks/Engagement/StreakTypeDetail/streakTypeDetailOptionsBag.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 { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type StreakTypeDetailOptionsBag = {
+    /** The List of guids of the group type for check in config linked type */
+    attendanceCheckInConfigGroupTypesGuids?: Guid[] | null;
+
+    /** Streak Occurrence Frequency list */
+    streakOccurrenceFrequencies?: ListItemBag[] | null;
+
+    /** List of Represents of the attendance association of a StreakType. */
+    streakStructureTypes?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Engagement/StreakTypeExclusionDetail/streakTypeExclusionBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type StreakTypeExclusionBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the Rock.Model.Location . */
+    location?: ListItemBag | null;
+
+    /** Gets or sets the Sequence Rock.Model.StreakType . */
+    streakType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Engagement/StreakTypeExclusionDetail/streakTypeExclusionDetailOptionsBag.d.ts

@@ -0,0 +1,25 @@
+//------------------------------------------------------------------------------
+// <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 StreakTypeExclusionDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Event/EventCalendarDetail/eventAttributeBag.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 { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+export type EventAttributeBag = {
+    /** Gets or sets the attribute. */
+    attribute?: PublicEditableAttributeBag | null;
+
+    /** Gets or sets the type of the field. */
+    fieldType?: string | null;
+};

package/types/ViewModels/Blocks/Event/EventCalendarDetail/eventCalendarBag.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 { EventAttributeBag } from "@Obsidian/ViewModels/Blocks/Event/EventCalendarDetail/eventAttributeBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type EventCalendarBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets a value indicating whether the current user has Administrate Authorization. */
+    canAdministrate: boolean;
+
+    /** Gets or sets the content channels. */
+    contentChannels?: ListItemBag[] | null;
+
+    /** Gets or sets the Description of the EventCalendar. */
+    description?: string | null;
+
+    /** Gets or sets the attributes. */
+    eventAttributes?: EventAttributeBag[] | null;
+
+    exportFeedUrl?: string | null;
+
+    /** Gets or sets the icon CSS class name for a font vector based icon. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance is index enabled. */
+    isIndexEnabled: boolean;
+
+    /** Gets or sets the Name of the EventCalendar. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the saved content channels. */
+    savedContentChannels?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Event/EventCalendarDetail/eventCalendarDetailOptionsBag.d.ts

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <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 { EventAttributeBag } from "@Obsidian/ViewModels/Blocks/Event/EventCalendarDetail/eventAttributeBag";
+
+export type EventCalendarDetailOptionsBag = {
+    /** Gets or sets the attributes. */
+    eventAttributes?: EventAttributeBag[] | null;
+};

package/types/ViewModels/Blocks/Event/EventItemDetail/eventCalendarItemAttributeBag.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 { Guid } from "@Obsidian/Types";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type EventCalendarItemAttributeBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the event calendar unique identifier. */
+    eventCalendarGuid?: Guid | null;
+
+    /** Gets or sets the name of the event calendar. */
+    eventCalendarName?: string | null;
+};

package/types/ViewModels/Blocks/Event/EventItemDetail/eventItemBag.d.ts

@@ -0,0 +1,89 @@
+//------------------------------------------------------------------------------
+// <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 { EventCalendarItemAttributeBag } from "@Obsidian/ViewModels/Blocks/Event/EventItemDetail/eventCalendarItemAttributeBag";
+import { EventItemOccurenceAttributeBag } from "@Obsidian/ViewModels/Blocks/Event/EventItemDetail/eventItemOccurenceAttributeBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type EventItemBag = {
+    /** Gets or sets the approval text. */
+    approvalText?: string | null;
+
+    /** Gets or sets the approved by Rock.Model.PersonAlias. */
+    approvedByPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets the date this event was approved. */
+    approvedOnDateTime?: string | null;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the audiences. */
+    audiences?: ListItemBag[] | null;
+
+    /** Gets or sets the available calendars. */
+    availableCalendars?: ListItemBag[] | null;
+
+    /** Gets or sets the calendars. */
+    calendars?: string[] | null;
+
+    /** Gets or sets the Description of the EventItem. */
+    description?: string | null;
+
+    /** Gets or sets the URL for an external event. */
+    detailsUrl?: string | null;
+
+    /** Gets or sets the event calendar item attributes. */
+    eventCalendarItemAttributes?: EventCalendarItemAttributeBag[] | null;
+
+    /** Gets or sets the event occurence attributes. */
+    eventOccurenceAttributes?: EventItemOccurenceAttributeBag[] | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the is active. */
+    isActive: boolean;
+
+    /** Gets or sets a flag indicating if the event has been approved. */
+    isApproved: boolean;
+
+    /** Gets or sets the Name of the EventItem. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the Rock.Model.BinaryFile that contains the EventItem's photo. */
+    photo?: ListItemBag | null;
+
+    /** Gets or sets the photo URL. */
+    photoUrl?: string | null;
+
+    /** Gets or sets the selected calendar names. */
+    selectedCalendarNames?: string[] | null;
+
+    /** Gets or sets the Summary of the EventItem. */
+    summary?: string | null;
+};

package/types/ViewModels/Blocks/Event/EventItemDetail/eventItemDetailOptionsBag.d.ts

@@ -0,0 +1,25 @@
+//------------------------------------------------------------------------------
+// <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 EventItemDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Event/EventItemDetail/eventItemOccurenceAttributeBag.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 { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+export type EventItemOccurenceAttributeBag = {
+    /** Gets or sets the attribute. */
+    attribute?: PublicEditableAttributeBag | null;
+
+    /** Gets or sets the type of the filter. */
+    fieldType?: string | null;
+};

package/types/ViewModels/Blocks/Event/InteractiveExperiences/ExperienceManager/experienceManagerInitializationBox.d.ts

@@ -0,0 +1,72 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Class ExperienceManagerInitializationBox.
+ * Implements the Rock.ViewModels.Blocks.BlockBox
+ */
+export type ExperienceManagerInitializationBox = {
+    /** Gets or sets the actions configured for this experience. */
+    actions?: 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 name of the experience. */
+    experienceName?: string | null;
+
+    /** Gets or sets the experience token used to authenticate to the RealTime topic. */
+    experienceToken?: string | null;
+
+    /** Gets or sets a value indicating whether this experience is inactive. */
+    isExperienceInactive: boolean;
+
+    /**
+     * Gets or sets a value indicating whether to display the notification
+     * toggle option to the individual.
+     */
+    isNotificationAvailable: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the occurrence identifier key. */
+    occurrenceIdKey?: string | null;
+
+    /** Gets or sets the number of active participants in the experience. */
+    participantCount: number;
+
+    /** Gets or sets the number of seconds between participant count updates. */
+    participantCountUpdateInterval: number;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the tabs that should be shown in the manager. */
+    tabsToShow?: string[] | null;
+};

package/types/ViewModels/Blocks/Event/InteractiveExperiences/ExperienceManagerOccurrences/experienceManagerOccurrencesInitializationBox.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Class ExperienceManagerOccurrencesInitializationBox.
+ * Implements the Rock.ViewModels.Blocks.BlockBox
+ */
+export type ExperienceManagerOccurrencesInitializationBox = {
+    /**
+     * 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 name of the experience. */
+    experienceName?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the occurrences that are available to be chosen. */
+    occurrences?: ListItemBag[] | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};