@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailCommunicationTemplateBag.d.ts

@@ -0,0 +1,97 @@
+//------------------------------------------------------------------------------
+// <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 { PushOpenAction } from "@Obsidian/Enums/Blocks/Communication/CommunicationFlowDetail/pushOpenAction";
+import { CommunicationTemplateUsageType } from "@Obsidian/Enums/Communication/communicationTemplateUsageType";
+import { Guid } from "@Obsidian/Types";
+import { PageRouteValueBag } from "@Obsidian/ViewModels/Rest/Controls/pageRouteValueBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Represents the communication template details for the Communication Flow Detail block. */
+export type CommunicationFlowDetailCommunicationTemplateBag = {
+    /** Gets or sets the email attachment binary files. */
+    emailAttachmentBinaryFiles?: ListItemBag[] | null;
+
+    /** Gets or sets the email address of the sender. */
+    fromEmail?: string | null;
+
+    /** Gets or sets the name of the sender. */
+    fromName?: string | null;
+
+    /** Gets or sets the unique identifier for the communication template. */
+    guid: Guid;
+
+    /** Gets or sets the binary file for the template preview. */
+    imageFile?: ListItemBag | null;
+
+    /** Gets or sets the message content. */
+    message?: string | null;
+
+    /** Gets or sets the name of the communication template. */
+    name?: string | null;
+
+    /** Gets or sets the message content of the push notification. */
+    pushMessage?: string | null;
+
+    /** Gets or sets the push mobile application. */
+    pushMobileApplication?: ListItemBag | null;
+
+    /** Gets or sets the mobile page for the push notification. */
+    pushMobilePage?: PageRouteValueBag | null;
+
+    /** Gets or sets the query string parameters for the push mobile page. */
+    pushMobilePageQueryString?: Record<string, string> | null;
+
+    /** Gets or sets the push open action. */
+    pushOpenAction?: PushOpenAction | null;
+
+    /** Gets or sets the push open message. */
+    pushOpenMessage?: string | null;
+
+    /** Gets or sets the push open message structured content JSON. */
+    pushOpenMessageJson?: string | null;
+
+    /** Gets or sets the title of the push notification. */
+    pushTitle?: string | null;
+
+    /** Gets or sets the URL for the push notification. */
+    pushUrl?: string | null;
+
+    /** Gets or sets the reply-to email address. */
+    replyToEmail?: string | null;
+
+    /** Gets or sets the SMS attachment binary file. */
+    smsAttachmentBinaryFile?: ListItemBag | null;
+
+    /** Gets or sets the system phone number used for SMS sending. */
+    smsFromSystemPhoneNumber?: ListItemBag | null;
+
+    /** Gets or sets the SMS message content. */
+    smsMessage?: string | null;
+
+    /** Gets or sets the subject of the email. */
+    subject?: string | null;
+
+    /** Gets or sets the usage type for the template. */
+    usageType?: CommunicationTemplateUsageType | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailCompletedFormSettingsBag.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 Detail block when the conversion goal type is "Completed Form". */
+export type CommunicationFlowDetailCompletedFormSettingsBag = {
+    /** 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/CommunicationFlowDetail/communicationFlowDetailConversionGoalSettingsBag.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 { CommunicationFlowDetailCompletedFormSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailCompletedFormSettingsBag";
+import { CommunicationFlowDetailEnteredDataViewSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailEnteredDataViewSettingsBag";
+import { CommunicationFlowDetailJoinedGroupSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailJoinedGroupSettingsBag";
+import { CommunicationFlowDetailJoinedGroupTypeSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailJoinedGroupTypeSettingsBag";
+import { CommunicationFlowDetailRegisteredSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailRegisteredSettingsBag";
+import { CommunicationFlowDetailTookStepSettingsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailTookStepSettingsBag";
+
+/** The conversion goal settings for the Communication Flow Detail block. */
+export type CommunicationFlowDetailConversionGoalSettingsBag = {
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Completed Form". */
+    completedFormSettings?: CommunicationFlowDetailCompletedFormSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Entered Data View". */
+    enteredDataViewSettings?: CommunicationFlowDetailEnteredDataViewSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Joined Specific Group". */
+    joinedGroupSettings?: CommunicationFlowDetailJoinedGroupSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Joined Group Of Type". */
+    joinedGroupTypeSettings?: CommunicationFlowDetailJoinedGroupTypeSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Registered". */
+    registeredSettings?: CommunicationFlowDetailRegisteredSettingsBag | null;
+
+    /** Gets or sets the conversion goal settings when the conversion goal type is "Completed Step". */
+    tookStepSettings?: CommunicationFlowDetailTookStepSettingsBag | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailEnteredDataViewSettingsBag.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 Detail block when the conversion goal type is "Entered Data View". */
+export type CommunicationFlowDetailEnteredDataViewSettingsBag = {
+    /** 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/CommunicationFlowDetail/communicationFlowDetailInitializationBox.d.ts

@@ -0,0 +1,68 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationFlowBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowBag";
+import { CommunicationFlowDetailCommunicationTemplateBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailCommunicationTemplateBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The initialization details for the Communication Flow Detail block. */
+export type CommunicationFlowDetailInitializationBox = {
+    /** Gets or sets the list of communication templates that can be selected. */
+    communicationTemplates?: CommunicationFlowDetailCommunicationTemplateBag[] | null;
+
+    /** Gets or sets the Communication Flow details. */
+    entity?: CommunicationFlowBag | 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 push medium is configured to use the Rock Mobile Push transport. */
+    isRockMobilePushTransportConfigured: boolean;
+
+    /** Gets or sets a value indicating whether the visual step indicator at the top of the block should be hidden to simplify the interface. */
+    isStepIndicatorHidden: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the push notification mobile applications that can be selected. */
+    pushMobileApplications?: ListItemBag[] | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the collection of short link sites. */
+    shortLinkSites?: ListItemBag[] | null;
+
+    /** Gets or sets the list of SMS From System phone numbers. */
+    smsFromSystemPhoneNumbers?: ListItemBag[] | null;
+
+    /** Gets or sets the test email address used for sending test email communications. */
+    testEmailAddress?: string | null;
+
+    /** Gets or sets the SMS phone number for sending test SMS communications. */
+    testSmsPhoneNumber?: string | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailJoinedGroupSettingsBag.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 Detail block when the conversion goal type is "Joined Specific Group". */
+export type CommunicationFlowDetailJoinedGroupSettingsBag = {
+    /** 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/CommunicationFlowDetail/communicationFlowDetailJoinedGroupTypeSettingsBag.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 Detail block when the conversion goal type is "Joined Group Of Type". */
+export type CommunicationFlowDetailJoinedGroupTypeSettingsBag = {
+    /** 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/CommunicationFlowDetail/communicationFlowDetailOptionsBag.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 Detail block. */
+export type CommunicationFlowDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowDetail/communicationFlowDetailRegisteredSettingsBag.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 Detail block when the conversion goal type is "Registered". */
+export type CommunicationFlowDetailRegisteredSettingsBag = {
+    /** 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/CommunicationFlowDetail/communicationFlowDetailTookStepSettingsBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The conversion goal settings for the Communication Flow Detail block when the conversion goal type is "Completed Step". */
+export type CommunicationFlowDetailTookStepSettingsBag = {
+    /** Gets or sets the Step Program associated with the Rock.ViewModels.Blocks.Communication.CommunicationFlowDetail.CommunicationFlowDetailTookStepSettingsBag.StepType. */
+    stepProgram?: ListItemBag | null;
+
+    /** 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/CommunicationFlowInstanceMessageMetrics/communicationFlowCommunicationBag.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 { CommunicationFlowInstanceCommunicationBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/communicationFlowInstanceCommunicationBag";
+
+/** Bag containing the high-level flow communication (blueprint) information needed for the Communication Flow Instance Message Metrics block. */
+export type CommunicationFlowCommunicationBag = {
+    /** Gets or sets the identifier key for this high-level flow communication. */
+    communicationFlowCommunicationIdKey?: string | null;
+
+    /** Gets or sets the name of the flow communication (blueprint). */
+    communicationFlowCommunicationName?: string | null;
+
+    /** Gets or sets the collection of flow instance communications that are associated with this high-level flow communication (blueprint). */
+    communicationFlowInstanceCommunications?: CommunicationFlowInstanceCommunicationBag[] | null;
+};

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

package/types/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/communicationFlowInstanceCommunicationBag.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 { RecipientMetricsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/recipientMetricsBag";
+
+/** Bag containing information about a communication flow instance communication for the Communication Flow Instance Message Metrics block. */
+export type CommunicationFlowInstanceCommunicationBag = {
+    /** Gets or sets the unique identifier key for the communication flow instance communication. */
+    communicationFlowInstanceCommunicationIdKey?: string | null;
+
+    /** Gets or sets the unique identifier key for the communication flow instance. */
+    communicationFlowInstanceIdKey?: string | null;
+
+    /** Gets or sets the list of recipient metrics associated with this communication flow instance communication. */
+    recipientMetrics?: RecipientMetricsBag[] | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/initializationBox.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>
+//
+
+import { CommunicationFlowCommunicationBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/communicationFlowCommunicationBag";
+import { CommunicationFlowInstanceBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/communicationFlowInstanceBag";
+
+/** Box containing the data needed to initialize the Communication Flow Instance Message Metrics block. */
+export type InitializationBox = {
+    /** Gets the number of unique people in the entire flow. */
+    allUniquePersonCount: number;
+
+    /** Gets or sets the high-level flow communication details. */
+    communicationFlowCommunication?: CommunicationFlowCommunicationBag | null;
+
+    /** Gets or sets the collection of communication flow instances associated with the parent communication flow. */
+    communicationFlowInstances?: CommunicationFlowInstanceBag[] | null;
+
+    /** Gets or sets a value indicating whether conversion goal tracking is enabled. */
+    isConversionGoalTrackingEnabled: boolean;
+
+    /** Gets the number of unique people included in the message metrics. */
+    uniquePersonCount: number;
+};

package/types/ViewModels/Blocks/Communication/CommunicationFlowInstanceMessageMetrics/recipientMetricsBag.d.ts

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <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 { PersonFieldBag } from "@Obsidian/ViewModels/Core/Grid/personFieldBag";
+
+/** Bag containing the recipient metrics of a communication flow message for the Communication Flow Instance Message Metrics block. */
+export type RecipientMetricsBag = {
+    /** Gets or sets the latest date the recipient clicked on a link in the communication. */
+    clickedDate?: string | null;
+
+    /** Gets or sets the unique identifier key for the parent Communication Flow Instance Communication. */
+    communicationFlowInstanceCommunicationIdKey?: string | null;
+
+    /** Gets or sets the date when the recipient achieved the conversion goal for the communication flow instance. */
+    conversionDate?: string | null;
+
+    /** Gets or sets the latest date the communication was opened by the recipient. */
+    openedDate?: string | null;
+
+    /** Gets or sets the person associated with the recipient metrics. */
+    person?: PersonFieldBag | null;
+
+    /** Gets or sets the unique identifier key for the recipient person. */
+    personAliasIdKey?: string | null;
+
+    /** Gets or sets the date the communication was sent to the recipient. */
+    sentDate?: string | null;
+
+    /** Gets or sets the date when the recipient unsubscribed from the communication. */
+    unsubscribeDate?: string | null;
+};