@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/emailPreferenceEntryInitializationBox.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";
+
+/** The box that contains all the initialization information for the Email Preference Entry block. */
+export type EmailPreferenceEntryInitializationBox = {
+    /** Gets or sets a value indicating whether [allow inactivating family]. */
+    allowInactivatingFamily: boolean;
+
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets the email preference. */
+    emailPreference?: string | null;
+
+    /** Gets or sets the type of the email preference update alert. */
+    emailPreferenceUpdateAlertType?: string | null;
+
+    /** Gets or sets the email preference update message. */
+    emailPreferenceUpdateMessage?: string | null;
+
+    /** Gets or sets the emails allowed text. */
+    emailsAllowedText?: 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;
+
+    /** Gets or sets the in active note. */
+    inActiveNote?: string | null;
+
+    /** Gets or sets the in active reason. */
+    inActiveReason?: string | null;
+
+    /** Gets or sets the in active reasons. */
+    inActiveReasons?: ListItemBag[] | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the no emails text. */
+    noEmailsText?: string | null;
+
+    /** Gets or sets the no mass emails text. */
+    noMassEmailsText?: string | null;
+
+    /** Gets or sets the not involved text. */
+    notInvolvedText?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the successfully unsubscribed text. */
+    successfullyUnsubscribedText?: string | null;
+
+    /** Gets or sets the unsubscribe from list. */
+    unsubscribeFromList?: ListItemBag[] | null;
+
+    /** Gets or sets the unsubscribe from list. */
+    unsubscribeFromListOptions?: ListItemBag[] | null;
+
+    /** Gets or sets the unsubscribe text. */
+    unsubscribeText?: string | null;
+
+    /** Gets or sets the update email address text. */
+    updateEmailAddressText?: string | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/emailPreferenceEntrySaveRequestBag.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>
+//
+
+export type EmailPreferenceEntrySaveRequestBag = {
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets the email preference. */
+    emailPreference?: string | null;
+
+    /** Gets or sets the ina active reason. */
+    inaActiveReason?: string | null;
+
+    /** Gets or sets a value indicating whether [in activate family]. */
+    inActivateFamily: boolean;
+
+    /** Gets or sets the in active reason note. */
+    inActiveReasonNote?: string | null;
+
+    /** Gets or sets the unsubscribe from list. */
+    unsubscribeFromList?: string[] | null;
+};

package/types/ViewModels/Blocks/Communication/EmailPreferenceEntry/emailPreferenceEntrySaveResponseBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 EmailPreferenceEntrySaveResponseBag = {
+    /** Gets or sets the type of the alert. */
+    alertType?: string | null;
+
+    /** Gets or sets the error message. */
+    errorMessage?: string | null;
+
+    /** Gets or sets the success message. */
+    successMessage?: string | null;
+};

package/types/ViewModels/Blocks/Communication/SnippetDetail/snippetBag.d.ts

@@ -0,0 +1,61 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Class SnippetBag.
+ * Implements the Rock.ViewModels.Utility.EntityBagBase
+ */
+export type SnippetBag = {
+    /** 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 category. */
+    category?: ListItemBag | null;
+
+    /** Gets or sets the content. */
+    content?: string | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this Snippet is active. */
+    isActive: boolean;
+
+    /** Gets or sets the name of the Snippet. */
+    name?: string | null;
+
+    /** Gets or sets the order. */
+    order: number;
+
+    /** Gets or sets the owner Rock.Model.PersonAlias. */
+    ownerPersonAlias?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/SnippetDetail/snippetDetailOptionsBag.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>
+//
+
+/** Class SnippetDetailOptionsBag. */
+export type SnippetDetailOptionsBag = {
+    /** Gets or sets a value indicating whether this instance is authorized to edit. */
+    isAuthorizedToEdit: boolean;
+
+    /** Gets or sets a value indicating whether this instance is personal allowed. */
+    isPersonalAllowed: boolean;
+};

package/types/ViewModels/Blocks/Communication/SnippetTypeDetail/snippetTypeBag.d.ts

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Class SnippetTypeBag.
+ * Implements the Rock.ViewModels.Utility.EntityBagBase
+ */
+export type SnippetTypeBag = {
+    /** 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 description. */
+    description?: string | null;
+
+    /** Gets or sets the help text. */
+    helpText?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is personal allowed. */
+    isPersonalAllowed: boolean;
+
+    /** Gets or sets a value indicating whether this instance is shared allowed. */
+    isSharedAllowed: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Communication/SnippetTypeDetail/snippetTypeDetailOptionsBag.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>
+//
+
+/** Class SnippetTypeDetailOptionsBag. */
+export type SnippetTypeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Communication/SystemPhoneNumberDetail/systemPhoneNumberBag.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";
+
+/** Class SystemPhoneNumberBag */
+export type SystemPhoneNumberBag = {
+    /**
+     * Gets or sets the person alias who should receive responses to the SMS
+     * number. This person must have a phone number with SMS enabled
+     * or no response will be sent.
+     */
+    assignedToPersonAlias?: ListItemBag | 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 description. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this phone number is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance support SMS. */
+    isSmsEnabled: boolean;
+
+    /**
+     * Gets or sets a value indicating whether this phone number will
+     * forward incoming messages to Rock.Model.SystemPhoneNumber.AssignedToPersonAliasId.
+     */
+    isSmsForwardingEnabled: boolean;
+
+    /**
+     * Gets or sets the mobile application site. This is used
+     * when determining what devices to send push notifications to.
+     */
+    mobileApplicationSite?: ListItemBag | null;
+
+    /** Gets or sets the friendly name of the phone number. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the phone number. This should be in E.123 format,
+     * such as +16235553324.
+     */
+    number?: string | null;
+
+    /**
+     * Gets or sets the SMS notification group. Active members of this
+     * group will be notified when a new SMS message comes in to this
+     * phone number.
+     */
+    smsNotificationGroup?: ListItemBag | null;
+
+    /**
+     * Gets or sets the workflow type that will be launched when an
+     * SMS message is received on this number.
+     */
+    smsReceivedWorkflowType?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/Communication/SystemPhoneNumberDetail/systemPhoneNumberDetailOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Class SystemPhoneNumberDetailOptionsBag */
+export type SystemPhoneNumberDetailOptionsBag = {
+    /** Gets or sets the mobile sites available to be selected. */
+    mobileSites?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Core/AssetStorageProviderDetail/assetStorageProviderBag.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <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 AssetStorageProviderBag = {
+    /** 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 description. */
+    description?: string | null;
+
+    /** Gets or sets the type of the entity. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this item is active or not. */
+    isActive: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Core/AssetStorageProviderDetail/assetStorageProviderDetailOptionsBag.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 AssetStorageProviderDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/BinaryFileDetail/binaryFileBag.d.ts

@@ -0,0 +1,70 @@
+//------------------------------------------------------------------------------
+// <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";
+
+export type BinaryFileBag = {
+    /** 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 id of the Rock.Model.BinaryFileType that this file belongs to. */
+    binaryFileType?: ListItemBag | null;
+
+    /** Gets or sets a user defined description of the file. */
+    description?: string | null;
+
+    /** Gets or sets the document. */
+    file?: ListItemBag | null;
+
+    /** Gets or sets the name of the file, including any extensions. This name is usually captured when the file is uploaded to Rock and this same name will be used when the file is downloaded. This property is required. */
+    fileName?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is label file. */
+    isLabelFile: boolean;
+
+    /** Gets or sets the Mime Type for the file. This property is required */
+    mimeType?: string | null;
+
+    /** Gets or sets the orphaned binary file identifier list. This holds the list of uploaded binary files that were ultimately not used and can be deleted. */
+    orphanedBinaryFileIdList?: Guid[] | null;
+
+    /** Gets or sets a value indicating whether [show binary file type]. */
+    showBinaryFileType: boolean;
+
+    /** Gets or sets a value indicating whether [show workflow button]. */
+    showWorkflowButton: boolean;
+
+    /** Gets or sets the re run workflow button text. */
+    workflowButtonText?: string | null;
+
+    /** Gets or sets the workflow notification message. */
+    workflowNotificationMessage?: string | null;
+};

package/types/ViewModels/Blocks/Core/BinaryFileDetail/binaryFileDetailOptionsBag.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 BinaryFileDetailOptionsBag = {
+};