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

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

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Representation of a Reminder retrieved from the GetReminders API action of
+ * the ReminderButton control.
+ */
+export type ReminderButtonGetRemindersReminderBag = {
+    /** The Reminder's Unique Identifier */
+    guid: Guid;
+
+    /** Reminder type's representative color */
+    highlightColor?: string | null;
+
+    /** The Reminder's Id */
+    id: number;
+
+    /** Whether or not the reminder renews */
+    isRenewing: boolean;
+
+    /** Text note regarding what the reminder is about/for */
+    note?: string | null;
+
+    /** Date to be reminded */
+    reminderDate?: string | null;
+
+    /** Text name of the type of reminder */
+    reminderTypeName?: string | null;
+};

package/types/ViewModels/Rest/Controls/reminderButtonGetRemindersResultsBag.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>
+//
+
+import { ReminderButtonGetRemindersReminderBag } from "@Obsidian/ViewModels/Rest/Controls/reminderButtonGetRemindersReminderBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Representation of a Reminder retrieved from the GetReminders API action of
+ * the ReminderButton control.
+ */
+export type ReminderButtonGetRemindersResultsBag = {
+    /** URL to go to to edit a reminder */
+    editUrl?: string | null;
+
+    /** Name of the entity the reminder is about */
+    entityName?: string | null;
+
+    /** Name of the type of entity that the entity is */
+    entityTypeName?: string | null;
+
+    /** A list of reminders to display */
+    reminders?: ReminderButtonGetRemindersReminderBag[] | null;
+
+    /** List of available reminder types to choose from */
+    reminderTypes?: ListItemBag[] | null;
+
+    /** URL to go to for viewing all of the person's reminders */
+    viewUrl?: string | null;
+};

package/types/ViewModels/Rest/Controls/reminderButtonReminderActionOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetReminders API action of
+ * the ReminderButton control.
+ */
+export type ReminderButtonReminderActionOptionsBag = {
+    /** Gets or sets the Entity Guid */
+    entityGuid: Guid;
+
+    /** Gets or sets the Entity Type Guid */
+    entityTypeGuid: Guid;
+
+    /** Gets or sets the Guid for the View Reminders page */
+    reminderGuid: Guid;
+};

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

@@ -31,6 +31,9 @@ export type SchedulePickerGetChildrenOptionsBag = {
     /** Whether to include schedules marked as inactive in the results. */
     includeInactiveItems: boolean;
 
+    /** Whether to include schedules marked as private in the results. */
+    includePublicItemsOnly: boolean;
+
     /**
      * The parent unique identifier whose children are to
      * be retrieved. If null then the root items are being requested.

package/types/ViewModels/Rest/Controls/structuredContentBag.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>
+//
+
+/**
+ * The StructuredContent of the StructuredContentEditor control.
+ */
+export type StructuredContentBag = {
+    /** The individual blocks of markup */
+    blocks: never[];
+
+    /** The timestamp of the last change. */
+    time?: number | null;
+
+    /** The version of the editor control. */
+    version?: string | null;
+};

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

@@ -28,7 +28,8 @@
 export type UniversalItemTreePickerOptionsBag = {
     /**
      * Gets or sets the general purpose context provided by the field
-     * type control.
+     * type control. We also recommend you encode any context data as a
+     * JSON string to future proof yourself from changes you might need to make.
      */
     context?: string | null;
 

package/types/ViewModels/Rest/Models/Workflows/launchWorkflowOptionsBag.d.ts

@@ -0,0 +1,71 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Details about how the workflow should be launched. */
+export type LaunchWorkflowOptionsBag = {
+    /**
+     * The attribute values that will be provided to the workflow. The
+     * key should match the key of a workflow attribute. The value is the
+     * raw database value that it will be set to.
+     */
+    attributeValues?: Record<string, string> | null;
+
+    /**
+     * The entity identifier as either an Id, Guid or IdKey value to
+     * launch the workflow with.
+     */
+    entityId?: string | null;
+
+    /**
+     * The entity type identifier as either an Id, Guid, IdKey, or name
+     * value. This will be used when loading the entity to launch the
+     * workflow with.
+     */
+    entityTypeId?: string | null;
+
+    /**
+     * If true then the workflow will be launched immediately.
+     * Otherwise the workflow is launched in the background and may take
+     * up to one minute to be launched.
+     */
+    immediate: boolean;
+
+    /**
+     * If true then an error should be returned if the entity
+     * was specified but could not be found.
+     */
+    isEntityRequired: boolean;
+
+    /**
+     * The name to set on the workflow. If not provided then a default
+     * name will be used based on the workflow type name.
+     */
+    name?: string | null;
+
+    /**
+     * If true then the request will not return until the workflow
+     * has launched and completed processing. This will also force
+     * Rock.ViewModels.Rest.Models.Workflows.LaunchWorkflowOptionsBag.Immediate to be true.
+     */
+    wait: boolean;
+};

package/types/ViewModels/Rest/Models/Workflows/launchWorkflowResponseBag.d.ts

@@ -0,0 +1,62 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Contains the response data from launching a workflow. */
+export type LaunchWorkflowResponseBag = {
+    /** Will contain any errors that occurred while processing the workflow. */
+    errors?: string[] | null;
+
+    /**
+     * The unique identifier of the launched workflow. Will be an empty
+     * Guid value if the workflow was not waited or not set to persist.
+     */
+    guid: Guid;
+
+    /**
+     * The integer identifier of the launched workflow. Will be 0 if the
+     * workflow was not waited or not set to persist.
+     */
+    id: number;
+
+    /**
+     * The identifier key of the launched workflow. Will be null if the
+     * workflow was not waited or not set to persist.
+     */
+    idKey?: string | null;
+
+    /**
+     * If the workflow was waited and did not fully complete while
+     * processing then this value will be true. For example, if the
+     * workflow hit an Entry form it will stop processing but remain
+     * active.
+     */
+    isActive: boolean;
+
+    /**
+     * The value of the status property for the workflow that was launched.
+     * This will be null if the workflow was not waited.
+     */
+    status?: string | null;
+};

package/types/ViewModels/Rest/Models/createdAtResponseBag.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 { Guid } from "@Obsidian/Types";
+
+/** The response to be sent for a newly created item via the REST v2 API. */
+export type CreatedAtResponseBag = {
+    /** The unique identifier. */
+    guid: Guid;
+
+    /** The integer identifier. */
+    id: number;
+
+    /** The identifier key. */
+    idKey?: string | null;
+
+    /** The location URI that can be used to retrieve the new item from. */
+    location?: string | null;
+};

package/types/ViewModels/Rest/Models/itemIdentifierBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * Contains the three identifier values for an item returned by various
+ * REST endpoints.
+ */
+export type ItemIdentifierBag = {
+    /** The unique identifier. */
+    guid: Guid;
+
+    /** The integer identifier. */
+    id: number;
+
+    /** The identifier key. */
+    idKey?: string | null;
+};

package/types/ViewModels/Rest/Models/modelAttributeValueBag.d.ts

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The object that contains a single attribute value of a model. */
+export type ModelAttributeValueBag = {
+    /** The formatted condensed HTML value. */
+    condensedHtmlValue?: string | null;
+
+    /** The formatted condensed text value. */
+    condensedTextValue?: string | null;
+
+    /** The formatted HTML value. */
+    htmlValue?: string | null;
+
+    /** The formatted text value. */
+    textValue?: string | null;
+
+    /** The raw attribute value. */
+    value?: string | null;
+};

package/types/ViewModels/Rock/Blocks/Communication/communicationEntryWizardSaveCommunicationTemplateResponseBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationEntryWizardCommunicationTemplateDetailBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationTemplateDetailBag";
+import { CommunicationEntryWizardCommunicationTemplateListItemBag } from "@Obsidian/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationTemplateListItemBag";
+
+/** Bag containing the save communication template response information in the Communication Entry Wizard block. */
+export type CommunicationEntryWizardSaveCommunicationTemplateResponseBag = {
+    /** Gets or sets the communication template detail information. */
+    communicationTemplateDetail?: CommunicationEntryWizardCommunicationTemplateDetailBag | null;
+
+    /** Gets or sets the communication template list item information. */
+    communicationTemplateListItem?: CommunicationEntryWizardCommunicationTemplateListItemBag | null;
+};

package/types/ViewModels/Utility/publicEditableAttributeBag.d.ts

@@ -32,6 +32,9 @@ export type PublicEditableAttributeBag = {
     /** Gets or sets the abbreviated name of the attribute. */
     abbreviatedName?: string | null;
 
+    /** Gets or sets a color to visually distinguish this attribute. */
+    attributeColor?: string | null;
+
     /** Gets or sets the categories the attribute is associated with. */
     categories?: ListItemBag[] | null;
 
@@ -61,6 +64,9 @@ export type PublicEditableAttributeBag = {
      */
     guid?: Guid | null;
 
+    /** Gets or sets the CSS class for the icon to show as a distinguishing mark for this attribute. */
+    iconCssClass?: string | null;
+
     /** Gets or sets a value indicating whether the attribute is active. */
     isActive: boolean;
 
@@ -103,6 +109,9 @@ export type PublicEditableAttributeBag = {
      */
     isShowOnBulk: boolean;
 
+    /** Gets or sets a flag indicating if changes to the attribute values should be recorded into the generic History log table. */
+    isSuppressHistoryLogging: boolean;
+
     /**
      * Gets or sets a value indicating whether this attribute is a system
      * attribute, which implies limited editing ability.

package/types/Controls/genderDropDownList.obs.d.ts

@@ -1,21 +0,0 @@
-import { PropType } from "vue";
-declare const _default: import("vue").DefineComponent<{
-    modelValue: {
-        type: PropType<string | string[]>;
-        required: true;
-    };
-    rules: import("@Obsidian/ValidationRules").RulesPropType;
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (value: string | string[]) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    modelValue: {
-        type: PropType<string | string[]>;
-        required: true;
-    };
-    rules: import("@Obsidian/ValidationRules").RulesPropType;
-}>> & {
-    "onUpdate:modelValue"?: ((value: string | string[]) => any) | undefined;
-}, {
-    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
-}>;
-export default _default;

package/types/Controls/skeleton.obs.d.ts

@@ -1,9 +0,0 @@
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>, {
-    default: (_: {}) => any;
-}>;
-export default _default;
-declare type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};

package/types/Enums/Lms/availableDateCalculationMethod.d.ts

@@ -1,17 +0,0 @@
-/** Determines the method for calculating the available date. */
-export declare const AvailableDateCalculationMethod: {
-    /** A specific date. */
-    readonly Specific: 0;
-    /** An offset of the class start date. */
-    readonly ClassStartOffset: 1;
-    /** An offset of the class enrollment date. */
-    readonly EnrollmentOffset: 2;
-    /** Always available. */
-    readonly AlwaysAvailable: 3;
-    /** No calculation (becomes available after previous is completed). */
-    readonly AfterPreviousCompleted: 4;
-};
-/** Determines the method for calculating the available date. */
-export declare const AvailableDateCalculationMethodDescription: Record<number, string>;
-/** Determines the method for calculating the available date. */
-export declare type AvailableDateCalculationMethod = typeof AvailableDateCalculationMethod[keyof typeof AvailableDateCalculationMethod];

package/types/Enums/Lms/dueDateCalculationMethod.d.ts

@@ -1,15 +0,0 @@
-/** Determines the method for calculating the due date. */
-export declare const DueDateCalculationMethod: {
-    /** A specific date. */
-    readonly Specific: 0;
-    /** An offset of the class start date. */
-    readonly ClassStartOffset: 1;
-    /** An offset of the class enrollment date. */
-    readonly EnrollmentOffset: 2;
-    /** No calculation. */
-    readonly NoDate: 3;
-};
-/** Determines the method for calculating the due date. */
-export declare const DueDateCalculationMethodDescription: Record<number, string>;
-/** Determines the method for calculating the due date. */
-export declare type DueDateCalculationMethod = typeof DueDateCalculationMethod[keyof typeof DueDateCalculationMethod];