@rockrms/obsidian-framework 17.0.43 → 17.2.4

package/types/ViewModels/Blocks/Core/DeviceDetail/deviceBag.d.ts

@@ -82,4 +82,7 @@ export type DeviceBag = {
 
     /** Gets or sets a flag that overrides which printer the print job is set to. */
     printToOverride: PrintTo;
+
+    /** The device that will act as a proxy for this device. */
+    proxyDevice?: ListItemBag | null;
 };

package/types/ViewModels/Blocks/Core/DeviceDetail/deviceDetailOptionsBag.d.ts

@@ -41,4 +41,7 @@ export type DeviceDetailOptionsBag = {
 
     /** Gets or sets the print to options. */
     printToOptions?: ListItemBag[] | null;
+
+    /** The list of cloud print proxy devices that can be selected. */
+    proxyItems?: ListItemBag[] | null;
 };

package/types/ViewModels/Blocks/Core/LocationDetail/locationBag.d.ts

@@ -37,6 +37,9 @@ export type LocationBag = {
     /** Gets or sets the attribute values. */
     attributeValues?: Record<string, string> | null;
 
+    /** Gets or sets the identifier of the bluetooth beacon. */
+    beaconId?: number | null;
+
     /** Gets or sets threshold that will prevent checkin (no option to override) */
     firmRoomThreshold?: string | null;
 

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

@@ -21,8 +21,8 @@
 // </copyright>
 //
 
-import { NoteBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteBag";
-import { NoteTypeBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteTypeBag";
+import { NoteBag } from "@Obsidian/ViewModels/Controls/noteBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Controls/noteTypeBag";
 
 export type NotesInitializationBox = {
     /** Gets or sets a value indicating whether the add note editor should always be visible. */

package/types/ViewModels/Blocks/Engagement/StepProgramList/stepProgramListOptionsBag.d.ts

@@ -23,4 +23,6 @@
 
 /** The additional configuration options for the Step Program List block. */
 export type StepProgramListOptionsBag = {
+    /** Gets or sets a value indicating whether the reorder column should be visible. */
+    isReOrderColumnVisible: boolean;
 };

package/types/ViewModels/Blocks/Event/RegistrationEntry/registrantBag.d.ts

@@ -43,6 +43,9 @@ export type RegistrantBag = {
     /** Gets or sets the unique identifier. */
     guid: Guid;
 
+    /** Gets or sets the boolean value that determines if the current registrant is a new family. */
+    isNewFamily: boolean;
+
     /** Gets or sets a value indicating whether this instance is on wait list. */
     isOnWaitList: boolean;
 

package/types/ViewModels/Blocks/Finance/FinancialAccountDetail/financialAccountBag.d.ts

@@ -91,4 +91,10 @@ export type FinancialAccountBag = {
 
     /** Gets or sets the URL which could be used to generate a link to a 'More Info' page */
     url?: string | null;
+
+    /**
+     * Determines if the account uses child accounts and a campus identifier from
+     * the block to pick a matching child account for the transaction.
+     */
+    usesCampusChildAccounts: boolean;
 };

package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduleToolbox/performScheduleRowActionRequestBag.d.ts

@@ -22,6 +22,7 @@
 //
 
 import { ToolboxScheduleRowActionType } from "@Obsidian/Enums/Blocks/Group/Scheduling/toolboxScheduleRowActionType";
+import { ToolboxScheduleRowConfirmationStatus } from "@Obsidian/Enums/Blocks/Group/Scheduling/toolboxScheduleRowConfirmationStatus";
 import { Guid } from "@Obsidian/Types";
 
 /**
@@ -40,6 +41,9 @@ export type PerformScheduleRowActionRequestBag = {
      */
     entityGuid: Guid;
 
+    /** Gets or sets the existing confirmation status. */
+    existingConfirmationStatus: ToolboxScheduleRowConfirmationStatus;
+
     /** Gets or sets the selected person unique identifier. */
     selectedPersonGuid: Guid;
 };

package/types/ViewModels/Blocks/{Cms/BlockList/blockListOptionsBag.d.ts → Security/LoginHistory/loginHistoryOptionsBag.d.ts}

@@ -21,6 +21,6 @@
 // </copyright>
 //
 
-/** The additional configuration options for the Block List block. */
-export type BlockListOptionsBag = {
+/** The additional configuration options for the Login History block. */
+export type LoginHistoryOptionsBag = {
 };

package/types/ViewModels/Blocks/Tv/TvPageList/tvPageListOptionsBag.d.ts

@@ -23,6 +23,9 @@
 
 /** Describes the TV Page List Options */
 export type TvPageListOptionsBag = {
+    /** Gets or sets the default page identifier key of the current application. */
+    defaultPageIdKey?: string | null;
+
     /** Gets or sets the site id key. */
     siteId?: string | null;
 };

package/types/ViewModels/Blocks/Workflow/WorkflowEntry/workflowEntryOptionsBag.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>
+//
+
+import { InteractiveActionBag } from "@Obsidian/ViewModels/Workflow/interactiveActionBag";
+
+/**
+ * The initial configuration options for the WorkflowEntry block when used
+ * on a Web site.
+ */
+export type WorkflowEntryOptionsBag = {
+    /** The initial action details to display. */
+    initialAction?: InteractiveActionBag | null;
+
+    /**
+     * If true then a captcha is required in order to submit any
+     * component data back to the server.
+     */
+    isCaptchaEnabled: boolean;
+};

package/types/ViewModels/Blocks/blockActionContextBag.d.ts

@@ -43,4 +43,11 @@ export type BlockActionContextBag = {
      * loaded with.
      */
     pageParameters?: Record<string, string> | null;
+
+    /**
+     * The Interaction session that this request belongs to. This is used
+     * to group block action API requests back to the main request's
+     * session.
+     */
+    sessionGuid?: Guid | null;
 };

package/types/ViewModels/CheckIn/kioskBag.d.ts

@@ -32,9 +32,15 @@ export type KioskBag = {
     /** Gets or sets the identifier of this item. */
     id?: string | null;
 
+    /** Determines if adding new families in registration mode is enabled. */
+    isAddingFamiliesEnabled: boolean;
+
     /** Gets or sets a value indicating whether this kiosk has the camera enabled. */
     isCameraEnabled: boolean;
 
+    /** Determines if editing new families in registration mode is enabled. */
+    isEditingFamiliesEnabled: boolean;
+
     /**
      * Gets or sets a value indicating whether this kiosk supports
      * registration mode.

package/types/ViewModels/{Blocks/Core/Notes → Controls}/saveNoteRequestBag.d.ts

@@ -21,13 +21,13 @@
 // </copyright>
 //
 
-import { NoteEditBag } from "@Obsidian/ViewModels/Blocks/Core/Notes/noteEditBag";
+import { NoteEditBag } from "@Obsidian/ViewModels/Controls/noteEditBag";
 
 /** Describes a request to save changes to an existing note. */
 export type SaveNoteRequestBag = {
     /** Gets or sets the bag that contains the changes that should be made to the note. */
     bag?: NoteEditBag | null;
 
-    /** Gets the valid properties of the Rock.ViewModels.Blocks.Core.Notes.SaveNoteRequestBag.Bag. */
+    /** Gets the valid properties of the Rock.ViewModels.Controls.SaveNoteRequestBag.Bag. */
     validProperties?: string[] | null;
 };

package/types/ViewModels/Finance/savedAccountTokenBag.d.ts

@@ -23,6 +23,9 @@
 
 /** A bag used to add a saved account using a payment method token. */
 export type SavedAccountTokenBag = {
+    /** The additional parameters to include on the payment request. */
+    additionalParameters?: Record<string, string> | null;
+
     /** Gets or sets the city. */
     city?: string | null;
 

package/types/ViewModels/Reporting/chartNumericDataPointBag.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>
+//
+
+/** A bag that contains a numeric data point for a reporting visual. */
+export type ChartNumericDataPointBag = {
+    /** Gets or sets the color for this data point. */
+    color?: string | null;
+
+    /** Gets or sets the label for this data point. */
+    label?: string | null;
+
+    /** Gets or sets the name of the series for this data point. */
+    seriesName?: string | null;
+
+    /** Gets or sets the value for this data point. */
+    value: number;
+};

package/types/ViewModels/Rest/CheckIn/proximityBeaconBag.d.ts

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/**
+ * Describes a single beacon that was detected when entering or leaving
+ * a proximity area.
+ */
+export type ProximityBeaconBag = {
+    /** The accuracy estimate of the signal strength. */
+    accuracy: number;
+
+    /**
+     * The major identifier value (0 - 65535) of the beacon. This is used
+     * to identify the campus.
+     */
+    major: number;
+
+    /**
+     * The minor identifier value (0 - 65535) of the beacon. This is used
+     * to identify the specific location within the campus.
+     */
+    minor: number;
+
+    /**
+     * The signal strength of the beacon. This is used to determine how
+     * close the individual is to the beacon.
+     */
+    rssi: number;
+};

package/types/ViewModels/Rest/CheckIn/proximityCheckInOptionsBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { ProximityBeaconBag } from "@Obsidian/ViewModels/Rest/CheckIn/proximityBeaconBag";
+
+/**
+ * Describes the values that are expected to be sent to the ProximityCheckIn
+ * API endpoint.
+ */
+export type ProximityCheckInOptionsBag = {
+    /**
+     * The set of beacons that were detected when entering or leaving
+     * an area.
+     */
+    beacons?: ProximityBeaconBag[] | null;
+
+    /**
+     * true if this message indicates that the individual has entered
+     * the area; otherwise, false.
+     */
+    isPresent: boolean;
+
+    /**
+     * The unique identifier of the personal device that is being used
+     * when the area was entered or left.
+     */
+    personalDeviceGuid?: Guid | null;
+
+    /**
+     * The unique identifier of the proximity group. Multiple beacons
+     * will share the same unique identifier. There is usually only one
+     * proximity identifier per organization.
+     */
+    proximityGuid: Guid;
+};

package/types/ViewModels/Rest/Controls/assessmentTypePickerGetAssessmentTypesOptionsBag.d.ts

@@ -28,4 +28,7 @@
 export type AssessmentTypePickerGetAssessmentTypesOptionsBag = {
     /** Whether to include assessment types that are marked inactive */
     isInactiveIncluded?: boolean | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/assetManagerGetFilesResultsBag.d.ts

@@ -26,9 +26,12 @@ export type AssetManagerGetFilesResultsBag<T> = {
     /** List of files to display */
     files?: T[] | null;
 
-    /** Whether or not this folder is restricted from having certain actions performed on it. */
+    /**
+     * roller
+     * Whether or not this folder is restricted from having certain actions performed on it.
+     */
     isFolderRestricted: boolean;
 
-    /** Whetehr or not this folder is restricted from having certain types of files uploaded to it. */
+    /** Whether or not this folder is restricted from having certain types of files uploaded to it. */
     isFolderUploadRestricted: boolean;
 };

package/types/ViewModels/Rest/Controls/binaryFilePickerGetBinaryFilesOptionsBag.d.ts

@@ -30,4 +30,10 @@ import { Guid } from "@Obsidian/Types";
 export type BinaryFilePickerGetBinaryFilesOptionsBag = {
     /** The type of binary files to search for */
     binaryFileTypeGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/campusAccountAmountPickerGetAccountsResultItemBag.d.ts

@@ -22,19 +22,12 @@
 //
 
 import { Guid } from "@Obsidian/Types";
-import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 /**
  * The options that can be passed to the GetAccounts API action of
  * the ampusAccountAmountPicker control.
  */
 export type CampusAccountAmountPickerGetAccountsResultItemBag = {
-    /**
-     * List of the ACTUAL accounts to use (if using account-campus mapping logic) for each of the campuses.
-     * The Campus GUID is the key and a ListItemBag of the account details are the value.
-     */
-    campusAccounts?: Record<Guid, ListItemBag> | null;
-
     /** Name of the account */
     name?: string | null;
 

package/types/ViewModels/Rest/Controls/emailEditorCreateAttendanceOccurrenceOptionsBag.d.ts

@@ -34,4 +34,10 @@ export type EmailEditorCreateAttendanceOccurrenceOptionsBag = {
 
     /** Gets or sets the schedule identifier. */
     scheduleId?: number | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/emailEditorDeleteEmailSectionOptionsBag.d.ts

@@ -27,4 +27,10 @@ import { Guid } from "@Obsidian/Types";
 export type EmailEditorDeleteEmailSectionOptionsBag = {
     /** Gets or sets the email section unique identifier. */
     emailSectionGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/emailEditorEmailSectionBag.d.ts

@@ -38,6 +38,12 @@ export type EmailEditorEmailSectionBag = {
     /** Gets or sets the email section name. */
     name?: string | null;
 
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
     /** Gets or sets the email section source markup. */
     sourceMarkup?: string | null;
 

package/types/ViewModels/Rest/Controls/emailEditorGetAllEmailSectionsOptionsBag.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>
+//
+
+/** Bag containing the information needed to get all Email Sections from the Email Editor control. */
+export type EmailEditorGetAllEmailSectionsOptionsBag = {
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/emailEditorGetAttendanceOccurrenceOptionsBag.d.ts

@@ -25,4 +25,10 @@
 export type EmailEditorGetAttendanceOccurrenceOptionsBag = {
     /** Gets or sets the attendance occurrence identifier. */
     occurrenceId: number;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/emailEditorGetEmailSectionOptionsBag.d.ts

@@ -27,4 +27,10 @@ import { Guid } from "@Obsidian/Types";
 export type EmailEditorGetEmailSectionOptionsBag = {
     /** Gets or sets the email section unique identifier. */
     emailSectionGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/emailEditorGetFutureAttendanceOccurrencesOptionsBag.d.ts

@@ -27,4 +27,10 @@ import { Guid } from "@Obsidian/Types";
 export type EmailEditorGetFutureAttendanceOccurrencesOptionsBag = {
     /** Gets or sets the group unique identifier. */
     groupGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/emailEditorRegisterRsvpRecipientsOptionsBag.d.ts

@@ -28,4 +28,10 @@ export type EmailEditorRegisterRsvpRecipientsOptionsBag = {
 
     /** Gets or sets the collection of person identifiers. */
     personIds?: number[] | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/personBasicEditorBag.d.ts

@@ -45,6 +45,9 @@ export type PersonBasicEditorBag = {
     /** Person's mobile phone number */
     mobilePhoneNumber?: string | null;
 
+    /** Person's nick name */
+    nickName?: string | null;
+
     /** Person's date of birth */
     personBirthDate?: DatePartsPickerValueBag | null;
 

package/types/ViewModels/Rest/Controls/reminderTypePickerGetReminderTypesOptionsBag.d.ts

@@ -30,4 +30,7 @@ import { Guid } from "@Obsidian/Types";
 export type ReminderTypePickerGetReminderTypesOptionsBag = {
     /** Gets or sets the Entity Type Guid */
     entityTypeGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Rest/Controls/stepStatusPickerGetStepStatusesOptionsBag.d.ts

@@ -28,6 +28,9 @@ import { Guid } from "@Obsidian/Types";
  * the StepStatusPicker control.
  */
 export type StepStatusPickerGetStepStatusesOptionsBag = {
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
     /** The GUID of the step program that this step status is part of. */
     stepProgramGuid?: Guid | null;
 };

package/types/ViewModels/Rest/Controls/stepTypePickerGetStepTypesOptionsBag.d.ts

@@ -28,6 +28,9 @@ import { Guid } from "@Obsidian/Types";
  * the StepTypePicker control.
  */
 export type StepTypePickerGetStepTypesOptionsBag = {
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
     /** The GUID of the step program that this step type is part of. */
     stepProgramGuid?: Guid | null;
 };

package/types/ViewModels/Workflow/entryFormButtonBag.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>
+//
+
+/** Defines a single button to display on an entry form. */
+export type EntryFormButtonBag = {
+    /** The name of the action to perform when the button is clicked. */
+    action?: string | null;
+
+    /** The HTML that will render the button. */
+    html?: string | null;
+
+    /**
+     * The title of the button that can be used when rendering an HTML
+     * button is not possible.
+     */
+    title?: string | null;
+};