@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Finance/BusinessDetail/businessDetailBag.d.ts

@@ -0,0 +1,86 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { SearchKeyBag } from "@Obsidian/ViewModels/Blocks/Finance/BusinessDetail/searchKeyBag";
+import { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type BusinessDetailBag = {
+    /** Gets or sets the address. */
+    address?: AddressControlBag | null;
+
+    /** Gets or sets the address as HTML. */
+    addressAsHtml?: string | null;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the name of the business. */
+    businessName?: string | null;
+
+    /** Gets or sets the campus. */
+    campus?: ListItemBag | null;
+
+    /** Gets or sets the country code. */
+    countryCode?: string | null;
+
+    /** Gets or sets the custom actions. */
+    customActions?: string | null;
+
+    /** Gets or sets the email address. */
+    emailAddress?: string | null;
+
+    /** Gets or sets the email preference. */
+    emailPreference?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is SMS checked. */
+    isSmsChecked: boolean;
+
+    /** Gets or sets a value indicating whether this instance is unlisted checked. */
+    isUnlistedChecked: boolean;
+
+    /** Gets or sets the phone number. */
+    phoneNumber?: string | null;
+
+    /** Gets or sets the previous address. */
+    previousAddress?: string | null;
+
+    /** Gets or sets the record status. */
+    recordStatus?: ListItemBag | null;
+
+    /** Gets or sets the record reason. */
+    recordStatusReason?: ListItemBag | null;
+
+    /** Gets or sets a value indicating whether [save former address as previous address]. */
+    saveFormerAddressAsPreviousAddress: boolean;
+
+    /** Gets or sets the search keys. */
+    searchKeys?: SearchKeyBag[] | null;
+};

package/types/ViewModels/Blocks/Finance/BusinessDetail/businessDetailOptionsBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { SearchKeyBag } from "@Obsidian/ViewModels/Blocks/Finance/BusinessDetail/searchKeyBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type BusinessDetailOptionsBag = {
+    /** Gets or sets the search keys. */
+    searchKeys?: SearchKeyBag[] | null;
+
+    /** Gets or sets the search types list. */
+    searchTypesList?: ListItemBag[] | null;
+
+    /** Gets or sets the tag category unique identifier. */
+    tagCategoryGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/Finance/BusinessDetail/searchKeyBag.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";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type SearchKeyBag = {
+    /** Gets or sets the identifier. */
+    guid?: Guid | null;
+
+    /** Gets or sets the type of the search. */
+    searchType?: ListItemBag | null;
+
+    /** Gets or sets the search value. */
+    searchValue?: string | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchDetail/financialBatchAccountTotalsBag.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>
+//
+
+/** AddressStandardizationResultBag */
+export type FinancialBatchAccountTotalsBag = {
+    /** Gets or sets the name of the currency to be displayed in the Accounts Total section in the view mode */
+    currency: number;
+
+    /** Gets or sets the name of the account to be displayed in the Accounts Total section in the view mode */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchDetail/financialBatchBag.d.ts

@@ -0,0 +1,87 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type FinancialBatchBag = {
+    /** Gets or sets an optional transaction code from an accounting system that batch is associated with */
+    accountingSystemCode?: string | null;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /**
+     * Gets or sets end of the posting date and time range for FinancialTransactions that are included in this batch.
+     * Transactions that post before or on this date and time and after the Rock.Model.FinancialBatch.BatchStartDateTime can be included in this batch.
+     */
+    batchEndDateTime?: string | null;
+
+    /**
+     * Gets or sets the start posting date and time range of FinancialTransactions that are included in this batch.  
+     * Transactions that post on or after this date and time and before the Rock.Model.FinancialBatch.BatchEndDateTime can be included in this batch.
+     */
+    batchStartDateTime?: string | null;
+
+    /** Gets or sets the Rock.Model.Campus that this batch is associated with. */
+    campus?: ListItemBag | null;
+
+    /**
+     * Gets or sets the control amount. This should match the total value of all
+     * FinancialTransactions that are included in the batch.
+     * Use Rock.Model.FinancialBatchService.IncrementControlAmount(System.Int32,System.Decimal,Rock.Model.History.HistoryChangeList) if you are incrementing the control amount
+     * based on a transaction amount.
+     */
+    controlAmount: number;
+
+    /** Gets or sets the control item count. */
+    controlItemCount?: number | null;
+
+    /**
+     * The Batch ID
+     * Motive: Although the IdKey is passed to the user, there is no way to get the id from it in the frontend
+     * Id is required to be displayed in the frontend and so is included.
+     */
+    id: number;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the value of the flag which shows if the batch is automated or not. */
+    isAutomated: boolean;
+
+    /** The flag which is set to true if the user is forbidden from reopening the batch */
+    isReopenDisabled: boolean;
+
+    /** Gets or sets the name of the batch. */
+    name?: string | null;
+
+    /** Gets or sets the note. */
+    note?: string | null;
+
+    /** Gets or sets the status of the batch. */
+    status?: number | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchDetail/financialBatchCurrencyTotalsBag.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>
+//
+
+/** AddressStandardizationResultBag */
+export type FinancialBatchCurrencyTotalsBag = {
+    /** Gets or sets the name of the currency to be displayed in the Accounts Total section in the view mode */
+    currency: number;
+
+    /** Gets or sets the name of the account to be displayed in the Accounts Total section in the view mode */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchDetail/financialBatchDetailOptionsBag.d.ts

@@ -0,0 +1,58 @@
+//------------------------------------------------------------------------------
+// <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 { FinancialBatchAccountTotalsBag } from "@Obsidian/ViewModels/Blocks/Finance/FinancialBatchDetail/financialBatchAccountTotalsBag";
+import { FinancialBatchCurrencyTotalsBag } from "@Obsidian/ViewModels/Blocks/Finance/FinancialBatchDetail/financialBatchCurrencyTotalsBag";
+
+export type FinancialBatchDetailOptionsBag = {
+    /** Gets or sets the accounts. */
+    accounts?: FinancialBatchAccountTotalsBag[] | null;
+
+    /** The message to be shown on the frontend if the batch is automated. */
+    automatedToolTip?: string | null;
+
+    /** The Defined Type Guid for the Batch Name Defined Type Picker if the Defined Type is specified. */
+    batchNameDefinedTypeGuid?: string | null;
+
+    /** Gets or sets the currency types. */
+    currencyTypes?: FinancialBatchCurrencyTotalsBag[] | null;
+
+    /** The message to be displayed if the batch is not editable. */
+    editModeMessage?: string | null;
+
+    /**
+     * Motive: a user who does not have the ReopenBatch permission should not be able to open a batch
+     * once closed even if they themselves were the ones who closed it.
+     * The front end is required to check this flag and not show the edit block button if the flag is set to true and the batch is closed.
+     */
+    isReopenAuthorized: boolean;
+
+    /** The flag which the frontend should use to determine if the status can be edited */
+    isStatusChangeDisabled: boolean;
+
+    /** Gets or sets the transaction amount. */
+    transactionAmount: number;
+
+    /** Gets or sets the transaction item count. */
+    transactionItemCount: number;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchList/financialBatchListOptionsBag.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>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type FinancialBatchListOptionsBag = {
+    /**
+     * Determines if the organization is configured with multiple active
+     * campuses or not.
+     */
+    hasMultipleCampuses: boolean;
+
+    /** Determines if the accounting system code column should be displayed. */
+    showAccountingSystemCodeColumn: boolean;
+
+    /** Determines if the accounts column should be displayed. */
+    showAccountsColumn: boolean;
+
+    /** The sources that can be used to filter the results. */
+    sources?: ListItemBag[] | null;
+
+    /** The transaction types that can be used to filter the results. */
+    transactionTypes?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchList/setBulkBatchStatusRequestBag.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 parameter data for the SetBulkBatchStatus block action. */
+export type SetBulkBatchStatusRequestBag = {
+    /** The batch identifiers to be opened or closed. */
+    keys?: string[] | null;
+
+    /** If true then the batches will be opened, otherwise false. */
+    open: boolean;
+};

package/types/ViewModels/Blocks/Finance/FinancialBatchList/setBulkBatchStatusResponseBag.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 response data for the SetBulkBatchStatus block action. */
+export type SetBulkBatchStatusResponseBag = {
+    /**
+     * An optional list of errors that could be displayed to provide more
+     * context about what happened.
+     */
+    errors?: string[] | null;
+
+    /**
+     * true if the operation the status of the batches was updated
+     * or false if an error occurred.
+     */
+    isSuccess: boolean;
+
+    /** The message that should be displayed to the individual. */
+    message?: string | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialGatewayDetail/financialGatewayBag.d.ts

@@ -0,0 +1,63 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** Used to store options for the FinancialGateway */
+export type FinancialGatewayBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the batch schedule whether Weekly or Daily. */
+    batchSchedule?: string | null;
+
+    /** Gets or sets the batch start day if BtachSchedule is set to Weekly. */
+    batchStartDay?: string | null;
+
+    /**
+     * Gets the batch time offset (in ticks). By default online payments will be grouped into batches with a start time
+     * of 12:00:00 AM.  However if the payment gateway groups transactions into batches based on a different
+     * time, this offset can specified so that Rock will use the same time when creating batches for online
+     * transactions
+     */
+    batchTimeOffsetTicks?: string | null;
+
+    /** Gets or sets the user defined description of the FinancialGateway. */
+    description?: string | null;
+
+    /** Gets or sets the type of the gateway entity. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets the (internal) Name of the FinancialGateway. This property is required. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Finance/FinancialGatewayDetail/financialGatewayDetailOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Options for the FinancialGatewayDetail box */
+export type FinancialGatewayDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Finance/FinancialPledgeDetail/financialPledgeBag.d.ts

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type FinancialPledgeBag = {
+    /** Gets or sets the Rock.Model.FinancialAccount or account that the pledge is being directed toward. */
+    account?: ListItemBag | null;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the end date of the pledge period. */
+    endDate?: string | null;
+
+    /** Gets or sets the Rock.Model.Group. */
+    group?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the Rock.Model.PersonAlias. */
+    personAlias?: ListItemBag | null;
+
+    /**
+     * Gets or sets the pledge frequency Rock.Model.DefinedValue. This is how often the Rock.Model.Person who is 
+     * making the pledge promises to give the Rock.Model.FinancialPledge.TotalAmount
+     */
+    pledgeFrequencyValue?: ListItemBag | null;
+
+    /** Gets or sets the start date of the pledge period. */
+    startDate?: string | null;
+
+    /** Gets or sets the pledge amount that is promised to be given. */
+    totalAmount?: number | null;
+};