@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/ViewModels/Blocks/Engagement/ConnectionOpportunityDetail/defaultConnectorOptionsRequestBag.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 a list of group guids to fetch associated group members,
+ * used as the options for selecting a default connector.
+ */
+export type DefaultConnectorOptionsRequestBag = {
+    /** Gets or sets the group guid. */
+    groupGuids?: string[] | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionOpportunityDetail/inheritedAttributeBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+export type InheritedAttributeBag = {
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the unique identifier. */
+    guid: Guid;
+
+    /** Gets or sets the key. */
+    key?: string | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionOpportunityDetail/inheritedConnectionWorkflowBag.d.ts

@@ -0,0 +1,41 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ConnectionWorkflowTriggerType } from "@Obsidian/Enums/Connection/connectionWorkflowTriggerType";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Minimal bag describing an inherited Connection Workflow for a Connection Opportunity,
+ * which would be set on the associated Connection Type.
+ */
+export type InheritedConnectionWorkflowBag = {
+    /** Gets or sets the unique identifier. */
+    guid: Guid;
+
+    /** Gets or sets the trigger type. */
+    triggerType: ConnectionWorkflowTriggerType;
+
+    /** Gets or sets the workflow type as a ListItemBag. */
+    workflowType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionOpportunityDetail/placementGroupBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Minimal bag describing a placement group for a Connection Opportunity. */
+export type PlacementGroupBag = {
+    /** Gets or sets the campus. */
+    campus?: ListItemBag | null;
+
+    /** Gets or sets the placement group as a ListItemBag. */
+    group?: ListItemBag | null;
+
+    /** Gets or sets the GroupType for the placement group. */
+    groupType?: ListItemBag | null;
+
+    /** Gets or sets the unique identifier. */
+    guid: Guid;
+
+    /** Gets or sets a value indicating whether this instance is archived. */
+    isArchived: boolean;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionOpportunityDetail/placementGroupConfigBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** Minimal bag describing a placement group configuration for a Connection Opportunity. */
+export type PlacementGroupConfigBag = {
+    /** Gets or sets the Group Member Role as a ListItemBag. */
+    groupMemberRole?: ListItemBag | null;
+
+    /** Gets or sets the group member status (enum value). */
+    groupMemberStatus: number;
+
+    /** Gets or sets the GroupType as a ListItemBag. */
+    groupType?: ListItemBag | null;
+
+    /** Gets or sets the unique identifier. */
+    guid: Guid;
+
+    /** Gets or sets a value indicating whether all groups of the type are used. */
+    useAllGroupsOfType: boolean;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionOpportunityList/connectionOpportunityListOptionsBag.d.ts

@@ -23,4 +23,6 @@
 
 /** The additional configuration options for the Connection Opportunity List block. */
 export type ConnectionOpportunityListOptionsBag = {
+    /** Gets or sets a value indicating whether the reorder column should be visible. */
+    isReOrderColumnVisible: boolean;
 };

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/canDeleteRequestBag.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";
+
+/** Request bag used to send an identifier for a specific entity to verify if it can be deleted. */
+export type CanDeleteRequestBag = {
+    /** Gets or sets the entity unique identifier. */
+    entityGuid: Guid;
+
+    /** Gets or sets the entity key identifying the type of entity to check. */
+    entityKey?: string | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/canDeleteResponseBag.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>
+//
+
+/**
+ * Response bag used to indicate whether a specific entity can be deleted,
+ * along with an optional explanation when deletion is not allowed.
+ */
+export type CanDeleteResponseBag = {
+    /** Gets or sets a value indicating whether the entity can be deleted. */
+    canDelete: boolean;
+
+    /**
+     * Gets or sets the error message explaining why the entity cannot be deleted.
+     * This value should be null or empty when Rock.ViewModels.Blocks.Engagement.ConnectionTypeDetail.CanDeleteResponseBag.CanDelete is true.
+     */
+    errorMessage?: string | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionActivityTypeBag.d.ts

@@ -0,0 +1,57 @@
+//------------------------------------------------------------------------------
+// <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 { PersonNoteCreationBehavior } from "@Obsidian/Enums/Connection/personNoteCreationBehavior";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** Minimal bag representation of a Connection Activity Type */
+export type ConnectionActivityTypeBag = {
+    /** 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 Guid. */
+    guid: Guid;
+
+    /** 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 name. */
+    name?: string | null;
+
+    /** Gets or sets the person note creation behavior. */
+    personNoteCreationBehavior?: PersonNoteCreationBehavior | null;
+
+    /**
+     * The note type that will be used when adding activity notes to
+     * requests of this type.
+     */
+    personNoteType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionStatusAutomationBag.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 { GroupRequirementsFilter } from "@Obsidian/Enums/Connection/groupRequirementsFilter";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Minimal bag representation of a Connection Status Automation. */
+export type ConnectionStatusAutomationBag = {
+    /** Gets or sets the name of the automation. */
+    automationName?: string | null;
+
+    /** Gets or sets the data view as a Rock.ViewModels.Utility.ListItemBag. */
+    dataView?: ListItemBag | null;
+
+    /** Gets or sets the destination status Guid. */
+    destinationStatusGuid?: Guid | null;
+
+    /** Gets or sets the group requirements filter. */
+    groupRequirementsFilter: GroupRequirementsFilter;
+
+    /** Gets or sets the Guid. */
+    guid: Guid;
+
+    /** Gets or sets the order. */
+    order: number;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionStatusBag.d.ts

@@ -0,0 +1,67 @@
+//------------------------------------------------------------------------------
+// <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 { ConnectionStatusAutomationBag } from "@Obsidian/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionStatusAutomationBag";
+
+/** Minimal bag representation of a Connection Status. */
+export type ConnectionStatusBag = {
+    /** Gets or sets a value that when set, automatically moves the request to Future Follow-Up for the specified number of days. */
+    autoFutureFollowUpPauseInDays?: number | null;
+
+    /** Gets or sets a value indicating whether choosing this Status will set the Request's State to Inactive. */
+    autoInactivateState: boolean;
+
+    /** Gets or sets the automations. */
+    automations?: ConnectionStatusAutomationBag[] | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the Guid. */
+    guid: Guid;
+
+    /** Gets or sets the highlight color. */
+    highlightColor?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance is default. */
+    isDefault: boolean;
+
+    /** Gets or sets a value indicating whether completing a request requires entering a note. */
+    isNoteRequiredOnCompletion: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the order. */
+    order: number;
+
+    /** Gets or sets a value indicating the number of days added to the calculated due date for a request status. */
+    requestStatusDueDateOffsetInDays?: number | null;
+
+    /** Gets or sets a value indicating the number of days before the due date when a request status is considered "due soon." */
+    requestStatusDueSoonOffsetInDays?: number | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionTypeAdditionalRequestToShowBag.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 { ConnectionState } from "@Obsidian/Enums/Connection/connectionState";
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** A single additional request filter row. */
+export type ConnectionTypeAdditionalRequestToShowBag = {
+    /** Gets or sets the source connection type for additional requests. */
+    connectionType?: ListItemBag | null;
+
+    /** Gets or sets a value indicating whether family member requests are included. */
+    includeFamilyMemberRequests: boolean;
+
+    /** Gets or sets the unique identifier for this filter row. */
+    key: Guid;
+
+    /** Gets or sets the number of days to limit recent requests. */
+    limitToRecentRequestsDays?: number | null;
+
+    /** Gets or sets the states to include. */
+    statesToShow?: ConnectionState[] | null;
+};

package/types/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionTypeAdditionalSettingsBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <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 { AISummaryTriggerMode } from "@Obsidian/Enums/Connection/aiSummaryTriggerMode";
+import { ConnectionTypeAdditionalRequestToShowBag } from "@Obsidian/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionTypeAdditionalRequestToShowBag";
+import { ConnectionTypeCommunicationSettingsBag } from "@Obsidian/ViewModels/Blocks/Engagement/ConnectionTypeDetail/connectionTypeCommunicationSettingsBag";
+
+/** Additional settings for a connection type. */
+export type ConnectionTypeAdditionalSettingsBag = {
+    /** Gets or sets the additional requests to show configuration rows. */
+    additionalRequestsToShow?: ConnectionTypeAdditionalRequestToShowBag[] | null;
+
+    /** Gets or sets the AI insights prompt. */
+    aiInsightsPrompt?: string | null;
+
+    /** Gets or sets the AI summary cache duration in minutes. */
+    aiSummaryCacheDurationMinutes?: number | null;
+
+    /** Gets or sets the AI summary trigger mode. */
+    aiSummaryTrigger?: AISummaryTriggerMode | null;
+
+    /** Gets or sets the communication settings. */
+    communicationSettings?: ConnectionTypeCommunicationSettingsBag | null;
+
+    /** Gets or sets the default value for Connection Opportunity Request Due Date Offset In Days. */
+    defaultOpportunityDueDateOffsetInDays?: number | null;
+
+    /** Gets or sets the default value for Connection Opportunity Request Due Soon Offset In Days. */
+    defaultOpportunityDueSoonOffsetInDays?: number | null;
+
+    /** Gets or sets the default value for Request Status Due Date Offset In Days. */
+    defaultStatusDueDateOffsetInDays?: number | null;
+
+    /** Gets or sets the default value for Request Status Due Soon Offset In Days. */
+    defaultStatusDueSoonOffsetInDays?: number | null;
+};