@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/ViewModels/Blocks/Communication/CommunicationFlowList/communicationFlowListOptionsBag.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 Communication Flow List block. */
+export type CommunicationFlowListOptionsBag = {
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/communicationFlowInstanceBag.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>
+//
+
+/** A bag that contains information about a Communication Flow Instance for the Communication Flow Performance block. */
+export type CommunicationFlowInstanceBag = {
+    /** Gets or sets the identifier key for the Communication Flow Instance. */
+    communicationFlowInstanceIdKey?: string | null;
+
+    /** Gets or sets the Communication Flow Instance start date. */
+    startDate?: string | null;
+
+    /** Gets a list of the unique person alias identifier keys. */
+    uniquePersonAliasIdKeys?: string[] | null;
+
+    /** Gets or sets the count of unique people in this Communication Flow Instance. */
+    uniquePersonCount: number;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/completedFormSettingsBag.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";
+
+/** The conversion goal settings for the Communication Flow Performance block when the conversion goal type is "Completed Form". */
+export type CompletedFormSettingsBag = {
+    /** Gets or sets the form (Workflow Type) that needs to be completed in order for the conversion goal to be achieved. */
+    workflowType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/conversionGoalSettingsBag.d.ts

@@ -0,0 +1,50 @@
+//------------------------------------------------------------------------------
+// <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 { CompletedFormSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/completedFormSettingsBag";
+import { EnteredDataViewSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/enteredDataViewSettingsBag";
+import { JoinedGroupSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/joinedGroupSettingsBag";
+import { JoinedGroupTypeSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/joinedGroupTypeSettingsBag";
+import { RegisteredSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/registeredSettingsBag";
+import { TookStepSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/tookStepSettingsBag";
+
+/** The conversion goal settings for the Communication Flow Performance block. */
+export type ConversionGoalSettingsBag = {
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Completed Form". */
+    completedFormSettings?: CompletedFormSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Entered Data View". */
+    enteredDataViewSettings?: EnteredDataViewSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Joined Specific Group". */
+    joinedGroupSettings?: JoinedGroupSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Joined Group Of Type". */
+    joinedGroupTypeSettings?: JoinedGroupTypeSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Registered". */
+    registeredSettings?: RegisteredSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Completed Step". */
+    tookStepSettings?: TookStepSettingsBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/enteredDataViewSettingsBag.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";
+
+/** The conversion goal settings for the Communication Flow Performance block when the conversion goal type is "Entered Data View". */
+export type EnteredDataViewSettingsBag = {
+    /** Gets or sets the Data View that needs to be entered for the conversion goal to be achieved. */
+    dataView?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/gridRowBag.d.ts

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { CommunicationType } from "@Obsidian/Enums/Communication/communicationType";
+
+/** Bag containing a row of data for the grid in the Communication Flow Performance block. */
+export type GridRowBag = {
+    /** Gets or sets the number of clicks. */
+    clicks: number;
+
+    /** Gets or sets the communication flow instance identifier key. */
+    communicationFlowCommunicationIdKey?: string | null;
+
+    /** Gets or sets the name of the communication flow communication. */
+    communicationFlowCommunicationName?: string | null;
+
+    /** Gets or sets the communication flow instance communication identifier key. */
+    communicationFlowInstanceCommunicationIdKey?: string | null;
+
+    /** Gets or sets the communication flow instance identifier key. */
+    communicationFlowInstanceIdKey?: string | null;
+
+    /** Gets or sets the instance start date. */
+    communicationFlowInstanceStartDate?: string | null;
+
+    /** Gets or sets the type of the communication. */
+    communicationType: CommunicationType;
+
+    /** Gets or sets the number of conversions. */
+    conversions: number;
+
+    /** Gets or sets the number of opens. */
+    opens: number;
+
+    /** Gets or sets the number of messages sent. */
+    sent: number;
+
+    /** Gets or sets the number of unsubscribes. */
+    unsubscribes: number;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/initializationBox.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 { PerformanceBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/performanceBag";
+import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+
+/** Initialization box for the Communication Flow Performance block. */
+export type InitializationBox = {
+    /**
+     * 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 flow performance. */
+    flowPerformance?: PerformanceBag | null;
+
+    /** Gets or sets the grid definition. */
+    gridDefinition?: GridDefinitionBag | 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/Communication/CommunicationFlowPerformance/joinedGroupSettingsBag.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";
+
+/** The conversion goal settings for the Communication Flow Performance block when the conversion goal type is "Joined Specific Group". */
+export type JoinedGroupSettingsBag = {
+    /** Gets or sets the Group that needs to be joined for the conversion goal to be achieved. */
+    group?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/joinedGroupTypeSettingsBag.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";
+
+/** The conversion goal settings for the Communication Flow Performance block when the conversion goal type is "Joined Group Of Type". */
+export type JoinedGroupTypeSettingsBag = {
+    /** Gets or sets the Group Type that needs to be joined for the conversion goal to be achieved. */
+    groupType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/messageBag.d.ts

@@ -0,0 +1,70 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationType } from "@Obsidian/Enums/Communication/communicationType";
+import { UnsubscribeLevel } from "@Obsidian/Enums/Communication/unsubscribeLevel";
+
+/** Bag containing information about a specific message that was sent as part of a communication flow. */
+export type MessageBag = {
+    /** Gets or sets the date/time the message was clicked. */
+    clickedDateTime?: string | null;
+
+    /** Gets or sets the communication flow communication identifier key. */
+    communicationFlowCommunicationIdKey?: string | null;
+
+    /** Gets or sets the name of the communication flow communication. */
+    communicationFlowCommunicationName?: string | null;
+
+    /** Gets or sets the communication flow instance communication identifier key. */
+    communicationFlowInstanceCommunicationIdKey?: string | null;
+
+    /** Gets or sets the communication flow instance identifier key. */
+    communicationFlowInstanceIdKey?: string | null;
+
+    /** Gets or sets the instance start date. */
+    communicationFlowInstanceStartDate?: string | null;
+
+    /** Gets or sets the type of the communication. */
+    communicationType: CommunicationType;
+
+    /** Gets or sets the end date of the conversion goal. */
+    conversionGoalEndDate?: string | null;
+
+    /** Gets or sets the date/time the person converted. */
+    convertedDateTime?: string | null;
+
+    /** Gets or sets the date/time the message was opened. */
+    openedDateTime?: string | null;
+
+    /** Gets or sets the person alias identifier key. */
+    personAliasIdKey?: string | null;
+
+    /** Gets or sets the date/time the message was sent. */
+    sentDateTime?: string | null;
+
+    /** Gets or sets the date/time the person unsubscribed. */
+    unsubscribedDateTime?: string | null;
+
+    /** Gets or sets the unsubscribe level. */
+    unsubscribeLevel?: UnsubscribeLevel | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/performanceBag.d.ts

@@ -0,0 +1,64 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationFlowTriggerType } from "@Obsidian/Enums/Communication/communicationFlowTriggerType";
+import { ConversionGoalType } from "@Obsidian/Enums/Communication/conversionGoalType";
+import { CommunicationFlowInstanceBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/communicationFlowInstanceBag";
+import { ConversionGoalSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/conversionGoalSettingsBag";
+import { MessageBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowPerformance/messageBag";
+
+/** Bag containing information about the performance of a communication flow. */
+export type PerformanceBag = {
+    /** Gets or sets the number of communications in each flow instance. */
+    communicationCount: number;
+
+    /** Gets or sets the communication flow identifier key. */
+    communicationFlowIdKey?: string | null;
+
+    /** Gets or sets the name of the communication flow. */
+    communicationFlowName?: string | null;
+
+    /** Gets or sets the start date of the flow. */
+    communicationFlowStartDateTime?: string | null;
+
+    /** Gets or sets the conversion goal settings. */
+    conversionGoalSettings?: ConversionGoalSettingsBag | null;
+
+    /** Gets or sets the conversion goal target percent. */
+    conversionGoalTargetPercent?: number | null;
+
+    /** Gets or sets the conversion goal timeframe in days. */
+    conversionGoalTimeframeInDays?: number | null;
+
+    /** Gets or sets the type of the conversion goal. */
+    conversionGoalType?: ConversionGoalType | null;
+
+    /** Gets or sets the communication flow instances in this communication flow. */
+    instances?: CommunicationFlowInstanceBag[] | null;
+
+    /** Gets or sets the messages that are part of this communication flow's instances. */
+    messages?: MessageBag[] | null;
+
+    /** Gets or sets the type of the trigger that kicks off new communication flow instances. */
+    triggerType: CommunicationFlowTriggerType;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/registeredSettingsBag.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";
+
+/** The conversion goal settings for the Communication Flow Performance block when the conversion goal type is "Registered". */
+export type RegisteredSettingsBag = {
+    /** Gets or sets the Registration Instance that needs to be joined for the conversion goal to be achieved. */
+    registrationInstance?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowPerformance/tookStepSettingsBag.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";
+
+/** The conversion goal settings for the Communication Flow Performance block when the conversion goal type is "Completed Step". */
+export type TookStepSettingsBag = {
+    /** Gets or sets the Step Type that needs to be taken for the conversion goal to be achieved. */
+    stepType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationList/communicationListOptionsBag.d.ts

@@ -25,15 +25,21 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 /** The additional configuration options for the Communication List block. */
 export type CommunicationListOptionsBag = {
-    /** Gets or sets a value indicating whether the current user can approve new communications. */
-    canApprove: boolean;
+    /** Gets or sets whether an active email transport exists. */
+    hasActiveEmailTransport: boolean;
 
-    /** Gets or sets the communication types for the communication type filter dropdown. */
-    communicationTypeItems?: ListItemBag[] | null;
+    /** Gets or sets whether an active push transport exists. */
+    hasActivePushTransport: boolean;
 
-    /** Gets or sets the current person. */
-    currentPerson?: ListItemBag | null;
+    /** Gets or sets whether an active SMS transport exists. */
+    hasActiveSmsTransport: boolean;
 
-    /** Gets or sets the status types for the status filter dropdown. */
-    statusItems?: ListItemBag[] | null;
+    /** Gets or sets whether to show the "sent by" filter controls. */
+    showSentByFilter: boolean;
+
+    /**
+     * Gets or sets the list of communication topic defined value items - both active and inactive - that the
+     * individual can filter by.
+     */
+    topicItems?: ListItemBag[] | null;
 };

package/types/ViewModels/Blocks/Communication/CommunicationSaturationReport/communicationSaturationReportBlockBox.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { CommunicationSaturationReportFiltersBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationSaturationReport/communicationSaturationReportFiltersBag";
+import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+
+export type CommunicationSaturationReportBlockBox = {
+    /** The grid configuration for the communications grid. */
+    communicationsGridBox?: GridDefinitionBag | 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;
+
+    /** The primary options and filter values for the block. */
+    filters?: CommunicationSaturationReportFiltersBag | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** The grid configuration for the recipients grid. */
+    recipientsGridBox?: GridDefinitionBag | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};