@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/ViewModels/Rest/Controls/iconPickerGetIconLibrariesOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the GetDefinedValues API action of
+ * the DefinedValuePicker control.
+ */
+export type IconPickerGetIconLibrariesOptionsBag = {
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/inGroupFilterGetGroupRolesForGroupsOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/** Options bag for the InGroupFilter's GetGroupRolesForGroups method. */
+export type InGroupFilterGetGroupRolesForGroupsOptionsBag = {
+    /** Guids of the groups that are of the group types we wish to get roles for. */
+    groupGuids?: Guid[] | null;
+
+    /**
+     * If Rock.ViewModels.Rest.Controls.InGroupFilterGetGroupRolesForGroupsOptionsBag.IncludeChildGroups is true and this is true, then also include the child groups
+     * all the way down the hierarchy when determining the group types.
+     */
+    includeAllDescendants: boolean;
+
+    /**
+     * Whether or not to include the direct child groups of the groups listed in GroupGuids.
+     * If this is true and IncludeSelectedGroups is false, then the groups in GroupGuids will be excluded.
+     */
+    includeChildGroups: boolean;
+
+    /** If Rock.ViewModels.Rest.Controls.InGroupFilterGetGroupRolesForGroupsOptionsBag.IncludeChildGroups is true and this is true, then also include inactive groups */
+    includeInactiveGroups: boolean;
+
+    /**
+     * If Rock.ViewModels.Rest.Controls.InGroupFilterGetGroupRolesForGroupsOptionsBag.IncludeChildGroups is true and this is true, then the groups in GroupGuids
+     * will be included along with the child groups when determining the group types.
+     */
+    includeSelectedGroups: boolean;
+
+    /** The security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/inGroupGroupTypeSelectGetRolesOptionsBag.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 InGroupGroupTypeSelect's GetRoles method. */
+export type InGroupGroupTypeSelectGetRolesOptionsBag = {
+    /** Guid of the group type we wish to get roles for. */
+    groupTypeGuid: Guid;
+};

package/types/ViewModels/Rest/Controls/interactionCountSelectGetComponentsOptionsBag.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 InteractionCountSelectGetComponentsOptionsBag's GetComponents method. */
+export type InteractionCountSelectGetComponentsOptionsBag = {
+    /** Guid of the Interaction Channel we wish to get the components for. */
+    interactionChannelGuid: Guid;
+};

package/types/ViewModels/Rest/Controls/interactionDateSelectGetComponentsOptionsBag.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 InteractionDateSelectGetComponentsOptionsBag's GetComponents method. */
+export type InteractionDateSelectGetComponentsOptionsBag = {
+    /** Guid of the Interaction Channel we wish to get the components for. */
+    interactionChannelGuid: Guid;
+};

package/types/ViewModels/Rest/Controls/learningClassActivityPickerGetLearningClassActivitiesOptionsBag.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";
+
+/**
+ * The options that can be passed to the GetLearningClassActivities API action of
+ * the LearningClassActivityPicker control.
+ */
+export type LearningClassActivityPickerGetLearningClassActivitiesOptionsBag = {
+    /** GUID of the class the activities are part of. */
+    learningClassGuid?: Guid | null;
+
+    /** The security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/learningClassPickerGetLearningClassesOptionsBag.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";
+
+/**
+ * The options that can be passed to the GetLearningClasses API action of
+ * the LearningClassPicker control.
+ */
+export type LearningClassPickerGetLearningClassesOptionsBag = {
+    /** GUID of the course the classes are part of. */
+    learningCourseGuid?: Guid | null;
+
+    /** The security grant token. */
+    securityGrantToken?: string | null;
+};

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

@@ -28,6 +28,15 @@ import { Guid } from "@Obsidian/Types";
  * the LocationPicker control.
  */
 export type LocationItemPickerGetActiveChildrenOptionsBag = {
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /**
      * Gets or sets the unique identifier of the parent location whose
      * children are to be enumerated.

package/types/ViewModels/Rest/Controls/memberListSelectGetGroupRolesOptionsBag.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 InGroupFilter's GetGroupRolesForGroups method. */
+export type MemberListSelectGetGroupRolesOptionsBag = {
+    /** Guids of the groups that are of the group types we wish to get roles for. */
+    groupType: Guid;
+};

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

@@ -26,6 +26,13 @@
  * universal item search picker.
  */
 export type UniversalItemSearchPickerOptionsBag = {
+    /**
+     * Gets or sets the general purpose context provided by the field
+     * 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;
+
     /** Gets or sets a value indicating whether inactive records should be included. */
     isInactiveIncluded: boolean;
 

package/types/ViewModels/Rest/Utilities/updateContextEntityOptionsBag.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 { ContextEntityItemBag } from "@Obsidian/ViewModels/Cms/contextEntityItemBag";
+
+/**
+ * Defines the options that can be sent to the ContextEntities API
+ * endpoints when setting context entity values.
+ */
+export type UpdateContextEntityOptionsBag = {
+    /**
+     * The context entity to be set. At least one of either EntityType
+     * or EntityTypeGuid must be set. The EntityGuid must also be set.
+     */
+    contextEntity?: ContextEntityItemBag | null;
+
+    /** Determines whether the context entity is specific to a page. */
+    pageId?: number | null;
+};

package/types/Core/Reporting/filterExpressionType.d.ts

@@ -1,28 +0,0 @@
-/**
- * The type of filter expressions that can be used when building filtering rules.
- */
-export declare enum FilterExpressionType {
-    /** Simple expression filter. */
-    Filter = 0,
-    /**
-     * A collection of expressions/conditions that all must match. Expressions
-     * are "and'd" together.
-     */
-    GroupAll = 1,
-    /**
-     * A collection of expressions/conditions where at least one must match.
-     * Expressions are "or'd" together.
-     */
-    GroupAny = 2,
-    /**
-     * A collection of expressions/conditions where all must be false. Expressions
-     * are combined using a logical OR and the group result must be FALSE.
-     */
-    GroupAllFalse = 3,
-    /**
-     * A collection of expressions/conditions where at least one must be false.
-     * Expressions are combined using a logical AND and the group result must
-     * be FALSE.
-     */
-    GroupAnyFalse = 4
-}

package/types/Core/Reporting/filterMode.d.ts

@@ -1,7 +0,0 @@
-/** The type of filter mode to use when choosing which components to display. */
-export declare enum FilterMode {
-    /** A simple filter editor should be used, with a minimal UI. */
-    Simple = 0,
-    /** A more advanced editor should be used that provides all available options. */
-    Advanced = 1
-}