@rockrms/obsidian-framework 1.16.3-rc.1

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

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

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <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 GetCampuses API action of
+ * the CampusPicker control.
+ */
+export type CampusPickerGetCampusesOptionsBag = {
+};

package/types/ViewModels/Rest/Controls/captchaControlConfigurationBag.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>
+//
+
+/**
+ * The options that can be passed to the GetConfiguration API action of
+ * the Captcha control.
+ */
+export type CaptchaControlConfigurationBag = {
+    /** Gets or sets the site key. */
+    siteKey?: string | null;
+};

package/types/ViewModels/Rest/Controls/captchaControlTokenValidateTokenResultBag.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>
+//
+
+/** The results from the Validate Token API action of the Captcha control. */
+export type CaptchaControlTokenValidateTokenResultBag = {
+    /** Gets or sets a value indicating whether the solved token is valid. */
+    isTokenValid: boolean;
+};

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

@@ -0,0 +1,27 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+export type CaptchaControlValidateTokenOptionsBag = {
+    /** Gets or sets the solved captcha token. */
+    token?: string | null;
+};

package/types/ViewModels/Rest/Controls/categorizedValuePickerGetTreeOptionsBag.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 GetGoogleMapSettings API action of
+ * the GeoPicker control.
+ */
+export type CategorizedValuePickerGetTreeOptionsBag = {
+    /** GUID for the Defined Type we're grabbing categories/values of */
+    definedTypeGuid?: Guid | null;
+
+    /** List of GUID values to include. If empty, include all, otherwise exclude all other values */
+    onlyIncludeGuids?: Guid[] | null;
+};

package/types/ViewModels/Rest/Controls/categorizedValuePickerGetTreeResultsBag.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 { CategorizedValuePickerNodeBag } from "@Obsidian/ViewModels/Rest/Controls/categorizedValuePickerNodeBag";
+
+/**
+ * The options that can be passed to the GetGoogleMapSettings API action of
+ * the GeoPicker control.
+ */
+export type CategorizedValuePickerGetTreeResultsBag = {
+    /** Name of the defined type that contains these values */
+    definedType?: string | null;
+
+    /** A tree of nodes of categories and defined values */
+    tree?: CategorizedValuePickerNodeBag | null;
+};

package/types/ViewModels/Rest/Controls/categorizedValuePickerNodeBag.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>
+//
+
+/** Describes a single item that can be displayed in a categorized value picker, both categories and value nodes. */
+export type CategorizedValuePickerNodeBag = {
+    /** Gets or sets the child categories. */
+    childCategories?: CategorizedValuePickerNodeBag[] | null;
+
+    /** Gets or sets the child values. */
+    childValues?: CategorizedValuePickerNodeBag[] | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets the text that should be displayed to identify this item. */
+    text?: string | null;
+
+    /** Gets or sets the generic identifier of this item. */
+    value?: string | null;
+};

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

@@ -0,0 +1,119 @@
+//------------------------------------------------------------------------------
+// <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 ChildTreeItems API action of
+ * the CategoryPicker control.
+ */
+export type CategoryPickerChildTreeItemsOptionsBag = {
+    /**
+     * 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 entity type unique identifier to limit the
+     * results to.
+     */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the entity qualifier that is used to filter category
+     * results. If not blank, then the category EntityTypeQualifierColumn
+     * property must match this value.
+     */
+    entityTypeQualifierColumn?: string | null;
+
+    /**
+     * Gets or sets the entity qualifier value that is used to filter
+     * category results. If both this and Rock.ViewModels.Rest.Controls.CategoryPickerChildTreeItemsOptionsBag.EntityTypeQualifierColumn
+     * are not blank, then the category EntityTypeQualifierValue property
+     * must match this value.
+     */
+    entityTypeQualifierValue?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether items should be loaded
+     * or only categories.
+     */
+    getCategorizedItems: boolean;
+
+    /**
+     * Gets or sets a value indicating whether categories that have no
+     * child categories and no items should be included.
+     */
+    includeCategoriesWithoutChildren: boolean;
+
+    /**
+     * Gets or sets a value indicating whether inactive items should be
+     * included in the results. If the entity type does not support the
+     * IsActive property then this value will be ignored.
+     */
+    includeInactiveItems: boolean;
+
+    /**
+     * Gets or sets a value indicating whether entity items without a name
+     * should be included in the results. Only applies if
+     * Rock.ViewModels.Rest.Controls.CategoryPickerChildTreeItemsOptionsBag.GetCategorizedItems is true.
+     */
+    includeUnnamedEntityItems: boolean;
+
+    /**
+     * Gets or sets the name of the item property to use for comparison
+     * with Rock.ViewModels.Rest.Controls.CategoryPickerChildTreeItemsOptionsBag.ItemFilterPropertyValue. When set the item query
+     * will attempt to filter on this property name. If it does not exist
+     * then an exception will be thrown.
+     */
+    itemFilterPropertyName?: string | null;
+
+    /**
+     * Gets or sets the item property value to compare against. This should
+     * be either an integer-string, Guid-string or plain string for
+     * comparison. And must match the database property type.
+     */
+    itemFilterPropertyValue?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether child categories and items
+     * are loaded automatically. If true then all descendant categories
+     * will be loaded along with the items if Rock.ViewModels.Rest.Controls.CategoryPickerChildTreeItemsOptionsBag.GetCategorizedItems
+     * is also true. This results in the Children property of the results
+     * being null to indicate they must be loaded on demand.
+     */
+    lazyLoad: boolean;
+
+    /**
+     * 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/componentPickerGetComponentsOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the GetComponents API action of
+ * the ComponentPicker control.
+ */
+export type ComponentPickerGetComponentsOptionsBag = {
+    /** Type of the container the components are within */
+    containerType?: string | null;
+};

package/types/ViewModels/Rest/Controls/connectionRequestPickerGetChildrenOptionsBag.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 GetChildren API action of
+ * the ConnectionRequestPicker control.
+ */
+export type ConnectionRequestPickerGetChildrenOptionsBag = {
+    /**
+     * 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/contentChannelItemPickerGetAllForContentChannelItemOptionsBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type ContentChannelItemPickerGetAllForContentChannelItemOptionsBag = {
+    contentChannelItemGuid?: Guid | null;
+
+    excludeContentChannelItems?: Guid[] | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/contentChannelItemPickerGetAllForContentChannelItemResultsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * The options that can be passed to the GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type ContentChannelItemPickerGetAllForContentChannelItemResultsBag = {
+    contentChannelItems?: ListItemBag[] | null;
+
+    selectedContentChannel?: ListItemBag | null;
+
+    selectedContentChannelItem?: ListItemBag | null;
+};

package/types/ViewModels/Rest/Controls/contentChannelItemPickerGetContentChannelItemsOptionsBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type ContentChannelItemPickerGetContentChannelItemsOptionsBag = {
+    contentChannelGuid?: Guid | null;
+
+    excludeContentChannelItems?: Guid[] | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};