@rockrms/obsidian-framework 1.16.3-rc.1

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

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 GetGroupTypes API action of
+ * the GroupTypePicker control.
+ */
+export type GroupTypeGroupPickerGetGroupTypeOfGroupOptionsBag = {
+    /** GUID of the group we want to find the group type of */
+    groupGuid?: Guid | null;
+};

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

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 GetGroupTypes API action of
+ * the GroupTypePicker control.
+ */
+export type GroupTypeGroupPickerGetGroupsOptionsBag = {
+    /** GUID of the group type we want to filter groups by */
+    groupTypeGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/groupTypePickerGetGroupTypesOptionsBag.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 GetGroupTypes API action of
+ * the GroupTypePicker control.
+ */
+export type GroupTypePickerGetGroupTypesOptionsBag = {
+    /** List of GUIDs for the group types we want to retrieve */
+    groupTypes?: Guid[] | null;
+
+    /** Whether the results are sorted by name or order */
+    isSortedByName: boolean;
+
+    /** Whether or not to filter out the group types that aren't flagged to be on the group list */
+    onlyGroupListItems: boolean;
+};

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

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 GetRegistrationTemplateForInstance API action of the RegistrationInstancePicker control. */
+export type InteractionChannelInteractionComponentPickerGetChannelFromComponentOptionsBag = {
+    /** The unique identifier of the Registration Instance you want the template for. */
+    interactionComponentGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 GetInteractionComponents API action of
+ * the InteractionComponentPicker control.
+ */
+export type InteractionComponentPickerGetInteractionComponentsOptionsBag = {
+    /** GUID of the container the components are within. */
+    interactionChannelGuid?: Guid | null;
+};

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

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <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 GetActiveChildren API action of
+ * the LocationPicker control.
+ */
+export type LocationItemPickerGetActiveChildrenOptionsBag = {
+    /**
+     * Gets or sets the unique identifier of the parent location whose
+     * children are to be enumerated.
+     */
+    guid?: Guid | null;
+
+    /**
+     * Gets or sets the root location unique identifier. This is used if Rock.ViewModels.Rest.Controls.LocationItemPickerGetActiveChildrenOptionsBag.Guid
+     * is empty to specify the root location to limit the tree to.
+     */
+    rootLocationGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <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 ValidateAddress API action of
+ * the LocationAddressPicker control.
+ */
+export type LocationListGetLocationsOptionsBag = {
+    /** GUID of the Location Type that the locations need to be */
+    locationTypeValueGuid?: Guid | null;
+
+    /** Guid of the location the results should be children of */
+    parentLocationGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /** Whether to include city and state in the name of the location in the list */
+    showCityState: boolean;
+};

package/types/ViewModels/Rest/Controls/locationListSaveNewLocationOptionsBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+
+/**
+ * The options that can be passed to the SaveNewValue API action of
+ * the DefinedValuePicker control for adding a new Defined Value
+ */
+export type LocationListSaveNewLocationOptionsBag = {
+    /** Address data for the new location */
+    address?: AddressControlBag | null;
+
+    /** Collection of attribute values for the new location */
+    attributeValues?: Record<string, string> | null;
+
+    /** The GUID of the defined type specifying the new location's type */
+    locationTypeValueGuid?: Guid | null;
+
+    /** The new location's name */
+    name?: string | null;
+
+    /** The GUID of the location that will be the new location's parent */
+    parentLocationGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /** Whether the city and state should be shown in the name of the returned location */
+    showCityState: boolean;
+};

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

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 ValidateAddress API action of
+ * the LocationAddressPicker control.
+ */
+export type MediaElementPickerGetMediaElementsOptionsBag = {
+    /** GUID of the media folder that the media elements are part of */
+    mediaFolderGuid?: Guid | null;
+};

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

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 ValidateAddress API action of
+ * the LocationAddressPicker control.
+ */
+export type MediaElementPickerGetMediaFoldersOptionsBag = {
+    /** GUID of the media account that the media folders are part of */
+    mediaAccountGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/mediaElementPickerGetMediaTreeOptionsBag.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 GetMediaTree API action of
+ * the MediaElementPicker control.
+ */
+export type MediaElementPickerGetMediaTreeOptionsBag = {
+    /** GUID of the selected media account, if one is selected */
+    mediaAccountGuid?: Guid | null;
+
+    /** GUID of the selected media element, if one is selected */
+    mediaElementGuid?: Guid | null;
+
+    /** GUID of the selected media folder, if one is selected */
+    mediaFolderGuid?: Guid | null;
+};

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

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <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 results of the GetMediaTree API action of the MediaElementPicker control. */
+export type MediaElementPickerGetMediaTreeResultsBag = {
+    /** The selected Media Account as a ListItemBag */
+    mediaAccount?: ListItemBag | null;
+
+    /** The list of Media Accounts as ListItemBags */
+    mediaAccounts?: ListItemBag[] | null;
+
+    /** The selected Media Element as a ListItemBag */
+    mediaElement?: ListItemBag | null;
+
+    /** The list of Media Elements in the above folder as ListItemBags */
+    mediaElements?: ListItemBag[] | null;
+
+    /** The selected Media Folder as a ListItemBag */
+    mediaFolder?: ListItemBag | null;
+
+    /** The list of Media Folders in the above account as ListItemBags */
+    mediaFolders?: ListItemBag[] | null;
+};

package/types/ViewModels/Rest/Controls/mergeFieldPickerFormatSelectedValueOptionsBag.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 for calling the Get Children API method for the Merge Field Picker */
+export type MergeFieldPickerFormatSelectedValueOptionsBag = {
+    /** ID of the parent Merge Field we want to get the children of */
+    selectedValue?: string | null;
+};

package/types/ViewModels/Rest/Controls/mergeFieldPickerGetChildrenOptionsBag.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>
+//
+
+/** Options for calling the Get Children API method for the Merge Field Picker */
+export type MergeFieldPickerGetChildrenOptionsBag = {
+    /** IDs of the parent Merge Fields at the root that we want to get data for */
+    additionalFields?: string | null;
+
+    /** ID of the parent Merge Field we want to get the children of */
+    id?: string | null;
+};

package/types/ViewModels/Rest/Controls/mergeTemplatePickerGetMergeTemplatesOptionsBag.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>
+//
+
+import { MergeTemplateOwnership } from "@Obsidian/Enums/Controls/mergeTemplateOwnership";
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetMergeTemplates API action of
+ * the MergeTemplatePicker control.
+ */
+export type MergeTemplatePickerGetMergeTemplatesOptionsBag = {
+    /**
+     * Gets or sets the default icon CSS class to use for items that do not
+     * specify their own IconCssClass value.
+     */
+    defaultIconCssClass?: string | null;
+
+    /** Gets or sets a filter for which merge templates to include in results: Global, Public, or Both */
+    mergeTemplateOwnership: MergeTemplateOwnership;
+
+    /**
+     * Gets or sets the parent unique identifier whose children are to
+     * be retrieved. If null then the root items are being requested.
+     */
+    parentGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <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 GetChildren API action of
+ * the MetricCategoryPicker control.
+ */
+export type MetricCategoryPickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the default icon CSS class to use for items that do not
+     * specify their own IconCssClass value.
+     */
+    defaultIconCssClass?: string | null;
+
+    /**
+     * Gets or sets the parent unique identifier whose children are to
+     * be retrieved. If null then the root items are being requested.
+     */
+    parentGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};