@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

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

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 { GroupMemberRequirementCardConfigBag } from "@Obsidian/ViewModels/Rest/Controls/groupMemberRequirementCardConfigBag";
+
+/**
+ * The GroupRequirement category information used by the GetData API action of
+ * the GroupMemberRequirementContainer control.
+ */
+export type GroupMemberRequirementCategoryBag = {
+    /** Identifier for the category */
+    id?: number | null;
+
+    /** List of requirement information in this category */
+    memberRequirements?: GroupMemberRequirementCardConfigBag[] | null;
+
+    /** Name of the category */
+    name?: string | null;
+};

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

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 GetData API action of
+ * the GroupMemberRequirementContainer control.
+ */
+export type GroupMemberRequirementContainerGetDataOptionsBag = {
+    /** Identifier for the Group */
+    groupGuid: Guid;
+
+    /** Identifier for the GroupRole the group member plays */
+    groupRoleGuid: Guid;
+
+    /** Identifier for the Person who is the member */
+    personGuid: Guid;
+};

package/types/ViewModels/Rest/Controls/groupMemberRequirementContainerGetDataResultsBag.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 { GroupMemberRequirementCategoryBag } from "@Obsidian/ViewModels/Rest/Controls/groupMemberRequirementCategoryBag";
+import { GroupMemberRequirementErrorBag } from "@Obsidian/ViewModels/Rest/Controls/groupMemberRequirementErrorBag";
+
+/**
+ * The results of calling the GetData API action of
+ * the GroupMemberRequirementContainer control.
+ */
+export type GroupMemberRequirementContainerGetDataResultsBag = {
+    /** List of the GroupMemberRequirements, grouped by their category. */
+    categorizedRequirements?: GroupMemberRequirementCategoryBag[] | null;
+
+    /** List of potential errors while retrieving requirements */
+    errors?: GroupMemberRequirementErrorBag[] | null;
+};

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

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 details about any error(s) that should be shown in
+ * the GroupMemberRequirementContainer control.
+ */
+export type GroupMemberRequirementErrorBag = {
+    /** Deeper details about the error. */
+    details?: string | null;
+
+    /** Primary text describing the error */
+    text?: string | null;
+};

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

@@ -0,0 +1,47 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { AttributeMatrixEditorPublicItemBag } from "@Obsidian/ViewModels/Rest/Controls/attributeMatrixEditorPublicItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The data used by the Obsidian Matrix Field Type to be able to edit an AttributeMatrix */
+export type MatrixFieldDataBag = {
+    /** Unique identifier of the currently saved AttributeMatrix */
+    attributeMatrixGuid?: Guid | null;
+
+    /** Public configuration data for the attributes of the matrix items */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Default values for each of the different values */
+    defaultAttributeValues?: Record<string, string> | null;
+
+    /** List of representations of AttributeMatrixItems in this AttributeMatrix */
+    matrixItems?: AttributeMatrixEditorPublicItemBag[] | null;
+
+    /** Maximum number of matrix items allowed to be valid */
+    maxRows?: number | null;
+
+    /** Minimum number of matrix items needed to be valid */
+    minRows?: number | null;
+};

package/types/ViewModels/Rest/Controls/mediaPlayerGetPlayerOptionsOptionsBag.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 { Guid } from "@Obsidian/Types";
+import { MediaPlayerOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/mediaPlayerOptionsBag";
+
+/** The options that can be passed to the GetPlayerOptions API action of the MediaPlayer control. */
+export type MediaPlayerGetPlayerOptionsOptionsBag = {
+    /**
+     * The number of days back to look for an existing interaction
+     * for the media element. Will be used to find where the user left off
+     * previously and resume from that point.
+     */
+    autoResumeInDays: number;
+
+    /**
+     * The number of days back to look for an existing
+     * interaction for the media element that should be updated. If one
+     * is not found then a new interaction will be created. Set to
+     * 0 to always create a new interaction.
+     */
+    combinePlayStatisticsInDays: number;
+
+    /** Identifier for the Media Element to play */
+    mediaElementGuid: Guid;
+
+    /** The initial set of options to pass to the media player */
+    playerOptions?: MediaPlayerOptionsBag | null;
+};

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

@@ -0,0 +1,156 @@
+//------------------------------------------------------------------------------
+// <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.
+ * 
+ * NOTE: This is copied from Rock/Media/MediaPlayerOptions.cs.
+ * If making any changes to this, be sure to update that as well.
+ */
+export type MediaPlayerOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether to automatically pause
+     * other media players on the page when this player begins playing.
+     */
+    autopause: boolean;
+
+    /**
+     * Gets or sets a value indicating whether to attempt to automatically
+     * play as soon as it can. This will likely only work if you also
+     * specify the Rock.ViewModels.Rest.Controls.MediaPlayerOptionsBag.Muted parameter as most browsers do not
+     * allow auto play with sound.
+     */
+    autoplay: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the user will be allowed to
+     * click anywhere on the media player to play or pause the playback.
+     */
+    clickToPlay: boolean;
+
+    /**
+     * Gets or sets the user interface controls to display on the player.
+     * This should be a comma delimited list of values taken from MediaPlayerControls.
+     */
+    controls?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether debug information should
+     * be written to the JavaScript console.
+     */
+    debug: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the user interface controls
+     * should be automatically hidden after a brief period of inactivity.
+     */
+    hideControls: boolean;
+
+    /**
+     * Gets or sets the interaction unique identifier to be updated. If
+     * not set then a new Interaction is created.
+     */
+    interactionGuid?: Guid | null;
+
+    /**
+     * Gets or sets the previous watch map data. This is used when
+     * calculating the resume position or updating an existing Interaction.
+     */
+    map?: string | null;
+
+    /**
+     * Gets or sets the media element unique identifier. This is used when
+     * writing an Interaction to associate it to the media element.
+     */
+    mediaElementGuid?: Guid | null;
+
+    /** Gets or sets the URL to use for playback. */
+    mediaUrl?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether the media player will be
+     * initially muted on page load.
+     */
+    muted: boolean;
+
+    /**
+     * Gets or sets the poster image URL to display before the video
+     * starts playing. This only works with HTML5 style videos, it will
+     * not work with embed links such as YouTube uses.
+     */
+    posterUrl?: string | null;
+
+    /**
+     * Gets or sets the related entity identifier to store with the
+     * interaction if the session is being tracked.
+     */
+    relatedEntityId?: number | null;
+
+    /**
+     * Gets or sets the related entity type identifier to store with
+     * the interaction if the session is being tracked.
+     */
+    relatedEntityTypeId?: number | null;
+
+    /**
+     * Gets or sets a value indicating whether to resume playback from
+     * the first gap in playback history.
+     */
+    resumePlaying?: boolean | null;
+
+    /**
+     * Gets or sets the number of seconds to seek forward or backward
+     * when the fast-forward or rewind controls are clicked.
+     */
+    seekTime: number;
+
+    /** Gets or sets the unique identifier for the current interaction session. */
+    sessionGuid?: Guid | null;
+
+    /** Gets or sets the title to display for the video. */
+    title?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether progress tracking should be
+     * enabled. This is different than Rock.ViewModels.Rest.Controls.MediaPlayerOptionsBag.WriteInteraction. This
+     * value determines if the internal logic for monitoring playback
+     * progress should be used or not. It is required for Rock.ViewModels.Rest.Controls.MediaPlayerOptionsBag.WriteInteraction
+     * to function.
+     */
+    trackProgress: boolean;
+
+    /** Gets or sets the type of media player to display. */
+    type?: string | null;
+
+    /** Gets or sets the initial volume for playback. */
+    volume: number;
+
+    /**
+     * Determines if the user's session should be tracked and stored as an
+     * Interaction in the system. This is required
+     * to provide play metrics as well as use the resume feature later.
+     */
+    writeInteraction: boolean;
+};

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

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 GetSearchedMergeFields API action of the MergePicker control. */
+export type MergeFieldPickerGetSearchedMergedFieldsOptionsBag = {
+    /** Gets or sets the additional fields. */
+    additionalFields?: string | null;
+
+    /** The query we're using to find merge fields */
+    searchTerm?: string | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/pageNavButtonsGetLinksOptionsBag.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 GetLinks API action of
+ * the PageNavButtons control.
+ */
+export type PageNavButtonsGetLinksOptionsBag = {
+    /** Guid of the current page, which is used to mark the current page's link active */
+    currentPageGuid: Guid;
+
+    /** List of page parameters to add each URL */
+    parameters?: Record<string, string> | null;
+
+    /** List of query string parameters to add each URL */
+    queryString?: Record<string, string> | null;
+
+    /** GUID of the parent page of all the links to show */
+    rootPageGuid: Guid;
+};

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

@@ -0,0 +1,79 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Gender } from "@Obsidian/Enums/Crm/gender";
+import { DatePartsPickerValueBag } from "@Obsidian/ViewModels/Controls/datePartsPickerValueBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The set of data that represents a Person for the Person Basic Editor control to use. */
+export type PersonBasicEditorBag = {
+    /** Person's email address */
+    email?: string | null;
+
+    /** Person's first name */
+    firstName?: string | null;
+
+    /** Whether SMS messaging is permitted to the person's mobile phone */
+    isMessagingEnabled?: boolean | null;
+
+    /** Person's last name */
+    lastName?: string | null;
+
+    /** Person's mobile phone's country code */
+    mobilePhoneCountryCode?: string | null;
+
+    /** Person's mobile phone number */
+    mobilePhoneNumber?: string | null;
+
+    /** Person's date of birth */
+    personBirthDate?: DatePartsPickerValueBag | null;
+
+    /** Person's connectedness to the organization/church */
+    personConnectionStatus?: ListItemBag | null;
+
+    /** Person's ethnicity */
+    personEthnicity?: ListItemBag | null;
+
+    /** Person's gender */
+    personGender?: Gender | null;
+
+    /** Person's grade offset */
+    personGradeOffset?: ListItemBag | null;
+
+    /** Person's family group role */
+    personGroupRole?: ListItemBag | null;
+
+    /** Person's relationship status */
+    personMaritalStatus?: ListItemBag | null;
+
+    /** Person's race */
+    personRace?: ListItemBag | null;
+
+    /** Person's suffix */
+    personSuffix?: ListItemBag | null;
+
+    /** Person's title */
+    personTitle?: ListItemBag | null;
+
+    validProperties?: string[] | null;
+};

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

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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 AddReminder API action of
+ * the ReminderButton control
+ */
+export type ReminderButtonAddReminderOptionsBag = {
+    /** The identifier of the person this reminder is assigned to */
+    assignedToGuid: Guid;
+
+    /** The Identifier for the entity that the reminder pertains to */
+    entityGuid: Guid;
+
+    /** The identifier for the entity type of the entity that the reminder pertains to */
+    entityTypeGuid: Guid;
+
+    /** The note of what the reminder is about */
+    note?: string | null;
+
+    /** Date of the reminder */
+    reminderDate?: string | null;
+
+    /** The identifier for the type of reminder */
+    reminderTypeGuid: Guid;
+
+    /** How many times to renew/repeat this reminder */
+    renewMaxCount?: number | null;
+
+    /** How often to renew/repeat this reminder in number of days */
+    renewPeriodDays?: number | null;
+};

package/types/ViewModels/Rest/Controls/reminderButtonGetRemindersOptionsBag.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 GetReminders API action of
+ * the ReminderButton control.
+ */
+export type ReminderButtonGetRemindersOptionsBag = {
+    /** Gets or set the Guid for Reminder edit page */
+    editReminderPage: Guid;
+
+    /** Gets or sets the Entity Guid */
+    entityGuid: Guid;
+
+    /** Gets or sets the Entity Type Guid */
+    entityTypeGuid: Guid;
+
+    /** Gets or sets the Guid for the View Reminders page */
+    viewRemindersPage: Guid;
+};