@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Bus/QueueDetail/queueDetailOptionsBag.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 QueueDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/AdaptiveMessageAdaptationDetail/adaptiveMessageAdaptationBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <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 AdaptiveMessageAdaptationBag = {
+    /** 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 identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the order. */
+    order: number;
+
+    /** Gets or sets the segment ids. */
+    segments?: string[] | null;
+
+    /** Gets or sets the view saturation count. */
+    viewSaturationCount?: number | null;
+
+    /** Gets or sets the view saturation in days. */
+    viewSaturationInDays?: number | null;
+};

package/types/ViewModels/Blocks/Cms/AdaptiveMessageAdaptationDetail/adaptiveMessageAdaptationDetailOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Adaptive Message Adaptation Detail Options Bag */
+export type AdaptiveMessageAdaptationDetailOptionsBag = {
+    /** Gets or sets the segment options. */
+    segmentOptions?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/AdaptiveMessageDetail/adaptiveMessageBag.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 { GridDataBag } from "@Obsidian/ViewModels/Core/Grid/gridDataBag";
+import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+export type AdaptiveMessageBag = {
+    /** The adaptation Attributes */
+    adaptationAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** Gets or sets the adaptations grid data. */
+    adaptationsGridData?: GridDataBag | null;
+
+    /** Gets or sets the step type adaptations grid definition. */
+    adaptationsGridDefinition?: GridDefinitionBag | null;
+
+    /** The adaptation shared Attributes */
+    adaptationSharedAttributes?: PublicEditableAttributeBag[] | 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 collection of Categories that this Rock.Model.AdaptiveMessage is associated with.
+     * NOTE: Since changes to Categories isn't tracked by ChangeTracker, set the ModifiedDateTime if Categories are modified.
+     */
+    categories?: 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;
+
+    /** Gets or sets the key. */
+    key?: string | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Cms/AdaptiveMessageDetail/adaptiveMessageDetailOptionsBag.d.ts

@@ -0,0 +1,27 @@
+//------------------------------------------------------------------------------
+// <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 AdaptiveMessageDetailOptionsBag = {
+    /** Gets or sets the reserved key names. */
+    reservedKeyNames?: string[] | null;
+};

package/types/ViewModels/Blocks/Cms/AdaptiveMessageList/adaptiveMessageListOptionsBag.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 AdaptiveMessageListOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/BlockTypeDetail/blockTypeBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type BlockTypeBag = {
+    /** 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 of the BlockType.  Blocks will be grouped by category when displayed to user */
+    category?: string | null;
+
+    /** Gets or sets the user defined description of the BlockType. */
+    description?: string | null;
+
+    /** Gets or sets the type of the entity. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this Block exists. */
+    isBlockExists: boolean;
+
+    /** Gets or sets a flag indicating if this BlockType was created by and is a part of the Rock core system/framework. This property is required. */
+    isSystem: boolean;
+
+    /** Gets or sets the name of the Layouts having the Block of the given Block Type. */
+    layouts?: string[] | null;
+
+    /** Gets or sets the name of the BlockType. */
+    name?: string | null;
+
+    /** Gets or sets the name of the fully qualified page referencing Block Type. */
+    pages?: string[] | null;
+
+    /** Gets or sets relative path to the .Net ASCX UserControl that provides the HTML Markup and code for the BlockType. */
+    path?: string | null;
+
+    /** Gets or sets the name of the Sites having the Block of the given Block Type. */
+    sites?: string[] | null;
+};

package/types/ViewModels/Blocks/Cms/BlockTypeDetail/blockTypeDetailOptionsBag.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 BlockTypeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/attributeFilterBag.d.ts

@@ -0,0 +1,62 @@
+//------------------------------------------------------------------------------
+// <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 { ContentCollectionFilterControl } from "@Obsidian/Enums/Cms/contentCollectionFilterControl";
+import { Guid } from "@Obsidian/Types";
+
+/** Represents a single attribute filter for a content collection. */
+export type AttributeFilterBag = {
+    /** Gets or sets the internal identification key of the attribute. */
+    attributeKey?: string | null;
+
+    /** Gets or sets the friendly name of the attribute. */
+    attributeName?: string | null;
+
+    /** Gets or sets the field type unique identifier used by this filter. */
+    fieldTypeGuid?: Guid | null;
+
+    /** Gets or sets the friendly field type name used by this filter. */
+    fieldTypeName?: string | null;
+
+    /** Gets or sets the type of control to use when displaying this filter. */
+    filterControl: ContentCollectionFilterControl;
+
+    /** Gets or sets the friendly label to use when displaying this filter. */
+    filterLabel?: string | null;
+
+    /** Gets or sets the enabled state of this attribute filter. */
+    isEnabled: boolean;
+
+    /**
+     * Gets or sets a value that indicates if this filter is in an
+     * inconsistent state. If true then editing should not be
+     * allowed.
+     */
+    isInconsistent: boolean;
+
+    /** Gets or sets if multiple selections are allowed. */
+    isMultipleSelection: boolean;
+
+    /** Gets or sets the names of the sources that make up this filter. */
+    sourceNames?: string[] | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/availableContentSourceBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Identifies a single collection content source object in the system
+ * that could be added to the collection.
+ */
+export type AvailableContentSourceBag = {
+    /** Gets or sets the attributes that can be selected on the potential source. */
+    attributes?: ListItemBag[] | null;
+
+    /** Gets or sets the unique identifier of the potential source. */
+    guid?: Guid | null;
+
+    /** Gets or sets the friendly name of the potential source. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/contentCollectionBag.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 { ContentSourceBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionDetail/contentSourceBag";
+import { FilterSettingsBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionDetail/filterSettingsBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Class ContentCollectionBag.
+ * Implements the Rock.ViewModels.Utility.EntityBagBase
+ */
+export type ContentCollectionBag = {
+    /** 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 collection key. */
+    collectionKey?: string | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets a value indicating whether personalization request filters should be enabled. */
+    enableRequestFilters: boolean;
+
+    /** Gets or sets a value indicating whether personalization segments should be enabled. */
+    enableSegments: boolean;
+
+    /** Gets or sets the filter settings. */
+    filterSettings?: FilterSettingsBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the last index date time. */
+    lastIndexDateTime?: string | null;
+
+    /** Gets or sets the last index item count. */
+    lastIndexItemCount?: number | null;
+
+    /** Gets or sets the name of the ContentCollection. This property is required. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the sources that are currently configured for this
+     * collection. This value is not used during save operations.
+     */
+    sources?: ContentSourceBag[] | null;
+
+    /** Gets or sets a value indicating whether trending is enabled. */
+    trendingEnabled: boolean;
+
+    /** Gets or sets the trending gravity to apply more weight to items that are newer. */
+    trendingGravity: number;
+
+    /** Gets or sets the trending max items. This property is required. */
+    trendingMaxItems: number;
+
+    /** Gets or sets the trending window day. This property is required. */
+    trendingWindowDay: number;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/contentCollectionDetailOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Class ContentCollectionDetailOptionsBag. */
+export type ContentCollectionDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/contentSourceBag.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 { Guid } from "@Obsidian/Types";
+import { ContentCollectionCustomFieldBag } from "@Obsidian/ViewModels/Cms/contentCollectionCustomFieldBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Identifies a single content source that will be displayed in the list
+ * of collection sources.
+ */
+export type ContentSourceBag = {
+    /**
+     * Gets or sets the attributes that are enabled for this content
+     * collection source.
+     */
+    attributes?: ListItemBag[] | null;
+
+    /**
+     * Gets or sets the CSS color to use when displaying this content
+     * collection source. This will be in the format #rrggbb.
+     */
+    color?: string | null;
+
+    /**
+     * Gets or sets the custom fields that when indexing content for
+     * this source.
+     */
+    customFields?: ContentCollectionCustomFieldBag[] | null;
+
+    /** Gets or sets the unique identifier of the entity this source references. */
+    entityGuid?: Guid | null;
+
+    /**
+     * Gets or sets the unique identifier of the entity type this source
+     * references.
+     */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the unique identifier of this content collection source
+     * record. This is not the unique identifier of the target entity.
+     */
+    guid?: Guid | null;
+
+    /**
+     * Gets or sets the CSS icon class to use when displaying this
+     * content collection source.
+     */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the number of items that exist on this content collection source. */
+    itemCount: number;
+
+    /** Gets or sets the friendly name of this content collection source. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the number of occurrences to include when indexing
+     * this source.
+     */
+    occurrencesToShow: number;
+};