@rockrms/obsidian-framework 1.16.3-rc.1

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

@@ -0,0 +1,86 @@
+//------------------------------------------------------------------------------
+// <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 GetDataViews API action of
+ * the DataViewPicker control.
+ */
+export type DataViewPickerGetDataViewsOptionsBag = {
+    /**
+     * Gets or sets the default icon CSS class to use for items that do not
+     * specify their own IconCssClass value.
+     */
+    defaultIconCssClass?: string | null;
+
+    /** Gets if the dataView Picker should show only persisted data views */
+    displayPersistedOnly: boolean;
+
+    /**
+     * 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.
+     */
+    entityTypeGuidFilter?: Guid | 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 entity items without a name
+     * should be included in the results. Only applies if
+     * Rock.ViewModels.Rest.Controls.DataViewPickerGetDataViewsOptionsBag.GetCategorizedItems is true.
+     */
+    includeUnnamedEntityItems: boolean;
+
+    /**
+     * 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.DataViewPickerGetDataViewsOptionsBag.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/definedValuePickerGetAttributesOptionsBag.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 GetAttributes API action of
+ * the DefinedValuePicker control.
+ */
+export type DefinedValuePickerGetAttributesOptionsBag = {
+    /** Gets or sets the unique identifier of the defined type to get attributes of. */
+    definedTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/definedValuePickerGetDefinedValuesOptionsBag.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 GetDefinedValues API action of
+ * the DefinedValuePicker control.
+ */
+export type DefinedValuePickerGetDefinedValuesOptionsBag = {
+    /** Gets or sets the unique identifier of the defined type to load values from. */
+    definedTypeGuid?: Guid | null;
+
+    /** Gets or sets a value indicating whether inactive values should be included. */
+    includeInactive: boolean;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/definedValuePickerSaveNewValueOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the SaveNewValue API action of
+ * the DefinedValuePicker control for adding a new Defined Value
+ */
+export type DefinedValuePickerSaveNewValueOptionsBag = {
+    /** A collection of attribute values for the new defined value */
+    attributeValues?: Record<string, string> | null;
+
+    /** The GUID of the defined type of the value we're saving */
+    definedTypeGuid?: Guid | null;
+
+    /** The description property of the new defined value */
+    description?: string | null;
+
+    /** Gets or sets the security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /** The value property of the new defined value */
+    value?: string | null;
+};

package/types/ViewModels/Rest/Controls/entityTagListAddEntityTagOptionsBag.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 AddEntityTag API action of
+ * the EntityTagList control.
+ */
+export type EntityTagListAddEntityTagOptionsBag = {
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.EntityTagListAddEntityTagOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets key identifier of the tag to apply to the entity. */
+    tagKey?: string | null;
+};

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

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the CreatePersonalTag API action of
+ * the EntityTagList control.
+ */
+export type EntityTagListCreatePersonalTagOptionsBag = {
+    /** Gets or sets the category unique identifier that the tag should be associated with. */
+    categoryGuid?: Guid | null;
+
+    /** Gets or sets the entity qualifier column. */
+    entityQualifierColumn?: string | null;
+
+    /** Gets or sets the entity qualifier value. */
+    entityQualifierValue?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /** Gets or sets the name of the tag to be created. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,63 @@
+//------------------------------------------------------------------------------
+// <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 GetAvailableTags API action of
+ * the EntityTagList control.
+ */
+export type EntityTagListGetAvailableTagsOptionsBag = {
+    /**
+     * Gets or sets the category unique identifier to limit tags to. If a
+     * value is specified then any tags must match the category.
+     */
+    categoryGuid?: Guid | null;
+
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.EntityTagListGetAvailableTagsOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity qualifier column. */
+    entityQualifierColumn?: string | null;
+
+    /** Gets or sets the entity qualifier value. */
+    entityQualifierValue?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /** Gets or sets the partial name match to search for. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets whether to include inactive tags. */
+    showInactiveTags: boolean;
+};

package/types/ViewModels/Rest/Controls/entityTagListGetEntityTagsOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetEntityTags API action of
+ * the EntityTagList control.
+ */
+export type EntityTagListGetEntityTagsOptionsBag = {
+    /**
+     * Gets or sets the category unique identifier to limit tags to. If a
+     * value is specified then any tags must match the category.
+     */
+    categoryGuid?: Guid | null;
+
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.EntityTagListGetEntityTagsOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity qualifier column. */
+    entityQualifierColumn?: string | null;
+
+    /** Gets or sets the entity qualifier value. */
+    entityQualifierValue?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets whether to include inactive tags in the results. */
+    showInactiveTags: boolean;
+};

package/types/ViewModels/Rest/Controls/entityTagListRemoveEntityTagOptionsBag.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 RemoveEntityTag API action of
+ * the EntityTagList control.
+ */
+export type EntityTagListRemoveEntityTagOptionsBag = {
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.EntityTagListRemoveEntityTagOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets key identifier of the tag to remove from the entity. */
+    tagKey?: string | null;
+};

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

@@ -0,0 +1,64 @@
+//------------------------------------------------------------------------------
+// <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 { EntityTagListTagBag } from "@Obsidian/ViewModels/Rest/Controls/entityTagListTagBag";
+
+/**
+ * The options that can be passed to the GetAvailableTags API action of
+ * the EntityTagList control.
+ */
+export type EntityTagListSaveTagValuesOptionsBag = {
+    /**
+     * Gets or sets the category unique identifier to limit tags to. If a
+     * value is specified then any tags must match the category.
+     */
+    categoryGuid?: Guid | null;
+
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.EntityTagListSaveTagValuesOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity qualifier column. */
+    entityQualifierColumn?: string | null;
+
+    /** Gets or sets the entity qualifier value. */
+    entityQualifierValue?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets whether to include inactive tags. */
+    showInactiveTags: boolean;
+
+    /** Gets or sets the list of tags. */
+    tags?: EntityTagListTagBag[] | null;
+};

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

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Identifies a single tag to the EntityTagList control. */
+export type EntityTagListTagBag = {
+    /** Gets or sets the color of the background of the tag. */
+    backgroundColor?: string | null;
+
+    /** Gets or sets the category the tag belongs to. */
+    category?: ListItemBag | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /** Gets or sets the icon CSS class to display with tag. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of the tag. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this tag is personal. */
+    isPersonal: boolean;
+
+    /** Gets or sets the name of the tag. */
+    name?: string | null;
+};

package/types/ViewModels/Rest/Controls/entityTypePickerGetEntityTypesOptionsBag.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 GetEntityTypes API action of
+ * the EntityTypePicker control.
+ */
+export type EntityTypePickerGetEntityTypesOptionsBag = {
+};

package/types/ViewModels/Rest/Controls/ethnicityPickerGetEthnicitiesResultsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The results from the GetEthnicities API action of the EthnicityPicker control. */
+export type EthnicityPickerGetEthnicitiesResultsBag = {
+    /** List of ListItemBags representing all the ethnicity options */
+    ethnicities?: ListItemBag[] | null;
+
+    /** String label for the control */
+    label?: string | null;
+};