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

package/types/ViewModels/Blocks/Reporting/InteractionComponentDetail/interactionComponentDetailInitializationBox.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>
+//
+
+/** The box that contains all the initialization information for the Interaction Component Detail block. */
+export type InteractionComponentDetailInitializationBox = {
+    /** Gets or sets the name of the component. */
+    componentName?: string | null;
+
+    /** Gets or sets the content. The content is generated using either the Component's LavaTemplate of the block's DefaultLavaTemplate attribute. */
+    content?: string | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Reporting/InteractionDetail/interactionDetailInitializationBox.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The box that contains all the initialization information for the Interaction Detail block. */
+export type InteractionDetailInitializationBox = {
+    content?: string | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Reporting/MergeTemplateDetail/mergeTemplateDetailOptionsBag.d.ts

@@ -21,5 +21,7 @@
 // </copyright>
 //
 
+/** Additional configuration details for the Merge Template Detail block.s */
 export type MergeTemplateDetailOptionsBag = {
+    isBlockVisible: boolean;
 };

package/types/ViewModels/Blocks/Reporting/MetricValueDetail/metricValueBag.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 { MetricValuePartitionBag } from "@Obsidian/ViewModels/Blocks/Reporting/MetricValueDetail/metricValuePartitionBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Metric Value Detail block. */
+export type MetricValueBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the metric value date time. */
+    metricValueDateTime?: string | null;
+
+    /** Gets or sets the metric value partitions. */
+    metricValuePartitions?: MetricValuePartitionBag[] | null;
+
+    /** Gets or sets the type of the metric value. */
+    metricValueType: number;
+
+    /** Gets or sets the note. */
+    note?: string | null;
+
+    /**
+     * Gets or sets the X axis value.
+     * Note that in Rock, graphs typically actually use the MetricValue.MetricValueDateTime as the graph's X Axis.
+     * Therefore, in most cases, Metric.XAxisLabel and MetricValue.XAxis are NOT used
+     */
+    xValue?: string | null;
+
+    /** Gets or sets the Y axis value. */
+    yValue?: number | null;
+};

package/types/ViewModels/Blocks/Reporting/MetricValueDetail/metricValueDetailOptionsBag.d.ts

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Metric Value Detail block. */
+export type MetricValueDetailOptionsBag = {
+    metricValueTypes?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Reporting/MetricValueDetail/metricValuePartitionBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type MetricValuePartitionBag = {
+    /** Gets or sets the configuration details of the entity type as an attribute so a matching field type control is rendered. */
+    attribute?: PublicAttributeBag | null;
+
+    /** Gets or sets the metric partition unique identifier. */
+    metricPartitionGuid: Guid;
+
+    /** Gets or sets the saved entity value. */
+    value?: string | null;
+};

package/types/ViewModels/Blocks/Reporting/PageParameterFilter/getUpdatedFiltersResponseBag.d.ts

@@ -28,6 +28,9 @@ export type GetUpdatedFiltersResponseBag = {
     /** Gets or sets the filter page parameters. */
     filterPageParameters?: Record<string, string> | null;
 
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
     /** Gets or sets the public filters available for selection. */
     publicFilters?: Record<string, PublicAttributeBag> | null;
 

package/types/ViewModels/Blocks/Reporting/PersistedDataViewList/persistedDataViewListOptionsBag.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 Data View List block. */
+export type PersistedDataViewListOptionsBag = {
+};

package/types/ViewModels/Blocks/Reporting/TithingOverview/tithingOverviewInitializationBox.d.ts

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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 { TithingOverviewToolTipBag } from "@Obsidian/ViewModels/Blocks/Reporting/TithingOverview/tithingOverviewToolTipBag";
+
+/** Contains all the initialization information for the Tithing Overview block. */
+export type TithingOverviewInitializationBox = {
+    /** Gets or sets the chart data json. */
+    chartDataJson?: string | null;
+
+    /** Gets or sets the type of the chart. */
+    chartType?: string | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether the data required to create the chart exists. */
+    hasData: boolean;
+
+    /** Gets or sets the legend data. */
+    legendData?: Record<string, string> | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the tool tip data. */
+    toolTipData?: Record<string, TithingOverviewToolTipBag> | null;
+};

package/types/ViewModels/Blocks/Reporting/TithingOverview/tithingOverviewToolTipBag.d.ts

@@ -0,0 +1,63 @@
+//------------------------------------------------------------------------------
+// <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 { CurrencyInfoBag } from "@Obsidian/ViewModels/Utility/currencyInfoBag";
+
+/** Contains all the tooltip information for the Tithing Overview block charts. */
+export type TithingOverviewToolTipBag = {
+    /** Gets or sets the campus. */
+    campus?: string | null;
+
+    /** Gets or sets the campus age. */
+    campusAge?: number | null;
+
+    /** Gets or sets the campus closing date. */
+    campusClosedDate?: string | null;
+
+    /** Gets or sets the campus identifier key. */
+    campusId: number;
+
+    /** Gets or sets the campus opening date. */
+    campusOpenedDate?: string | null;
+
+    /** Gets or sets the campus short code. */
+    campusShortCode?: string | null;
+
+    /** Gets or sets the currency symbol. */
+    currencyInfo?: CurrencyInfoBag | null;
+
+    /** Gets or sets the date. */
+    date?: string | null;
+
+    /** Gets or sets the giving house holds. */
+    givingHouseHolds?: number | null;
+
+    /** Gets or sets the tithe metric. */
+    titheMetric?: number | null;
+
+    /** Gets or sets the tithing house holds. */
+    tithingHouseHolds?: number | null;
+
+    /** Gets or sets the value. */
+    value?: number | null;
+};

package/types/ViewModels/Blocks/Security/AccountEntry/accountEntryInitializationBox.d.ts

@@ -82,6 +82,9 @@ export type AccountEntryInitializationBox = {
     /** Gets or sets a value indicating whether username must be an email. */
     isEmailRequiredForUsername: boolean;
 
+    /** Indicating whether the Gender dropdown is required. */
+    isGenderPickerRequired: boolean;
+
     /** Indicating whether the Gender dropdown is shown. */
     isGenderPickerShown: boolean;
 

package/types/ViewModels/Blocks/Security/AccountEntry/accountEntryRegisterRequestBox.d.ts

@@ -32,9 +32,6 @@ export type AccountEntryRegisterRequestBox = {
     /** Gets or sets the passwordless verification code. */
     code?: string | null;
 
-    /** Gets or sets the fullname of the person. */
-    fullName?: string | null;
-
     /** Gets or sets the person info. */
     personInfo?: AccountEntryPersonInfoBag | null;
 

package/types/ViewModels/Blocks/Tv/AppleTvAppDetail/appleTvAppBag.d.ts

@@ -43,9 +43,6 @@ export type AppleTvAppBag = {
     /** Gets or sets the description. */
     description?: string | null;
 
-    /** Gets or sets a value indicating whether [enable page view geo tracking]. */
-    enablePageViewGeoTracking: boolean;
-
     /** Gets or sets a value indicating whether [enable page views]. */
     enablePageViews: boolean;
 
@@ -65,7 +62,7 @@ export type AppleTvAppBag = {
     name?: string | null;
 
     /** Gets or sets the page view retention period. */
-    pageViewRetentionPeriod?: number | null;
+    pageViewRetentionPeriod?: string | null;
 
     /** Gets or sets a value indicating whether [show application javascript]. */
     showApplicationJavascript: boolean;

package/types/ViewModels/Blocks/Tv/AppleTvPageList/appleTvPageListOptionsBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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 Page List block. */
+export type AppleTvPageListOptionsBag = {
+    /** Gets or sets the default page identifier key of the current application. */
+    defaultPageIdKey?: string | null;
+
+    /** Gets or sets a value indicating whether the block is visible, the block is displayed if an ApplicationId is provided as a query parameter. */
+    isBlockVisible: boolean;
+};

package/types/ViewModels/Blocks/WebFarm/WebFarmSettings/webFarmSettingsBag.d.ts

@@ -39,7 +39,7 @@ export type WebFarmSettingsBag = {
     idKey?: string | null;
 
     /** Gets or sets a value indicating whether this instance is active. */
-    isActive: boolean;
+    isEnabled: boolean;
 
     /** Gets or sets a value indicating whether this instance is in memory transport. */
     isInMemoryTransport: boolean;

package/types/ViewModels/Blocks/Workflow/WorkflowTriggerDetail/workflowTriggerBag.d.ts

@@ -64,6 +64,9 @@ export type WorkflowTriggerBag = {
     /** Gets or sets the qualifier columns. */
     qualifierColumns?: ListItemBag[] | null;
 
+    /** Gets or sets the readonly notification message. */
+    readonlyNotificationMessage?: string | null;
+
     /** Gets or sets a value indicating whether [show previous and alt qualifier value text boxes]. */
     showPreviousAndAltQualifierValueTextBoxes: boolean;
 

package/types/ViewModels/Blocks/Workflow/WorkflowTriggerDetail/workflowTriggerDetailOptionsBag.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 WorkflowTriggerDetailOptionsBag = {
+};

package/types/ViewModels/Controls/datePartsPickerValueBag.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>
+//
+
+/** Address Control View Model */
+export type DatePartsPickerValueBag = {
+    /** The Day. */
+    day: number;
+
+    /** The Month. */
+    month: number;
+
+    /** The Year. */
+    year: number;
+};

package/types/ViewModels/Controls/fieldPropertyItemBag.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 { FieldFormat } from "@Obsidian/Enums/Controls/fieldFormat";
+
+/**
+ * POCO to store the settings for the fields.
+ * This is copied from Rock/Mobile/JsonFields/FieldSetting.cs. If any changes are made here,
+ * they may need to be copied there as well.
+ */
+export type FieldPropertyItemBag = {
+    /** Gets or sets the category for this item. */
+    category?: string | null;
+
+    /** Gets or sets disabled for this item. */
+    disabled?: boolean | null;
+
+    /** Gets or sets the field source. */
+    fieldFormat: FieldFormat;
+
+    /** Gets or sets the text. */
+    text?: string | null;
+
+    /** Gets or sets the value. */
+    value?: string | null;
+};

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

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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 { AttributeFormat } from "@Obsidian/Enums/Controls/attributeFormat";
+import { FieldFormat } from "@Obsidian/Enums/Controls/fieldFormat";
+import { FieldSource } from "@Obsidian/Enums/Controls/fieldSource";
+
+/**
+ * POCO to store the settings for the fields.
+ * This is copied from Rock/Mobile/JsonFields/FieldSetting.cs. If any changes are made here,
+ * they may need to be copied there as well.
+ */
+export type FieldSettingBag = {
+    /** Gets or sets the attribute format. */
+    attributeFormat: AttributeFormat;
+
+    /** Gets or sets the field format. */
+    fieldFormat: FieldFormat;
+
+    /** Gets or sets the name of the property. */
+    fieldName?: string | null;
+
+    /** Gets or sets the field source. */
+    fieldSource: FieldSource;
+
+    /** Creates an identifier based off the key. This is used for grid operations. */
+    id: number;
+
+    /** Gets or sets the field key. */
+    key?: string | null;
+
+    /** Gets or sets the field value. */
+    value?: string | null;
+};