@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntrySendResponseBag.d.ts

@@ -32,6 +32,9 @@ export type CommunicationEntrySendResponseBag = {
     /** Gets the communication identifier. */
     communicationId: number;
 
+    /** Gets or sets the hashed communication identifier key. */
+    communicationIdKey?: string | null;
+
     /** Gets or sets the communication status. */
     communicationStatus?: CommunicationStatus | null;
 

package/types/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationBag.d.ts

@@ -37,12 +37,23 @@ export type CommunicationEntryWizardCommunicationBag = {
     /** Gets or sets the CC email addresses. */
     ccEmails?: string | null;
 
+    /**
+     * Gets or sets the canonical URL for the saved communication. The
+     * wizard uses this to rewrite the browser address bar in place after
+     * saving so a refresh resolves the IdKey instead of the integer id
+     * that may still be in the route.
+     */
+    communicationDetailUrl?: string | null;
+
     /** Gets or sets the communication unique identifier. */
     communicationGuid: Guid;
 
     /** Gets or sets the communication identifier. */
     communicationId?: number | null;
 
+    /** Gets or sets the hashed communication identifier key. */
+    communicationIdKey?: string | null;
+
     /** Gets or sets the communication list group unique identifier. */
     communicationListGroupGuid?: Guid | null;
 
@@ -76,8 +87,8 @@ export type CommunicationEntryWizardCommunicationBag = {
     /** Gets or sets the future send date time. */
     futureSendDateTime?: string | null;
 
-    /** Gets or sets the individual recipient person alias unique identifiers. */
-    individualRecipientPersonAliasGuids?: Guid[] | null;
+    /** Gets or sets the individual recipient person alias identifier keys. */
+    individualRecipientPersonAliasIdKeys?: string[] | null;
 
     /** Gets or sets whether this is a bulk communication. */
     isBulkCommunication: boolean;

package/types/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCustomTextBag.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>
+//
+
+/** Bag containing the customizable text used in the Communication Entry Wizard block. */
+export type CommunicationEntryWizardCustomTextBag = {
+    /** Gets or sets the description for the "Is Bulk" option. */
+    isBulkOptionDescription?: string | null;
+
+    /** Gets or sets the name for the "Is Bulk" option.  */
+    isBulkOptionTitle?: string | null;
+
+    /** Gets or sets the description for the "Is Not Bulk" option. */
+    isNotBulkOptionDescription?: string | null;
+
+    /** Gets or sets the name for the "Is Not Bulk" option.  */
+    isNotBulkOptionTitle?: string | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardInitializationBox.d.ts

@@ -25,7 +25,9 @@ import { Guid } from "@Obsidian/Types";
 import { CommunicationEntryWizardCommunicationBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationBag";
 import { CommunicationEntryWizardCommunicationTemplateDetailBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationTemplateDetailBag";
 import { CommunicationEntryWizardCommunicationTemplateListItemBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationTemplateListItemBag";
+import { CommunicationEntryWizardCustomTextBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCustomTextBag";
 import { CommunicationEntryWizardRecipientBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardRecipientBag";
+import { SmsFromNumberListItemBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/smsFromNumberListItemBag";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 /** Box containing initialization information for the Communication Entry Wizard block. */
@@ -42,6 +44,7 @@ export type CommunicationEntryWizardInitializationBox = {
     /** Gets or sets the communication details being created/edited. */
     communication?: CommunicationEntryWizardCommunicationBag | null;
 
+    /** Gets or sets the available communication list groups. */
     communicationListGroups?: ListItemBag[] | null;
 
     /** Gets or sets the initial communication template detail. */
@@ -50,6 +53,17 @@ export type CommunicationEntryWizardInitializationBox = {
     /** Gets or sets the communication topic values. */
     communicationTopicValues?: ListItemBag[] | null;
 
+    /**
+     * Gets or sets the URL the client should navigate to when the admin clicks
+     * "Create New Communication" after queueing a send. The URL targets the
+     * current page with no communication identifier so the wizard renders a
+     * fresh state on load.
+     */
+    createNewCommunicationUrl?: string | null;
+
+    /** Gets or sets the custom text content used by the communication entry wizard. */
+    customText?: CommunicationEntryWizardCustomTextBag | null;
+
     /**
      * Gets or sets the error message. A non-empty value indicates that
      * an error is preventing the block from being displayed.
@@ -65,6 +79,7 @@ export type CommunicationEntryWizardInitializationBox = {
     /** Gets or sets a value indicating whether adding individuals to recipient lists is disabled. */
     isAddingIndividualsToRecipientListsDisabled: boolean;
 
+    /** Gets or sets whether the duplicate prevention option should be shown. */
     isDuplicatePreventionOptionShown: boolean;
 
     /** Gets or sets whether the communication wizard block should be hidden. */
@@ -82,6 +97,7 @@ export type CommunicationEntryWizardInitializationBox = {
     /** Gets or sets the communication mediums. */
     mediums?: ListItemBag[] | null;
 
+    /** Gets or sets the merge fields. */
     mergeFields?: string[] | null;
 
     /** Gets or sets the minimum number of characters for short link tokens. */
@@ -96,6 +112,7 @@ export type CommunicationEntryWizardInitializationBox = {
     /** Gets or sets the applications that support push notifications. */
     pushApplications?: ListItemBag[] | null;
 
+    /** Gets or sets the recipients. */
     recipients?: CommunicationEntryWizardRecipientBag[] | null;
 
     /** Gets or sets the security grant token. */
@@ -110,7 +127,8 @@ export type CommunicationEntryWizardInitializationBox = {
     /** Gets or sets the SMS accepted MIME types. */
     smsAcceptedMimeTypes?: string[] | null;
 
-    smsFromNumbers?: ListItemBag[] | null;
+    /** Gets or sets the SMS "from" numbers. */
+    smsFromNumbers?: SmsFromNumberListItemBag[] | null;
 
     /** Gets or sets the SMS media size limit in bytes. */
     smsMediaSizeLimitBytes: number;

package/types/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardRecipientBag.d.ts

@@ -21,8 +21,6 @@
 // </copyright>
 //
 
-import { Guid } from "@Obsidian/Types";
-
 /** Bag used to maintain state of recipients. */
 export type CommunicationEntryWizardRecipientBag = {
     /** Gets or sets email of this recipient. */
@@ -49,8 +47,8 @@ export type CommunicationEntryWizardRecipientBag = {
     /** Gets or sets the name of this recipient. */
     name?: string | null;
 
-    /** Gets or sets the unique identifier of the person associated with this recipient. */
-    personAliasGuid: Guid;
+    /** Gets or sets the identifier key of the person associated with this recipient. */
+    personAliasIdKey?: string | null;
 
     /** Gets or sets the recipient's person identifier. */
     personId: number;

package/types/ViewModels/Blocks/Communication/CommunicationEntryWizard/smsFromNumberListItemBag.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>
+//
+
+/**
+ * Represents a container for SMS "from" number information, including the associated list item and assignment
+ * status for the current person.
+ */
+export type SmsFromNumberListItemBag = {
+    /** Gets or sets the category for this item. */
+    category?: string | null;
+
+    /** Gets or sets disabled for this item. */
+    disabled?: boolean | null;
+
+    /** Gets or sets a value indicating whether a number is assigned to the current person. */
+    isNumberAssignedToCurrentPerson: boolean;
+
+    /** Gets or sets the text. */
+    text?: string | null;
+
+    /** Gets or sets the value. */
+    value?: string | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationListSubscribe/communicationListItemBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+
+/**
+ * A bag that contains information about a single communication list item
+ * for the Communication List Subscribe block.
+ */
+export type CommunicationListItemBag = {
+    /** Gets or sets the unique identifier for the communication list group. */
+    communicationListGuid: Guid;
+
+    /**
+     * Gets or sets the communication preference for this list.
+     * This represents the group member's communication preference,
+     * falling back to the person's preference if not explicitly set.
+     */
+    communicationPreference: CommunicationType;
+
+    /** Gets or sets the description of the communication list. */
+    description?: string | null;
+
+    /**
+     * Gets or sets the display name for the communication list,
+     * which is the PublicName attribute if available, otherwise the group name.
+     */
+    displayName?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether the person is subscribed
+     * (i.e., an active group member) to this communication list.
+     */
+    isSubscribed: boolean;
+};

package/types/ViewModels/Blocks/Communication/CommunicationListSubscribe/communicationListPreferenceRequestBag.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>
+//
+
+import { CommunicationType } from "@Obsidian/Enums/Communication/communicationType";
+import { Guid } from "@Obsidian/Types";
+
+/** The request bag for the UpdateCommunicationPreference block action. */
+export type CommunicationListPreferenceRequestBag = {
+    /** Gets or sets the communication list unique identifier. */
+    communicationListGuid: Guid;
+
+    /** Gets or sets the communication preference. */
+    communicationType: CommunicationType;
+};

package/types/ViewModels/Blocks/Communication/CommunicationListSubscribe/communicationListSubscribeBag.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 { CommunicationListItemBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationListSubscribe/communicationListItemBag";
+
+/**
+ * A bag that contains the data needed by the Communication List Subscribe block
+ * to render the list of communication lists and their subscription states.
+ */
+export type CommunicationListSubscribeBag = {
+    /**
+     * Gets or sets the list of communication list items that the person
+     * can subscribe to or unsubscribe from.
+     */
+    communicationLists?: CommunicationListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationListSubscribe/communicationListSubscribeOptionsBag.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>
+//
+
+/** A bag that contains the configuration options for the Communication List Subscribe block. */
+export type CommunicationListSubscribeOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether the medium preference toggle
+     * (Email/SMS) should be displayed for each communication list.
+     */
+    isShowMediumPreferenceEnabled: boolean;
+};

package/types/ViewModels/Blocks/Communication/CommunicationListSubscribe/communicationListSubscribeRequestBag.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 { Guid } from "@Obsidian/Types";
+
+/** The request bag for the UpdateSubscription block action. */
+export type CommunicationListSubscribeRequestBag = {
+    /** Gets or sets the communication list unique identifier. */
+    communicationListGuid: Guid;
+
+    /** Gets or sets a value indicating whether this instance is subscribed. */
+    isSubscribed: boolean;
+};

package/types/ViewModels/Blocks/Communication/CommunicationTemplateList/communicationTemplateListOptionsBag.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>
+//
+
+/** The additional configuration options for the Communication Template List block. */
+export type CommunicationTemplateListOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether the current user is authorized
+     * to edit the block. Controls visibility of the "Created By" column.
+     */
+    isBlockAuthorizedToEdit: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the security column should
+     * be visible in the grid.
+     */
+    isSecurityColumnVisible: boolean;
+};

package/types/ViewModels/Blocks/Communication/CommunicationUnsubscribeReport/communicationUnsubscribeReportOptionsBag.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 additional configuration options for the Communication Unsubscribe Report block. */
+export type CommunicationUnsubscribeReportOptionsBag = {
+    /** Gets or sets the list of Rock.Model.UnsubscribeLevel items the individual can filter by. */
+    unsubscribeLevelItems?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Communication/SnippetDetail/snippetDetailOptionsBag.d.ts

@@ -23,8 +23,11 @@
 
 /** Class SnippetDetailOptionsBag. */
 export type SnippetDetailOptionsBag = {
-    /** Gets or sets a value indicating whether this instance is authorized to edit. */
-    isAuthorizedToEdit: boolean;
+    /**
+     * Gets or sets a value indicating whether the current person can edit the snippet type,
+     * which determines whether they may make a snippet shared (public) rather than personal.
+     */
+    canEditSnippetType: boolean;
 
     /** Gets or sets a value indicating whether this instance is personal allowed. */
     isPersonalAllowed: boolean;

package/types/ViewModels/Blocks/Communication/SnippetList/snippetListOptionsBag.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>
+//
+
+/** The additional configuration options for the Snippet List block. */
+export type SnippetListOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether the Personal column
+     * should be displayed in the grid.
+     */
+    isShowPersonalColumnEnabled: boolean;
+
+    /**
+     * Gets or sets the title to display for the grid, derived from
+     * the configured snippet type name (e.g., "Email Snippets").
+     */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Communication/SnippetTypeList/snippetTypeListOptionsBag.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 Snippet Type List block. */
+export type SnippetTypeListOptionsBag = {
+};