@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Core/NotificationMessageList/getMessageActionResponseBag.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 { NotificationMessageActionBag } from "@Obsidian/ViewModels/Core/notificationMessageActionBag";
+
+/**
+ * Describes the response data sent back from the GetMessageAction
+ * block action.
+ */
+export type GetMessageActionResponseBag = {
+    /** Gets or sets the action to be performed for the message. */
+    action?: NotificationMessageActionBag | null;
+
+    /** Gets or sets a value indicating whether the message was deleted. */
+    isDeleted: boolean;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/getMessagesRequestBag.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>
+//
+
+/** Describes the request data sent to the GetMessages block action. */
+export type GetMessagesRequestBag = {
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/getMessagesResponseBag.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>
+//
+
+import { NotificationMessageBag } from "@Obsidian/ViewModels/Blocks/Core/NotificationMessageList/notificationMessageBag";
+
+/** Describes the response data sent back from the GetMessages block action. */
+export type GetMessagesResponseBag = {
+    /** Gets or sets the messages that matched the request. */
+    messages?: NotificationMessageBag[] | null;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/markMessageAsReadRequestBag.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>
+//
+
+/** Describes the request sent to the MarkMessageAsRead block action. */
+export type MarkMessageAsReadRequestBag = {
+    /** Gets or sets the identifier key of the notification message. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether to mark the message as read. */
+    isRead: boolean;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/markMessageAsReadResponseBag.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>
+//
+
+/**
+ * Describes the response data sent back from the MarkMessageAsRead
+ * block action.
+ */
+export type MarkMessageAsReadResponseBag = {
+    /** Gets or sets a value indicating whether the message was deleted. */
+    isDeleted: boolean;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/markMessagesAsReadRequestBag.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>
+//
+
+/** Describes the request sent to the MarkMessagesAsRead block action. */
+export type MarkMessagesAsReadRequestBag = {
+    /** Gets or sets the identifier keys of the notification messages. */
+    idKeys?: string[] | null;
+
+    /** Gets or sets a value indicating whether to mark the messages as read. */
+    isRead: boolean;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/markMessagesAsReadResponseBag.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 the response data sent back from the MarkMessagesAsRead
+ * block action.
+ */
+export type MarkMessagesAsReadResponseBag = {
+    /**
+     * Gets or sets a value indicating whether the message specified by
+     * the key was deleted.
+     */
+    isDeleted?: Record<string, boolean> | null;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/notificationMessageBag.d.ts

@@ -0,0 +1,55 @@
+//------------------------------------------------------------------------------
+// <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 notification message that should be displayed in the list block. */
+export type NotificationMessageBag = {
+    /** Gets or sets the color of the message. */
+    color?: string | null;
+
+    /** Gets or sets the component identifier key. */
+    componentIdKey?: string | null;
+
+    /** Gets or sets the count related to the message. */
+    count: number;
+
+    /** Gets or sets the date time of the message. */
+    dateTime?: string | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the icon CSS class that represents the message. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier of the notification message. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this message has been read. */
+    isRead: boolean;
+
+    /** Gets or sets the photo URL to display with the message. */
+    photoUrl?: string | null;
+
+    /** Gets or sets the title. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Core/NotificationMessageList/notificationMessageListInitializationBox.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 { NotificationMessageBag } from "@Obsidian/ViewModels/Blocks/Core/NotificationMessageList/notificationMessageBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Describes the data required to initialize the Obsidian component for
+ * the notification message list block.
+ */
+export type NotificationMessageListInitializationBox = {
+    /** Gets or sets the component types used for filtering purposes. */
+    componentTypes?: ListItemBag[] | null;
+
+    /** Gets or sets the messages to display upon loading. */
+    messages?: NotificationMessageBag[] | null;
+};

package/types/ViewModels/Blocks/Core/ScheduleDetail/scheduleBag.d.ts

@@ -0,0 +1,87 @@
+//------------------------------------------------------------------------------
+// <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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type ScheduleBag = {
+    /**
+     * Gets or sets the shortened name of the attribute.
+     * If null or whitespace then the full name is returned.
+     */
+    abbreviatedName?: string | null;
+
+    /** 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 [auto inactivate when complete]. */
+    autoInactivateWhenComplete: boolean;
+
+    /** Gets or sets the Rock.Model.Category that this Schedule belongs to. */
+    category?: ListItemBag | null;
+
+    /**
+     * Gets or sets the number of minutes following schedule start that Check-in should be active. 0 represents that Check-in will only be available
+     * until the Schedule's start time.
+     */
+    checkInEndOffsetMinutes?: number | null;
+
+    /**
+     * Gets or sets the number of minutes prior to the Schedule's start time  that Check-in should be active. 0 represents that Check-in 
+     * will not be available to the beginning of the event.
+     */
+    checkInStartOffsetMinutes?: number | null;
+
+    /** Gets or sets a user defined Description of the Schedule. */
+    description?: string | null;
+
+    /** Gets or sets that date that this Schedule expires and becomes inactive. This value is inclusive and the schedule will be inactive after this date. */
+    effectiveEndDate?: string | null;
+
+    /** Gets or sets the Date that the Schedule becomes effective/active. This property is inclusive, and the schedule will be inactive before this date.  */
+    effectiveStartDate?: string | null;
+
+    /** Gets the friendly schedule text. */
+    friendlyScheduleText?: string | null;
+
+    /** Gets or sets the content lines of the iCalendar */
+    iCalendarContent?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this is an active schedule. This value is required. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating if this Schedule is public. */
+    isPublic?: boolean | null;
+
+    /** Gets or sets the Name of the Schedule. This property is required. */
+    name?: string | null;
+
+    /** Gets the next occurrence date to be displayed on the remote device. */
+    nextOccurrence?: string | null;
+};

package/types/ViewModels/Blocks/Core/ScheduleDetail/scheduleDetailOptionsBag.d.ts

@@ -0,0 +1,41 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ScheduleExclusionBag } from "@Obsidian/ViewModels/Blocks/Core/ScheduleDetail/scheduleExclusionBag";
+
+export type ScheduleDetailOptionsBag = {
+    /** Gets or sets a value indicating whether this instance can delete. */
+    canDelete: boolean;
+
+    /** Gets or sets the exclusions. */
+    exclusions?: ScheduleExclusionBag[] | null;
+
+    /** Gets or sets a value indicating whether this instance has attendance. */
+    hasAttendance: boolean;
+
+    /** Gets or sets a value indicating whether this instance has schedule warning. */
+    hasScheduleWarning: boolean;
+
+    /** Gets or sets the help text. */
+    helpText?: string | null;
+};

package/types/ViewModels/Blocks/Core/ScheduleDetail/scheduleExclusionBag.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 ScheduleExclusionBag = {
+    endDate?: string | null;
+
+    startDate?: string | null;
+
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Core/ServiceJobDetail/serviceJobBag.d.ts

@@ -0,0 +1,84 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type ServiceJobBag = {
+    /**
+     * Gets or sets the Assembly name of the .dll file that contains the job class.
+     * Set this to null to have Rock figure out the Assembly automatically.
+     */
+    assembly?: string | null;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the fully qualified class name with Namespace of the Job class. This property is required. */
+    class?: string | null;
+
+    /** Gets or sets the cron description. */
+    cronDescription?: string | null;
+
+    /** Gets or sets the Cron Expression that is used to schedule the Job. This property is required. */
+    cronExpression?: string | null;
+
+    /** Gets or sets a user defined description of the Job. */
+    description?: string | null;
+
+    /** Gets or sets a value indicating whether jobs should be logged in ServiceJobHistory */
+    enableHistory: boolean;
+
+    /** Gets or sets the history count per job. */
+    historyCount: number;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if the Job is active. */
+    isActive?: boolean | null;
+
+    /** Gets or sets a flag indicating if this Job is part of the Rock core system/framework */
+    isSystem: boolean;
+
+    /**
+     * Gets or sets the status message that was returned the last time that the job was run. In most cases this will be used
+     * in the event of an exception to return the exception message.
+     */
+    lastStatusMessage?: string | null;
+
+    /** Gets or sets the friendly Name of the Job. This property is required. */
+    name?: string | null;
+
+    /**
+     * Gets or sets a comma delimited list of email address that should receive notification emails for this job. Notification
+     * emails are sent to these email addresses based on the completion status of the Job and the Rock.Model.ServiceJob.NotificationStatus
+     * property of this job.
+     */
+    notificationEmails?: string | null;
+
+    /** Gets or sets the notification status. */
+    notificationStatus?: string | null;
+};

package/types/ViewModels/Blocks/Core/ServiceJobDetail/serviceJobDetailOptionsBag.d.ts

@@ -0,0 +1,32 @@
+//------------------------------------------------------------------------------
+// <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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type ServiceJobDetailOptionsBag = {
+    /** Gets or sets the job type options. */
+    jobTypeOptions?: ListItemBag[] | null;
+
+    /** Gets or sets the notification status options. */
+    notificationStatusOptions?: ListItemBag[] | null;
+};