@rockrms/obsidian-framework 17.5.2 → 18.1.0

package/types/ViewModels/Controls/iconLibraryBag.d.ts

@@ -0,0 +1,43 @@
+// <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>
+//
+
+/* eslint-disable @typescript-eslint/naming-convention */
+
+export type IconLibraryBag = {
+    /** A list of icon definitions that are part of this icon set. */
+    Icons?: IconDefinitionBag[] | null;
+
+    /**
+     * A CSS class that is added with the Rock.ViewModels.Controls.IconDefinitionBag.StyleClass
+     * required to the icon element to cause the icon to show.
+     */
+    StyleClassPrefix?: string | null;
+};
+
+export type IconBag = {
+    /** The SVG markup for the icon for preview purposes in the icon picker. */
+    IconSvg?: string | null;
+
+    /** A list of search terms that can be used to find this icon. */
+    SearchTerms?: string[] | null;
+
+    /** A CSS class added to the icon element to cause the correct icon to display. */
+    StyleClass?: string | null;
+
+    /** The name of the icon */
+    Title?: string | null;
+};

package/types/ViewModels/Core/Automation/Triggers/chatMessageCriteriaBag.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 { ChatMessageCriteriaRuleBag } from "@Obsidian/ViewModels/Core/Automation/Triggers/chatMessageCriteriaRuleBag";
+
+/** The criteria used to determine if a chat message should trigger. */
+export type ChatMessageCriteriaBag = {
+    /** Gets or sets whether all rules must match or if any one matching rule is sufficient to trigger the events. */
+    areAllRulesRequired: boolean;
+
+    /** Gets or sets the list of rules that will be used to determine if the chat message matches this criteria. */
+    rules?: ChatMessageCriteriaRuleBag[] | null;
+};

package/types/ViewModels/Core/Automation/Triggers/chatMessageCriteriaRuleBag.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>
+//
+
+import { ChatMessageCriteriaRuleType } from "@Obsidian/Enums/Core/Automation/Triggers/chatMessageCriteriaRuleType";
+import { Guid } from "@Obsidian/Types";
+
+/** A single rule that is used to determine if a chat message should trigger the events. */
+export type ChatMessageCriteriaRuleBag = {
+    /** Gets or sets the criteria value to use to determine if a chat message should trigger the events. */
+    criteriaValue?: string | null;
+
+    /** Gets or sets the friendly criteria value to display to the individual when administering this rule in the UI. */
+    friendlyCriteriaValue?: string | null;
+
+    /**
+     * Gets or sets a unique identifier for this rule. This is used to identify the rule in the UI and not used for
+     * any other purpose.
+     */
+    guid: Guid;
+
+    /** Gets or sets the type of rule to use to determine if a chat message should trigger the events. */
+    ruleType: ChatMessageCriteriaRuleType;
+};

package/types/ViewModels/Core/Automation/Triggers/entityChangeSimpleCriteriaBag.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 { EntityChangeSimpleCriteriaRuleBag } from "@Obsidian/ViewModels/Core/Automation/Triggers/entityChangeSimpleCriteriaRuleBag";
+
+/**
+ * The criteria used to determine if an entity change should trigger
+ * the events when the component is in simple filtering mode.
+ */
+export type EntityChangeSimpleCriteriaBag = {
+    /**
+     * Determines if all rules must match or if any one matching rule is
+     * sufficient to trigger the events.
+     */
+    areAllRulesRequired: boolean;
+
+    /**
+     * The list of rules that will be used to determine if the entity
+     * matches this criteria.
+     */
+    rules?: EntityChangeSimpleCriteriaRuleBag[] | null;
+};

package/types/ViewModels/Core/Automation/Triggers/entityChangeSimpleCriteriaRuleBag.d.ts

@@ -0,0 +1,58 @@
+//------------------------------------------------------------------------------
+// <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 { EntityChangeSimpleChangeType } from "@Obsidian/Enums/Core/Automation/Triggers/entityChangeSimpleChangeType";
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * A single rule that is used to determine if an entity change should
+ * trigger the events. This is used when the component is in simple
+ * filtering mode.
+ */
+export type EntityChangeSimpleCriteriaRuleBag = {
+    /** The type of change that will trigger the criteria to match. */
+    changeType: EntityChangeSimpleChangeType;
+
+    /**
+     * A unique identifier for this rule. This is used to identify the
+     * rule in the UI and not used for any other purpose.
+     */
+    guid: Guid;
+
+    /**
+     * The original value of the property must be equal to in
+     * order to match the rule. This is only used for certain change
+     * types.
+     */
+    originalValue?: string | null;
+
+    /** The name of the property that is being monitored for changes. */
+    property?: string | null;
+
+    /**
+     * The current value of the property must be equal to in
+     * order to match the rule. This is only used for certain change
+     * types.
+     */
+    updatedValue?: string | null;
+};

package/types/ViewModels/Core/Automation/automationValueDefinitionBag.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>
+//
+
+/**
+ * Represents the definition of a single value that can exist in an
+ * automation request.
+ */
+export type AutomationValueDefinitionBag = {
+    /**
+     * The description of what this key is and how it is used. This should
+     * be written for an end-user and contain language they would understand.
+     */
+    description?: string | null;
+
+    /**
+     * The key in the values dictionary for an automation request that
+     * this entry represents.
+     */
+    key?: string | null;
+
+    /**
+     * The C# type name that represents the most basic type of this value. For
+     * example, if the value could either be a Person or a Group then it
+     * should be Rock.Data.IEntity. If it can only ever be a Person
+     * then it should be Rock.Model.Person.
+     */
+    typeName?: string | null;
+};

package/types/ViewModels/Entities/prayerRequestBag.d.ts

@@ -0,0 +1,117 @@
+//------------------------------------------------------------------------------
+// <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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** PrayerRequest View Model */
+export type PrayerRequestBag = {
+    /** Gets or sets a flag indicating  whether or not comments can be made against the request. */
+    allowComments?: boolean | null;
+
+    /** Gets or sets a description of the way that God has answered the prayer. */
+    answer?: string | null;
+
+    /** Gets or sets the PersonId of the Rock.Model.Person who approved this prayer request. */
+    approvedByPersonAliasId?: number | null;
+
+    /** Gets or sets the date this prayer request 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 campus identifier. */
+    campusId?: number | null;
+
+    /** Gets or sets the CategoryId of the Rock.Model.Category that the PrayerRequest belongs to. */
+    categoryId?: number | null;
+
+    /** Gets or sets the created by person alias identifier. */
+    createdByPersonAliasId?: number | null;
+
+    /** Gets or sets the created date time. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets the email address of the person requesting prayer. */
+    email?: string | null;
+
+    /** Gets or sets the date that this prayer request was entered. */
+    enteredDateTime?: string | null;
+
+    /** Gets or sets the date that the prayer request expires.  */
+    expirationDate?: string | null;
+
+    /** Gets or sets the First Name of the person that this prayer request is about. This property is required. */
+    firstName?: string | null;
+
+    /** Gets or sets the number of times this request has been flagged. */
+    flagCount?: number | null;
+
+    /** Gets or sets the FullName of the request. */
+    fullName?: string | null;
+
+    /**
+     * TODO: GET CLARIFICATION AND DOCUMENT
+     * Gets or sets the group id.
+     */
+    groupId?: number | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this prayer request is active. */
+    isActive?: boolean | null;
+
+    /** Gets or sets a flag indicating if the prayer request has been approved.  */
+    isApproved?: boolean | null;
+
+    /** Gets or sets the flag indicating whether or not the request is public. */
+    isPublic?: boolean | null;
+
+    /** Gets or sets a flag indicating if this is an urgent prayer request. */
+    isUrgent?: boolean | null;
+
+    /** Gets or sets the DefinedValueId of the Rock.Model.DefinedValue that represents the Language for this prayer request. */
+    languageValueId?: number | null;
+
+    /** Gets or sets the Last Name of the person that this prayer request is about. This property is required. */
+    lastName?: string | null;
+
+    /** Gets or sets the modified by person alias identifier. */
+    modifiedByPersonAliasId?: number | null;
+
+    /** Gets or sets the modified date time. */
+    modifiedDateTime?: string | null;
+
+    /** Gets or sets the number of times that this prayer request has been prayed for. */
+    prayerCount?: number | null;
+
+    /** Gets or sets the PersonId of the Rock.Model.Person who is submitting the PrayerRequest */
+    requestedByPersonAliasId?: number | null;
+
+    /** Gets or sets the text/content of the request. */
+    text?: string | null;
+};

package/types/ViewModels/Entities/scheduleBag.d.ts

@@ -0,0 +1,103 @@
+//------------------------------------------------------------------------------
+// <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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** Schedule View Model */
+export type ScheduleBag = {
+    /**
+     * Gets or sets the shortened name of the attribute.
+     * If null or whitespace then the full name is returned.
+     */
+    abbreviatedName?: 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 a value indicating whether [auto inactivate when complete]. */
+    autoInactivateWhenComplete: boolean;
+
+    /** Gets or sets the CategoryId of the Rock.Model.Category that this Schedule belongs to. */
+    categoryId?: number | null;
+
+    /**
+     * Gets or sets the number of minutes following schedule start that Check-in should be active. 0 represents that Check-in will only be available
+     * until the Schedule's start time.
+     */
+    checkInEndOffsetMinutes?: number | null;
+
+    /**
+     * Gets or sets the number of minutes prior to the Schedule's start time  that Check-in should be active. 0 represents that Check-in 
+     * will not be available to the beginning of the event.
+     */
+    checkInStartOffsetMinutes?: number | null;
+
+    /** Gets or sets the created by person alias identifier. */
+    createdByPersonAliasId?: number | null;
+
+    /** Gets or sets the created date time. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets a user defined Description of the Schedule. */
+    description?: string | null;
+
+    /** Gets or sets that date that this Schedule expires and becomes inactive. This value is inclusive and the schedule will be inactive after this date. */
+    effectiveEndDate?: string | null;
+
+    /** Gets or sets the Date that the Schedule becomes effective/active. This property is inclusive, and the schedule will be inactive before this date.  */
+    effectiveStartDate?: string | null;
+
+    /** Gets or sets the content lines of the iCalendar */
+    iCalendarContent?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this is an active schedule. This value is required. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating if this Schedule is public. */
+    isPublic?: boolean | null;
+
+    /** Gets or sets the modified by person alias identifier. */
+    modifiedByPersonAliasId?: number | null;
+
+    /** Gets or sets the modified date time. */
+    modifiedDateTime?: string | null;
+
+    /** Gets or sets the Name of the Schedule. This property is required. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the order.
+     * Use List&lt;Schedule&gt;().OrderByOrderAndNextScheduledDateTime
+     * to get the schedules in the desired order.
+     */
+    order: number;
+
+    /** Gets or sets the weekly day of week. */
+    weeklyDayOfWeek?: number | null;
+};

package/types/ViewModels/Entities/scheduleCategoryExclusionBag.d.ts

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** ScheduleCategoryExclusion View Model */
+export type ScheduleCategoryExclusionBag = {
+    /** 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 category identifier. */
+    categoryId: number;
+
+    /** Gets or sets the created by person alias identifier. */
+    createdByPersonAliasId?: number | null;
+
+    /** Gets or sets the created date time. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets the end date. */
+    endDate?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the modified by person alias identifier. */
+    modifiedByPersonAliasId?: number | null;
+
+    /** Gets or sets the modified date time. */
+    modifiedDateTime?: string | null;
+
+    /** Gets or sets the start date. */
+    startDate?: string | null;
+
+    /** Gets or sets the title. */
+    title?: string | null;
+};

package/types/ViewModels/Event/RegistrationEntry/registrationRegistrantUpdatedMessageBag.d.ts

@@ -0,0 +1,59 @@
+//------------------------------------------------------------------------------
+// <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 { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Details about a registramt record that is transmitted over
+ * the RealTime engine.
+ */
+export type RegistrationRegistrantUpdatedMessageBag = {
+    /** Gets or sets the list of fees associated with the registrant. */
+    fees?: Record<string, ListItemBag> | null;
+
+    /** Gets or sets the person associated with the registrant. */
+    person?: PersonBag | null;
+
+    /** Gets or sets the registrant unique identifier. */
+    registrantGuid: Guid;
+
+    /** Gets or sets the registrant encrypted identifier. */
+    registrantIdKey?: string | null;
+
+    /** Gets or sets the GUID of the registration instance. */
+    registrationInstanceGuid?: Guid | null;
+
+    /** Gets or sets the registration instance encrypted identifier. */
+    registrationInstanceIdKey?: string | null;
+
+    /** Gets or sets the name of the registration instance. */
+    registrationInstanceName?: string | null;
+
+    /** Gets or sets the GUID of the registration template. */
+    registrationTemplateGuid?: Guid | null;
+
+    /** Gets or sets the registration template encrypted identifier. */
+    registrationTemplateIdKey?: string | null;
+};

package/types/ViewModels/Group/GroupMember/groupMemberUpdatedMessageBag.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 { Guid } from "@Obsidian/Types";
+import { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+
+/**
+ * Details about an group member record that is transmitted over
+ * the RealTime engine.
+ */
+export type GroupMemberUpdatedMessageBag = {
+    /** The date and time the group member was added. */
+    dateTimeAdded?: string | null;
+
+    /** The GUID of the group. */
+    groupGuid?: Guid | null;
+
+    /** The encrypted identifier key for the group. */
+    groupIdKey?: string | null;
+
+    /** The GUID of the group member. */
+    groupMemberGuid: Guid;
+
+    /**
+     * Gets or sets the group member unique identifier. (TODO: Remove
+     * this when Group Member Detail is converted to Obsidian.)
+     */
+    groupMemberId: number;
+
+    /** The encrypted identifier key for the group member. */
+    groupMemberIdKey?: string | null;
+
+    /** The encrypted identifier key for the group role. */
+    groupRoleIdKey?: string | null;
+
+    /** The encrypted identifier key for the group type. */
+    groupTypeIdKey?: string | null;
+
+    /** The person associated with the group member. */
+    person?: PersonBag | null;
+};