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

package/types/ViewModels/Blocks/Core/SignatureDocumentList/signatureDocumentListOptionsBag.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 Signature Document List Options Bag */
+export type SignatureDocumentListOptionsBag = {
+    /** Gets or set the boolean value determining who can view. */
+    canView: boolean;
+
+    /** Gets or sets the boolean value whether to show a document type. */
+    showDocumentType: boolean;
+};

package/types/ViewModels/Blocks/Core/SignatureDocumentTemplateDetail/signatureDocumentTemplateBag.d.ts

@@ -83,5 +83,5 @@ export type SignatureDocumentTemplateBag = {
      * Gets or sets a number of days the signature document made form this template be deemed valid.
      * This property is honored only if the IsValidInFuture property is set.
      */
-    validityDurationInDays?: string | null;
+    validityDurationInDays?: number | null;
 };

package/types/ViewModels/Blocks/Core/SignatureDocumentTemplateList/signatureDocumentTemplateListOptionsBag.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 Signature Document Template List block. */
+export type SignatureDocumentTemplateListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/TagDetail/tagDetailOptionsBag.d.ts

@@ -21,5 +21,8 @@
 // </copyright>
 //
 
+/** Additional Configuration for the TagDetail block. */
 export type TagDetailOptionsBag = {
+    /** The Regular Expression used to determine a valid tag name. This regex will return true if the string does not contain angle brackets, percent, or ampersand. */
+    tagNameBlackListRegex?: string | null;
 };

package/types/ViewModels/Blocks/Core/TagList/tagListOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Tag List block. */
+export type TagListOptionsBag = {
+    /** Gets or sets the current person. */
+    currentPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets a value indicating whether the qualifier columns should visible. */
+    isQualifierColumnsVisible: boolean;
+
+    /** Gets or sets a value indicating whether the reorder column on the grid should be visible. */
+    isReorderColumnVisible: boolean;
+};

package/types/ViewModels/Blocks/Core/TaggedItemList/taggedItemListOptionsBag.d.ts

@@ -23,24 +23,24 @@
 
 /** Represents options for a tagged item list. */
 export type TaggedItemListOptionsBag = {
-    /** Gets or sets the globally unique identifier of the entity type. */
+    /** Gets the Entity Type GUID. */
     entityTypeGuid?: string | null;
 
-    /** Gets or sets the name of the entity type. */
+    /** Gets the Entity Type Name. */
     entityTypeName?: string | null;
 
-    /** Gets or sets a value indicating whether the block is hidden. */
+    /** Gets if the block needs to be hidden. */
     isBlockHidden: boolean;
 
-    /** Gets or sets a value indicating whether this is a person tag. */
+    /** Gets if the Tag is a Person Tag. */
     isPersonTag: boolean;
 
-    /** Gets or sets the tag identifier. */
+    /** Gets the Tag Id. */
     tagId: number;
 
-    /** Gets or sets the name of the tag. */
+    /** Gets the tag Name. */
     tagName?: string | null;
 
-    /** Gets or sets the title. */
+    /** Gets the title. */
     title?: string | null;
 };

package/types/ViewModels/Blocks/Crm/AssessmentList/assessmentListBag.d.ts

@@ -22,12 +22,6 @@
 //
 
 export type AssessmentListBag = {
-    /** Gets or sets the assessment list. */
-    assessmentList?: string | null;
-
-    /** Gets or sets the error message. */
-    errorMessage?: string | null;
-
-    /** Gets or sets a value indicating whether this instance has content. */
-    hasContent: boolean;
+    /** Gets or sets the assessment list content. */
+    assessmentListContent?: string | null;
 };

package/types/ViewModels/Blocks/Crm/AssessmentTypeDetail/assessmentTypeBag.d.ts

@@ -65,5 +65,5 @@ export type AssessmentTypeBag = {
      * Gets or sets the number of days the assessment is valid for Rock.Model.AssessmentType.
      * How long (in days) is this assessment valid before it must be taken again.
      */
-    validDuration: number;
+    validDuration?: number | null;
 };

package/types/ViewModels/Blocks/Crm/AssessmentTypeList/assessmentTypeListOptionsBag.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 Assessment Type List block. */
+export type AssessmentTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Crm/BadgeList/badgeListOptionsBag.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 Badge List block. */
+export type BadgeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Crm/Disc/assessmentResponseBag.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>
+//
+
+/** Contains the data representing the response to a question series for the DISC assessment. */
+export type AssessmentResponseBag = {
+    /** Gets or sets the least score. */
+    leastScore?: string | null;
+
+    /** Gets or sets the most score. */
+    mostScore?: string | null;
+
+    /** Gets or sets the question number. */
+    questionNumber?: string | null;
+
+    /** Gets or sets the questions. */
+    questions?: Record<string, string> | null;
+};

package/types/ViewModels/Blocks/Crm/Disc/assessmentResultsBag.d.ts

@@ -0,0 +1,52 @@
+//------------------------------------------------------------------------------
+// <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 bag containing the results of the assessment. */
+export type AssessmentResultsBag = {
+    /** Gets or sets the adaptive behavior score for the 'S' trait. */
+    adaptiveBehaviorC: number;
+
+    /** Gets or sets the adaptive behavior score for the 'D' trait. */
+    adaptiveBehaviorD: number;
+
+    /** Gets or sets the adaptive behavior score for the 'I' trait. */
+    adaptiveBehaviorI: number;
+
+    /** Gets or sets the adaptive behavior score for the 'C' trait. */
+    adaptiveBehaviorS: number;
+
+    /** Gets or sets the natural behavior score for the 'C' trait. */
+    naturalBehaviorC: number;
+
+    /** Gets or sets the natural behavior score for the 'D' trait. */
+    naturalBehaviorD: number;
+
+    /** Gets or sets the natural behavior score for the 'I' trait. */
+    naturalBehaviorI: number;
+
+    /** Gets or sets the natural behavior score for the 'S' trait. */
+    naturalBehaviorS: number;
+
+    /** Gets or sets the personality type code. */
+    personalityType?: string | null;
+};

package/types/ViewModels/Blocks/Crm/Disc/discInitializationBox.d.ts

@@ -0,0 +1,104 @@
+//------------------------------------------------------------------------------
+// <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 { AssessmentResponseBag } from "@Obsidian/ViewModels/Blocks/Crm/Disc/assessmentResponseBag";
+import { AssessmentResultsBag } from "@Obsidian/ViewModels/Blocks/Crm/Disc/assessmentResultsBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Contains all the initial configuration data required to render the Disc block. */
+export type DiscInitializationBox = {
+    /** Gets or sets whether the individual can retake the test. */
+    canRetakeTest: boolean;
+
+    /** Gets or sets the "Challenges"" description for the individual based on the results of their DISC assessment. */
+    discChallenges?: string | null;
+
+    /** Gets or sets the "Follower Style" description for the individual based on the results of their DISC assessment. */
+    discFollowerStyle?: string | null;
+
+    /** Gets or sets the "Leadership Style" description for the individual based on the results of their DISC assessment. */
+    discLeadershipStyle?: string | null;
+
+    /** Gets or sets the "Motivation" description for the individual based on the results of their DISC assessment. */
+    discMotivation?: string | null;
+
+    /** Gets or sets the overall personality description for the individual based on the results of their DISC assessment. */
+    discPersonalityDescription?: string | null;
+
+    /** Gets or sets the "Strengths" description for the individual based on the results of their DISC assessment. */
+    discStrengths?: string | null;
+
+    /** Gets or sets the "Team Contribution" description for the individual based on the results of their DISC assessment. */
+    discTeamContribution?: string | null;
+
+    /** Gets or sets the "Under Pressure" description for the individual based on the results of their DISC assessment. */
+    discUnderPressure?: string | 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;
+
+    /** An optional informational message to display to the individual. */
+    infoMessage?: string | null;
+
+    /** Gets or sets the instructions for the assessment. */
+    instructions?: string | null;
+
+    /** Gets or sets a value indicating whether the assessment is for the person currently viewing the assessment. */
+    isAsessmentForCurrentPerson: boolean;
+
+    /** Gets or sets the date the assessment was last saved. */
+    lastSavedDate?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the number of questions to show per page. */
+    pageSize: number;
+
+    /** Gets or sets the CSS class to use for the panel icon. */
+    panelIcon?: string | null;
+
+    /** Gets or sets the title to use for the panel. */
+    panelTitle?: string | null;
+
+    /** Gets or sets the 1-2 character personality type for the individual based on the results of their DISC assessment. */
+    personalityType?: string | null;
+
+    /** Gets or sets the responses/questions for the DISC assessment. */
+    responses?: AssessmentResponseBag[] | null;
+
+    /** The results of the most recent assessment. */
+    results?: AssessmentResultsBag | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the date the individual started the assessment (should be after clicking start). */
+    startDateTime?: string | null;
+
+    /** Gets or sets the target person bag. */
+    targetPersonBag?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Crm/FamilyPreRegistration/familyPreRegistrationInitializationBox.d.ts

@@ -60,6 +60,9 @@ export type FamilyPreRegistrationInitializationBox = {
     /** Gets or sets the adult gender field. */
     adultGenderField?: FamilyPreRegistrationFieldBag | null;
 
+    /** The label that should be used when referring to adults on the form. */
+    adultLabel?: string | null;
+
     /** Gets or sets the adult marital status field. */
     adultMaritalStatusField?: FamilyPreRegistrationFieldBag | null;
 
@@ -111,6 +114,9 @@ export type FamilyPreRegistrationInitializationBox = {
     /** Gets or sets the child grade field. */
     childGradeField?: FamilyPreRegistrationFieldBag | null;
 
+    /** The label that should be used when referring to children on the form. */
+    childLabel?: string | null;
+
     /** Gets or sets the child mobile phone field. */
     childMobilePhoneField?: FamilyPreRegistrationFieldBag | null;
 
@@ -138,6 +144,9 @@ export type FamilyPreRegistrationInitializationBox = {
     /** Gets or sets the create account title. */
     createAccountTitle?: string | null;
 
+    /** Gets or sets a value indicating whether captcha support should be disabled for this block. */
+    disableCaptchaSupport: boolean;
+
     /** Gets or sets the display SMS opt in. */
     displaySmsOptIn?: FamilyPreRegistrationSmsOptInFieldBag | null;
 

package/types/ViewModels/Blocks/Crm/FamilyPreRegistration/familyPreRegistrationSaveRequestBag.d.ts

@@ -52,9 +52,6 @@ export type FamilyPreRegistrationSaveRequestBag = {
     /** Gets or sets the family unique identifier. */
     familyGuid?: Guid | null;
 
-    /** Gets or sets the full name. */
-    fullName?: string | null;
-
     /** Gets or sets the planned visit date. */
     plannedVisitDate?: string | null;
 

package/types/ViewModels/Blocks/Crm/NamelessPersonList/namelessPersonListOptionsBag.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 Nameless Person List block. */
+export type NamelessPersonListOptionsBag = {
+};

package/types/ViewModels/Blocks/Crm/PhotoUpload/personPhotoBag.d.ts

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type PersonPhotoBag = {
+    /**
+     * Gets or sets the FullName of the person with which
+     * the profile photo belongs to.
+     */
+    fullName?: string | null;
+
+    /**
+     * Gets or sets the IdKey of the person with which
+     * the profile photo belongs to.
+     */
+    idKey?: string | null;
+
+    /**
+     * Gets or sets IsStaffMemberDisabled which is used
+     * to determine if the is a staff member that should
+     * be disabled from the photo upload process.
+     */
+    isStaffMemberDisabled: boolean;
+
+    /**
+     * Gets or sets the Url of the photo to be displayed
+     * when the person does not have a profile photo.
+     */
+    noPhotoUrl?: string | null;
+
+    /** Gets or sets the ProfilePhoto for the person */
+    profilePhoto?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Crm/PhotoUpload/photoUploadInitializationBox.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 { PersonPhotoBag } from "@Obsidian/ViewModels/Blocks/Crm/PhotoUpload/personPhotoBag";
+
+export type PhotoUploadInitializationBox = {
+    /**
+     * 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 the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the list of profile photos for the people
+     * within the same family as the person logged in.
+     */
+    personPhotoList?: PersonPhotoBag[] | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Crm/SignalTypeDetail/signalTypeBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type SignalTypeBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets a value indicating whether this instance can administrate. */
+    canAdministrate: boolean;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the name of the SignalType. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the order. */
+    order: number;
+
+    /** Gets or sets the HTML color of the SignalType. This property is required. */
+    signalColor?: string | null;
+
+    /** Gets or sets the icon CSS class of the SignalType. */
+    signalIconCssClass?: string | null;
+};