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

package/types/ViewModels/Blocks/Core/NoteTypeDetail/noteTypeBag.d.ts

@@ -26,6 +26,12 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
 
 export type NoteTypeBag = {
+    /** Gets or sets the criteria for AI to automatically approve notes.  */
+    aiApprovalGuidelines?: string | null;
+
+    /** Gets or sets the AI provider to use for AI approvals. */
+    aiProvider?: ListItemBag | null;
+
     /** Gets or sets a value indicating whether attachments are allowed for this note type. */
     allowsAttachments: boolean;
 
@@ -50,6 +56,9 @@ export type NoteTypeBag = {
     /** Gets or sets the color of each note. */
     color?: string | null;
 
+    /** Gets or sets a value indicating whether [enabled AI approvals]. */
+    enabledAIApprovals: boolean;
+
     /** Gets or sets the Rock.Model.EntityType of the entities that Notes of this NoteType  */
     entityType?: ListItemBag | null;
 
@@ -74,6 +83,9 @@ export type NoteTypeBag = {
     /** Gets or sets the Name of the NoteType. This property is required. */
     name?: string | null;
 
+    /** Gets or sets a value indicating whether [requires approvals]. */
+    requiresApprovals: boolean;
+
     /** Gets or sets a value indicating whether to show the entity type picker to allow user selection. */
     showEntityTypePicker: boolean;
 

package/types/ViewModels/Blocks/Core/NoteTypeDetail/noteTypeDetailOptionsBag.d.ts

@@ -22,4 +22,6 @@
 //
 
 export type NoteTypeDetailOptionsBag = {
+    /** Gets or sets a value indicating whether there any active AI providers. */
+    hasActiveAIProviders: boolean;
 };

package/types/ViewModels/Blocks/Core/NoteTypeList/noteTypeListOptionsBag.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 Note Type List block. */
+export type NoteTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/NoteWatchDetail/noteWatchBag.d.ts

@@ -0,0 +1,73 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Contains the NoteWatch details. */
+export type NoteWatchBag = {
+    /**
+     * Set AllowOverride to False to prevent people from adding an IsWatching=False on NoteWatch with the same filter that is marked as IsWatching=True
+     * In other words, if a group is configured a NoteWatch, an individual shouldn't be able to add an un-watch if AllowOverride=False (and any un-watches that may have been already added would be ignored)
+     */
+    allowOverride: 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 watch entity. */
+    entityId?: number | null;
+
+    /** Gets or sets the name of the entity. */
+    entityName?: string | null;
+
+    /** Gets or sets the type of the entity. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Set IsWatching to False to disable this NoteWatch (or specifically don't watch based on the notewatch criteria) */
+    isWatching: boolean;
+
+    /** Gets or sets the note. */
+    note?: ListItemBag | null;
+
+    /** Gets or sets the type of the note. */
+    noteType?: ListItemBag | null;
+
+    /** Gets or sets the watched entity. */
+    watchedEntity?: ListItemBag | null;
+
+    /** Gets or sets the watched note text. */
+    watchedNoteText?: string | null;
+
+    /** Gets or sets the group that is watching this note watch */
+    watcherGroup?: ListItemBag | null;
+
+    /** Gets or sets the person alias of the person watching this note watch */
+    watcherPersonAlias?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Core/NoteWatchDetail/noteWatchDetailOptionsBag.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Contains information required to configure the NoteWatchDetail edit view. */
+export type NoteWatchDetailOptionsBag = {
+    /** Gets or sets a value indicating whether [disable group picker] based on the current context Group.. */
+    disableGroupPicker: boolean;
+
+    /** Gets or sets a value indicating whether [disable person picker] based on the current context Person. */
+    disablePersonPicker: boolean;
+
+    /** Gets or sets a value indicating whether [hide group picker] based on the current context Person. */
+    hideGroupPicker: boolean;
+
+    /** Gets or sets a value indicating whether [hide panel]. */
+    hidePanel: boolean;
+
+    /** Gets or sets a value indicating whether [hide person picker] based on the current context Group. */
+    hidePersonPicker: boolean;
+
+    /** Gets or sets the available note type options. */
+    noteTypeOptions?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Core/NoteWatchList/noteWatchListOptionsBag.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 additional configuration options for the Note Watch List block. */
+export type NoteWatchListOptionsBag = {
+    /** Gets or sets the Entity Type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /** Gets or sets the Note Type unique identifier. */
+    noteTypeGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/Core/Notes/noteBag.d.ts

@@ -21,11 +21,16 @@
 // </copyright>
 //
 
+import { NoteApprovalStatus } from "@Obsidian/Enums/Core/noteApprovalStatus";
+
 /** Describes an existing note that should be displayed to the person. */
 export type NoteBag = {
     /** Gets or sets the unique anchor identifier used to link to this note. */
     anchorId?: string | null;
 
+    /** Gets or sets the approval status of this note. */
+    approvalStatus: NoteApprovalStatus;
+
     /** Gets or sets the attribute values. */
     attributeValues?: Record<string, string> | null;
 

package/types/ViewModels/Blocks/Core/Notes/noteTypeBag.d.ts

@@ -55,6 +55,9 @@ export type NoteTypeBag = {
     /** Gets or sets the name. */
     name?: string | null;
 
+    /** Gets or sets a value indicating whether notes of this type require approvals. */
+    requiresApprovals: boolean;
+
     /** Gets or sets a value indicating whether the person can select this note type. */
     userSelectable: boolean;
 };

package/types/ViewModels/Blocks/Core/PersonFollowingList/personFollowingListOptionsBag.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>
+//
+
+/** The additional configuration options for the Person Following List block. */
+export type PersonFollowingListOptionsBag = {
+    /** Gets or sets the home phone defined value text. */
+    homePhoneDefinedValueText?: string | null;
+
+    /** Gets or sets the mobile phone defined value text. */
+    mobilePhoneDefinedValueText?: string | null;
+};

package/types/ViewModels/Blocks/Core/PersonSuggestionList/personSuggestionListOptionsBag.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 Following Suggested List block. */
+export type PersonSuggestionListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/RestActionList/restActionListOptionsBag.d.ts

@@ -21,5 +21,11 @@
 // </copyright>
 //
 
+/** The options bag for the RestActionList block. */
 export type RestActionListOptionsBag = {
+    /** Gets or sets the controller name. */
+    controllerName?: string | null;
+
+    /** Gets or sets the obsolete warning. */
+    obsoleteWarning?: string | null;
 };

package/types/ViewModels/Blocks/Core/RestControllerList/restControllerListBag.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type RestControllerListBag = {
+    actions: number;
+
+    actionsWithPublicCachingHeaders: number;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    className?: string | null;
+
+    id: number;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Core/RestControllerList/restControllerListOptionsBag.d.ts

@@ -21,5 +21,6 @@
 // </copyright>
 //
 
+/** The additional configuration options for the Rest Controller List block. */
 export type RestControllerListOptionsBag = {
 };

package/types/ViewModels/Blocks/Core/ScheduleList/scheduleListOptionsBag.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 Schedule List block. */
+export type ScheduleListOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether or not the Category Column and Filter are visible
+     * There are hidden if the FilterCategoryFromQueryString block setting is set to true and
+     * a CategoryId/Guid is provided.
+     */
+    isCategoryColumnAndFilterVisible: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the grid should be visible.
+     * The grid will not be displayed if the 'FilterCategoryFromQueryString' block setting is set to true
+     * and no CategoryId is provided in the URL.
+     */
+    isGridVisible: boolean;
+};

package/types/ViewModels/Blocks/Core/ScheduledJobHistoryList/scheduledJobHistoryListOptionsBag.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>
+//
+
+/** The additional configuration options for the Service Job History List block. */
+export type ScheduledJobHistoryListOptionsBag = {
+    /** Gets or sets a value indicating whether the page has a valid ScheduledJobId parameter. */
+    isJobIdValid: boolean;
+
+    /** Gets or sets the name of the service job. */
+    serviceJobName?: string | null;
+};

package/types/ViewModels/Blocks/Core/SignalTypeList/signalTypeListOptionsBag.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 Signal Type List block. */
+export type SignalTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/SignatureDocumentDetail/signatureDocumentBag.d.ts

@@ -0,0 +1,134 @@
+//------------------------------------------------------------------------------
+// <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 { SignatureDocumentStatus } from "@Obsidian/Enums/Core/signatureDocumentStatus";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type SignatureDocumentBag = {
+    /** Gets or sets the applies to person alias. */
+    appliesToPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets the applies to person alias identifier. */
+    appliesToPersonAliasId?: number | null;
+
+    /** Gets or sets the assigned to person alias. */
+    assignedToPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets the assigned to person alias identifier. */
+    assignedToPersonAliasId?: number | null;
+
+    /** 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. */
+    binaryFile?: ListItemBag | null;
+
+    /** Gets or sets the binary file identifier. */
+    binaryFileId?: number | null;
+
+    /** The date and time the document completion email was sent. */
+    completionEmailSentDateTime?: string | null;
+
+    /** Gets or sets the document key. */
+    documentKey?: string | null;
+
+    /** The ID of the entity to which the document is related. */
+    entityId?: number | null;
+
+    /** The EntityType that this document is related to (example Rock.Model.Registration) */
+    entityType?: ListItemBag | null;
+
+    /** The EntityType that this document is related to (example Rock.Model.Registration) */
+    entityTypeId?: number | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the invite count. */
+    inviteCount: number;
+
+    /** Gets or sets whether we are dealing with a legacy template. */
+    isLegacyDocument: boolean;
+
+    /** Gets or sets the request date. */
+    lastInviteDate?: string | null;
+
+    /** Gets or sets the last status date. */
+    lastStatusDate?: string | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /**
+     * The encrypted data that was collected during a drawn signature type.
+     * Use Rock.Model.SignatureDocument.SignatureData to set this from the unencrypted drawn signature.
+     */
+    signatureDataEncrypted?: string | null;
+
+    /** Gets or sets the Rock.Model.SignatureDocumentTemplate that is being executed in this persisted SignatureDocument instance. */
+    signatureDocumentTemplate?: ListItemBag | null;
+
+    /** Gets or sets the SignatureDocumentTemplateId of the Rock.Model.SignatureDocumentTemplate that this SignatureDocument instance is executing. */
+    signatureDocumentTemplateId: number;
+
+    /**
+     * The computed SHA1 hash for the SignedDocumentText, SignedClientIP address, SignedClientUserAgent, SignedDateTime, SignedByPersonAliasId, SignatureData, and SignedName.
+     * This hash can be used to prove the authenticity of the unaltered signature document.
+     * This is only calculated once during the pre-save event when the SignedDateTime was originally null/empty but now has a value.
+     */
+    signatureVerificationHash?: string | null;
+
+    /** The email address that was used to send the completion receipt. */
+    signedByEmail?: string | null;
+
+    /** Gets or sets the signed by person alias. */
+    signedByPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets the signed by person alias identifier. */
+    signedByPersonAliasId?: number | null;
+
+    /** The observed IP address of the client system of the individual who signed the document. */
+    signedClientIp?: string | null;
+
+    /** The observed 'user agent' of the client system of the individual who signed the document. */
+    signedClientUserAgent?: string | null;
+
+    /** The date and time the document was signed. */
+    signedDateTime?: string | null;
+
+    /**
+     * The resulting text/document using the Lava template from the Rock.Model.SignatureDocumentTemplate at the time the document was signed.
+     * Does not include the signature data. It would be what they saw just prior to signing.
+     */
+    signedDocumentText?: string | null;
+
+    /** The name of the individual who signed the document. */
+    signedName?: string | null;
+
+    /** Gets or sets the status. */
+    status: SignatureDocumentStatus;
+};

package/types/ViewModels/Blocks/Core/SignatureDocumentDetail/signatureDocumentDetailOptionsBag.d.ts

@@ -0,0 +1,25 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+export type SignatureDocumentDetailOptionsBag = {
+};