@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceTypeBag.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 { BenevolenceTypeOptionsBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceTypeOptionsBag";
+
+/** Represents a benevolence type and its configuration options for a benevolence request. */
+export type BenevolenceTypeBag = {
+    /** Gets or sets the unique identifier of the benevolence type. */
+    id: number;
+
+    /** Gets or sets a value indicating whether the current instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets the detailed information related to the lava template of the benevolence type. */
+    lavaDetails?: string | null;
+
+    /** Gets or sets the name of the benevolence type. */
+    name?: string | null;
+
+    /** Gets or sets the options for the benevolence type. */
+    options?: BenevolenceTypeOptionsBag | null;
+};

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/benevolenceTypeOptionsBag.d.ts

@@ -0,0 +1,38 @@
+//------------------------------------------------------------------------------
+// <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 configuration options for a benevolence type. */
+export type BenevolenceTypeOptionsBag = {
+    /**
+     * Gets or sets any additional settings for the benevolence type. This is a
+     * <em>staging property</em> used to retrieve data to be transformed
+     * and is cleared before it is sent to the client.
+     */
+    additionalSettingsJson?: string | null;
+
+    /** Gets or sets a value indicating whether financial results are shown for the benevolence type. */
+    isShowingFinancialResults: boolean;
+
+    /** Gets or sets the maximum number of documents that can be attached to a benevolence request. */
+    maximumDocuments: number;
+};

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/campusBag.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";
+
+/**
+ * Represents a container for campus-related information, including identifiers and descriptive details
+ * that are relevevant in the context of a benevolence request.
+ */
+export type CampusBag = {
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the unique identifier for the entity. */
+    guid?: Guid | null;
+
+    /** Gets or sets the unique identifier for the entity. */
+    id?: number | null;
+
+    /** Gets or sets the name of the Campus. This property is required. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/connectionStatusBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/** Represents the connection status information for a benevolence request. */
+export type ConnectionStatusBag = {
+    /** Gets or sets the unique identifier (GUID) of the connection status. */
+    connectionStatusGuid: Guid;
+
+    /** Gets or sets the name of the connection status. */
+    connectionStatusName?: string | null;
+
+    /** Gets or sets the identifier of the connection status value. */
+    connectionStatusValueId?: number | null;
+};

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/locationBag.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";
+import { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Contains details of the location that are relevevant in the context of a benevolence request. */
+export type LocationBag = {
+    /** Gets or sets the address fields. */
+    addressFields?: AddressControlBag | null;
+
+    /** Gets or sets the guid. */
+    guid?: Guid | null;
+
+    /** Gets or sets the unique identifier for the entity. */
+    id?: number | null;
+
+    /**
+     * Gets or sets the Id of the LocationType Rock.Model.DefinedValue that is used to identify the type of Rock.Model.Location
+     * that this is. Examples: Campus, Building, Room, etc
+     */
+    locationTypeValue?: ListItemBag | null;
+
+    /** Gets or sets the Location's Name. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/personBag.d.ts

@@ -0,0 +1,81 @@
+//------------------------------------------------------------------------------
+// <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 { ConnectionStatusBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/connectionStatusBag";
+import { LocationBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/locationBag";
+import { PhoneNumberBag } from "@Obsidian/ViewModels/Blocks/Finance/BenevolenceRequestDetail/phoneNumberBag";
+
+/**
+ * Represents a collection of personal information for an individual, including identifiers, contact details, and
+ * names that are relevevant in the context of a benevolence request.
+ */
+export type PersonBag = {
+    /** Gets or sets the Cell Phone Number of the person who requested benevolence. */
+    cellPhoneNumber?: PhoneNumberBag | null;
+
+    /** Gets or sets the Id representing the Person's connection status */
+    connectionStatus?: ConnectionStatusBag | null;
+
+    /** Gets or sets the email address of the person requesting benevolence. */
+    email?: string | null;
+
+    /** Gets or sets the unique identifier for the ethnicity. */
+    ethnicityGuid: Guid;
+
+    /** Gets or sets the first name of the Person. */
+    firstName?: string | null;
+
+    /** Gets or sets the GovernmentId of the person who requested benevolence. */
+    governmentId?: string | null;
+
+    /** Gets or sets the Home Phone Number of the person who requested benevolence. */
+    homePhoneNumber?: PhoneNumberBag | null;
+
+    /** Gets or sets the last name (Sir Name) of the Person. */
+    lastName?: string | null;
+
+    /** Gets or sets the location information. */
+    location?: LocationBag | null;
+
+    /** Gets or sets the nick name of the Person.  If a nickname was not entered, the first name is used. */
+    nickName?: string | null;
+
+    /** Gets or sets the unique identifier for the person's alias. */
+    personAliasGuid: Guid;
+
+    /** Gets or sets the alias identifier for a person. */
+    personAliasId?: number | null;
+
+    /** Gets or sets the unique identifier for a person. */
+    personIdKey?: string | null;
+
+    /** Gets or sets the URL of the photo associated with the entity. */
+    photoUrl?: string | null;
+
+    /** Gets or sets the unique identifier for the race. */
+    raceGuid: Guid;
+
+    /** Gets or sets the Work Phone Number of the person who requested benevolence. */
+    workPhoneNumber?: PhoneNumberBag | null;
+};

package/types/ViewModels/Blocks/Finance/BenevolenceRequestDetail/phoneNumberBag.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>
+//
+
+/**
+ * Represents a collection of properties related to a phone number,
+ * including the country code, the number itself, and the type of
+ * phone number that are relevevant in the context of a benevolence request..
+ */
+export type PhoneNumberBag = {
+    /**
+     * Gets or sets the country code for the phone number.
+     * This is typically the international dialing code (e.g., 1 for USA/Canada).
+     */
+    countryCode?: string | null;
+
+    /** Gets or sets a value indicating whether the phone number was obtained from the person's record. */
+    isNumberFromPersonRecord: boolean;
+
+    /**
+     * Gets or sets the phone number.
+     * This should be the local portion of the phone number, excluding the country code.
+     */
+    number?: string | null;
+
+    /** Gets or sets the formatted representation of the phone number, exluding the country code. */
+    numberFormatted?: string | null;
+};

package/types/ViewModels/Blocks/Finance/ConvertBusiness/conversionResultBag.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>
+//
+
+/** Holds the result payload returned after a successful conversion operation. */
+export type ConversionResultBag = {
+    /** The success message to be shown after conversion completes. */
+    successMessage?: string | null;
+};

package/types/ViewModels/Blocks/Finance/ConvertBusiness/conversionSelectionResultBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Contains UI state details after evaluating the selected source record for conversion. */
+export type ConversionSelectionResultBag = {
+    /** The initial business name value to use when converting a person to a business. */
+    businessName?: string | null;
+
+    /** The heading text for an error message shown to the user. */
+    errorHeading?: string | null;
+
+    /** The error message text shown when conversion cannot proceed. */
+    errorText?: string | null;
+
+    /** The conversion mode to display, such as converting to person or converting to business. */
+    mode?: string | null;
+
+    /** The default connection status selection when converting a business to a person. */
+    personConnectionStatus?: ListItemBag | null;
+
+    /** The initial first name value to use when converting a business to a person. */
+    personFirstName?: string | null;
+
+    /** The initial gender value used when converting a business to a person. */
+    personGender: number;
+
+    /** The initial last name value to use when converting a business to a person. */
+    personLastName?: string | null;
+};

package/types/ViewModels/Blocks/Finance/ConvertBusiness/convertBusinessBag.d.ts

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Contains initialization values used when the Convert Business block first loads. */
+export type ConvertBusinessBag = {
+    /** Gets or sets the default person connection status. */
+    defaultPersonConnectionStatus?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Finance/ConvertBusiness/convertToBusinessRequestBag.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 { Guid } from "@Obsidian/Types";
+
+/** Represents the client request to convert a person record into a business record. */
+export type ConvertToBusinessRequestBag = {
+    /** The business name to store on the converted business record. */
+    businessName?: string | null;
+
+    /** The person alias GUID that identifies the selected source person record. */
+    sourcePersonAliasGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/Finance/ConvertBusiness/convertToPersonRequestBag.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 { Gender } from "@Obsidian/Enums/Crm/gender";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Represents the client request to convert a business record into a person record. */
+export type ConvertToPersonRequestBag = {
+    /** The connection status to assign to the converted person record. */
+    personConnectionStatus?: ListItemBag | null;
+
+    /** The first name to set on the converted person record. */
+    personFirstName?: string | null;
+
+    /** The gender to assign to the converted person record. */
+    personGender: Gender;
+
+    /** The last name to set on the converted person record. */
+    personLastName?: string | null;
+
+    /** The marital status to assign to the converted person record. */
+    personMaritalStatus?: ListItemBag | null;
+
+    /** The person alias GUID that identifies the selected source business record. */
+    sourcePersonAliasGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialPledgeAnalytics/financialPledgeAnalyticsBlockBox.d.ts

@@ -0,0 +1,50 @@
+//------------------------------------------------------------------------------
+// <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 { FinancialPledgeAnalyticsFiltersBag } from "@Obsidian/ViewModels/Blocks/Finance/FinancialPledgeAnalytics/financialPledgeAnalyticsFiltersBag";
+import { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+import { CurrencyInfoBag } from "@Obsidian/ViewModels/Utility/currencyInfoBag";
+
+/** Contains the configuration, filters, and supporting data for the Financial Pledge Analytics block. */
+export type FinancialPledgeAnalyticsBlockBox = {
+    /** Gets or sets the currency information. */
+    currencyInfo?: CurrencyInfoBag | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** The primary options and filter values for the block. */
+    filters?: FinancialPledgeAnalyticsFiltersBag | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** The grid configuration for the pledges grid. */
+    pledgeGridBox?: GridDefinitionBag | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialPledgeAnalytics/financialPledgeAnalyticsBlockDataBag.d.ts

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <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 { GridDataBag } from "@Obsidian/ViewModels/Core/Grid/gridDataBag";
+
+/** The additional configuration options for the Financial Pledge Analytics block. */
+export type FinancialPledgeAnalyticsBlockDataBag = {
+    /** Data and configuration for the pledge analytics grid (column definitions and row data) used by the UI. */
+    pledgeGridData?: GridDataBag | null;
+};