@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Event/InteractiveExperiences/visualizerRenderConfigurationBag.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";
+
+/** The configuration required to display a visualizer. */
+export type VisualizerRenderConfigurationBag = {
+    /** Gets or sets the action identifier. */
+    actionId: number;
+
+    /** Gets or sets the configuration values for the visualizer type. */
+    configurationValues?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the title of the action this visualizer is
+     * associated with.
+     */
+    title?: string | null;
+
+    /** Gets or sets the visualizer type unique identifier. */
+    visualizerTypeGuid?: Guid | null;
+};

package/types/ViewModels/Event/attendanceOccurrenceUpdatedMessageBag.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Details about an attendance occurrence record that is transmitted over
+ * the RealTime engine.
+ */
+export type AttendanceOccurrenceUpdatedMessageBag = {
+    /** Gets or sets the unique identifier of the attendance occurrence type. */
+    attendanceOccurrenceTypeGuid?: Guid | null;
+
+    /** Gets or sets the unique identifier of the attendance occurrence type. */
+    didNotOccur?: boolean | null;
+
+    /** Gets or sets the unique identifier of the group the person attended. */
+    groupGuid?: Guid | null;
+
+    /** Gets or sets the unique identifier of the location that was attended. */
+    locationGuid?: Guid | null;
+
+    /** Gets or sets th attendance occurrence unique identifier. */
+    occurrenceGuid?: Guid | null;
+};

package/types/ViewModels/Event/attendanceUpdatedMessageBag.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 { AttendanceStatus } from "@Obsidian/Enums/Event/attendanceStatus";
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * Details about an attendance record that is transmitted over
+ * the RealTime engine.
+ */
+export type AttendanceUpdatedMessageBag = {
+    /** Gets or sets the attendance unique identifier. */
+    attendanceGuid?: Guid | null;
+
+    /** Gets or sets the unique identifier of the group the person attended. */
+    groupGuid?: Guid | null;
+
+    /**
+     * Gets or sets the group type unique identifier of the group the
+     * person attended.
+     */
+    groupTypeGuid?: Guid | null;
+
+    /** Gets or sets the unique identifier of the location that was attended. */
+    locationGuid?: Guid | null;
+
+    /** Gets or sets the occurrence unique identifier. */
+    occurrenceGuid?: Guid | null;
+
+    /** Gets or sets the full name of the person this attendance record is for. */
+    personFullName?: string | null;
+
+    /** Gets or sets the unique identifier of the person that attended. */
+    personGuid?: Guid | null;
+
+    /** Gets or sets the photo URL of the person this attendance record is for. */
+    personPhotoUrl?: string | null;
+
+    /** Gets or sets the RSVP state of this attendance record. */
+    rSVP: number;
+
+    /**
+     * Gets or sets the attendance status which indicates if the persent
+     * attended or not.
+     */
+    status: AttendanceStatus;
+};

package/types/ViewModels/Finance/savedFinancialAccountListItemBag.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>
+//
+
+/**
+ * A list item that describes an payment account the individual has
+ * previously setup that can be used again.
+ */
+export type SavedFinancialAccountListItemBag = {
+    /** Gets or sets the category for this item. */
+    category?: string | null;
+
+    /**
+     * Gets or sets the description of the card to help identify it to the
+     * individual.
+     */
+    description?: string | null;
+
+    /** Gets or sets disabled for this item. */
+    disabled?: boolean | null;
+
+    /** Gets or sets the image to be displayed to help identify the card. */
+    image?: string | null;
+
+    /** Gets or sets the text. */
+    text?: string | null;
+
+    /** Gets or sets the value. */
+    value?: string | null;
+};

package/types/ViewModels/Prayer/PrayerRequestEntry/prayerRequestEntryInitializationBox.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>
+//
+
+export type PrayerRequestEntryInitializationBox = {
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    isLastNameRequired: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Prayer/PrayerRequestEntry/prayerRequestEntrySaveRequestBag.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <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 PrayerRequestEntrySaveRequestBag = {
+    allowComments?: boolean | null;
+
+    campusGuid?: Guid | null;
+
+    categoryGuid?: Guid | null;
+
+    email?: string | null;
+
+    firstName?: string | null;
+
+    isPublic?: boolean | null;
+
+    isUrgent?: boolean | null;
+
+    lastName?: string | null;
+
+    phoneNumber?: string | null;
+
+    phoneNumberCountryCode?: string | null;
+
+    request?: string | null;
+};

package/types/ViewModels/Prayer/PrayerRequestEntry/prayerRequestEntrySaveResponseBag.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>
+//
+
+export type PrayerRequestEntrySaveResponseBag = {
+    errors?: string[] | null;
+
+    successMessage?: string | null;
+
+    successRedirectUrl?: string | null;
+};

package/types/ViewModels/Reporting/fieldFilterGroupBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { FieldFilterRuleBag } from "@Obsidian/ViewModels/Reporting/fieldFilterRuleBag";
+
+/** A group of filter rules/expressions that make up a logical comparison group. */
+export type FieldFilterGroupBag = {
+    /** The logic operator to use when joining all rules and child-groups in this group. */
+    expressionType: number;
+
+    /** The collection of child groups that make up any nested expressions in this group. */
+    groups?: FieldFilterGroupBag[] | null;
+
+    /** The unique identifier of this filter group. */
+    guid?: Guid | null;
+
+    /** The collection of rules/expression that make up this group. */
+    rules?: FieldFilterRuleBag[] | null;
+};

package/types/ViewModels/Reporting/fieldFilterRuleBag.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";
+
+/**
+ * A single rule for a field filter. this defines the source to obtain the
+ * left-hand value from, the right hand value, and the operator to use when
+ * comparing them.
+ */
+export type FieldFilterRuleBag = {
+    /**
+     * The attribute unique identifier to use as the left-hand side value
+     * if Rock.ViewModels.Reporting.FieldFilterRuleBag.SourceType specifies an Attribute.
+     */
+    attributeGuid?: Guid | null;
+
+    /**
+     * The type of comparison to use when comparing the source value (left-hand
+     * side) and Rock.ViewModels.Reporting.FieldFilterRuleBag.Value (right-hand side).
+     */
+    comparisonType: number;
+
+    /** The unique identifier of this rule. */
+    guid?: Guid | null;
+
+    /** The source location for where to get the left-hand side value. */
+    sourceType: number;
+
+    /** The right-hand side of the comparison to use when executing the rule. */
+    value?: string | null;
+};

package/types/ViewModels/Reporting/fieldFilterSourceBag.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>
+//
+
+import { FieldFilterSourceType } from "@Obsidian/Enums/Reporting/fieldFilterSourceType";
+import { Guid } from "@Obsidian/Types";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Describes a single source item an individual can pick from when building
+ * a custom filter. This contains the information required to determine the
+ * name to display, how to identify the source value and any other information
+ * required to build the filter UI.
+ */
+export type FieldFilterSourceBag = {
+    /** Gets or sets the attribute if the source type is Attribute. */
+    attribute?: PublicAttributeBag | null;
+
+    /** Gets or sets the unique identifier of this source item. */
+    guid?: Guid | null;
+
+    /**
+     * Gets or sets the type of this source item. This indicates which
+     * other properties are valid for inspection.
+     */
+    type: FieldFilterSourceType;
+};

package/types/ViewModels/Rest/Controls/accountPickerGetChildrenOptionsBag.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";
+
+/** The options that can be passed to the GetChildren API action of the AccountPicker control. */
+export type AccountPickerGetChildrenOptionsBag = {
+    /** Whether or not to display the public name (vs the normal name) */
+    displayPublicName: boolean;
+
+    /** Whether or not to include inactive accounts */
+    includeInactive: boolean;
+
+    /** Whether or not to load the full tree instead of just this level */
+    loadFullTree: boolean;
+
+    /** Get the child accounts for the account of this GUID. Empty Guid gets the root level accounts */
+    parentGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/accountPickerGetParentGuidsOptionsBag.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";
+
+/** The options that can be passed to the GetParentGuids API action of the AccountPicker control. */
+export type AccountPickerGetParentGuidsOptionsBag = {
+    /** List of Guids of accounts that we want to get the parent Guids of */
+    guids?: Guid[] | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/accountPickerGetPreviewItemsOptionsBag.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";
+
+/** The options that can be passed to the GetPreviewItems API action of the AccountPicker control. */
+export type AccountPickerGetPreviewItemsOptionsBag = {
+    /** Whether or not to display the public name (vs the normal name) */
+    displayPublicName: boolean;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /** The Guids of the accounts we need data on */
+    selectedGuids?: Guid[] | null;
+};

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

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The options that can be passed to the GetSearchedAccounts API action of the AccountPicker control. */
+export type AccountPickerGetSearchedAccountsOptionsBag = {
+    /** Whether or not to display the public name (vs the normal name) */
+    displayPublicName: boolean;
+
+    /** Whether or not to include inactive accounts */
+    includeInactive: boolean;
+
+    /** The query we're using to find accounts */
+    searchTerm?: string | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/**
+ * The options that can be passed to the GetAchievementTypes API action of
+ * the AchievementTypePicker control.
+ */
+export type AchievementTypePickerGetAchievementTypesOptionsBag = {
+};