@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Groups/GroupRegistration/groupRegistrationBag.d.ts

@@ -0,0 +1,65 @@
+//------------------------------------------------------------------------------
+// <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 { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+
+export type GroupRegistrationBag = {
+    /** Gets or sets the address. */
+    address?: AddressControlBag | null;
+
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets a value indicating whether [enable SMS]. */
+    enableSms: boolean;
+
+    /** Gets or sets a value indicating whether [enable spouse SMS]. */
+    enableSpouseSms: boolean;
+
+    /** Gets or sets the first name. */
+    firstName?: string | null;
+
+    /** Gets or sets the home phone. */
+    homePhone?: string | null;
+
+    /** Gets or sets the last name. */
+    lastName?: string | null;
+
+    /** Gets or sets the mobile phone. */
+    mobilePhone?: string | null;
+
+    /** Gets or sets the result lava template. */
+    resultLavaTemplate?: string | null;
+
+    /** Gets or sets the spouse email. */
+    spouseEmail?: string | null;
+
+    /** Gets or sets the first name of the spouse. */
+    spouseFirstName?: string | null;
+
+    /** Gets or sets the last name of the spouse. */
+    spouseLastName?: string | null;
+
+    /** Gets or sets the spouse mobile phone. */
+    spouseMobilePhone?: string | null;
+};

package/types/ViewModels/Blocks/Groups/GroupRegistration/groupRegistrationBlockBox.d.ts

@@ -0,0 +1,65 @@
+//------------------------------------------------------------------------------
+// <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 { GroupRegistrationBag } from "@Obsidian/ViewModels/Blocks/Groups/GroupRegistration/groupRegistrationBag";
+
+export type GroupRegistrationBlockBox = {
+    /** Gets or sets a value indicating whether /[automatic fill]. */
+    autoFill: boolean;
+
+    /** Gets or sets the entity. */
+    entity?: GroupRegistrationBag | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is email required. */
+    isEmailRequired: boolean;
+
+    /** Gets or sets a value indicating whether this instance is mobile phone required. */
+    isMobilePhoneRequired: boolean;
+
+    /** Gets or sets the lava over view. */
+    lavaOverview?: string | null;
+
+    /** Gets or sets the mode. */
+    mode?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the open spots. */
+    openSpots: number;
+
+    /** Gets or sets the phone label. */
+    phoneLabel?: string | null;
+
+    /** Gets or sets the register button alt text */
+    registerButtonAltText?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Mobile/Communication/SmsConversation/conversationDetailBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <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 { ConversationMessageBag } from "@Obsidian/ViewModels/Communication/conversationMessageBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Details about a conversation between Rock and another individual. */
+export type ConversationDetailBag = {
+    /** Gets or sets the conversation key. */
+    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 the initial messages to be displayed. */
+    messages?: ConversationMessageBag[] | null;
+
+    /** Gets or sets the person unique identifier. */
+    personGuid?: Guid | null;
+
+    /** Gets or sets the phone number for the person. */
+    phoneNumber?: string | 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 snippets available to use when sending a message. */
+    snippets?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Mobile/Communication/SmsConversationList/phoneNumberBag.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";
+
+/**
+ * A single phone number provided by the server that can be selected
+ * by the individual.
+ */
+export type PhoneNumberBag = {
+    /** Gets or sets the contact key. */
+    contactKey?: string | null;
+
+    /** Gets or sets the text that describes the phone number. */
+    description?: string | null;
+
+    /** Gets or sets the unique identifier. */
+    guid?: Guid | null;
+
+    /** Gets or sets the phone number. */
+    phoneNumber?: string | null;
+};

package/types/ViewModels/Blocks/Prayer/PrayerRequestDetail/prayerRequestBag.d.ts

@@ -0,0 +1,90 @@
+//------------------------------------------------------------------------------
+// <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 PrayerRequestBag = {
+    /** Gets or sets a flag indicating  whether or not comments can be made against the request. */
+    allowComments?: boolean | null;
+
+    /** Gets or sets a description of the way that God has answered the prayer. */
+    answer?: 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 campus. */
+    campus?: ListItemBag | null;
+
+    /** Gets or sets the Rock.Model.Category that this prayer request belongs to. */
+    category?: ListItemBag | null;
+
+    /** Gets or sets the email address of the person requesting prayer. */
+    email?: string | null;
+
+    /** Gets or sets the date that the prayer request expires.  */
+    expirationDate?: string | null;
+
+    /** Gets or sets the First Name of the person that this prayer request is about. This property is required. */
+    firstName?: string | null;
+
+    /** Gets or sets the number of times this request has been flagged. */
+    flagCount?: number | null;
+
+    /** Gets the FullName as it needs to be sent to the frontend */
+    fullName?: string | null;
+
+    /** Gets or sets the group. */
+    group?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this prayer request is active. */
+    isActive?: boolean | null;
+
+    /** Gets or sets a flag indicating if the prayer request has been approved.  */
+    isApproved?: boolean | null;
+
+    /** Gets or sets the flag indicating whether or not the request is public. */
+    isPublic?: boolean | null;
+
+    /** Gets or sets a flag indicating if this is an urgent prayer request. */
+    isUrgent?: boolean | null;
+
+    /** Gets or sets the Last Name of the person that this prayer request is about. This property is required. */
+    lastName?: string | null;
+
+    /** Gets or sets the number of times that this prayer request has been prayed for. */
+    prayerCount?: number | null;
+
+    /** Gets or sets the requested by person alias. */
+    requestedByPersonAlias?: ListItemBag | null;
+
+    /** Gets or sets the text/content of the request. */
+    text?: string | null;
+};

package/types/ViewModels/Blocks/Prayer/PrayerRequestDetail/prayerRequestDetailAddPersonResponseBag.d.ts

@@ -0,0 +1,25 @@
+//------------------------------------------------------------------------------
+// <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 PrayerRequestDetailAddPersonResponseBag = {
+};

package/types/ViewModels/Blocks/Prayer/PrayerRequestDetail/prayerRequestDetailOptionsBag.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 PrayerRequestDetailOptionsBag = {
+    /** Pass the value of the RequireCampus block attribute to the front end */
+    isCampusRequired: boolean;
+
+    /** Pass the value of the RequireLastName block attribute to the front end */
+    isLastNameRequired: boolean;
+};

package/types/ViewModels/Blocks/Prayer/PrayerRequestEntry/prayerRequestEntryInitializationBox.d.ts

@@ -0,0 +1,140 @@
+//------------------------------------------------------------------------------
+// <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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The box that contains all the initialization information for the Prayer Request Entry block. */
+export type PrayerRequestEntryInitializationBox = {
+    /** The default value for the "Allow Comments" field. */
+    allowCommentsDefaultValue: boolean;
+
+    /** The prayer request attributes that can be edited. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /**
+     * The categories the person can choose from when entering their prayer request.
+     * If empty, then categories will not be shown.
+     */
+    categories?: ListItemBag[] | null;
+
+    /**
+     * The number of characters allowed when entering a new prayer request.
+     * There will be no limit if this is not a positive number.
+     */
+    characterLimit: number;
+
+    /**
+     * The default campus of the person making the prayer request.
+     * Defaults to the campus of the currently authenticated person.
+     */
+    defaultCampus?: ListItemBag | null;
+
+    /**
+     * The default category to use for all new prayer requests.
+     * If <see cref="P:Rock.ViewModels.Blocks.Prayer.PrayerRequestEntry.PrayerRequestEntryInitializationBox.Categories" /> contains this default value, then it will be selected by default.
+     */
+    defaultCategoryGuid?: Guid | null;
+
+    /**
+     * The default email of the person making the prayer request.
+     * Defaults to the email of the currently authenticated person.
+     */
+    defaultEmail?: string | null;
+
+    /**
+     * The default first name of the person making the prayer request.
+     * Defaults to the first name of the currently authenticated person.
+     */
+    defaultFirstName?: string | null;
+
+    /**
+     * The default last name of the person making the prayer request.
+     * Defaults to the last name of the currently authenticated person.
+     */
+    defaultLastName?: string | null;
+
+    /**
+     * The default prayer request text.
+     * Defaults to the value of the "Request" page parameter.
+     */
+    defaultRequest?: string | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Determines if the "Allow Comments" field should be shown. */
+    isAllowCommentsShown: boolean;
+
+    /**
+     * Determines if the campus field is required.
+     * If there is only one active campus, then the campus field will not show. If not show and if this is set to <c>true</c>, then the single campus is automatically used.
+     */
+    isCampusRequired: boolean;
+
+    /**
+     * Determines if the campus field is shown.
+     * If there is only one active campus, then the campus field will not show.
+     */
+    isCampusShown: boolean;
+
+    /** Determines if the "Is Public" field is shown. */
+    isIsPublicShown: boolean;
+
+    /** Determines if the last name field is required. */
+    isLastNameRequired: boolean;
+
+    /** Determines if the "Mobile Phone" field is shown. */
+    isMobilePhoneShown: boolean;
+
+    /** Determines if the parent page will be redirected to on successful save. */
+    isPageRedirectedToParentOnSave: boolean;
+
+    /**
+     * Determines if the current page will be refreshed on successful save.
+     * This is ignored if <see cref="P:Rock.ViewModels.Blocks.Prayer.PrayerRequestEntry.PrayerRequestEntryInitializationBox.IsPageRedirectedToParentOnSave" /> is <c>true</c>.
+     */
+    isPageRefreshedOnSave: boolean;
+
+    /** The default value for the "Is Public" field. */
+    isPublicDefaultValue: boolean;
+
+    /** Determines if the requester info is shown. */
+    isRequesterInfoShown: boolean;
+
+    /** Determines if the "Is Urgent" field is shown. */
+    isUrgentShown: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** The parent page URL to redirect to if Rock.ViewModels.Blocks.Prayer.PrayerRequestEntry.PrayerRequestEntryInitializationBox.IsPageRedirectedToParentOnSave is true. */
+    parentPageUrl?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

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

@@ -0,0 +1,66 @@
+//------------------------------------------------------------------------------
+// <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 bag that contains all the information to save a prayer request. */
+export type PrayerRequestEntrySaveRequestBag = {
+    /** Determines if comments can be made against this prayer request. */
+    allowComments?: boolean | null;
+
+    /** The prayer request attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** The campus unique identifier of the person making the prayer request. */
+    campusGuid?: Guid | null;
+
+    /** The category unique identifier to which the prayer request belongs. */
+    categoryGuid?: Guid | null;
+
+    /** The email of the person making the prayer request. */
+    email?: string | null;
+
+    /** The first name of the person making the prayer request. */
+    firstName?: string | null;
+
+    /**
+     * Determines if the prayer request is public.
+     * Defaults to the block setting value if <c>null</c>.
+     */
+    isPublic?: boolean | null;
+
+    /** Determines if this is an urgent prayer request. */
+    isUrgent?: boolean | null;
+
+    /** The last name of the person making the prayer request. */
+    lastName?: string | null;
+
+    /** The mobile phone number of the person making the prayer request. */
+    mobilePhoneNumber?: string | null;
+
+    /** The mobile phone number country code of the person making the prayer request. */
+    mobilePhoneNumberCountryCode?: string | null;
+
+    /** The prayer request text. */
+    request?: string | null;
+};

package/types/ViewModels/Blocks/Prayer/PrayerRequestEntry/prayerRequestEntrySaveResponseBag.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 bag containing the response information from saving a prayer request. */
+export type PrayerRequestEntrySaveResponseBag = {
+    /** The list of error messages if the prayer request failed to save. */
+    errors?: string[] | null;
+
+    /** The success message if the prayer request was successfully saved. */
+    successMessage?: string | null;
+};