@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/Utility/treeItemProviders.d.ts

@@ -43,6 +43,8 @@ export interface ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class CategoryTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The root category to start pulling categories from. Set to undefined to
      * begin with any category that does not have a parent.
@@ -90,15 +92,26 @@ export declare class CategoryTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class LocationTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The security grant token that will be used to request additional access
      * to the category list.
      */
     securityGrantToken?: string | null;
+    /**
+     * The root location to restrict the tree to.
+     */
+    rootLocationGuid?: Guid | null;
+    /**
+     * Determines if inactive locations should be included in the results.
+     */
+    includeInactive: boolean;
     /**
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -117,6 +130,8 @@ export declare class LocationTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class DataViewTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The entity type unique identifier to restrict results to. Set to undefined
      * to include all categories, regardless of entity type.
@@ -153,6 +168,8 @@ export declare class DataViewTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class WorkflowTypeTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The entity type unique identifier to restrict results to. Set to undefined
      * to include all categories, regardless of entity type.
@@ -185,6 +202,8 @@ export declare class WorkflowTypeTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class PageTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The security grant token that will be used to request additional access
      * to the category list.
@@ -202,10 +221,16 @@ export declare class PageTreeItemProvider implements ITreeItemProvider {
      * The site type to limit the results.
      */
     siteType?: SiteType | null;
+    /**
+     * The unique identifier of the root page whose
+     * children are to be enumerated.
+     */
+    rootPageGuid?: Guid | null;
     /**
      * Gets the child items of the given parent (or root if no parent given) from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -227,7 +252,7 @@ export declare class PageTreeItemProvider implements ITreeItemProvider {
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -238,6 +263,8 @@ export declare class PageTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class ConnectionRequestTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The security grant token that will be used to request additional access
      * to the category list.
@@ -247,6 +274,7 @@ export declare class ConnectionRequestTreeItemProvider implements ITreeItemProvi
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -254,7 +282,7 @@ export declare class ConnectionRequestTreeItemProvider implements ITreeItemProvi
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -265,12 +293,16 @@ export declare class ConnectionRequestTreeItemProvider implements ITreeItemProvi
  * them inside a tree list.
  */
 export declare class GroupTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /** GUID of the group you want to use as the root. */
     rootGroupGuid: Guid | null;
     /** List of group types GUIDs to limit to groups of those types. */
     includedGroupTypeGuids: Guid[];
+    /** When true, show no groups by default. */
+    excludeAllByDefault: boolean;
     /** Whether to include inactive groups or not. */
     includeInactiveGroups: boolean;
     /** Whether to limit to only groups that have scheduling enabled. */
@@ -281,6 +313,7 @@ export declare class GroupTreeItemProvider implements ITreeItemProvider {
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -288,7 +321,7 @@ export declare class GroupTreeItemProvider implements ITreeItemProvider {
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -299,6 +332,8 @@ export declare class GroupTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class MergeTemplateTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /** Filter for which merge templates to include in results: Global, Public, or Both */
@@ -307,6 +342,7 @@ export declare class MergeTemplateTreeItemProvider implements ITreeItemProvider
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -314,7 +350,7 @@ export declare class MergeTemplateTreeItemProvider implements ITreeItemProvider
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -325,12 +361,15 @@ export declare class MergeTemplateTreeItemProvider implements ITreeItemProvider
  * them inside a tree list.
  */
 export declare class MetricCategoryTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /**
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -338,7 +377,7 @@ export declare class MetricCategoryTreeItemProvider implements ITreeItemProvider
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -349,6 +388,8 @@ export declare class MetricCategoryTreeItemProvider implements ITreeItemProvider
  * them inside a tree list.
  */
 export declare class MetricItemTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /** A list of category GUIDs to filter the results */
@@ -375,12 +416,15 @@ export declare class MetricItemTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class RegistrationTemplateTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /**
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -388,7 +432,7 @@ export declare class RegistrationTemplateTreeItemProvider implements ITreeItemPr
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -399,6 +443,8 @@ export declare class RegistrationTemplateTreeItemProvider implements ITreeItemPr
  * them inside a tree list.
  */
 export declare class ReportTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /** A list of category GUIDs to filter the results. */
@@ -409,6 +455,7 @@ export declare class ReportTreeItemProvider implements ITreeItemProvider {
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -416,7 +463,7 @@ export declare class ReportTreeItemProvider implements ITreeItemProvider {
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -427,16 +474,21 @@ export declare class ReportTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class ScheduleTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /** Whether to include inactive schedules in the results. */
     includeInactive: boolean;
     /** Whether to exclude private schedules in the results. */
     includePublicOnly: boolean;
+    /** The category GUIDs to filter schedules by. */
+    includeCategoryGuids: Guid[] | null;
     /**
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -444,7 +496,7 @@ export declare class ScheduleTreeItemProvider implements ITreeItemProvider {
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -455,6 +507,8 @@ export declare class ScheduleTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class WorkflowActionTypeTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** The security grant token that will be used to request additional access to the group list. */
     securityGrantToken: string | null;
     /** Whether to include inactive schedules in the results. */
@@ -463,6 +517,7 @@ export declare class WorkflowActionTypeTreeItemProvider implements ITreeItemProv
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -470,7 +525,7 @@ export declare class WorkflowActionTypeTreeItemProvider implements ITreeItemProv
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */
@@ -481,6 +536,8 @@ export declare class WorkflowActionTypeTreeItemProvider implements ITreeItemProv
      * them inside a tree list.
      */
 export declare class MergeFieldTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The security grant token that will be used to request additional access
      * to the category list.
@@ -536,6 +593,8 @@ export declare class MergeFieldTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class AssetManagerTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /** List of folders that are currently expanded in the tree list. */
     openFolders: Set<string>;
     selectedFolder: string | null;
@@ -558,6 +617,8 @@ export declare class AssetManagerTreeItemProvider implements ITreeItemProvider {
  * them inside a tree list.
  */
 export declare class AdaptiveMessageTreeItemProvider implements ITreeItemProvider {
+    /** The HTTP client for making API requests. */
+    private readonly http;
     /**
      * The security grant token that will be used to request additional access
      * to the category list.
@@ -567,6 +628,7 @@ export declare class AdaptiveMessageTreeItemProvider implements ITreeItemProvide
      * Gets the child items from the server.
      *
      * @param parentGuid The parent item whose children are retrieved.
+     * @param expandToValues The values that should be auto-expanded to.
      *
      * @returns A collection of TreeItem objects as an asynchronous operation.
      */
@@ -574,7 +636,7 @@ export declare class AdaptiveMessageTreeItemProvider implements ITreeItemProvide
     /**
      * @inheritdoc
      */
-    getRootItems(): Promise<TreeItemBag[]>;
+    getRootItems(expandToValues: string[]): Promise<TreeItemBag[]>;
     /**
      * @inheritdoc
      */

package/types/Utility/url.d.ts

@@ -15,15 +15,38 @@ export declare function isUrl(val: unknown): boolean;
  */
 export declare function makeUrlRedirectSafe(url: string): string;
 /**
- * Keep a list of named Refs synchronized with URL query parameters in the address of the same names.
- * If there are already query parameters in the URL with those names, the Refs will be assigned those
- * values. This will also watch those Refs for changes and update the query parameters to reflect
- * those changes.
+ * The types of query parameters that can be synchronized with Refs using the
+ * syncRefsWithQueryParams function.
+ */
+export type QueryParamType = "string" | "number" | "boolean" | "json";
+/**
+ * Defines the binding between a Ref and a query parameter, including the query
+ * parameter name and expected type for proper parsing and serialization.
+ */
+export type QueryParamBinding = {
+    /**
+     * The query parameter name in the URL.
+     */
+    param: string;
+    /**
+     * The Ref to keep synchronized with the query parameter.
+     */
+    ref: Ref;
+    /**
+     * The expected type of the query parameter for parsing/serialization.
+     */
+    type: QueryParamType;
+};
+/**
+ * Keep a list of named Refs synchronized with URL query parameters. If there
+ * are already query parameters in the URL with matching parameter names, the
+ * Refs will be assigned those values. This will also watch those Refs for
+ * changes and update the query parameters to reflect those changes.
  *
- * @param refs An object where the keys represent the query parameters keys to keep synchronized with
- * and the values are the Refs those query parameters are synched with.
+ * @param bindings The list of bindings that define which Refs to sync with
+ * which query parameters, and how to parse/serialize them.
  */
-export declare function syncRefsWithQueryParams(refs: Record<string, Ref>): void;
+export declare function syncRefsWithQueryParams(bindings: QueryParamBinding[]): void;
 /**
  * Removes query parameters from the current URL and replaces the state in history.
  *

package/types/ViewModels/Blocks/Administration/NotificationList/notificationItemBag.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 { NotificationClassification } from "@Obsidian/Enums/Communication/notificationClassification";
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * Contains the data for a single notification item displayed in the
+ * Notification List block.
+ */
+export type NotificationItemBag = {
+    /**
+     * Gets or sets the classification of the notification. This is used
+     * to determine the alert styling.
+     */
+    classification: NotificationClassification;
+
+    /**
+     * Gets or sets the unique identifier of the notification recipient
+     * record. This is used to mark the notification as read.
+     */
+    guid: Guid;
+
+    /** Gets or sets the CSS class for the notification icon. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the HTML message content of the notification. */
+    message?: string | null;
+
+    /** Gets or sets the title of the notification. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Administration/NotificationList/notificationListBag.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 { NotificationItemBag } from "@Obsidian/ViewModels/Blocks/Administration/NotificationList/notificationItemBag";
+
+/**
+ * Contains the main data for the Notification List block, including the
+ * list of unread notification items for the current person.
+ */
+export type NotificationListBag = {
+    /** Gets or sets the list of unread notification items to display. */
+    notifications?: NotificationItemBag[] | null;
+};

package/types/ViewModels/{Rest/Controls/captchaControlConfigurationBag.d.ts → Blocks/Administration/NotificationList/notificationListOptionsBag.d.ts}

@@ -21,11 +21,6 @@
 // </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;
+/** Contains the options for the Notification List block. */
+export type NotificationListOptionsBag = {
 };

package/types/ViewModels/Blocks/Administration/SystemConfiguration/generalConfigurationBag.d.ts

@@ -37,6 +37,12 @@ export type GeneralConfigurationBag = {
     /** Gets or sets a value indicating whether this instance is multiple time zone support enabled. */
     isMultipleTimeZoneSupportEnabled: boolean;
 
+    /**
+     * Determines if the system is currently in Trailblazer Mode. When this
+     * is enabled, the system will show more advanced configuration options.
+     */
+    isTrailblazerMode: boolean;
+
     /** Gets or sets the PDF external render endpoint. */
     pdfExternalRenderEndpoint?: string | null;
 

package/types/ViewModels/Blocks/Administration/SystemConfiguration/uiSettingsConfigurationBag.d.ts

@@ -21,13 +21,12 @@
 // </copyright>
 //
 
+import { CaptchaMode } from "@Obsidian/Enums/Cms/captchaMode";
+
 /** Contains the Ui Settings configuration details. */
 export type UiSettingsConfigurationBag = {
-    /** Gets or sets the captcha secret key. */
-    captchaSecretKey?: string | null;
-
-    /** Gets or sets the captcha site key. */
-    captchaSiteKey?: string | null;
+    /** Gets or sets the captcha mode. */
+    captchaMode: CaptchaMode;
 
     /** Gets or sets the value indicating whether or not default address state selection is enabled. */
     enableDefaultAddressStateSelection: boolean;

package/types/ViewModels/Blocks/BulkImport/csvImportBox.d.ts

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The initialization data for the Bulk Import Tool block. */
+export type CsvImportBox = {
+    /** Gets or sets the available Connection Status options for this Rock instance. */
+    connectionStatusOptions?: string | null;
+
+    /** Gets or sets the available Email Preference options for this Rock instance. */
+    emailPreferenceOptions?: string | null;
+
+    /** Gets or sets the available Gender options for this Rock instance. */
+    genderOptions?: string | null;
+
+    /** Gets or sets the available Grade options for this Rock instance. */
+    gradeOptions?: string | null;
+
+    /** Gets or sets the available Marital Status options for this Rock instance. */
+    maritalStatusOptions?: string | null;
+
+    /** Gets or sets the available Record Status options for this Rock instance. */
+    recordStatusOptions?: string | null;
+
+    /** Gets or sets the Encrypted Root Folder. */
+    rootFolder?: string | null;
+
+    /** Gets or sets the list of previous sources for the import. */
+    sources?: ListItemBag[] | null;
+
+    /** Gets or sets the available Suffix options for this Rock instance. */
+    suffixOptions?: string | null;
+};

package/types/ViewModels/Blocks/BulkImport/csvImportDeleteFileOptionsBag.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 request parameters for deleting a CSV file after it has been removed. */
+export type CsvImportDeleteFileOptionsBag = {
+    /** Gets or sets the name of the file to be deleted. */
+    fileName?: string | null;
+};

package/types/ViewModels/Blocks/BulkImport/csvImportGetCsvFieldsOptionsBag.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 request parameters for reading the CSV file and getting the list of fields. */
+export type CsvImportGetCsvFieldsOptionsBag = {
+    /** Gets or sets the name of the file to be read. */
+    fileName?: string | null;
+};