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

package/types/ViewModels/Controls/fileAsset.d.ts

@@ -0,0 +1,51 @@
+// <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>
+//
+
+/**
+ * TODO
+ */
+export type FileAsset = {
+    /** DO NOT TRUST. ID for the AssetStoragePriver this files resides in */
+    assetStorageProviderId: number,
+
+    /** The name of the file */
+    name: string,
+
+    /** An identifier for the file. It contains the full path to the file within the provider */
+    key: string,
+
+    /** Public URI to view/download the file. */
+    uri: string,
+
+    /** Whether it's a folder or a file. 0 is a file */
+    type: 0,
+
+    /** Relative URL for the thumbnail of this file */
+    iconPath: string,
+
+    /** Size of the file in bytes */
+    fileSize: number,
+
+    /** Size of the file as a formatted string */
+    formattedFileSize: string,
+
+    /** ISO Date/time the file was last modified */
+    lastModifiedDateTime: string,
+
+    /** Description of the file */
+    description: string
+};

package/types/ViewModels/Controls/fullFieldSettingBag.d.ts

@@ -0,0 +1,22 @@
+// <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 { FieldSettingBag } from "./fieldSettingBag";
+
+type FullFieldSettingBag = Required<{
+    [Property in keyof FieldSettingBag]: NonNullable<FieldSettingBag[Property]>
+}>;

package/types/ViewModels/{Blocks/Engagement/Steps/flowNodeDiagramEdgeBag.d.ts → Controls/sankeyDiagramEdgeBag.d.ts}

@@ -25,7 +25,7 @@
  * A description of the number of items flowing from a Node on
  * one level to a node on the next level
  */
-export type FlowNodeDiagramEdgeBag = {
+export type SankeyDiagramEdgeBag = {
     /** Gets or sets the level */
     level: number;
 

package/types/ViewModels/{Blocks/Engagement/Steps/flowNodeDiagramNodeBag.d.ts → Controls/sankeyDiagramNodeBag.d.ts}

@@ -22,10 +22,10 @@
 //
 
 /**
- * Type for a Flow Node Diagram's Node definitions.
+ * Type for a Sankey Diagram's Node definitions.
  * For Step Flow diagrams, this represents a Step
  */
-export type FlowNodeDiagramNodeBag = {
+export type SankeyDiagramNodeBag = {
     /** Gets or sets the color */
     color?: string | null;
 

package/types/ViewModels/{Blocks/Engagement/Steps/flowNodeDiagramSettingsBag.d.ts → Controls/sankeyDiagramSettingsBag.d.ts}

@@ -21,8 +21,8 @@
 // </copyright>
 //
 
-/** Model of the settings for the Flow Node Diagram */
-export type FlowNodeDiagramSettingsBag = {
+/** Model of the settings for a Sankey Diagram */
+export type SankeyDiagramSettingsBag = {
     /** Gets or sets the chart height */
     chartHeight?: number | null;
 

package/types/ViewModels/Controls/valueFilter.d.ts

@@ -0,0 +1,35 @@
+// <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 { ComparisonType } from "@Obsidian/Enums/Reporting/comparisonType";
+import { FilterExpressionType } from "@Obsidian/Enums/Reporting/filterExpressionType";
+
+export type ComparisonItem = {
+    value: ComparisonType,
+    text: string
+};
+
+export type ComparisonFilterExpression = {
+    value: string,
+    value2?: string | null,
+    comparison: ComparisonType
+};
+
+export type CompoundFilterExpression = {
+    expressionType: FilterExpressionType,
+    filters: ComparisonFilterExpression[]
+};

package/types/ViewModels/Core/entitySearchQueryBag.d.ts

@@ -0,0 +1,75 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/**
+ * Defines the details about an entity search request that will be
+ * executed.
+ */
+export type EntitySearchQueryBag = {
+    /**
+     * Gets or sets the expression that will be used to group the results.
+     * This is processed after the Rock.ViewModels.Core.EntitySearchQueryBag.Where expression.
+     */
+    groupBy?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether only the number of matching
+     * items should be returned.
+     */
+    isCountOnly: boolean;
+
+    /**
+     * Gets or sets the number of items to include in the result set.
+     * This is processed after Rock.ViewModels.Core.EntitySearchQueryBag.Offset is processed.
+     */
+    limit?: number | null;
+
+    /**
+     * Gets or sets the number of items to skip before the first item the result set. This
+     * is processed after Rock.ViewModels.Core.EntitySearchQueryBag.Sort performs sorting.
+     */
+    offset?: number | null;
+
+    /**
+     * Gets or sets the expression that will be used to define the structure
+     * of the the resulting items. This is processed after the Rock.ViewModels.Core.EntitySearchQueryBag.GroupBy
+     * expression.
+     */
+    select?: string | null;
+
+    /**
+     * Gets or sets the expression that will be used to define the structure
+     * of the the resulting items. This is processed after the Rock.ViewModels.Core.EntitySearchQueryBag.GroupBy
+     * expression and instead of the Rock.ViewModels.Core.EntitySearchQueryBag.Select expression.
+     */
+    selectMany?: string | null;
+
+    /**
+     * Gets or sets the expression that will be used to sort the results.
+     * This is processed after the Rock.ViewModels.Core.EntitySearchQueryBag.Select expression.
+     */
+    sort?: string | null;
+
+    /** Gets or sets the expression that will be used to filter the query. */
+    where?: string | null;
+};

package/types/ViewModels/Core/entitySearchResultsBag.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>
+//
+
+/** Contains the results of an entity search request. */
+export type EntitySearchResultsBag = {
+    /** Gets or sets the number of items in this result. */
+    count: number;
+
+    /** Gets or sets the set of objects that matched the query. */
+    items?: unknown[] | null;
+};

package/types/ViewModels/Finance/savedAccountTokenBag.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** A bag used to add a saved account using a payment method token. */
+export type SavedAccountTokenBag = {
+    /** Gets or sets the city. */
+    city?: string | null;
+
+    /** Gets or sets the country. */
+    country?: string | null;
+
+    /** The currency type value identifier. */
+    currencyTypeValueId?: string | null;
+
+    /** Gets or sets the postal code. */
+    postalCode?: string | null;
+
+    /** Gets or sets the state. */
+    state?: string | null;
+
+    /** Gets or sets the first street line. */
+    street1?: string | null;
+
+    /** The token for the payment method. */
+    token?: string | null;
+};

package/types/ViewModels/Finance/savedFinancialAccountListItemBag.d.ts

@@ -21,14 +21,22 @@
 // </copyright>
 //
 
+import { Guid } from "@Obsidian/Types";
+
 /**
  * A list item that describes an payment account the individual has
  * previously setup that can be used again.
  */
 export type SavedFinancialAccountListItemBag = {
+    /** Gets or sets the masked account number. */
+    accountNumberMasked?: string | null;
+
     /** Gets or sets the category for this item. */
     category?: string | null;
 
+    /** The Guid for the currency type of this account. */
+    currencyTypeGuid?: Guid | null;
+
     /**
      * Gets or sets the description of the card to help identify it to the
      * individual.

package/types/ViewModels/Rest/Controls/aiProviderPickerGetAIProviderOptionsBag.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 GetAIProviders API action of
+ * the AIProviderPicker control.
+ */
+export type AIProviderPickerGetAIProviderOptionsBag = {
+};

package/types/ViewModels/Rest/Controls/aiProviderPickerGetAIProvidersOptionsBag.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 AIProviderPickerGetAIProviderOptionsBag API action of
+ * the AIProviderPicker control.
+ */
+export type AIProviderPickerGetAIProvidersOptionsBag = {
+};

package/types/ViewModels/Rest/Controls/assetManagerAddFolderOptionsBag.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 AddFolder API action of
+ * the AssetManager control.
+ */
+export type AssetManagerAddFolderOptionsBag = {
+    /** A key that contains all the information needed to get the full asset that is being acted upon */
+    assetFolderId?: string | null;
+
+    /** Name of the folder to be added. */
+    newFolderName?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/assetManagerBaseOptionsBag.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 many actions of the AssetManager control. */
+export type AssetManagerBaseOptionsBag = {
+    /** 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;
+};

package/types/ViewModels/Rest/Controls/assetManagerDeleteFilesOptionsBag.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 DeleteFiles API action of
+ * the AssetManager control.
+ */
+export type AssetManagerDeleteFilesOptionsBag = {
+    /** The ID of the asset storage provider where the files to be deleted reside. */
+    assetStorageProviderId: number;
+
+    /** The list of IDs of files to be deleted */
+    files?: string[] | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/assetManagerDownloadFileOptionsBag.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 DownloadFile API action of
+ * the AssetManager control.
+ */
+export type AssetManagerDownloadFileOptionsBag = {
+    /** The ID of the asset storage provider where the file to be downloaded resides. */
+    assetStorageProviderId: number;
+
+    /** The identifier for the file that is to be downloaded. */
+    file?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/assetManagerExtractFileOptionsBag.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 ExtractFile API action of
+ * the AssetManager control.
+ */
+export type AssetManagerExtractFileOptionsBag = {
+    /** Encrypted path to the root of where the file is located. */
+    encryptedRoot?: string | null;
+
+    /** The path to the file that is to be extracted. */
+    fileName?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,32 @@
+//------------------------------------------------------------------------------
+// <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 AddFolder API action of
+ * the AssetManager control.
+ */
+export type AssetManagerGetChildrenOptionsBag = {
+    assetFolderId?: string | null;
+
+    expandedFolders?: string[] | null;
+};

package/types/ViewModels/Rest/Controls/assetManagerGetFilesOptionsBag.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 AddFolder API action of
+ * the AssetManager control.
+ */
+export type AssetManagerGetFilesOptionsBag = {
+    /** A key that contains all the information needed to get the full asset that is being acted upon */
+    assetFolderId?: string | null;
+
+    /** Either "image" or "doc". If "image", only return image files, otherwise all files. */
+    browseMode?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};