@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/ViewModels/Rest/Controls/assetManagerGetFilesResultsBag.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 result from the GetFiles API action of the AssetManager control. */
+export type AssetManagerGetFilesResultsBag<T> = {
+    /** List of files to display */
+    files?: T[] | null;
+
+    /** Whether or not this folder is restricted from having certain actions performed on it. */
+    isFolderRestricted: boolean;
+
+    /** Whetehr or not this folder is restricted from having certain types of files uploaded to it. */
+    isFolderUploadRestricted: boolean;
+};

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

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <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 GetListOfAllFolders API action of
+ * the AssetManager control.
+ */
+export type AssetManagerGetListOfAllFoldersOptionsBag = {
+    /** The file manager's root folder, encrypted */
+    encryptedRoot?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** The folder that we want to move. Don't show this folder or its children in the list. */
+    selectedFolder?: string | null;
+
+    /**
+     * If set to true, instead of using the given root directly, the root folder shown will be a
+     * folder under the given root that is named after the current person's username. If the folder
+     * does not exist, it will be created.
+     */
+    userSpecificRoot: boolean;
+};

package/types/ViewModels/Rest/Controls/assetManagerGetRootFoldersOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the GetRootFolders API action of
+ * the AssetManager control.
+ */
+export type AssetManagerGetRootFoldersOptionsBag = {
+    /** Whether Asset providers should be included in the result. */
+    enableAssetManager: boolean;
+
+    /** Whether local file system folders should be included in the result. */
+    enableFileManager: boolean;
+
+    /**
+     * A list of keys of the folders that should be expanded in the tree
+     * (include their subfolders in the results)
+     */
+    expandedFolders?: string[] | null;
+
+    /** Root folder for the file manager (encrypted). */
+    rootFolder?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /**
+     * The key of the currently selected folder. In order for the client to
+     * be able to use this key, we need to have the encrypted root of this
+     * asset provider / folder match this key's encrypted root.
+     */
+    selectedFolder?: string | null;
+
+    /**
+     * If set to true, instead of using the given root directly, the root folder shown will be a
+     * folder under the given root that is named after the current person's username. If the folder
+     * does not exist, it will be created.
+     */
+    userSpecificRoot: boolean;
+};

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

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/**
+ * The options that can be passed to the MoveFolder API action of
+ * the AssetManager control.
+ */
+export type AssetManagerMoveFolderOptionsBag = {
+    /** A key that contains all the information needed to get the full asset that is being acted upon */
+    assetFolderId?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** The folder you want to move the selected folder into */
+    targetFolder?: string | null;
+};

package/types/ViewModels/Rest/Controls/assetManagerRenameFileOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the RenameFile API action of
+ * the AssetManager control.
+ */
+export type AssetManagerRenameFileOptionsBag = {
+    /** ID of the asset storage provider that this file resides on. */
+    assetStorageProviderId: number;
+
+    /** The path and file name of the file that is being renamed. */
+    file?: string | null;
+
+    /** The new name of the file. */
+    newFileName?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/**
+ * The options that can be passed to the RenameFolder API action of
+ * the AssetManager control.
+ */
+export type AssetManagerRenameFolderOptionsBag = {
+    /** A key that contains all the information needed to get the folder being renamed */
+    assetFolderId?: string | null;
+
+    /** New name for the folder */
+    newFolderName?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,69 @@
+//------------------------------------------------------------------------------
+// <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 { TreeItemBag } from "@Obsidian/ViewModels/Utility/treeItemBag";
+
+/** A TreeItemBag that is extended to give additional information for the AssetManager. */
+export type AssetManagerTreeItemBag = {
+    /** Gets or sets the child count. Optional. */
+    childCount?: number | null;
+
+    /**
+     * Gets or sets the children. A value of null indicates that the
+     * children should be lazy loaded by the caller.
+     */
+    children?: TreeItemBag[] | null;
+
+    /** Gets or sets a value indicating whether this instance has children. */
+    hasChildren: boolean;
+
+    /** Gets or sets the icon CSS class. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /**
+     * Gets or sets a value indicating whether this instance is a folder.
+     * A folder is an item that is intended to hold child items. This is
+     * a distinction from the Rock.ViewModels.Utility.TreeItemBag.HasChildren property which
+     * specifies if this item _currently_ has children or not.
+     */
+    isFolder: boolean;
+
+    /** Gets or sets the text that should be displayed to identify this item. */
+    text?: string | null;
+
+    /**
+     * Gets or sets the type of item represented by this instance. There is
+     * no pre-defined meaning to this, it is up to the item provider to
+     * decide what to do with it.
+     */
+    type?: string | null;
+
+    /** The unencrypted path to the root directory of the asset. */
+    unencryptedRoot?: string | null;
+
+    /** Gets or sets the generic identifier of this item. */
+    value?: string | null;
+};

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

@@ -0,0 +1,41 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * The options for the NormalizeNewValue API action of the AttributeMatrixEditor control.
+ * In this case, normalizing means we're taking the public edit values that we got from
+ * the "add" or "edit" forms of the matrix and converting them to the public value so
+ * they can be displayed correctly.
+ */
+export type AttributeMatrixEditorNormalizeEditValueOptionsBag = {
+    /** Configuration information for the attributes that we're normalizing the value of. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /**
+     * A list of the attribute values (public edit values) for the attributes of the
+     * new matrix item. Key is the attribute name.
+     */
+    attributeValues?: Record<string, string> | null;
+};

package/types/ViewModels/Rest/Controls/attributeMatrixEditorNormalizeEditValueResultsBag.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>
+//
+
+/**
+ * The results for the NormalizeNewValue API action of the AttributeMatrixEditor control.
+ * It contains the newly retrieved viewing values along with the edit values that were sent.
+ */
+export type AttributeMatrixEditorNormalizeEditValueResultsBag = {
+    /**
+     * A list of the attribute values (public edit values) for the attributes of the
+     * new matrix item. Key is the attribute name.
+     */
+    editValues?: Record<string, string> | null;
+
+    /**
+     * A list of the attribute values (public viewing values) for the attributes of the
+     * new matrix item. Key is the attribute name.
+     */
+    viewValues?: Record<string, string> | null;
+};

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

@@ -0,0 +1,47 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options for the NormalizeNewValue API action of the AttributeMatrixEditor control.
+ * In this case, normalizing means we're taking the public edit values that we got from
+ * the "add" or "edit" forms of the matrix and converting them to the public value so
+ * they can be displayed correctly.
+ */
+export type AttributeMatrixEditorPublicItemBag = {
+    /** A list of the attribute values (public edit values) of the AttributeMatrixItem. Key is the attribute name. */
+    editValues?: Record<string, string> | null;
+
+    /** Unique identifier of the AttributeMatrixItem */
+    guid: Guid;
+
+    /** Only used on the client side as a temporary ID until the item is saved and gains a Guid. */
+    key?: number | null;
+
+    /** Order in which this item is displayed in a list of these items */
+    order: number;
+
+    /** A list of the attribute values (public view values) of the AttributeMatrixItem. Key is the attribute name. */
+    viewValues?: Record<string, string> | null;
+};

package/types/ViewModels/Rest/Controls/badgeControlGetBadgeOptionsBag.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 GetBadges API action of
+ * the BadgeList control.
+ */
+export type BadgeControlGetBadgeOptionsBag = {
+    /** Gets or sets the badge type guid being requested. */
+    badgeTypeGuid: Guid;
+
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.BadgeControlGetBadgeOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/{definedValuePickerGetAttributesOptionsBag.d.ts → definedValueEditorGetAttributesOptionsBag.d.ts}

@@ -27,7 +27,7 @@ import { Guid } from "@Obsidian/Types";
  * The options that can be passed to the GetAttributes API action of
  * the DefinedValuePicker control.
  */
-export type DefinedValuePickerGetAttributesOptionsBag = {
+export type DefinedValueEditorGetAttributesOptionsBag = {
     /** Gets or sets the unique identifier of the defined type to get attributes of. */
     definedTypeGuid: Guid;
 

package/types/ViewModels/Rest/Controls/definedValueEditorGetAttributesResultsBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The results from the GetAttributes API action of the DefinedValuePicker control. */
+export type DefinedValueEditorGetAttributesResultsBag = {
+    /** The attributes data. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** The default values of the attributes. */
+    defaultValues?: Record<string, string> | null;
+};

package/types/ViewModels/Rest/Controls/{definedValuePickerSaveNewValueOptionsBag.d.ts → definedValueEditorSaveNewValueOptionsBag.d.ts}

@@ -27,7 +27,7 @@ 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 = {
+export type DefinedValueEditorSaveNewValueOptionsBag = {
     /** A collection of attribute values for the new defined value */
     attributeValues?: Record<string, string> | null;
 
@@ -40,6 +40,12 @@ export type DefinedValuePickerSaveNewValueOptionsBag = {
     /** Gets or sets the security grant token to use when performing authorization checks. */
     securityGrantToken?: string | null;
 
+    /**
+     * Gets or sets the attribute identifier that should be updated. This
+     * must be null or represent a Defined Value field type attribute.
+     */
+    updateAttributeGuid?: Guid | null;
+
     /** The value property of the new defined value */
     value?: string | null;
 };

package/types/ViewModels/Rest/Controls/emailEditorAttendanceOccurrenceBag.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>
+//
+
+/** Bag containing the attendance occurrence information needed for the Email Editor control. */
+export type EmailEditorAttendanceOccurrenceBag = {
+    /** Gets or sets the group identifier. */
+    groupId?: number | null;
+
+    /** Gets or sets the location identifier. */
+    locationId?: number | null;
+
+    /** Gets or sets the occurrence date. */
+    occurrenceDate?: string | null;
+
+    /** Gets or sets the attendance occurrence identifier. */
+    occurrenceId: number;
+
+    /** Gets or sets the schedule identifier. */
+    scheduleId?: number | null;
+};

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

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** Bag containing the information to create an attendance occurrence in the Email Editor control. */
+export type EmailEditorCreateAttendanceOccurrenceOptionsBag = {
+    /** Gets or sets the group identifier. */
+    groupId: number;
+
+    /** Gets or sets the location identifier. */
+    locationId?: number | null;
+
+    /** Gets or sets the date of the attendance occurrence. */
+    occurrenceDate?: string | null;
+
+    /** Gets or sets the schedule identifier. */
+    scheduleId?: number | null;
+};