@rockrms/obsidian-framework 1.16.3-rc.1

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

@@ -0,0 +1,83 @@
+//------------------------------------------------------------------------------
+// <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 { CampusScheduleBag } from "@Obsidian/ViewModels/Blocks/Core/CampusDetail/campusScheduleBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Class CampusBag.
+ * Implements the Rock.ViewModels.Utility.EntityBagBase
+ */
+export type CampusBag = {
+    /** 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 schedules. */
+    campusSchedules?: CampusScheduleBag[] | null;
+
+    /** Gets or sets the campus status value. */
+    campusStatusValue?: ListItemBag | null;
+
+    /** Gets or sets the campus type value. */
+    campusTypeValue?: ListItemBag | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive?: boolean | null;
+
+    /** Gets or sets a value indicating whether this instance is system. */
+    isSystem: boolean;
+
+    /** Gets or sets the leader person alias. */
+    leaderPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets the location. */
+    location?: ListItemBag | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the phone number. */
+    phoneNumber?: string | null;
+
+    /** Gets or sets the service times. */
+    serviceTimes?: ListItemBag[] | null;
+
+    /** Gets or sets the short code. */
+    shortCode?: string | null;
+
+    /** Gets or sets the time zone identifier. */
+    timeZoneId?: string | null;
+
+    /** Gets or sets the URL. */
+    url?: string | null;
+};

package/types/ViewModels/Blocks/Core/CampusDetail/campusDetailOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Class CampusDetailOptionsBag. */
+export type CampusDetailOptionsBag = {
+    /** Gets or sets a value indicating whether this instance is multi time zone supported. */
+    isMultiTimeZoneSupported: boolean;
+
+    /** Gets or sets the time zone options. */
+    timeZoneOptions?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Core/CampusDetail/campusScheduleBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Class CampusScheduleBag. */
+export type CampusScheduleBag = {
+    /** Gets or sets the unique identifier. */
+    guid?: Guid | null;
+
+    /** Gets or sets the schedule. */
+    schedule?: ListItemBag | null;
+
+    /** Gets or sets the schedule type value. */
+    scheduleTypeValue?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Core/CampusList/campusListOptionsBag.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 CampusListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/CategoryDetail/categoryBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type CategoryBag = {
+    /** 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 description. */
+    description?: string | null;
+
+    /** Gets or sets the Rock.Model.EntityType that can use this Category. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the entity type qualifier column that contains the value (see Rock.Model.Category.EntityTypeQualifierValue) that is used to narrow the scope of the Category. */
+    entityTypeQualifierColumn?: string | null;
+
+    /** Gets or sets the entity type qualifier value that is used to narrow the scope of the Category to a subset or specific instance of an EntityType. */
+    entityTypeQualifierValue?: string | null;
+
+    /** Gets or sets the color of the highlight. */
+    highlightColor?: string | null;
+
+    /** Gets or sets the name of the icon CSS class. This property is only used for CSS based icons. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this Category is part of the Rock core system/framework. */
+    isSystem: boolean;
+
+    /** Gets or sets the Name of the Category */
+    name?: string | null;
+
+    /** Gets or sets the parent category. */
+    parentCategory?: ListItemBag | null;
+
+    /** Gets or sets the root category. */
+    rootCategoryGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/Core/CategoryDetail/categoryDetailOptionsBag.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 CategoryDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/CategoryDetail/customSettingsBag.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * The settings that will be edited in the custom settings panel for the
+ * Category Detail block.
+ */
+export type CustomSettingsBag = {
+    /** Gets or sets the entity type identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /** Gets or sets the entity type qualifier. */
+    entityTypeQualifierProperty?: string | null;
+
+    /** Gets or sets the entity type qualifier value. */
+    entityTypeQualifierValue?: string | null;
+
+    /** Gets or sets the exclude categories. */
+    excludeCategories?: ListItemBag[] | null;
+
+    /** Gets or sets the root category. */
+    rootCategory?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Core/CategoryDetail/customSettingsOptionsBag.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>
+//
+
+/**
+ * The additional information required to build the custom settings UI
+ * for the Category Detail View block.
+ */
+export type CustomSettingsOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/FollowingEventTypeDetail/followingEventTypeBag.d.ts

@@ -0,0 +1,73 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Following Event Type View Model */
+export type FollowingEventTypeBag = {
+    /** 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 user defined description of the FollowingEvent. */
+    description?: string | null;
+
+    /** Gets or sets how an entity should be formatted when included in the event notification to follower. */
+    entityNotificationFormatLava?: string | null;
+
+    /** Gets or sets the type of the event entity. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the type of the followed entity. */
+    followedEntityType?: ListItemBag | null;
+
+    /** Gets or sets the followed entity type identifier. */
+    followedEntityTypeId?: number | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether [include non public requests]. */
+    includeNonPublicRequests: boolean;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this event is required. If not, followers will be able to optionally select if they want to be notified of this event */
+    isNoticeRequired: boolean;
+
+    /** Gets or sets the last check. */
+    lastCheckDateTime?: string | null;
+
+    /** Gets or sets the (internal) Name of the FollowingEvent. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the order. */
+    order: number;
+
+    /** Gets or sets a value indicating whether [send on weekends]. */
+    sendOnWeekends: boolean;
+};

package/types/ViewModels/Blocks/Core/FollowingEventTypeDetail/followingEventTypeDetailOptionsBag.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 FollowingEventTypeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/InteractionChannelDetail/interactionChannelBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type InteractionChannelBag = {
+    /** 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 channel detail template. */
+    channelDetailTemplate?: string | null;
+
+    /** Gets or sets the channel list template. */
+    channelListTemplate?: string | null;
+
+    /** Gets or sets the length of time (in minutes) that components of this channel should be cached */
+    componentCacheDuration?: number | null;
+
+    /** Gets or sets the component detail template. */
+    componentDetailTemplate?: string | null;
+
+    /** Gets or sets the component list template. */
+    componentListTemplate?: string | null;
+
+    /**
+     * Gets or sets the content displayed in View-Mode. It is generated via Lava using either the DefaultTemplate
+     * block setting or the Rock.ViewModels.Blocks.Core.InteractionChannelDetail.InteractionChannelBag.ChannelDetailTemplate if one is provided.
+     */
+    content?: string | null;
+
+    /** Gets or sets the engagement strength. */
+    engagementStrength?: number | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the interaction custom 1 label. */
+    interactionCustom1Label?: string | null;
+
+    /** Gets or sets the interaction custom 2 label. */
+    interactionCustom2Label?: string | null;
+
+    /** Gets or sets the interaction custom indexed 1 label. */
+    interactionCustomIndexed1Label?: string | null;
+
+    /** Gets or sets the interaction detail template. */
+    interactionDetailTemplate?: string | null;
+
+    /** Gets or sets the interaction list template. */
+    interactionListTemplate?: string | null;
+
+    /** Gets or sets a flag indicating if this is an active group. This value is required. */
+    isActive: boolean;
+
+    /** Gets or sets the interaction channel name. */
+    name?: string | null;
+
+    /** Gets or sets the retention days. */
+    retentionDuration?: number | null;
+
+    /** Gets or sets the session list template. */
+    sessionListTemplate?: string | null;
+};

package/types/ViewModels/Blocks/Core/InteractionChannelDetail/interactionChannelDetailOptionsBag.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 InteractionChannelDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/LocationDetail/addressStandardizationResultBag.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 { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+
+/** AddressStandardizationResultBag */
+export type AddressStandardizationResultBag = {
+    /** Gets or sets the address fields. */
+    addressFields?: AddressControlBag | null;
+
+    /** Gets or sets the geocode attempted result. */
+    geocodeAttemptedResult?: string | null;
+
+    /** Gets or sets the standardize attempted result. */
+    standardizeAttemptedResult?: string | null;
+};