@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Cms/obsidianBlockPreferencesBag.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 { PersonPreferenceValueBag } from "@Obsidian/ViewModels/Core/personPreferenceValueBag";
+
+/** Contains details about the person preferences associated with a block. */
+export type ObsidianBlockPreferencesBag = {
+    /** Gets or sets the entity key that these preferences are scoped to. */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type key that these preferences are scoped to. */
+    entityTypeKey?: string | null;
+
+    /** Gets or sets the person preference values. */
+    values?: PersonPreferenceValueBag[] | null;
+};

package/types/ViewModels/Communication/conversationAttachmentBag.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>
+//
+
+/** A single attachment to a conversation message. */
+export type ConversationAttachmentBag = {
+    /** Gets or sets the name of the file. */
+    fileName?: string | null;
+
+    /** Gets or sets the thumbnail URL. */
+    thumbnailUrl?: string | null;
+
+    /** Gets or sets the URL. */
+    url?: string | null;
+};

package/types/ViewModels/Communication/conversationMessageBag.d.ts

@@ -0,0 +1,95 @@
+//------------------------------------------------------------------------------
+// <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 { ConversationAttachmentBag } from "@Obsidian/ViewModels/Communication/conversationAttachmentBag";
+
+/** Class ConversationMessageBag */
+export type ConversationMessageBag = {
+    /** Gets or sets the attachments to this message. */
+    attachments?: ConversationAttachmentBag[] | null;
+
+    /**
+     * Gets or sets the contact key of the recipient. This would contain
+     * a phone number, e-mail address, or other transport specific key
+     * to allow communication.
+     */
+    contactKey?: string | null;
+
+    /**
+     * Gets or sets the unique identifier of the conversation that
+     * this message belongs to.
+     */
+    conversationKey?: string | null;
+
+    /** Gets or sets the full name of the person being communicated with. */
+    fullName?: string | null;
+
+    /** Gets or sets a value indicating whether the recipient is a nameless person. */
+    isNamelessPerson: boolean;
+
+    /** Gets or sets a value indicating whether the message was sent from Rock. */
+    isOutbound: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the most recent
+     * message has been read.
+     */
+    isRead: boolean;
+
+    /** Gets or sets the content of the most recent message. */
+    message?: string | null;
+
+    /** Gets or sets the created date time of the most recent message. */
+    messageDateTime?: string | null;
+
+    /**
+     * Gets or sets the unique identifier for this message. This can
+     * be used to determine if the message has already been seen.
+     */
+    messageKey?: string | null;
+
+    /**
+     * Gets or sets the full name of the person that send the message from
+     * Rock. This is only valid if Rock.ViewModels.Communication.ConversationMessageBag.IsOutbound is true.
+     */
+    outboundSenderFullName?: string | null;
+
+    /**
+     * Gets or sets the unique identifier of the person being
+     * communicated with.
+     */
+    personGuid?: Guid | null;
+
+    /**
+     * Gets or sets the photo URL for the person. Value will be null
+     * if no photo is available.
+     */
+    photoUrl?: string | null;
+
+    /**
+     * Gets or sets the contact key of the Rock side of the conversation.
+     * For an SMS message this would be the Guid of the Rock phone number.
+     */
+    rockContactKey?: string | null;
+};

package/types/ViewModels/Connection/connectionRequestCountsBag.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>
+//
+
+/** Bag that contains the request counts that have been calculated. */
+export type ConnectionRequestCountsBag = {
+    /**
+     * Gets or sets the number of requests in the opportunity that
+     * are assigned to the specified person.
+     */
+    assignedToYouCount: number;
+
+    /** Gets or sets the number of active requests in the opportunity. */
+    totalCount: number;
+};

package/types/ViewModels/Controls/addressControlBag.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>
+//
+
+/** Address Control View Model */
+export type AddressControlBag = {
+    /** Gets or sets the city. */
+    city?: string | null;
+
+    /** Gets or sets the country. */
+    country?: string | null;
+
+    /** Gets or sets the locality. */
+    locality?: string | null;
+
+    /** Gets or sets the postal code. */
+    postalCode?: string | null;
+
+    /** Gets or sets the state. */
+    state?: string | null;
+
+    /** Gets or sets the street1. */
+    street1?: string | null;
+
+    /** Gets or sets the street2. */
+    street2?: string | null;
+};

package/types/ViewModels/Controls/birthdayPickerBag.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>
+//
+
+/** Birthday Picker View Model */
+export type BirthdayPickerBag = {
+    /** Gets or sets the day. */
+    day: number;
+
+    /** Gets or sets the month. */
+    month: number;
+
+    /** Gets or sets the year. */
+    year: number;
+};

package/types/ViewModels/Controls/campusPickerItemBag.d.ts

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * An item bag used by the Campus Picker to gather additional details about
+ * a campus.
+ */
+export type CampusPickerItemBag = {
+    /** Gets or sets the campus status. */
+    campusStatus?: Guid | null;
+
+    /** Gets or sets the type of campus. */
+    campusType?: Guid | null;
+
+    /** Gets or sets the category for this item. */
+    category?: string | null;
+
+    /** Gets or sets disabled for this item. */
+    disabled?: boolean | null;
+
+    /** Gets or sets a value indicating whether this campus is active. */
+    isActive: boolean;
+
+    /** Gets or sets the text. */
+    text?: string | null;
+
+    /** Gets or sets the value. */
+    value?: string | null;
+};

package/types/ViewModels/Controls/electronicSignatureValue.d.ts

@@ -0,0 +1,31 @@
+// <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 signature value view model that will be passed to and emitted from the
+ * electronic signature control.
+ */
+export type ElectronicSignatureValue = {
+    /** The drawn signature data encoded as a URI. */
+    signatureData?: string | null;
+
+    /** The name of the person that signed the document. */
+    signedByName?: string | null;
+
+    /** The email provided to contact the signer. */
+    signedByEmail?: string | null;
+};

package/types/ViewModels/Controls/fieldTypeEditorGetAvailableFieldTypesOptionsBag.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 GetAvailableFieldTypes API action
+ * for the FieldTypeEditor control.
+ */
+export type FieldTypeEditorGetAvailableFieldTypesOptionsBag = {
+};

package/types/ViewModels/Controls/fieldTypeEditorUpdateAttributeConfigurationOptionsBag.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";
+
+/** Contains information required to update a field type's configuration. */
+export type FieldTypeEditorUpdateAttributeConfigurationOptionsBag = {
+    /**
+     * Gets or sets the configuration values that describe the current
+     * selections when editing a field type.
+     */
+    configurationValues?: Record<string, string> | null;
+
+    /** Gets or sets the default value currently set. */
+    defaultValue?: string | null;
+
+    /** Gets or sets the field type unique identifier. */
+    fieldTypeGuid?: Guid | null;
+};

package/types/ViewModels/Controls/fieldTypeEditorUpdateAttributeConfigurationResultBag.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>
+//
+
+/**
+ * Describes a field type configuration state. This provides the information
+ * required to edit a field type on a remote system.
+ */
+export type FieldTypeEditorUpdateAttributeConfigurationResultBag = {
+    /**
+     * Gets or sets the configuration properties that contain information
+     * describing a field type edit operation.
+     */
+    configurationProperties?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the configuration options that describe the current
+     * selections when editing a field type.
+     */
+    configurationValues?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the default attribute value view model that corresponds
+     * to the current Rock.ViewModels.Controls.FieldTypeEditorUpdateAttributeConfigurationResultBag.ConfigurationValues.
+     */
+    defaultValue?: string | null;
+};

package/types/ViewModels/Controls/gatewayControlBag.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>
+//
+
+/** GatewayControlViewModel */
+export type GatewayControlBag = {
+    /** Gets or sets the file URL. */
+    fileUrl?: string | null;
+
+    /** Gets or sets the settings. */
+    settings?: unknown;
+};

package/types/ViewModels/Controls/monthDayValue.d.ts

@@ -0,0 +1,27 @@
+// <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>
+//
+
+/**
+ * Type representing the different date part of month and day as numbers (1-indexed month)
+ */
+export type MonthDayValue = {
+    /** The month as number 1-12 */
+    month: number;
+
+    /** The day as number 1-31 */
+    day: number;
+};

package/types/ViewModels/Controls/monthYearValue.d.ts

@@ -0,0 +1,27 @@
+// <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>
+//
+
+/**
+ * Type representing the different date part of month and year as numbers (1-indexed month)
+ */
+export type MonthYearValue = {
+    /** The month as number 1-12 */
+    month: number;
+
+    /** The year as number */
+    year: number;
+};

package/types/ViewModels/Controls/noteMentionItemBag.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>
+//
+
+/**
+ * A single mention source item used to display the possible matches
+ * when adding a new mention reference.
+ */
+export type NoteMentionItemBag = {
+    /** Gets or sets the name of the campus this mention belongs to. */
+    campusName?: string | null;
+
+    /** Gets or sets the name to display for this mention source. */
+    displayName?: string | null;
+
+    /** Gets or sets the e-mail address for this mention source. */
+    email?: string | null;
+
+    /** Gets or sets the identifier to store with the mention. */
+    identifier?: string | null;
+
+    /** Gets or sets the image to display with name. */
+    imageUrl?: string | null;
+};

package/types/ViewModels/Controls/phoneNumberBoxWithSmsControlBag.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>
+//
+
+/** Address Control View Model */
+export type PhoneNumberBoxWithSmsControlBag = {
+    /** Gets or sets the country code. */
+    countryCode?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is messaging enbabled. */
+    isMessagingEnabled: boolean;
+
+    /** Gets or sets the numbers. */
+    number?: string | null;
+};