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

package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryGetRecipientsRequestBag.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 { Guid } from "@Obsidian/Types";
+
+/** Bag containing the information for retrieving communication entry recipients. */
+export type CommunicationEntryGetRecipientsRequestBag = {
+    /** Gets or sets the person alias unique identifiers for which to retrieve recipient data. */
+    personAliasGuids?: Guid[] | null;
+};

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

@@ -0,0 +1,88 @@
+//------------------------------------------------------------------------------
+// <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 { Mode } from "@Obsidian/Enums/Blocks/Communication/CommunicationEntry/mode";
+import { CommunicationEntryAuthorizationBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryAuthorizationBag";
+import { CommunicationEntryCommunicationBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryCommunicationBag";
+import { CommunicationEntryMediumOptionsBaseBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryMediumOptionsBaseBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Box containing initialization information for the Communication Entry block. */
+export type CommunicationEntryInitializationBox = {
+    /** Gets or sets a value indicating whether additional email recipients are allowed. */
+    areAdditionalEmailRecipientsAllowed: boolean;
+
+    /** Gets or sets a value indicating whether the email metrics reminder options are shown. */
+    areEmailMetricsReminderOptionsShown: boolean;
+
+    /** Gets or sets the authorization details for the block. */
+    authorization?: CommunicationEntryAuthorizationBag | null;
+
+    /** Gets or sets the communication details being created/edited. */
+    communication?: CommunicationEntryCommunicationBag | 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 CC/BCC entry is allowed. */
+    isCcBccEntryAllowed: boolean;
+
+    /** Gets or sets a value indicating whether the duplicate prevention option is shown. */
+    isDuplicatePreventionOptionShown: boolean;
+
+    /** Gets or sets a value indicating whether the block is in edit mode. */
+    isEditMode: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the entire Communication Entry block is hidden.
+     * There should be another block on the page that will display the Communication details in view mode when this is true.
+     */
+    isHidden: boolean;
+
+    /** Gets a value indicating whether lava is supported. */
+    isLavaEnabled: boolean;
+
+    /** Gets or sets the maximum number of recipients allowed before communication will need to be approved. */
+    maximumRecipientsBeforeApprovalRequired: number;
+
+    /** Gets or sets the options for the selected communication medium. */
+    mediumOptions?: CommunicationEntryMediumOptionsBaseBag | null;
+
+    /** Gets or sets the mediums for the tab control. */
+    mediums?: ListItemBag[] | null;
+
+    /** Gets or sets the mode. */
+    mode: Mode;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the title. */
+    title?: string | null;
+};

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

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <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 { MediumType } from "@Obsidian/Enums/Blocks/Communication/CommunicationEntry/mediumType";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Bag containing basic information about a communication medium. */
+export type CommunicationEntryMediumOptionsBaseBag = {
+    /** Gets or sets a value indicating whether this medium has an active transport. */
+    hasActiveTransport: boolean;
+
+    /** Gets a value indicating whether this communication medium is unknown. */
+    isUnknown: boolean;
+
+    /** Gets or sets the medium entity type unique identifier. */
+    mediumEntityTypeGuid: Guid;
+
+    /** Gets the type of the medium. */
+    mediumType: MediumType;
+
+    /** Gets or sets the communication templates that can be selected. */
+    templates?: ListItemBag[] | null;
+};

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

@@ -0,0 +1,53 @@
+//------------------------------------------------------------------------------
+// <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 { MediumType } from "@Obsidian/Enums/Blocks/Communication/CommunicationEntry/mediumType";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Bag containing the Push Medium options for the Communication Entry block. */
+export type CommunicationEntryPushMediumOptionsBag = {
+    /** Gets or sets the list of applications to which push notifications can be sent. */
+    applications?: ListItemBag[] | null;
+
+    /** Gets or sets the character limit for the message. */
+    characterLimit: number;
+
+    /** Gets or sets a value indicating whether this medium has an active transport. */
+    hasActiveTransport: boolean;
+
+    /** Gets a value indicating whether this communication medium is unknown. */
+    isUnknown: boolean;
+
+    /** Gets or sets a value indicating whether the Push Notification Medium is using the Rock Mobile Push Transport. */
+    isUsingRockMobilePushTransport: boolean;
+
+    /** Gets or sets the medium entity type unique identifier. */
+    mediumEntityTypeGuid: Guid;
+
+    /** Gets the type of the medium. */
+    mediumType: MediumType;
+
+    /** Gets or sets the communication templates that can be selected. */
+    templates?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryPushNotificationOptionsBag.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 { Guid } from "@Obsidian/Types";
+import { PageRouteValueBag } from "@Obsidian/ViewModels/Rest/Controls/pageRouteValueBag";
+
+/** Bag containing the push notification options for the Communication Entry block. */
+export type CommunicationEntryPushNotificationOptionsBag = {
+    /** Gets or sets the link-to-page URL. */
+    linkToPageUrl?: string | null;
+
+    /** Gets or sets the mobile application unique identifier. */
+    mobileApplicationGuid?: Guid | null;
+
+    /** Gets or sets the mobile page. */
+    mobilePage?: PageRouteValueBag | null;
+
+    /** Gets or sets the mobile page query string. */
+    mobilePageQueryString?: Record<string, string> | null;
+};

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

@@ -0,0 +1,63 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/** Bag used to maintain state of recipients. */
+export type CommunicationEntryRecipientBag = {
+    /** Gets or sets email of this recipient. */
+    email?: string | null;
+
+    /** Gets or sets the email preference for this recipient. */
+    emailPreference?: string | null;
+
+    /** Gets or sets a value indicating whether bulk email is allowed for this recipient. */
+    isBulkEmailAllowed: boolean;
+
+    /** Gets or sets a value indicating whether this recipient is deceased. */
+    isDeceased: boolean;
+
+    /** Gets or sets a value indicating whether email is active for this recipient. */
+    isEmailActive: boolean;
+
+    /** Gets or sets a value indicating whether email is allowed for this recipient. */
+    isEmailAllowed: boolean;
+
+    /** Gets or sets a value indicating whether push notifications are allowed for this recipient. */
+    isPushAllowed: boolean;
+
+    /** Gets or sets a value indicating whether SMS is allowed for this recipient. */
+    isSmsAllowed: boolean;
+
+    /** 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 photo URL of the recipient. */
+    photoUrl?: string | null;
+
+    /** Gets or sets the SMS number for this recipient. */
+    smsNumber?: string | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntrySaveMetricsReminderRequestBag.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";
+
+/** Bag containing the information for the Communication Entry block to save a metrics reminder. */
+export type CommunicationEntrySaveMetricsReminderRequestBag = {
+    /** Gets or sets the Communication unique identifier. */
+    communicationGuid: Guid;
+
+    /** Gets or sets the number of days to wait after the communication is sent to send the email metrics reminder communication. */
+    daysUntilReminder: number;
+};

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

@@ -0,0 +1,128 @@
+//------------------------------------------------------------------------------
+// <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 { PushOpenActionType } from "@Obsidian/Enums/Blocks/Communication/CommunicationEntry/pushOpenActionType";
+import { CommunicationStatus } from "@Obsidian/Enums/Communication/communicationStatus";
+import { Guid } from "@Obsidian/Types";
+import { CommunicationEntryPushNotificationOptionsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryPushNotificationOptionsBag";
+import { CommunicationEntryRecipientBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryRecipientBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Bag containing the information for the Communication Entry block to save a communication. */
+export type CommunicationEntrySaveRequestBag = {
+    /** Gets or sets the additional email addresses to receive the communication. */
+    additionalEmailAddresses?: string[] | null;
+
+    /** Gets or sets the BCC email addresses. */
+    bccAddresses?: string | null;
+
+    /** Gets or sets the cc email addresses. */
+    ccAddresses?: string | null;
+
+    /** Gets or sets the communication unique identifier. */
+    communicationGuid: Guid;
+
+    /** Gets or sets the communication list group unique identifier. */
+    communicationListGroupGuid?: Guid | null;
+
+    /** Gets or sets the communication list name. */
+    communicationListName?: string | null;
+
+    /** Gets or sets the number of recipients in the communication list. */
+    communicationListRecipientCount?: number | null;
+
+    /** Gets or sets the communication template unique identifier. */
+    communicationTemplateGuid?: Guid | null;
+
+    /** Gets or sets the email attachment binary files. */
+    emailAttachmentBinaryFiles?: ListItemBag[] | null;
+
+    /**
+     * Option to prevent communications from being sent to people with the same email/SMS addresses.
+     * This will mean two people who share an address will not receive a personalized communication, only one of them will.
+     */
+    excludeDuplicateRecipientAddress: boolean;
+
+    /** Gets or sets from email address. */
+    fromAddress?: string | null;
+
+    /** Gets or sets from name. */
+    fromName?: string | null;
+
+    /** Gets or sets the future send date time. */
+    futureSendDateTime?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is bulk communication. */
+    isBulkCommunication: boolean;
+
+    /** Gets or sets the medium entity type unique identifier. */
+    mediumEntityTypeGuid: Guid;
+
+    /** Gets or sets the message. */
+    message?: string | null;
+
+    /** Gets or sets the message meta data. */
+    messageMetaData?: string | null;
+
+    /** Gets or sets the push data. */
+    pushData?: CommunicationEntryPushNotificationOptionsBag | null;
+
+    /** Gets or sets the push image binary file identifier. */
+    pushImageBinaryFileId?: number | null;
+
+    /** Gets or sets the push message. */
+    pushMessage?: string | null;
+
+    /** Gets or sets the push open action. */
+    pushOpenAction?: PushOpenActionType | null;
+
+    /** Gets or sets the push open message structured content JSON. */
+    pushOpenMessageJson?: string | null;
+
+    /** Gets or sets the push sound. */
+    pushSound?: string | null;
+
+    /** Gets or sets the push title. */
+    pushTitle?: string | null;
+
+    /** Gets or sets the recipients. */
+    recipients?: CommunicationEntryRecipientBag[] | null;
+
+    /** Gets or sets the reply to email address. */
+    replyAddress?: string | null;
+
+    /** Gets or sets the SMS attachment binary files. */
+    smsAttachmentBinaryFiles?: ListItemBag[] | null;
+
+    /** Gets or sets the SMS from system phone number unique identifier. */
+    smsFromSystemPhoneNumberGuid?: Guid | null;
+
+    /** Gets or sets the SMS message. */
+    smsMessage?: string | null;
+
+    /** Gets or sets the status. */
+    status: CommunicationStatus;
+
+    /** Gets or sets the subject. */
+    subject?: string | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntrySaveResponseBag.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 { CommunicationStatus } from "@Obsidian/Enums/Communication/communicationStatus";
+import { Guid } from "@Obsidian/Types";
+
+/** Bag containing the response information after saving a communication via the Communication Entry block. */
+export type CommunicationEntrySaveResponseBag = {
+    /** Gets the communication unique identifier. */
+    communicationGuid: Guid;
+
+    /** Gets the communication identifier. */
+    communicationId: number;
+
+    /** Gets or sets the communication status. */
+    communicationStatus?: CommunicationStatus | null;
+
+    /** Gets a value indicating whether the page has a detail block for viewing the communication details. */
+    hasDetailBlockOnCurrentPage: boolean;
+
+    /** Gets or sets the response message. */
+    message?: string | null;
+
+    /** Gets or sets a value indicating whether to redirect view mode. */
+    redirectToViewMode: boolean;
+};

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

@@ -0,0 +1,128 @@
+//------------------------------------------------------------------------------
+// <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 { PushOpenActionType } from "@Obsidian/Enums/Blocks/Communication/CommunicationEntry/pushOpenActionType";
+import { CommunicationStatus } from "@Obsidian/Enums/Communication/communicationStatus";
+import { Guid } from "@Obsidian/Types";
+import { CommunicationEntryPushNotificationOptionsBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryPushNotificationOptionsBag";
+import { CommunicationEntryRecipientBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryRecipientBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Bag containing the information for the Communication Entry block to send a communication. */
+export type CommunicationEntrySendRequestBag = {
+    /** Gets or sets the additional email addresses to receive the communication. */
+    additionalEmailAddresses?: string[] | null;
+
+    /** Gets or sets the BCC email addresses. */
+    bccAddresses?: string | null;
+
+    /** Gets or sets the cc email addresses. */
+    ccAddresses?: string | null;
+
+    /** Gets or sets the communication unique identifier. */
+    communicationGuid: Guid;
+
+    /** Gets or sets the communication list group unique identifier. */
+    communicationListGroupGuid?: Guid | null;
+
+    /** Gets or sets the communication list name. */
+    communicationListName?: string | null;
+
+    /** Gets or sets the number of recipients in the communication list. */
+    communicationListRecipientCount?: number | null;
+
+    /** Gets or sets the communication template unique identifier. */
+    communicationTemplateGuid?: Guid | null;
+
+    /** Gets or sets the email attachment binary files. */
+    emailAttachmentBinaryFiles?: ListItemBag[] | null;
+
+    /**
+     * Option to prevent communications from being sent to people with the same email/SMS addresses.
+     * This will mean two people who share an address will not receive a personalized communication, only one of them will.
+     */
+    excludeDuplicateRecipientAddress: boolean;
+
+    /** Gets or sets from email address. */
+    fromAddress?: string | null;
+
+    /** Gets or sets from name. */
+    fromName?: string | null;
+
+    /** Gets or sets the future send date time. */
+    futureSendDateTime?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is bulk communication. */
+    isBulkCommunication: boolean;
+
+    /** Gets or sets the medium entity type unique identifier. */
+    mediumEntityTypeGuid: Guid;
+
+    /** Gets or sets the message. */
+    message?: string | null;
+
+    /** Gets or sets the message meta data. */
+    messageMetaData?: string | null;
+
+    /** Gets or sets the push data. */
+    pushData?: CommunicationEntryPushNotificationOptionsBag | null;
+
+    /** Gets or sets the push image binary file identifier. */
+    pushImageBinaryFileId?: number | null;
+
+    /** Gets or sets the push message. */
+    pushMessage?: string | null;
+
+    /** Gets or sets the push open action. */
+    pushOpenAction?: PushOpenActionType | null;
+
+    /** Gets or sets the push open message structured content JSON. */
+    pushOpenMessageJson?: string | null;
+
+    /** Gets or sets the push sound. */
+    pushSound?: string | null;
+
+    /** Gets or sets the push title. */
+    pushTitle?: string | null;
+
+    /** Gets or sets the recipients. */
+    recipients?: CommunicationEntryRecipientBag[] | null;
+
+    /** Gets or sets the reply to email address. */
+    replyAddress?: string | null;
+
+    /** Gets or sets the SMS attachment binary files. */
+    smsAttachmentBinaryFiles?: ListItemBag[] | null;
+
+    /** Gets or sets the SMS from system phone number unique identifier. */
+    smsFromSystemPhoneNumberGuid?: Guid | null;
+
+    /** Gets or sets the SMS message. */
+    smsMessage?: string | null;
+
+    /** Gets or sets the status. */
+    status: CommunicationStatus;
+
+    /** Gets or sets the subject. */
+    subject?: string | null;
+};