@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountDeleteConfirmationViewOptionsBag.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>
+//
+
+/** A bag containing the required information to display the Confirm Account Block's delete confirmation view. */
+export type ConfirmAccountDeleteConfirmationViewOptionsBag = {
+    /** The encrypted confirmation code. */
+    code?: string | null;
+
+    /** The delete confirmation view caption. */
+    viewCaption?: string | null;
+};

package/types/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountDeleteRequestBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** A bag containing the information required to process a delete account request. */
+export type ConfirmAccountDeleteRequestBag = {
+    /** The encrypted confirmation code. */
+    code?: string | null;
+};

package/types/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountInitializationBox.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>
+//
+
+import { ConfirmAccountActionNamesBag } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountActionNamesBag";
+import { ConfirmAccountViewBox } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountViewBox";
+
+/** A box containing the required information to display the Confirm Account block. */
+export type ConfirmAccountInitializationBox = {
+    /** The bag containing the available actions for the Confirm Account block. */
+    actionNames?: ConfirmAccountActionNamesBag | 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 navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** The box containing the required information to display a Confirm Account block view. */
+    view?: ConfirmAccountViewBox | null;
+};

package/types/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountShowChangePasswordViewRequestBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** A bag containing the required information to show the change password view. */
+export type ConfirmAccountShowChangePasswordViewRequestBag = {
+    /** The encrypted confirmation code. */
+    code?: string | null;
+};

package/types/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountShowDeleteConfirmationRequestBag.d.ts

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

package/types/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountViewBox.d.ts

@@ -0,0 +1,68 @@
+//------------------------------------------------------------------------------
+// <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 { ConfirmAccountViewType } from "@Obsidian/Enums/Blocks/Security/ConfirmAccount/confirmAccountViewType";
+import { ConfirmAccountAccountConfirmationViewOptionsBag } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountAccountConfirmationViewOptionsBag";
+import { ConfirmAccountAlertViewOptionsBag } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountAlertViewOptionsBag";
+import { ConfirmAccountChangePasswordViewOptionsBag } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountChangePasswordViewOptionsBag";
+import { ConfirmAccountContentViewOptionsBag } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountContentViewOptionsBag";
+import { ConfirmAccountDeleteConfirmationViewOptionsBag } from "@Obsidian/ViewModels/Blocks/Security/ConfirmAccount/confirmAccountDeleteConfirmationViewOptionsBag";
+
+/** A box containing the required information to display a Confirm Account block view. */
+export type ConfirmAccountViewBox = {
+    /**
+     * The bag containing the required information to display the Confirm Account Block's account confirmation view.
+     * Set when <see cref="P:Rock.ViewModels.Blocks.Security.ConfirmAccount.ConfirmAccountViewBox.ViewType" /> == <see cref="F:Rock.Enums.Blocks.Security.ConfirmAccount.ConfirmAccountViewType.AccountConfirmation" />; otherwise, <c>null</c>.
+     */
+    accountConfirmationViewOptions?: ConfirmAccountAccountConfirmationViewOptionsBag | null;
+
+    /**
+     * The bag containing the required information to display the Confirm Account Block's alert view.
+     * Set when <see cref="P:Rock.ViewModels.Blocks.Security.ConfirmAccount.ConfirmAccountViewBox.ViewType" /> == <see cref="F:Rock.Enums.Blocks.Security.ConfirmAccount.ConfirmAccountViewType.Alert" />; otherwise, <c>null</c>.
+     */
+    alertViewOptions?: ConfirmAccountAlertViewOptionsBag | null;
+
+    /**
+     * The bag containing the required information to display the Confirm Account Block's change password view.
+     * Set when <see cref="P:Rock.ViewModels.Blocks.Security.ConfirmAccount.ConfirmAccountViewBox.ViewType" /> == <see cref="F:Rock.Enums.Blocks.Security.ConfirmAccount.ConfirmAccountViewType.ChangePassword" />; otherwise, <c>null</c>.
+     */
+    changePasswordViewOptions?: ConfirmAccountChangePasswordViewOptionsBag | null;
+
+    /**
+     * The bag containing the required information to display the Confirm Account Block's content view.
+     * Set when <see cref="P:Rock.ViewModels.Blocks.Security.ConfirmAccount.ConfirmAccountViewBox.ViewType" /> == <see cref="F:Rock.Enums.Blocks.Security.ConfirmAccount.ConfirmAccountViewType.Content" />; otherwise, <c>null</c>.
+     */
+    contentViewOptions?: ConfirmAccountContentViewOptionsBag | null;
+
+    /**
+     * The bag containing the required information to display the Confirm Account Block's delete confirmation view.
+     * Set when <see cref="P:Rock.ViewModels.Blocks.Security.ConfirmAccount.ConfirmAccountViewBox.ViewType" /> == <see cref="F:Rock.Enums.Blocks.Security.ConfirmAccount.ConfirmAccountViewType.DeleteConfirmation" />; otherwise, <c>null</c>.
+     */
+    deleteConfirmationViewOptions?: ConfirmAccountDeleteConfirmationViewOptionsBag | null;
+
+    /**
+     * The view type to display.
+     * The corresponding view property will be set while the others will remain <c>null</c>.
+     */
+    viewType: ConfirmAccountViewType;
+};

package/types/ViewModels/Blocks/Security/ForgotUserName/changePasswordNotSupportedResultBag.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>
+//
+
+/** A bag containing the required information to display a "Change Password Not Supported" message. */
+export type ChangePasswordNotSupportedResultBag = {
+    /** All the account types associated with the email. */
+    accountTypes?: string[] | null;
+
+    /** The URL to redirect to to create a new account. */
+    newAccountUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/ForgotUserName/forgotUserNameCaptionsBag.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 bag containing the required information to display various block captions. */
+export type ForgotUserNameCaptionsBag = {
+    /** The caption to display in the block heading (HTML). */
+    headingCaption?: string | null;
+
+    /** The caption to display when an invalid email is used to get reset instructions (HTML). */
+    invalidEmailCaption?: string | null;
+
+    /** The caption to display when instructions are sent successfully (HTML). */
+    successCaption?: string | null;
+};

package/types/ViewModels/Blocks/Security/ForgotUserName/forgotUserNameInitializationBox.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <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 { ForgotUserNameCaptionsBag } from "@Obsidian/ViewModels/Blocks/Security/ForgotUserName/forgotUserNameCaptionsBag";
+
+/** A bag containing the required information to render a Forgot UserName block. */
+export type ForgotUserNameInitializationBox = {
+    /** A bag containing the required information to display various block captions. */
+    captions?: ForgotUserNameCaptionsBag | null;
+
+    /** If set to true if the Captcha verification step should not be performed. */
+    disableCaptchaSupport: boolean;
+
+    /**
+     * 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 navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Security/ForgotUserName/forgotUserNameSendInstructionsRequestBag.d.ts

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

package/types/ViewModels/Blocks/Security/ForgotUserName/forgotUserNameSendInstructionsResultBag.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 { SendInstructionsResultType } from "@Obsidian/Enums/Blocks/Security/ForgotUserName/sendInstructionsResultType";
+import { ChangePasswordNotSupportedResultBag } from "@Obsidian/ViewModels/Blocks/Security/ForgotUserName/changePasswordNotSupportedResultBag";
+
+/** A bag containing the results of sending instructions. */
+export type ForgotUserNameSendInstructionsResultBag = {
+    /**
+     * The bag containing the required information to display a "Change Password Not Supported" message.
+     * Only present if <see cref="P:Rock.ViewModels.Blocks.Security.ForgotUserName.ForgotUserNameSendInstructionsResultBag.ResultType" /> == <see cref="F:Rock.Enums.Blocks.Security.ForgotUserName.SendInstructionsResultType.ChangePasswordNotSupported" />.
+     */
+    changePasswordNotSupportedResult?: ChangePasswordNotSupportedResultBag | null;
+
+    /** The result type. */
+    resultType: SendInstructionsResultType;
+};

package/types/ViewModels/Blocks/Security/Login/credentialLoginMfaBag.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 bag that contains the credential login MFA information. */
+export type CredentialLoginMfaBag = {
+    /** Gets a value indicating whether there is an error. */
+    isError: boolean;
+
+    /** Gets or sets a value indicating whether username and password is missing. */
+    isUsernameAndPasswordMissing: boolean;
+
+    /** Gets or sets the MFA ticket. */
+    ticket?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/credentialLoginRequestBag.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>
+//
+
+/** A bag that contains the credential login request information. */
+export type CredentialLoginRequestBag = {
+    /** Gets or sets the MFA ticket. */
+    mfaTicket?: string | null;
+
+    /** Gets or sets the password. */
+    password?: string | null;
+
+    /** Gets or sets a value indicating whether [remember me]. */
+    rememberMe: boolean;
+
+    /** Gets or sets the username. */
+    username?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/credentialLoginResponseBag.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <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 { PasswordlessLoginMfaBag } from "@Obsidian/ViewModels/Blocks/Security/Login/passwordlessLoginMfaBag";
+
+/** A bag that contains the credential login response information. */
+export type CredentialLoginResponseBag = {
+    /** The error message. */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether authentication was successful. */
+    isAuthenticated: boolean;
+
+    /** Gets or sets a value indicating whether the individual needs to confirm their account. */
+    isConfirmationRequired: boolean;
+
+    /** Gets or sets a value indicating whether the individual is locked out. */
+    isLockedOut: boolean;
+
+    /** Gets or sets the MFA details. */
+    mfa?: PasswordlessLoginMfaBag | null;
+
+    /** Gets or sets the redirect URL if authentication was successful. */
+    redirectUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/externalAuthenticationButtonBag.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>
+//
+
+/** A bag that contains the required information to render an external authentication button. */
+export type ExternalAuthenticationButtonBag = {
+    /** Gets or sets the authentication entity type guid. */
+    authenticationType?: string | null;
+
+    /** Gets or sets the CSS class to add to the button. */
+    cssClass?: string | null;
+
+    /** Gets or sets button's the image URL. */
+    imageUrl?: string | null;
+
+    /** Gets or sets the text to display. */
+    text?: string | null;
+};