@rockrms/obsidian-framework 1.16.3-rc.1

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

@@ -0,0 +1,114 @@
+//------------------------------------------------------------------------------
+// <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 { LoginMethod } from "@Obsidian/Enums/Blocks/Security/Login/loginMethod";
+import { ExternalAuthenticationButtonBag } from "@Obsidian/ViewModels/Blocks/Security/Login/externalAuthenticationButtonBag";
+import { PasswordlessLoginAutoVerifyOptionsBag } from "@Obsidian/ViewModels/Blocks/Security/Login/passwordlessLoginAutoVerifyOptionsBag";
+
+/**
+ * A box that contains the required information to render a login block.
+ * Implements the Rock.ViewModels.Blocks.BlockBox
+ */
+export type LoginInitializationBox = {
+    /** The configuration errors. */
+    configurationErrors?: string[] | null;
+
+    /** Gets or sets the content text. */
+    contentText?: string | null;
+
+    /** The default login method when the block is loaded. */
+    defaultLoginMethod: LoginMethod;
+
+    /**
+     * 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 external authentication buttons. */
+    externalAuthProviderButtons?: ExternalAuthenticationButtonBag[] | null;
+
+    /** Gets or sets the help page URL. */
+    helpPageUrl?: string | null;
+
+    /** Gets or sets a value indicating whether to hide the new account option. */
+    hideNewAccountOption: boolean;
+
+    /** Gets or sets a value indicating whether two-factor authentication is not supported for the selected authentication factor. */
+    is2FANotSupportedForAuthenticationFactor?: boolean | null;
+
+    /** Indicates whether internal database login is supported. */
+    isInternalDatabaseLoginSupported: boolean;
+
+    /** Indicates whether passwordless login is supported. */
+    isPasswordlessLoginSupported: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the new account button text. */
+    newAccountButtonText?: string | null;
+
+    /** Gets or sets the new account page URL. */
+    newAccountPageUrl?: string | null;
+
+    /** The passwordless login auto verify options bag. */
+    passwordlessAutoVerifyOptions?: PasswordlessLoginAutoVerifyOptionsBag | null;
+
+    /** Gets or sets the prompt message. */
+    promptMessage?: string | null;
+
+    /**
+     * Page to redirect user to upon successful log in.
+     * The 'returnurl' query string will always override this setting for database authenticated logins.
+     * Redirect Page Setting will override third-party authentication 'returnurl'.
+     */
+    redirectUrl?: string | null;
+
+    /** Optional text (HTML) to display above remote authorization options. */
+    remoteAuthorizationPromptMessage?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets a value indicating whether the client should redirect to the Rock.ViewModels.Blocks.Security.Login.LoginInitializationBox.RedirectUrl. */
+    shouldRedirect: boolean;
+
+    /** Gets or sets the two-factor email phone not available message. */
+    twoFactorEmailPhoneNotAvailableMessage?: string | null;
+
+    /** Gets or sets the two-factor email phone required message. */
+    twoFactorEmailPhoneRequiredMessage?: string | null;
+
+    /** Gets or sets the two-factor login not available message. */
+    twoFactorLoginNotAvailableMessage?: string | null;
+
+    /** Gets or sets the two-factor login required message. */
+    twoFactorLoginRequiredMessage?: string | null;
+
+    /** Gets or sets the two-factor not supported by authentication method message. */
+    twoFactorNotSupportedByAuthenticationMethodMessage?: string | null;
+
+    /** Gets or sets the username field label. */
+    usernameFieldLabel?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginAutoVerifyOptionsBag.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 that contains the required information to handle passwordless auto-verification. */
+export type PasswordlessLoginAutoVerifyOptionsBag = {
+    /** The passwordless authentication code. */
+    code?: string | null;
+
+    /** The passwordless authentication state. */
+    state?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginMfaBag.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 passwordless login MFA information. */
+export type PasswordlessLoginMfaBag = {
+    /** Gets or sets a value indicating whether email and mobile phone are missing. */
+    isEmailAndMobilePhoneMissing: boolean;
+
+    /** Gets a value indicating whether there is an error. */
+    isError: boolean;
+
+    /** Gets or sets the MFA ticket. */
+    ticket?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginOptionsBag.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 { PasswordlessLoginStep } from "@Obsidian/Enums/Blocks/Security/Login/passwordlessLoginStep";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** A bag that contains the required information to render a login block's passwordless section. */
+export type PasswordlessLoginOptionsBag = {
+    /** The passwordless authentication code. */
+    code?: string | null;
+
+    /** Indicating whether this automatic verification is required. */
+    isAutomaticVerificationRequired: boolean;
+
+    /** Indicates whether person selection is required. */
+    isPersonSelectionRequired: boolean;
+
+    /** The people matching the email or phone number. */
+    matchingPeople?: ListItemBag[] | null;
+
+    /** The passwordless authentication state. */
+    state?: string | null;
+
+    /** The passwordless authentication step. */
+    step: PasswordlessLoginStep;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginStartRequestBag.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>
+//
+
+/** A bag that contains the passwordless login start request information. */
+export type PasswordlessLoginStartRequestBag = {
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets the matching person value. */
+    matchingPersonValue?: string | null;
+
+    /** Gets or sets the MFA details. */
+    mfaTicket?: string | null;
+
+    /** Gets or sets the phone number. */
+    phoneNumber?: string | null;
+
+    /** Gets or sets a value indicating whether to send email code. */
+    shouldSendEmailCode: boolean;
+
+    /** Gets or sets a value indicating whether to send email link. */
+    shouldSendEmailLink: boolean;
+
+    /** Gets or sets a value indicating whether to send SMS code. */
+    shouldSendSmsCode: boolean;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginStartResponseBag.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 passwordless login start response information. */
+export type PasswordlessLoginStartResponseBag = {
+    /** The error message if the passwordless login start step was unsuccessful. */
+    errorMessage?: string | null;
+
+    /** Indicates whether the passwordless login start step was successful. */
+    isSuccessful: boolean;
+
+    /** The auto-generated state value that should be sent during the passwordless login verify step. */
+    state?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginVerifyOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** A bag that contains the required information to render a login block's passwordless verify section. */
+export type PasswordlessLoginVerifyOptionsBag = {
+    /** The passwordless authentication code. */
+    code?: string | null;
+
+    /** Indicates whether person selection is required. */
+    isPersonSelectionRequired: boolean;
+
+    /** The people matching the email or phone number. */
+    matchingPeople?: ListItemBag[] | null;
+
+    /** The matching person value. */
+    matchingPersonValue?: string | null;
+
+    /** The passwordless authentication state. */
+    state?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/passwordlessLoginVerifyRequestBag.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 passwordless login verify request information. */
+export type PasswordlessLoginVerifyRequestBag = {
+    /** The passwordless authentication code. */
+    code?: string | null;
+
+    /** The matching person value. */
+    matchingPersonValue?: string | null;
+
+    /** Gets or sets the MFA ticket. */
+    mfaTicket?: string | null;
+
+    /** The passwordless authentication state. */
+    state?: string | null;
+};

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

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <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 { CredentialLoginMfaBag } from "@Obsidian/ViewModels/Blocks/Security/Login/credentialLoginMfaBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** A bag that contains the passwordless login verify response information. */
+export type PasswordlessLoginVerifyResponseBag = {
+    /** The error message. */
+    errorMessage?: string | null;
+
+    /** Gets or sets a value indicating whether the person is authenticated. */
+    isAuthenticated: boolean;
+
+    /** Indicates whether person selection is required. */
+    isPersonSelectionRequired: boolean;
+
+    /** Indicates whether account registration is required. */
+    isRegistrationRequired: boolean;
+
+    /** The people matching the email or phone number. */
+    matchingPeople?: ListItemBag[] | null;
+
+    /** Gets or sets the MFA details. */
+    mfa?: CredentialLoginMfaBag | null;
+
+    /** Gets or sets the registration URL. */
+    registrationUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/remoteLoginStartRequestBag.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 that contains the remote login start request information. */
+export type RemoteLoginStartRequestBag = {
+    /** Gets or sets the authentication entity type guid. */
+    authenticationType?: string | null;
+
+    /** Gets or sets the current URL path. */
+    route?: string | null;
+};

package/types/ViewModels/Blocks/Security/Login/remoteLoginStartResponseBag.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 that contains the remote login start response information. */
+export type RemoteLoginStartResponseBag = {
+    /** Gets or sets the URL to redirect to. */
+    redirectUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/RestKeyDetail/restKeyBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type RestKeyBag = {
+    /** Gets or sets the API key associated with the UserLogin */
+    apiKey?: 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 Description that is associated with this Rest Key. This property is required. */
+    description?: string | null;
+
+    /** Gets or sets the Rock.Model.EntityType for the authentication service that this Rest Key. */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this Rest Key is active. This property is required. */
+    isActive: boolean;
+
+    /** Gets or sets the Name that this UserLogin is associated with. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Security/RestKeyDetail/restKeyDetailOptionsBag.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 RestKeyDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Tv/AppleTvAppDetail/appleTvAppBag.d.ts

@@ -0,0 +1,72 @@
+//------------------------------------------------------------------------------
+// <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 { PageRouteValueBag } from "@Obsidian/ViewModels/Rest/Controls/pageRouteValueBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+export type AppleTvAppBag = {
+    /** Gets or sets the API key. */
+    apiKey?: string | null;
+
+    /** Gets or sets the application javascript. */
+    applicationJavascript?: string | null;
+
+    /** Gets or sets the application styles. */
+    applicationStyles?: 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 description. */
+    description?: string | null;
+
+    /** Gets or sets a value indicating whether [enable page view geo tracking]. */
+    enablePageViewGeoTracking: boolean;
+
+    /** Gets or sets a value indicating whether [enable page views]. */
+    enablePageViews: boolean;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance is system. */
+    isSystem: boolean;
+
+    /** Gets or sets the Rock.Model.EntityType of this item. */
+    loginPage?: PageRouteValueBag | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the page view retention period. */
+    pageViewRetentionPeriod?: number | null;
+
+    /** Gets or sets a value indicating whether [show application javascript]. */
+    showApplicationJavascript: boolean;
+};