@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/ViewModels/Entities/scheduleCategoryExclusionBag.d.ts

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** ScheduleCategoryExclusion View Model */
+export type ScheduleCategoryExclusionBag = {
+    /** 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 category identifier. */
+    categoryId: number;
+
+    /** Gets or sets the created by person alias identifier. */
+    createdByPersonAliasId?: number | null;
+
+    /** Gets or sets the created date time. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets the end date. */
+    endDate?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the modified by person alias identifier. */
+    modifiedByPersonAliasId?: number | null;
+
+    /** Gets or sets the modified date time. */
+    modifiedDateTime?: string | null;
+
+    /** Gets or sets the start date. */
+    startDate?: string | null;
+
+    /** Gets or sets the title. */
+    title?: string | null;
+};

package/types/ViewModels/Event/RegistrationEntry/registrationRegistrantUpdatedMessageBag.d.ts

@@ -0,0 +1,59 @@
+//------------------------------------------------------------------------------
+// <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 { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Details about a registramt record that is transmitted over
+ * the RealTime engine.
+ */
+export type RegistrationRegistrantUpdatedMessageBag = {
+    /** Gets or sets the list of fees associated with the registrant. */
+    fees?: Record<string, ListItemBag> | null;
+
+    /** Gets or sets the person associated with the registrant. */
+    person?: PersonBag | null;
+
+    /** Gets or sets the registrant unique identifier. */
+    registrantGuid: Guid;
+
+    /** Gets or sets the registrant encrypted identifier. */
+    registrantIdKey?: string | null;
+
+    /** Gets or sets the GUID of the registration instance. */
+    registrationInstanceGuid?: Guid | null;
+
+    /** Gets or sets the registration instance encrypted identifier. */
+    registrationInstanceIdKey?: string | null;
+
+    /** Gets or sets the name of the registration instance. */
+    registrationInstanceName?: string | null;
+
+    /** Gets or sets the GUID of the registration template. */
+    registrationTemplateGuid?: Guid | null;
+
+    /** Gets or sets the registration template encrypted identifier. */
+    registrationTemplateIdKey?: string | null;
+};

package/types/ViewModels/Group/GroupMember/groupMemberUpdatedMessageBag.d.ts

@@ -0,0 +1,61 @@
+//------------------------------------------------------------------------------
+// <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 { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+
+/**
+ * Details about an group member record that is transmitted over
+ * the RealTime engine.
+ */
+export type GroupMemberUpdatedMessageBag = {
+    /** The date and time the group member was added. */
+    dateTimeAdded?: string | null;
+
+    /** The GUID of the group. */
+    groupGuid?: Guid | null;
+
+    /** The encrypted identifier key for the group. */
+    groupIdKey?: string | null;
+
+    /** The GUID of the group member. */
+    groupMemberGuid: Guid;
+
+    /**
+     * Gets or sets the group member unique identifier. (TODO: Remove
+     * this when Group Member Detail is converted to Obsidian.)
+     */
+    groupMemberId: number;
+
+    /** The encrypted identifier key for the group member. */
+    groupMemberIdKey?: string | null;
+
+    /** The encrypted identifier key for the group role. */
+    groupRoleIdKey?: string | null;
+
+    /** The encrypted identifier key for the group type. */
+    groupTypeIdKey?: string | null;
+
+    /** The person associated with the group member. */
+    person?: PersonBag | null;
+};

package/types/ViewModels/Reporting/BarChart/barSeriesBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents a single bar series in a bar chart, including its label, data points, colors, opacity, and label configuration. */
+export type BarSeriesBag = {
+    /**
+     * Gets or sets the color of the bars.
+     * Can be a single color value or a comma-separated list for each data point.
+     */
+    color?: string[] | null;
+
+    /** Gets or sets the data points for the bar series. */
+    data?: number[] | null;
+
+    /**
+     * Gets or sets a value indicating whether the bars are unfilled.
+     * If true, bars are rendered as outlines; otherwise, they are filled.
+     */
+    isUnfilled?: boolean | null;
+
+    /** Gets or sets the label for the bar series. */
+    label?: string | null;
+};

package/types/ViewModels/Reporting/LineChart/lineSeriesBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents a single line series in a line chart, including its label, data points, color, opacity, and label configuration. */
+export type LineSeriesBag = {
+    /** Gets or sets the color of the line. */
+    color?: string | null;
+
+    /** Gets or sets the data points for the line series. */
+    data?: number[] | null;
+
+    /** Gets or sets a value indicating whether the transformation is linear. */
+    isLinear: boolean;
+
+    /** Gets or sets a value indicating whether the underside of the line has a fill. */
+    isUnfilled?: boolean | null;
+
+    /** Gets or sets the label for the line series. */
+    label?: string | null;
+
+    /** Gets or sets the style of the line used in rendering. Allowed values: "solid", "dashed", "dotted". */
+    lineStyle?: string | null;
+};

package/types/ViewModels/Reporting/PieChart/pieSeriesBag.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>
+//
+
+/** Represents a single pie series in a pie chart, including its label, data points, colors, opacity, and label configuration. */
+export type PieSeriesBag = {
+    /** Gets or sets the color of the slices. */
+    colors?: string[] | null;
+
+    /** Gets or sets the data points for the pie series. */
+    data?: number[] | null;
+
+    /** Gets or sets the label for the pie series. */
+    label?: string | null;
+};

package/types/ViewModels/Reporting/chartBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { IChartSeriesBag } from "@Obsidian/ViewModels/Blocks/Reporting/iChartSeriesBag";
+import { ChartOptionsBag } from "@Obsidian/ViewModels/Reporting/chartOptionsBag";
+
+/** Defines the contract for a chart bag, which contains the labels, series data, and chart options for a chart. */
+export type ChartBag = {
+    /** Gets or sets the chart options bag. */
+    chartOptionsBag?: ChartOptionsBag | null;
+
+    /** Gets or sets the labels for the chart. */
+    labels?: string[] | null;
+
+    /** Gets or sets the series bags for the chart. */
+    seriesBags?: IChartSeriesBag[] | null;
+};

package/types/ViewModels/Reporting/chartOptionsBag.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>
+//
+
+/** Options Bag for charts. */
+export type ChartOptionsBag = {
+};

package/types/ViewModels/Rest/Controls/communicationRecipientActivityBag.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 { CommunicationRecipientActivity } from "@Obsidian/Enums/Communication/communicationRecipientActivity";
+
+/** A bag that contains information about a specific activity for a communication recipient. */
+export type CommunicationRecipientActivityBag = {
+    /** The activity that took place. */
+    activity: CommunicationRecipientActivity;
+
+    /** The activity datetime. */
+    activityDateTime?: string | null;
+
+    /** A description of the activity. */
+    description?: string | null;
+
+    /** A tooltip containing more information about the activity. */
+    tooltip?: string | null;
+};

package/types/ViewModels/Rest/Controls/communicationRecipientGetActivityOptionsBag.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>
+//
+
+/** A bag that contains information needed to get activity for a communication recipient. */
+export type CommunicationRecipientGetActivityOptionsBag = {
+    /** Gets or sets the communication recipient's hashed identifier key. */
+    communicationRecipientIdKey?: string | null;
+
+    /** Gets or sets the security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <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 { CommunicationRecipientActivityBag } from "@Obsidian/ViewModels/Rest/Controls/communicationRecipientActivityBag";
+
+/** A bag that contains activity information for a communication recipient. */
+export type CommunicationRecipientGetActivityResultsBag = {
+    /** Gets or sets the list of activities for this recipient. */
+    activities?: CommunicationRecipientActivityBag[] | null;
+
+    /** Gets or sets the recipient person's age. */
+    personAge?: number | null;
+
+    /** Gets or sets the recipient person's primary campus name. */
+    personCampusName?: string | null;
+
+    /** Gets or sets the recipient person's connection status. */
+    personConnectionStatus?: string | null;
+
+    /** Gets or sets the recipient person's email address. */
+    personEmail?: string | null;
+
+    /** Gets or sets the recipient person's hashed identifier key. */
+    personIdKey?: string | null;
+
+    /** Gets or sets the recipient person's last name. */
+    personLastName?: string | null;
+
+    /** Gets or sets the recipient person's marital status. */
+    personMaritalStatus?: string | null;
+
+    /** Gets or sets the recipient person's nick name. */
+    personNickName?: string | null;
+
+    /** Gets or sets the recipient person's phone number. */
+    personPhoneNumber?: string | null;
+
+    /** Gets or sets the recipient person's photo URL. */
+    personPhotoUrl?: string | null;
+};

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

@@ -28,4 +28,7 @@
 export type ComponentPickerGetComponentsOptionsBag = {
     /** Type of the container the components are within */
     containerType?: string | null;
+
+    /**  Gets or sets a value indicating whether inactive components are included. (Defaults to false.) */
+    includeInactive: boolean;
 };

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

@@ -0,0 +1,47 @@
+//------------------------------------------------------------------------------
+// <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 FormatSelection API action
+ * of the DataFilter control (this is not a real control). This is
+ * used by the Obsidian data filters so that the UI can update the
+ * formatted description of the filter settings.
+ */
+export type DataFilterFormatSelectionOptionsBag = {
+    /** The data from the UI component that needs to be formatted. */
+    componentData?: string | null;
+
+    /** The unique identifier of the entity type that the filter applies to. */
+    entityTypeGuid: Guid;
+
+    /**
+     * The unique identifier of the entity type that represents the filter
+     * class.
+     */
+    filterTypeGuid: Guid;
+
+    /** The security grant token to use when authorizing the request. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/emailEditorGetGroupOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/** Bag containing the information needed to get a group from the Email Editor control. */
+export type EmailEditorGetGroupOptionsBag = {
+    /** Gets or sets the group unique identifier used for retrieving the group. */
+    groupGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** Options bag for the InGroupFilter's GetGroupRolesForGroups method. */
+export type FormattedFieldSelectGetSortByPropertiesOptionsBag = {
+    /** Guids of the groups that are of the group types we wish to get roles for. */
+    property?: string | null;
+};

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

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Options bag for the HasCompletedCourseSelect's GetCourses method. */
+export type HasCompletedCourseSelectGetCoursesOptionsBag = {
+    /** Guid of the LMS program we wish to get the courses for. */
+    programGuid: Guid;
+};