@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Core/notificationMessageMetadataBag.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>
+//
+
+/** The standard metadata that will be used to display the notification. */
+export type NotificationMessageMetadataBag = {
+    /**
+     * Gets or sets the base color. This is used to calculate the background
+     * and foreground colors used when displaying certain parts of the
+     * notification message.
+     */
+    color?: string | null;
+
+    /**
+     * Gets or sets the icon CSS class. This is used in some places to
+     * give a visual representation to the type of message.
+     */
+    iconCssClass?: string | null;
+
+    /**
+     * Gets or sets the photo URL. This is used to represent the source of
+     * the notification. For example, a notification that originates from
+     * an action a person took might use the person's photo.
+     * 
+     * 
+     * The image should either be a full absolute URL including the scheme
+     * and hostname or should be a path only URL that begins with <c>~</c>.
+     * If it is a path that begins with <c>~</c> then the URL will be
+     * automatically resolved to the proper scheme and hostname.
+     * 
+     * 
+     * The image must be square and should be around 128x128 pixels in size.
+     */
+    photoUrl?: string | null;
+};

package/types/ViewModels/Core/personPreferenceValueBag.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>
+//
+
+/** Describes a single person preference key and value. */
+export type PersonPreferenceValueBag = {
+    /** Gets or sets the key of the preference value. */
+    key?: string | null;
+
+    /** Gets or sets the last accessed date time. */
+    lastAccessedDateTime?: string | null;
+
+    /** Gets or sets the preference value. */
+    value?: string | null;
+};

package/types/ViewModels/Crm/currentPersonBag.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>
+//
+
+/** Represents the currently logged in person. */
+export type CurrentPersonBag = {
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets the first name. */
+    firstName?: string | null;
+
+    /** Gets or sets the full name. */
+    fullName?: string | null;
+
+    /** Gets or sets the identifier key of the person. */
+    idKey?: string | null;
+
+    /** Gets or sets the last name. */
+    lastName?: string | null;
+
+    /** Gets or sets the name of the nick. */
+    nickName?: string | null;
+};

package/types/ViewModels/Crm/renderedBadgeBag.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 the rendered content from a Badge. */
+export type RenderedBadgeBag = {
+    /** Gets or sets the HTML content generated by the badge. */
+    html?: string | null;
+
+    /** Gets or sets the JavaScript that needs to be executed for the badge. */
+    javaScript?: string | null;
+};

package/types/ViewModels/Engagement/achievementCompletedMessageBag.d.ts

@@ -0,0 +1,63 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * Details about an achievement completion that is transmitted over
+ * the RealTime engine.
+ */
+export type AchievementCompletedMessageBag = {
+    /** Gets or sets the achievement attempt unique identifier. */
+    achievementAttemptGuid?: Guid | null;
+
+    /** Gets or sets the achievement type alternate image URL. */
+    achievementTypeAlternateImageUrl?: string | null;
+
+    /**
+     * Gets or sets the unique identifier of the achievement type that
+     * was completed.
+     */
+    achievementTypeGuid?: Guid | null;
+
+    /** Gets or sets the achievement type image URL. */
+    achievementTypeImageUrl?: string | null;
+
+    /** Gets or sets the name of the achievement type. */
+    achievementTypeName?: string | null;
+
+    /**
+     * Gets or sets the unique identifier of the entity that completed
+     * the achievement.
+     */
+    entityGuid?: Guid | null;
+
+    /** Gets or sets the name of the entity. */
+    entityName?: string | null;
+
+    /**
+     * Gets or sets the photo URL of the entity. This is null for most
+     * entities.
+     */
+    entityPhotoUrl?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/actionRenderConfigurationBag.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 configuration required to display an action. */
+export type ActionRenderConfigurationBag = {
+    /** Gets or sets the action identifier. */
+    actionId: number;
+
+    /** Gets or sets the action type unique identifier. */
+    actionTypeGuid?: Guid | null;
+
+    /** Gets or sets the configuration values for the action type. */
+    configurationValues?: Record<string, string> | null;
+
+    /** Gets or sets a value indicating whether multiple responses are allowed. */
+    isMultipleSubmissionAllowed: boolean;
+};

package/types/ViewModels/Event/InteractiveExperiences/experienceActionStyleBag.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>
+//
+
+/** The styles that should be applied to experience actions. */
+export type ExperienceActionStyleBag = {
+    /** Gets or sets the color of the background. */
+    backgroundColor?: string | null;
+
+    /** Gets or sets the background image URL. */
+    backgroundImage?: string | null;
+
+    /** Gets or sets the custom CSS. */
+    customCss?: string | null;
+
+    /** Gets or sets the color of the primary button background. */
+    primaryButtonColor?: string | null;
+
+    /** Gets or sets the color of the primary button text. */
+    primaryButtonTextColor?: string | null;
+
+    /** Gets or sets the color of the secondary button background. */
+    secondaryButtonColor?: string | null;
+
+    /** Gets or sets the color of the secondary button text. */
+    secondaryButtonTextColor?: string | null;
+
+    /** Gets or sets the color of the text. */
+    textColor?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/experienceAnswerBag.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 { InteractiveExperienceApprovalStatus } from "@Obsidian/Enums/Event/interactiveExperienceApprovalStatus";
+import { Guid } from "@Obsidian/Types";
+
+/** Details about an answer to an experience question. */
+export type ExperienceAnswerBag = {
+    /** Gets or sets the action identifier key. */
+    actionIdKey?: string | null;
+
+    /** Gets or sets the campus unique identifier. */
+    campusGuid?: Guid | null;
+
+    /** Gets or sets the name of the campus. */
+    campusName?: string | null;
+
+    /** Gets or sets the identifier of this answer. */
+    idKey?: string | null;
+
+    /** Gets or sets the response text. */
+    response?: string | null;
+
+    /** Gets or sets the approval status. */
+    status: InteractiveExperienceApprovalStatus;
+
+    /** Gets or sets the name of the submitter. */
+    submitterName?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/experienceOccurrenceStateBag.d.ts

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

package/types/ViewModels/Event/InteractiveExperiences/experiencePlaceholderStyleBag.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>
+//
+
+/** Content and style for an action placeholder. */
+export type ExperiencePlaceholderStyleBag = {
+    /** Gets or sets the header image URL. */
+    headerImage?: string | null;
+
+    /** Gets or sets the additional message details to display. */
+    message?: string | null;
+
+    /** Gets or sets the short title to display. */
+    title?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/experienceSettingsBag.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 { InteractiveExperienceCampusBehavior } from "@Obsidian/Enums/Event/interactiveExperienceCampusBehavior";
+
+/** Contents of the ExperienceSettingsJson property on an InteractiveExperience. */
+export type ExperienceSettingsBag = {
+    /**
+     * The behavior of campus choices for this experience. See the description
+     * of the individual enum values for specific functionality.
+     */
+    campusBehavior: InteractiveExperienceCampusBehavior;
+
+    /**
+     * The default campus to use when recording an Interaction if no other
+     * campus could be determined.
+     */
+    defaultCampusId?: number | null;
+
+    /** The lava template to use when the experience has ended. */
+    experienceEndedTemplate?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/experienceStyleBag.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 { ExperienceActionStyleBag } from "@Obsidian/ViewModels/Event/InteractiveExperiences/experienceActionStyleBag";
+import { ExperiencePlaceholderStyleBag } from "@Obsidian/ViewModels/Event/InteractiveExperiences/experiencePlaceholderStyleBag";
+import { ExperienceVisualizerStyleBag } from "@Obsidian/ViewModels/Event/InteractiveExperiences/experienceVisualizerStyleBag";
+
+/** The visual style information for an experience. */
+export type ExperienceStyleBag = {
+    /** Gets or sets the action styles. */
+    action?: ExperienceActionStyleBag | null;
+
+    /**
+     * Gets or sets the placeholder content and style when no action is
+     * currently being displayed.
+     */
+    noAction?: ExperiencePlaceholderStyleBag | null;
+
+    /** Gets or sets the visualizer styles. */
+    visualizer?: ExperienceVisualizerStyleBag | null;
+
+    /**
+     * Gets or sets the placeholder content and style when an action has not
+     * yet been displayed.
+     */
+    welcome?: ExperiencePlaceholderStyleBag | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/experienceVisualizerStyleBag.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 styles that should be applied to the visualizer. */
+export type ExperienceVisualizerStyleBag = {
+    /** Gets or sets the accent color. */
+    accentColor?: string | null;
+
+    /** Gets or sets the color of the background. */
+    backgroundColor?: string | null;
+
+    /** Gets or sets the background image URL. */
+    backgroundImage?: string | null;
+
+    /** Gets or sets the custom CSS. */
+    customCss?: string | null;
+
+    /** Gets or sets the primary color. */
+    primaryColor?: string | null;
+
+    /** Gets or sets the secondary color. */
+    secondaryColor?: string | null;
+
+    /** Gets or sets the color of the text. */
+    textColor?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/joinExperienceResponseBag.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 { ActionRenderConfigurationBag } from "@Obsidian/ViewModels/Event/InteractiveExperiences/actionRenderConfigurationBag";
+import { VisualizerRenderConfigurationBag } from "@Obsidian/ViewModels/Event/InteractiveExperiences/visualizerRenderConfigurationBag";
+
+/** The response object returned by the Join Experience real-time command. */
+export type JoinExperienceResponseBag = {
+    /** Gets or sets the current action identifier key. */
+    currentActionConfiguration?: ActionRenderConfigurationBag | null;
+
+    /** Gets or sets the currently displayed action identifier. */
+    currentActionIdKey?: string | null;
+
+    /** Gets or sets the action identifier for the currently displayed visualizer. */
+    currentVisualizerActionIdKey?: string | null;
+
+    /** Gets or sets the current visualizer identifier key. */
+    currentVisualizerConfiguration?: VisualizerRenderConfigurationBag | null;
+
+    /**
+     * Gets or sets the identifier of the experience occurrence that has
+     * been joined. This should be treated as a string of unknown data
+     * as the format might change in the future.
+     */
+    occurrenceIdKey?: string | null;
+};

package/types/ViewModels/Event/InteractiveExperiences/pingExperienceResponseBag.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 response object returned by the Ping Experience real-time command. */
+export type PingExperienceResponseBag = {
+    /** Gets or sets a value indicating whether this experience is active. */
+    isActive: boolean;
+};