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

package/types/ViewModels/Blocks/Communication/SmsConversations/smsConversationsInitializationBox.d.ts

@@ -0,0 +1,55 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationMessageFilter } from "@Obsidian/Enums/Communication/communicationMessageFilter";
+import { ConversationBag } from "@Obsidian/ViewModels/Blocks/Communication/SmsConversations/conversationBag";
+import { SnippetBag } from "@Obsidian/ViewModels/Blocks/Communication/SmsConversations/snippetBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteTypeBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The SMS Conversations Initialization Box */
+export type SmsConversationsInitializationBox = {
+    /** Gets or sets the value indicating whether the logged in person can Edit or Administrate. */
+    canEditOrAdministrate: boolean;
+
+    /** Gets or sets the list of Conversations */
+    conversations?: ConversationBag[] | null;
+
+    /** Gets or sets the error message, if any. */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether the "New Message" button is visible. */
+    isNewMessageButtonVisible: boolean;
+
+    /** Gets or sets the filter used to filter communication messages. */
+    messageFilter: CommunicationMessageFilter;
+
+    /** Gets or sets the list of available note types. */
+    noteTypes?: NoteTypeBag[] | null;
+
+    /** Gets or sets the list of available snippets. */
+    snippets?: SnippetBag[] | null;
+
+    /** Gets or sets the list of System Phone Numbers */
+    systemPhoneNumbers?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Communication/SmsConversations/smsConversationsSaveNoteBag.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 { SaveNoteRequestBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/saveNoteRequestBag";
+
+/** The Save Note Bag for SMS Conversations */
+export type SmsConversationsSaveNoteBag = {
+    /** Gets or sets the note request bag containing the details for saving a note. */
+    noteRequestBag?: SaveNoteRequestBag | null;
+
+    /** Gets or sets the alias ID key for the selected person. */
+    selectedPersonAliasIdKey?: string | null;
+};

package/types/ViewModels/Blocks/Communication/SmsConversations/snippetBag.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 { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The Snippet Bag for SMS Conversations */
+export type SnippetBag = {
+    /** Gets or sets the list of category GUIDs associated with the snippet. */
+    categories?: Guid[] | null;
+
+    /** Gets or sets the snippet data. */
+    snippet?: ListItemBag | null;
+
+    /** Gets or sets the visibility of the snippet (e.g., "Personal" or "Shared"). */
+    snippetVisibility?: string | null;
+};

package/types/ViewModels/Blocks/Communication/SmsPipelineList/smsPipelineListOptionsBag.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 Sms Pipeline List block. */
+export type SmsPipelineListOptionsBag = {
+};

package/types/ViewModels/Blocks/Communication/SystemCommunicationPreview/systemCommunicationPreviewInitializationBox.d.ts

@@ -0,0 +1,75 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type SystemCommunicationPreviewInitializationBox = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Get or set the body. */
+    body?: string | null;
+
+    /** Get or set the date options. */
+    dateOptions?: ListItemBag[] | null;
+
+    /** Get or set the email address */
+    email?: string | null;
+
+    /** Get or set the error message */
+    errorMessage?: string | null;
+
+    /** Get or set the from. */
+    from?: string | null;
+
+    /** Get or set the from name. */
+    fromName?: string | null;
+
+    /** Get or set the HasSendDate property. */
+    hasSendDate: boolean;
+
+    /** ets or sets the ID. */
+    id: number;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Get or set the publication date. */
+    publicationDate?: string | null;
+
+    /** Get or set the subject. */
+    subject?: string | null;
+
+    /** Get or set the Target Person bag */
+    targetPersonBag?: ListItemBag | null;
+
+    /** Get or set the Target Person ID Key */
+    targetPersonIdKey?: string | null;
+
+    /** Get or set the title. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Core/AssetStorageProviderList/assetStorageProviderListOptionsBag.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 Asset Storage Provider List block. */
+export type AssetStorageProviderListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/AttributeMatrixTemplateDetail/attributeMatrixTemplateBag.d.ts

@@ -0,0 +1,58 @@
+//------------------------------------------------------------------------------
+// <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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+/** The item details for the Attribute Matrix Template Detail block. */
+export type AttributeMatrixTemplateBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** The lava template for what is shown when displaying the Matrix Attribute formatted value  */
+    formattedLava?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets the maximum rows. */
+    maximumRows?: string | null;
+
+    /** Gets or sets the minimum rows. */
+    minimumRows?: string | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the template attributes. */
+    templateAttributes?: PublicEditableAttributeBag[] | null;
+};

package/types/ViewModels/Blocks/Core/AttributeMatrixTemplateDetail/attributeMatrixTemplateDetailOptionsBag.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 Attribute Matrix Template Detail block. */
+export type AttributeMatrixTemplateDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/AttributeMatrixTemplateList/attributeMatrixTemplateListOptionsBag.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 Attribute Matrix Template List block. */
+export type AttributeMatrixTemplateListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/BinaryFileList/binaryFileListOptionsBag.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>
+//
+
+/** The additional configuration options for the Binary File List block. */
+export type BinaryFileListOptionsBag = {
+    /** Gets or sets the configured binary file type. */
+    binaryFileTypeName?: string | null;
+};

package/types/ViewModels/Blocks/Core/BinaryFileTypeDetail/binaryFileTypeBag.d.ts

@@ -0,0 +1,86 @@
+//------------------------------------------------------------------------------
+// <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 { RockCacheabilityBag } from "@Obsidian/ViewModels/Controls/rockCacheabilityBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+export type BinaryFileTypeBag = {
+    /** Gets or sets a flag indicating if this BinaryFileType allows anonymous uploads. */
+    allowAnonymous: boolean;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the binary file type attributes. */
+    binaryFileTypeAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** Gets or sets the cache control header settings. */
+    cacheControlHeaderSettings?: RockCacheabilityBag | null;
+
+    /** Gets or sets a flag indicating whether the file on any Rock.Model.BinaryFile child entities should be cached to the server. */
+    cacheToServerFileSystem: boolean;
+
+    /** Gets or sets a description of the BinaryFileType. */
+    description?: string | null;
+
+    /** Gets or sets the edit mode message. */
+    editModeMessage?: string | null;
+
+    /** Gets or sets the CSS class that is used for a vector/CSS icon. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this BinaryFileType is part of the Rock core system/framework. This property is required. */
+    isSystem: boolean;
+
+    /** Gets or sets the maximum file size bytes. */
+    maxFileSizeBytes?: number | null;
+
+    /** Gets or sets a value indicating the maximum height of a file type. */
+    maxHeight?: number | null;
+
+    /** Gets or sets a value indicating the maximum width of a file type. */
+    maxWidth?: number | null;
+
+    /** Gets or sets the given Name of the BinaryFileType. This value is an alternate key and is required. */
+    name?: string | null;
+
+    /** Gets or sets a value indicating whether the preferred attributes of the file type are required */
+    preferredRequired: boolean;
+
+    /** Gets or sets a value indicating whether security should be checked when displaying files of this type */
+    requiresViewSecurity: boolean;
+
+    /** Gets or sets a value indicating whether [restricted edit]. */
+    restrictedEdit: boolean;
+
+    /** Gets or sets the storage mode Rock.Model.EntityType. */
+    storageEntityType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Core/BinaryFileTypeDetail/binaryFileTypeDetailOptionsBag.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>
+//
+
+/** Additional Configuration details for the Binary File Type Detail */
+export type BinaryFileTypeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/BinaryFileTypeList/binaryFileTypeListOptionsBag.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 Binary File Type List block. */
+export type BinaryFileTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/CampusDetail/campusBag.d.ts

@@ -49,6 +49,9 @@ export type CampusBag = {
     /** Gets or sets the campus type value. */
     campusTypeValue?: ListItemBag | null;
 
+    /** Gets or sets the closed date. */
+    closedDate?: string | null;
+
     /** Gets or sets the description. */
     description?: string | null;
 
@@ -70,6 +73,9 @@ export type CampusBag = {
     /** Gets or sets the name. */
     name?: string | null;
 
+    /** Gets or sets the opened date. */
+    openedDate?: string | null;
+
     /** Gets or sets the phone number. */
     phoneNumber?: string | null;
 

package/types/ViewModels/Blocks/Core/CategoryDetail/categoryBag.d.ts

@@ -32,6 +32,12 @@ export type CategoryBag = {
     /** Gets or sets the attribute values. */
     attributeValues?: Record<string, string> | null;
 
+    /** Gets or sets the CategoryId of the currently selected Category. */
+    categoryId: number;
+
+    /** If true all AttributeValue records for the Category will be deleted. */
+    deleteAttributeValues: boolean;
+
     /** Gets or sets the description. */
     description?: string | null;
 
@@ -53,6 +59,9 @@ export type CategoryBag = {
     /** Gets or sets the identifier key of this entity. */
     idKey?: string | null;
 
+    /** Gets or sets if the delete option should be shown on the remote device. */
+    isDeletable: boolean;
+
     /** Gets or sets a flag indicating if this Category is part of the Rock core system/framework. */
     isSystem: boolean;
 

package/types/ViewModels/Blocks/Core/CategoryDetail/categoryDetailOptionsBag.d.ts

@@ -22,4 +22,6 @@
 //
 
 export type CategoryDetailOptionsBag = {
+    /** Gets or sets whether the block should be shown. */
+    showBlock: boolean;
 };