@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/ViewModels/Blocks/Group/GroupTypeDetail/groupTypeRoleBag.d.ts

@@ -0,0 +1,89 @@
+//------------------------------------------------------------------------------
+// <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 { ChatRole } from "@Obsidian/Enums/Communication/Chat/chatRole";
+import { Guid } from "@Obsidian/Types";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** Represents a group type role, including its edit-able settings and optional attributes. */
+export type GroupTypeRoleBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets a value indicating whether members in this role can edit the group. */
+    canEdit: boolean;
+
+    /** Gets or sets a value indicating whether members in this role can manage group members. */
+    canManageMembers: boolean;
+
+    /** Gets or sets a value indicating whether members in this role can take attendance. */
+    canTakeAttendance: boolean;
+
+    /** Gets or sets a value indicating whether members in this role can view the group. */
+    canView: boolean;
+
+    /** Gets or sets the chat role for members in this role. */
+    chatRole: ChatRole;
+
+    /** Gets or sets the description of the role. */
+    description?: string | null;
+
+    /** Gets or sets the unique identifier of the role. */
+    guid: Guid;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether members in this role are allowed for check-in. */
+    isCheckInAllowed: boolean;
+
+    /** Gets or sets a value indicating whether members in this role are excluded from the peer network. */
+    isExcludedFromPeerNetwork: boolean;
+
+    /** Gets or sets a value indicating whether this role is a leader role. */
+    isLeader: boolean;
+
+    /** Gets or sets a value indicating whether this role is public. */
+    isPublic: boolean;
+
+    /** Gets or sets a value indicating whether this role is a system role. */
+    isSystem: boolean;
+
+    /** Gets or sets the maximum number of members allowed for this role. */
+    maxCount?: number | null;
+
+    /** Gets or sets the minimum number of members required for this role. */
+    minCount?: number | null;
+
+    /** Gets or sets the name of the role. */
+    name?: string | null;
+
+    /** Gets or sets the order of the role. */
+    order: number;
+
+    /** Gets or sets a value indicating whether members in this role receive requirements notifications. */
+    receiveRequirementsNotifications: boolean;
+};

package/types/ViewModels/Blocks/Group/GroupTypeDetail/groupTypeRoleDefaultAttributesResponseBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Response bag for the default GroupTypeRole attributes and attribute values
+ * used when initializing a new role in the UI.
+ */
+export type GroupTypeRoleDefaultAttributesResponseBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+};

package/types/ViewModels/Blocks/Lms/LearningClassActivityCompletionDetail/learningClassActivityCompletionBag.d.ts

@@ -79,6 +79,12 @@ export type LearningClassActivityCompletionBag = {
     /** Indicates whether or not the activity is currently available. */
     isAvailable: boolean;
 
+    /**
+     * Indicates whether or not the related activity instance has been completed by the party (student or facilitator)
+     * who's actually responsible for completing it based on the activity's "assigned to" value.
+     */
+    isCompleted: boolean;
+
     /** Indicates whether or not the activity is due within a week. */
     isDueSoon: boolean;
 

package/types/ViewModels/Blocks/Lms/PublicLearningClassWorkspace/publicLearningClassWorkspaceBox.d.ts

@@ -74,6 +74,9 @@ export type PublicLearningClassWorkspaceBox = {
     /** Whether announcements are enabled. */
     enableAnnouncements: boolean;
 
+    /** Gets or sets whether to enable smart scroll. */
+    enableSmartScroll: boolean;
+
     /**
      * Gets or sets the error message. A non-empty value indicates that
      * an error is preventing the block from being displayed.

package/types/ViewModels/Blocks/Mobile/MobileDeepLinkDetail/mobileDeepLinkDetailBag.d.ts

@@ -0,0 +1,52 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { PageRouteValueBag } from "@Obsidian/ViewModels/Rest/Controls/pageRouteValueBag";
+
+/** Represents a mobile page with its unique identifier and name. */
+export type MobileDeepLinkDetailBag = {
+    /** Gets or sets the GUID of the mobile page. */
+    mobilePage?: PageRouteValueBag | null;
+
+    /** Gets or sets the path prefix for the site's deep links. */
+    pathPrefix?: string | null;
+
+    /** Gets or sets the route for the deep link. */
+    route?: string | null;
+
+    /** Gets or sets the GUID of the deep link route. */
+    routeGuid: Guid;
+
+    /** Gets or sets the identifier of the site. */
+    siteId: number;
+
+    /** Gets or sets a value indicating whether the URL is used as a fallback. */
+    usesUrlAsFallback: boolean;
+
+    /** Gets or sets the GUID of the web fallback page. */
+    webFallbackPage?: PageRouteValueBag | null;
+
+    /** Gets or sets the URL of the web fallback page. */
+    webFallbackPageUrl?: string | null;
+};

package/types/ViewModels/Blocks/Mobile/MobileDeepLinkDetail/mobileDeepLinkDetailInitializationBox.d.ts

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <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 { MobileDeepLinkDetailBag } from "@Obsidian/ViewModels/Blocks/Mobile/MobileDeepLinkDetail/mobileDeepLinkDetailBag";
+import { MobileDeepLinkDetailOptionsBag } from "@Obsidian/ViewModels/Blocks/Mobile/MobileDeepLinkDetail/mobileDeepLinkDetailOptionsBag";
+
+/** Represents the initialization data for the Mobile Deep Link Detail block. */
+export type MobileDeepLinkDetailInitializationBox = {
+    /** Gets or sets the entity. */
+    bag?: MobileDeepLinkDetailBag | 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;
+
+    /** Gets or sets a value indicating whether this instance is editable. */
+    isEditable: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the options. */
+    options?: MobileDeepLinkDetailOptionsBag | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Mobile/MobileDeepLinkDetail/mobileDeepLinkDetailOptionsBag.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";
+
+/** Additional Configuration for the Auth Scope List block. */
+export type MobileDeepLinkDetailOptionsBag = {
+    /**
+     * Gets or sets the unique identifier of the root page whose
+     * children are to be enumerated.
+     */
+    rootPageGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/Prayer/PrayerRequestList/prayerRequestListOptionsBag.d.ts

@@ -22,4 +22,16 @@
 //
 
 export type PrayerRequestListOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether the Campus column should be
+     * visible. This is typically only true when the organization has more
+     * than one active campus.
+     */
+    isCampusColumnVisible: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the current person is authorized
+     * to approve prayer requests (via the block's "Approve" security action).
+     */
+    showIsApprovedColumn: boolean;
 };

package/types/ViewModels/Blocks/Reporting/DynamicData/gridResultsBag.d.ts

@@ -77,14 +77,6 @@ export type GridResultsBag = {
     /** Gets or sets whether the query returns a list of people. */
     isPersonReport: boolean;
 
-    /**
-     * Gets or sets the field that will be used to uniquely identify each row.
-     * 
-     * This may be a simple field name (i.e. "id") or a dot-separated path to the
-     * key value within a particular field's object (i.e. "person.idKey").
-     */
-    keyField?: string | null;
-
     /**
      * Gets or sets the field that will contain the person key.
      * 

package/types/ViewModels/Blocks/Reporting/ReportSearch/reportSearchOptionsBag.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>
+//
+
+/** Provides additional options for the report search block. */
+export type ReportSearchOptionsBag = {
+};

package/types/ViewModels/Blocks/Reporting/ReportSearch/reportSearchResultBag.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>
+//
+
+/** Contains a report search result row. */
+export type ReportSearchResultBag = {
+    /** Gets or sets the identifier of the report. */
+    id: number;
+
+    /** Gets or sets the report name. */
+    name?: string | null;
+
+    /** Gets or sets the display category structure that appears before the report link. */
+    structure?: string | null;
+
+    /** Gets or sets the target URL for the report. */
+    url?: string | null;
+};

package/types/ViewModels/Blocks/Security/AuthClaims/authClaimBag.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>
+//
+
+/** The item details for the AuthClaims block. */
+export type AuthClaimBag = {
+    /** Gets or sets the identifier key. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this item is active or not. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this is a system claim. */
+    isSystem: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the public name. */
+    publicName?: string | null;
+
+    /** Gets or sets the claim value (Lava template). */
+    value?: string | null;
+};

package/types/ViewModels/Blocks/Security/AuthClaims/authClaimRequestBag.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 request bag for saving an auth claim in the AuthClaims block. */
+export type AuthClaimRequestBag = {
+    /** Gets or sets the identifier key of the claim to update, or empty/null for a new claim. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this item is active or not. */
+    isActive: boolean;
+
+    /** Gets or sets the claim name. */
+    name?: string | null;
+
+    /** Gets or sets the public name. */
+    publicName?: string | null;
+
+    /** Gets or sets the claim value (Lava template). */
+    value?: string | null;
+};

package/types/ViewModels/Blocks/Security/AuthClaims/authClaimsOptionsBag.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>
+//
+
+/** Additional Configuration for the AuthClaims block. */
+export type AuthClaimsOptionsBag = {
+    /** Gets or sets an error message to display instead of the grid. */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether the block should be visible. */
+    isBlockVisible: boolean;
+};

package/types/ViewModels/Blocks/Security/BackgroundCheck/CheckrRequestList/checkrRequestListOptionsBag.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>
+//
+
+/** The additional configuration options for the Checkr Request List block. */
+export type CheckrRequestListOptionsBag = {
+};

package/types/ViewModels/Blocks/Security/BackgroundCheck/CheckrSettings/checkrSettingsOptionsBag.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>
+//
+
+/** The initialization options for the Checkr Settings block. */
+export type CheckrSettingsOptionsBag = {
+    /** Gets or sets the decrypted access token for display. */
+    accessToken?: string | null;
+
+    /** Gets or sets a value indicating whether an access token has been configured. */
+    isConfigured: boolean;
+
+    /** Gets or sets a value indicating whether Checkr is the current default background check provider. */
+    isDefaultProvider: boolean;
+
+    /** Gets or sets the organization name used to construct the Checkr signup URL. */
+    organizationName?: string | null;
+
+    /** Gets or sets the list of active Checkr package names (with the type prefix stripped). */
+    packages?: string[] | null;
+
+    /**
+     * Gets or sets an optional warning message to display after a successful action
+     * that encountered non-fatal errors (e.g., package sync failure).
+     */
+    warningMessage?: string | null;
+};

package/types/ViewModels/Blocks/Security/BackgroundCheck/CheckrSettings/checkrSettingsSaveTokenRequestBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The request bag for saving a new Checkr access token. */
+export type CheckrSettingsSaveTokenRequestBag = {
+    /** Gets or sets the new access token to save. */
+    accessToken?: string | null;
+};

package/types/ViewModels/Blocks/Security/BackgroundCheck/RequestList/requestListOptionsBag.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>
+//
+
+/** The additional configuration options for the Request List block. */
+export type RequestListOptionsBag = {
+};