@rockrms/obsidian-framework 17.5.2 → 18.1.0

package/types/ViewModels/Blocks/Communication/CommunicationSaturationReport/communicationSaturationReportBlockDataBag.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>
+//
+
+import { CommunicationSaturationReportChartDataBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationSaturationReport/communicationSaturationReportChartDataBag";
+import { GridDataBag } from "@Obsidian/ViewModels/Core/Grid/gridDataBag";
+
+/** The additional configuration options for the Communication Recipient List block. */
+export type CommunicationSaturationReportBlockDataBag = {
+    /** The data shown in the chart on the main tab */
+    chartData?: CommunicationSaturationReportChartDataBag[] | null;
+
+    /** The data shown in the grid on the communications tab */
+    communicationsGridData?: GridDataBag | null;
+
+    /** The data shown in the grid on the recipients tab */
+    recipientsGridData?: GridDataBag | null;
+};

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

@@ -0,0 +1,38 @@
+//------------------------------------------------------------------------------
+// <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 data used to fill the chart for the Communication Saturation Report. It represents
+ * the number of people who were sent X number of communications in a given time period. X is
+ * the Bucket, which is a range of numbers (e.g. 1-3).
+ */
+export type CommunicationSaturationReportChartDataBag = {
+    /**
+     * The bucket representing a number of communications sent to a person.
+     * The bucket is a range of numbers (e.g. 1-3).
+     */
+    bucket?: string | null;
+
+    /** The number of people who were sent the number of communications represented by the bucket. */
+    numberOfRecipients: number;
+};

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

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <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 filter options for the Communication Saturation Report block. */
+export type CommunicationSaturationReportFiltersBag = {
+    /** Whether or not to include only bulk communications or all communications in the report. */
+    bulkOnly: boolean;
+
+    /** The connection status of people to filter results of the report by. */
+    connectionStatus?: ListItemBag | null;
+
+    /** A data view of people to filter results of the report by. */
+    dataView?: ListItemBag | null;
+
+    /** String representing a range of time to filter results of the report by. */
+    dateRangeDelimitedString?: string | null;
+
+    /** The communication medium(s) to filter results of the report by. */
+    medium?: string[] | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/communicationChannelBag.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 { CommunicationChannelType } from "@Obsidian/Enums/Blocks/Communication/EmailPreferenceEntry/communicationChannelType";
+import { CommunicationType } from "@Obsidian/Enums/Communication/communicationType";
+
+/** A bag that contains information about a communication channel (list or flow) for the Email Preference Entry block. */
+export type CommunicationChannelBag = {
+    /** Gets or sets the type for this communication channel. */
+    communicationChannelType: CommunicationChannelType;
+
+    /** Gets or sets the person's communication preference for this communication channel. */
+    communicationPreference?: CommunicationType | null;
+
+    /** Gets or sets the hashed identifier key for this communication channel. */
+    idKey?: string | null;
+
+    /** Gets or sets whether the person is unsubscribed from this communication channel. */
+    isUnsubscribed: boolean;
+
+    /** Gets or sets the count of messages the person has received within this communication channel. */
+    messagesReceivedCount?: number | null;
+
+    /** Gets or sets the name of this communication channel. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/deactivateRecordRequestBag.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";
+
+/** A bag that contains information about a request to deactivate a person's Rock record for the Email Preference Entry block. */
+export type DeactivateRecordRequestBag = {
+    /** Gets or sets the inactive reason note. */
+    inactiveReasonNote?: string | null;
+
+    /** Gets or sets the unique identifier of the inactive reason defined value. */
+    inactiveReasonValueGuid: Guid;
+
+    /** Gets or sets whether the person is deactivating the records of all family members. */
+    isFamilyDeactivation: boolean;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/deactivateRecordResponseBag.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 the outcome of a request to deactivate a person's Rock record for the
+ * Email Preference Entry block.
+ */
+export type DeactivateRecordResponseBag = {
+    /** Gets or sets the HTML for the removed involvement success description to display to the person. */
+    removedInvolvementSuccessDescriptionHtml?: string | null;
+
+    /** Gets or sets the removed involvement success title to display to the person. */
+    removedInvolvementSuccessTitle?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/emailPreferenceEntryInitializationBox.d.ts

@@ -21,27 +21,41 @@
 // </copyright>
 //
 
+import { EmailPreference } from "@Obsidian/Enums/Crm/emailPreference";
+import { CommunicationChannelBag } from "@Obsidian/ViewModels/Blocks/Communication/EmailPreferenceEntry/communicationChannelBag";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
-/** The box that contains all the initialization information for the Email Preference Entry block. */
+/** The box that contains all the initialization information for the email preference entry block. */
 export type EmailPreferenceEntryInitializationBox = {
-    /** Gets or sets a value indicating whether [allow inactivating family]. */
-    allowInactivatingFamily: boolean;
+    /**
+     * Gets or sets the list of communication channels the person is able to manage within the "Available
+     * Communication Channels" section.
+     */
+    availableCommunicationChannels?: CommunicationChannelBag[] | null;
 
-    /** Gets or sets the email. */
-    email?: string | null;
+    /** Gets or sets the HTML for the "Available Communication Channels" section description. */
+    availableCommunicationChannelsDescriptionHtml?: string | null;
 
-    /** Gets or sets the email preference. */
-    emailPreference?: string | null;
+    /**
+     * Gets or sets the list of communication channels the person is able to manage within the "Current
+     * Communication Channels" section.
+     */
+    currentCommunicationChannels?: CommunicationChannelBag[] | null;
 
-    /** Gets or sets the type of the email preference update alert. */
-    emailPreferenceUpdateAlertType?: string | null;
+    /** Gets or sets the HTML for the "Current Communication Channels" section description. */
+    currentCommunicationChannelsDescriptionHtml?: string | null;
 
-    /** Gets or sets the email preference update message. */
-    emailPreferenceUpdateMessage?: string | null;
+    /** Gets or sets the person's email address. */
+    emailAddress?: string | null;
 
-    /** Gets or sets the emails allowed text. */
-    emailsAllowedText?: string | null;
+    /** Gets or sets the person's email preference. */
+    emailPreference: EmailPreference;
+
+    /** Gets or sets the email preference description to display to the person. */
+    emailPreferenceDescription?: string | null;
+
+    /** Gets or sets the email preference title to display to the person. */
+    emailPreferenceTitle?: string | null;
 
     /**
      * Gets or sets the error message. A non-empty value indicates that
@@ -49,42 +63,84 @@ export type EmailPreferenceEntryInitializationBox = {
      */
     errorMessage?: string | null;
 
-    /** Gets or sets the in active note. */
-    inActiveNote?: string | null;
+    /** Gets or sets the HTML for the header description to display to the person. */
+    headerDescriptionHtml?: string | null;
+
+    /** Gets or sets the header title to display to the person. */
+    headerTitle?: string | null;
+
+    /** Gets or sets the inactive reasons the person may choose when removing themselves from church involvement. */
+    inactiveReasons?: ListItemBag[] | null;
+
+    /** Gets or sets whether the "Available Communication Channels" section is enabled. */
+    isAvailableCommunicationChannelsSectionEnabled: boolean;
+
+    /** Gets or sets whether the "Current Communication Channels" section is enabled. */
+    isCurrentCommunicationChannelsSectionEnabled: boolean;
+
+    /** Gets or sets whether the person is allowed to remove their whole family from church involvement. */
+    isDeactivatingFamilyEnabled: boolean;
+
+    /** Gets or sets whether the person has been removed from church involvement. */
+    isRemovedFromChurchInvolvement: boolean;
+
+    /** Gets or sets whether the person may remove themselves from church involvement. */
+    isRemoveInvolvementEnabled: boolean;
+
+    /** Gets or sets whether the block is currently operating in "Unsubscribe" mode. */
+    isUnsubscribeMode: boolean;
 
-    /** Gets or sets the in active reason. */
-    inActiveReason?: string | null;
+    /** Gets or sets whether the person may update their contact info. */
+    isUpdateContactInfoEnabled: boolean;
 
-    /** Gets or sets the in active reasons. */
-    inActiveReasons?: ListItemBag[] | null;
+    /** Gets or sets the number of days used to calculate how many messages a person has received per current channel. */
+    messageCountWindowDays: number;
 
     /** Gets or sets the navigation urls. */
     navigationUrls?: Record<string, string> | null;
 
-    /** Gets or sets the no emails text. */
-    noEmailsText?: string | null;
+    /** Gets or sets the HTML for the "Opt-Out Options" section description. */
+    optOutOptionsDescriptionHtml?: string | null;
 
-    /** Gets or sets the no mass emails text. */
-    noMassEmailsText?: string | null;
+    /**
+     * Gets or sets the HTML for the header description to display to the person when they request to be removed
+     * from involvement.
+     */
+    removeInvolvementConfirmationDescriptionHtml?: string | null;
 
-    /** Gets or sets the not involved text. */
-    notInvolvedText?: string | null;
+    /** Gets or sets the header title to display to the person when they request to be removed from involvement. */
+    removeInvolvementConfirmationTitle?: string | null;
 
-    /** Gets or sets the security grant token. */
-    securityGrantToken?: string | null;
+    /** Gets or sets the remove involvement description to display to the person. */
+    removeInvolvementDescription?: string | null;
+
+    /** Gets or sets the remove involvement title to display to the person. */
+    removeInvolvementTitle?: string | null;
+
+    /**
+     * Gets or sets the HTML for the header description to display to the person when they've resubscribed after
+     * the block is initialized in "Unsubscribe" model.
+     */
+    resubscribedHeaderDescriptionHtml?: string | null;
 
-    /** Gets or sets the successfully unsubscribed text. */
-    successfullyUnsubscribedText?: string | null;
+    /**
+     * Gets or sets the header title to display to the person when they've resubscribed after the block is
+     * initialized in "Unsubscribe" model.
+     */
+    resubscribedHeaderTitle?: string | null;
 
-    /** Gets or sets the unsubscribe from list. */
-    unsubscribeFromList?: ListItemBag[] | null;
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
 
-    /** Gets or sets the unsubscribe from list. */
-    unsubscribeFromListOptions?: ListItemBag[] | null;
+    /** Gets or sets whether the header icon should be shown. */
+    showHeaderIcon: boolean;
 
-    /** Gets or sets the unsubscribe text. */
-    unsubscribeText?: string | null;
+    /**
+     * Gets or sets whether the person should be shown - and allowed to change - their communication preference
+     * for each current communication channel.
+     */
+    showMediumPreference: boolean;
 
-    /** Gets or sets the update email address text. */
-    updateEmailAddressText?: string | null;
+    /** Gets or sets the communication channel that was unsubscribed from upon block initialization. */
+    unsubscribedFromChannel?: CommunicationChannelBag | null;
 };

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/manageChannelSubscriptionRequestBag.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 { CommunicationChannelType } from "@Obsidian/Enums/Blocks/Communication/EmailPreferenceEntry/communicationChannelType";
+
+/**
+ * A bag that contains the information needed to manage a person's communication channel subscription for the Email
+ * Preference Entry block.
+ */
+export type ManageChannelSubscriptionRequestBag = {
+    /** Gets or sets the type of communication channel subscription the person is managing. */
+    communicationChannelType: CommunicationChannelType;
+
+    /** Gets or sets the hashed identifier key for this communication channel. */
+    idKey?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/manageEmailSubscriptionRequestBag.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 { EmailSubscriptionType } from "@Obsidian/Enums/Blocks/Communication/EmailPreferenceEntry/emailSubscriptionType";
+
+/** A bag that contains information about managing an person's email subscription for the Email Preference Entry block. */
+export type ManageEmailSubscriptionRequestBag = {
+    /** Gets or sets the type of email subscription the person is managing. */
+    emailSubscriptionType: EmailSubscriptionType;
+
+    /** Gets or sets the hashed identifier key for this communication channel. */
+    idKey?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/updateCommunicationPreferenceRequestBag.d.ts

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { CommunicationChannelType } from "@Obsidian/Enums/Blocks/Communication/EmailPreferenceEntry/communicationChannelType";
+import { CommunicationType } from "@Obsidian/Enums/Communication/communicationType";
+
+/**
+ * A bag that contains information about a request to update a person's communication preference for a communication
+ * channel for the Email Preference Entry block.
+ */
+export type UpdateCommunicationPreferenceRequestBag = {
+    /** Gets or sets the type of communication channel subscription the person is managing. */
+    communicationChannelType: CommunicationChannelType;
+
+    /** Gets or sets the person's communication preference for this communication channel. */
+    communicationPreference: CommunicationType;
+
+    /** Gets or sets the hashed identifier key for this communication channel. */
+    idKey?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/updateContactInfoRequestBag.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>
+//
+
+/** A bag that contains information about a request to update a person's contact info for the Email Preference Entry block. */
+export type UpdateContactInfoRequestBag = {
+    /** Gets or sets the person's updated email address. */
+    emailAddress?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/updateEmailPreferenceRequestBag.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 { EmailPreference } from "@Obsidian/Enums/Crm/emailPreference";
+
+/** A bag that contains information about a request to update a person's email preference for the Email Preference Entry block. */
+export type UpdateEmailPreferenceRequestBag = {
+    /** Gets or sets the person's updated email preference. */
+    emailPreference: EmailPreference;
+};

package/types/ViewModels/Blocks/Communication/SystemPhoneNumberDetail/systemPhoneNumberBag.d.ts

@@ -42,6 +42,12 @@ export type SystemPhoneNumberBag = {
     /** Gets or sets the description. */
     description?: string | null;
 
+    /**
+     * Gets or sets whether to prevent Rock from updating an individual's SMS status when they opt in or out of
+     * receiving SMS messages.
+     */
+    disableSmsOptInOutTracking: boolean;
+
     /** Gets or sets the identifier key of this entity. */
     idKey?: string | null;
 
@@ -84,4 +90,7 @@ export type SystemPhoneNumberBag = {
      * SMS message is received on this number.
      */
     smsReceivedWorkflowType?: ListItemBag | null;
+
+    /** Gets or sets whether to prevent Rock from sending automatic SMS replies to opt-in or opt-out messages. */
+    suppressSmsOptInOutAutoReplies: boolean;
 };