@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/ViewModels/Blocks/Core/DefinedTypeDetail/definedTypeBag.d.ts

@@ -0,0 +1,71 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+/** The item details for the Defined Type Detail block. */
+export type DefinedTypeBag = {
+    /** 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 flag indicating if the Defined Values associated with this Defined Type can be grouped into categories. */
+    categorizedValuesEnabled?: boolean | null;
+
+    /** Gets or sets the category. */
+    category?: ListItemBag | null;
+
+    /** Gets or sets the defined type attributes. */
+    definedTypeAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** Gets or sets a user defined description of the DefinedType. */
+    description?: string | null;
+
+    /** Gets or sets a value indicating whether the DefinedValues for this DefinedType should allow security settings. */
+    enableSecurityOnValues: boolean;
+
+    /** Gets or sets the help text for the defined type. */
+    helpText?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this Defined Type is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether the block is being used on a stand alone page ( i.e. not navigated to through defined type list ) */
+    isStandAlone: boolean;
+
+    /** Gets or sets a flag indicating if this DefinedType is part of the Rock core system/framework. This property is required. */
+    isSystem: boolean;
+
+    /** Gets or sets the Name of the DefinedType. */
+    name?: string | null;
+
+    /** Gets or sets the report detail page URL. */
+    reportDetailPageUrl?: string | null;
+};

package/types/ViewModels/Blocks/Core/DefinedTypeDetail/definedTypeDetailOptionsBag.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>
+//
+
+/** The additional configuration options for the Defined Type Detail block. */
+export type DefinedTypeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/DefinedTypeList/definedTypeListOptionsBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <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 configuration options for the Defined Type List block. */
+export type DefinedTypeListOptionsBag = {
+    /** Determines if the category column should be displayed. */
+    showCategoryColumn: boolean;
+};

package/types/ViewModels/Blocks/Core/DefinedValueList/definedValueBag.d.ts

@@ -38,6 +38,9 @@ export type DefinedValueBag = {
     /** Gets or sets the Description of the DefinedValue. */
     description?: string | null;
 
+    /** Gets or sets the identifier. */
+    id: number;
+
     /** Gets or sets the identifier key of this entity. */
     idKey?: string | null;
 

package/types/ViewModels/Blocks/Core/DeviceDetail/deviceBag.d.ts

@@ -0,0 +1,85 @@
+//------------------------------------------------------------------------------
+// <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 { CameraBarcodeConfiguration } from "@Obsidian/Enums/Core/cameraBarcodeConfiguration";
+import { KioskType } from "@Obsidian/Enums/Core/kioskType";
+import { PrintFrom } from "@Obsidian/Enums/Core/printFrom";
+import { PrintTo } from "@Obsidian/Enums/Core/printTo";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type DeviceBag = {
+    /** 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 type of the camera barcode configuration. */
+    cameraBarcodeConfigurationType?: CameraBarcodeConfiguration | null;
+
+    /** Gets or sets a description of the device. */
+    description?: string | null;
+
+    /** Gets or sets the Rock.Model.DefinedValue that represents the type of the device. */
+    deviceType?: ListItemBag | null;
+
+    /** Gets or sets the geop fence. */
+    geoFence?: string | null;
+
+    /** Gets or sets the geop point. */
+    geoPoint?: string | null;
+
+    /** Gets or sets a value indicating whether this instance has camera. */
+    hasCamera: boolean;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the IP address of the device. */
+    ipAddress?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets the type of the kiosk. */
+    kioskType?: KioskType | null;
+
+    /** Gets or sets the physical location or geographic fence for the device. */
+    location?: ListItemBag | null;
+
+    /** Gets or sets the locations. */
+    locations?: ListItemBag[] | null;
+
+    /** Gets or sets the device name. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the printer that is associated with this device.  */
+    printerDevice?: ListItemBag | null;
+
+    /** Gets or sets where print jobs for this device originates from. */
+    printFrom: PrintFrom;
+
+    /** Gets or sets a flag that overrides which printer the print job is set to. */
+    printToOverride: PrintTo;
+};

package/types/ViewModels/Blocks/Core/DeviceDetail/deviceDetailOptionsBag.d.ts

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type DeviceDetailOptionsBag = {
+    /** Gets or sets the camera barcode configuration options. */
+    cameraBarcodeConfigurationOptions?: ListItemBag[] | null;
+
+    /** Gets or sets the kiosk type options. */
+    kioskTypeOptions?: ListItemBag[] | null;
+
+    /** Gets or sets the map style value unique identifier. */
+    mapStyleValueGuid?: string | null;
+
+    /** Gets or sets the printer options. */
+    printerOptions?: ListItemBag[] | null;
+
+    /** Gets or sets the print from options. */
+    printFromOptions?: ListItemBag[] | null;
+
+    /** Gets or sets the print to options. */
+    printToOptions?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Core/DeviceList/deviceListOptionsBag.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>
+//
+
+/** The additional configuration options for the Device List block. */
+export type DeviceListOptionsBag = {
+};

package/types/ViewModels/Blocks/{Crm → Core}/DocumentTypeDetail/documentTypeBag.d.ts

@@ -65,7 +65,7 @@ export type DocumentTypeBag = {
     isSystem: boolean;
 
     /** Gets or sets the maximum documents per entity.  This would limit the documents of that type per entity. A blank value means no limit. */
-    maxDocumentsPerEntity?: number | null;
+    maxDocumentsPerEntity?: string | null;
 
     /** Gets or sets the given Name of the DocumentType. */
     name?: string | null;

package/types/ViewModels/Blocks/Core/DocumentTypeList/documentTypeListOptionsBag.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>
+//
+
+/** The additional configuration options for the Document Type List block. */
+export type DocumentTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/EntitySearchDetail/entitySearchBag.d.ts

@@ -0,0 +1,106 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** The item details for the Entity Search Detail block. */
+export type EntitySearchBag = {
+    /** 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 text that describes the purpose of this search. */
+    description?: string | null;
+
+    /** Gets or sets the Entity Type that will be queried by this search. */
+    entityType?: ListItemBag | null;
+
+    /**
+     * Gets or sets the expression that will be used to group the results.
+     * This is processed after Rock.Model.EntitySearch.WhereExpression.
+     */
+    groupByExpression?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the property paths to be included by Entity Framework. */
+    includePaths?: string | null;
+
+    /** Gets or sets a value indicating whether this search is active. */
+    isActive: boolean;
+
+    /**
+     * Gets or sets a value indicating whether this search will
+     * enforce entity security. Entity security has a pretty heafty
+     * performance hit and should only be used when it is actually needed.
+     */
+    isEntitySecurityEnabled: boolean;
+
+    /**
+     * Gets or sets a value indicating whether search query will allow
+     * custom refinement options in the form of an additional user query.
+     */
+    isRefinementAllowed: boolean;
+
+    /**
+     * Gets or sets the  key of this search. This is used to identify
+     * this search item through the API and Lava. This value must be
+     * unique for a given Rock.Model.EntitySearch.EntityTypeId. This property
+     * is required.
+     */
+    key?: string | null;
+
+    /**
+     * Gets or sets the maximum number of results per query. More data can
+     * be retrieved by subsequent queries that skip the first n items.
+     */
+    maximumResultsPerQuery?: number | null;
+
+    /** Gets or sets the name of the search query. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the expression that will be used to define the structure
+     * of the resulting items. This is processed after Rock.Model.EntitySearch.GroupByExpression.
+     */
+    selectExpression?: string | null;
+
+    /**
+     * Gets or sets the expression that will be used to define the structure
+     * of the resulting items. This is processed after Rock.Model.EntitySearch.GroupByExpression.
+     */
+    selectManyExpression?: string | null;
+
+    /**
+     * Gets or sets the expression that will be used to sort the results.
+     * This is processed after Rock.Model.EntitySearch.SelectExpression.
+     */
+    sortExpression?: string | null;
+
+    /** Gets or sets the expression that will be used to filter the query. */
+    whereExpression?: string | null;
+};

package/types/ViewModels/Blocks/Core/EntitySearchDetail/entitySearchDetailOptionsBag.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>
+//
+
+/** The additional configuration options for the Entity Search Detail block. */
+export type EntitySearchDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/EntitySearchDetail/previewResultsBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The results from a preview query request. */
+export type PreviewResultsBag = {
+    /** Gets or sets the data returned by the query, encoded as a JSON string. */
+    data?: string | null;
+
+    /** Gets or sets the duration of the query in milliseconds. */
+    duration: number;
+
+    /** Gets or sets the number of queries generated to perform the search. */
+    queryCount: number;
+};

package/types/ViewModels/Blocks/Core/EntitySearchList/entitySearchListOptionsBag.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>
+//
+
+/** The additional configuration options for the Entity Search List block. */
+export type EntitySearchListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/EventList/eventListOptionsBag.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>
+//
+
+/** The additional configuration options for the Event List block. */
+export type EventListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/FollowingSuggestionTypeList/followingSuggestionTypeListOptionsBag.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>
+//
+
+/** The additional configuration options for the Following Suggestion Type List block. */
+export type FollowingSuggestionTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/InteractionChannelDetail/interactionChannelBag.d.ts

@@ -40,7 +40,7 @@ export type InteractionChannelBag = {
     channelListTemplate?: string | null;
 
     /** Gets or sets the length of time (in minutes) that components of this channel should be cached */
-    componentCacheDuration?: string | null;
+    componentCacheDuration?: number | null;
 
     /** Gets or sets the component detail template. */
     componentDetailTemplate?: string | null;
@@ -55,7 +55,7 @@ export type InteractionChannelBag = {
     content?: string | null;
 
     /** Gets or sets the engagement strength. */
-    engagementStrength?: string | null;
+    engagementStrength?: number | null;
 
     /** Gets or sets the identifier key of this entity. */
     idKey?: string | null;
@@ -82,7 +82,7 @@ export type InteractionChannelBag = {
     name?: string | null;
 
     /** Gets or sets the retention days. */
-    retentionDuration?: string | null;
+    retentionDuration?: number | null;
 
     /** Gets or sets the session list template. */
     sessionListTemplate?: string | null;

package/types/ViewModels/Blocks/Core/LocationList/locationListOptionsBag.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>
+//
+
+/** The additional configuration options for the Location List block. */
+export type LocationListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/LogViewer/rockLogEventsBag.d.ts

@@ -23,11 +23,11 @@
 
 /** Describes the Rock Log Events */
 export type RockLogEventsBag = {
+    category?: string | null;
+
     /** Gets or sets the DateTime */
     dateTime?: string | null;
 
-    domain?: string | null;
-
     exception?: string | null;
 
     level?: string | null;