@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Cms/PageRouteDetail/pageRouteBag.d.ts

@@ -0,0 +1,55 @@
+//------------------------------------------------------------------------------
+// <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 PageRouteBag = {
+    /** 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 identifier key of this entity. */
+    idKey?: string | null;
+
+    /** If true then the route will be accessible from all sites regardless if EnableExclusiveRoutes is set on the site */
+    isGlobal: boolean;
+
+    /** Gets or sets a flag indicating if the PageRoute is part of the Rock core system/framework. This property is required. */
+    isSystem: boolean;
+
+    /** Gets or sets the Rock.Model.Page associated with the RoutePath. */
+    page?: ListItemBag | null;
+
+    /**
+     * Gets or sets the format of the route path. Route examples include: Page NewAccount or Checkin/Welcome. 
+     * A specific group Group/{GroupId} (i.e. Group/16). A person's history Person/{PersonId}/History (i.e. Person/12/History).
+     * This property is required.
+     */
+    route?: string | null;
+
+    /** Gets or sets the site. */
+    site?: string | null;
+};

package/types/ViewModels/Blocks/Cms/PageRouteDetail/pageRouteDetailOptionsBag.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 PageRouteDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/PageShortLinkDetail/pageShortLinkBag.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 PageShortLinkBag = {
+    /** 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 link to be copied to the clipboard in the UI when the user clicks the copy button in the view mode. */
+    copyLink?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the Rock.Model.Site that is associated with this PageShortLink. */
+    site?: ListItemBag | null;
+
+    /** Gets or sets the token. */
+    token?: string | null;
+
+    /** Gets or sets the URL. */
+    url?: string | null;
+};

package/types/ViewModels/Blocks/Cms/PageShortLinkDetail/pageShortLinkDetailOptionsBag.d.ts

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+export type PageShortLinkDetailOptionsBag = {
+    /** Gets or sets the site options. */
+    siteOptions?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/PersistedDatasetDetail/persistedDatasetBag.d.ts

@@ -0,0 +1,106 @@
+//------------------------------------------------------------------------------
+// <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 PersistedDatasetBag.
+ * Implements the Rock.ViewModels.Utility.EntityBagBase
+ */
+export type PersistedDatasetBag = {
+    /** Gets or sets the unique key to use to access this persisted dataset */
+    accessKey?: string | null;
+
+    /** Gets or sets a value indicating whether [allow manual refresh]. */
+    allowManualRefresh: boolean;
+
+    /** 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 build script. See Rock.Model.PersistedDataset.BuildScriptType */
+    buildScript?: string | null;
+
+    /** Gets or sets a user defined description of the PersistedDataset. */
+    description?: string | null;
+
+    /** Gets or sets a comma-delimited list of enabled LavaCommands */
+    enabledLavaCommands?: ListItemBag[] | null;
+
+    /** Gets or sets the type of the entity. */
+    entityType?: ListItemBag | null;
+
+    /** The DateTime when to stop updating the Rock.Model.PersistedDataset.ResultData */
+    expireDateTime?: string | null;
+
+    /**  Gets or sets the readable iCalendar content  */
+    friendlyScheduleText?: string | null;
+
+    /** 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 used by the system. */
+    isSystem: boolean;
+
+    /** Gets or sets the persisted last refresh date time. */
+    lastRefreshDateTime?: string | null;
+
+    /** Gets or sets the memory cache duration ms. */
+    memoryCacheDurationHours?: number | null;
+
+    /** Gets or sets the Name of the PersistedDataset. */
+    name?: string | null;
+
+    /** Gets or sets the named schedules. */
+    namedSchedules?: ListItemBag[] | null;
+
+    /** Gets or sets the schedule data. */
+    persistedSchedule?: string | null;
+
+    /** Gets or sets the Schedule ID. */
+    persistedScheduleId?: number | null;
+
+    /** Gets or sets the persisted schedule interval type. */
+    persistedScheduleIntervalType?: string | null;
+
+    /** Gets or sets the persisted schedule type. */
+    persistedScheduleType?: string | null;
+
+    /** Gets or sets the persistence type. */
+    persistenceType?: string | null;
+
+    /** Gets or sets the refresh interval */
+    refreshInterval?: number | null;
+
+    /** Gets or sets the refresh interval Hours */
+    refreshIntervalHours?: number | null;
+
+    /**  Gets or sets the time to build in milliseconds */
+    timeToBuildMS?: number | null;
+};

package/types/ViewModels/Blocks/Cms/PersistedDatasetDetail/persistedDatasetDetailOptionsBag.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 PersistedDatasetDetailOptionsBag. */
+export type PersistedDatasetDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/PersonalLinkSectionDetail/personalLinkSectionBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Class PersonalLinkSectionBag.
+ * Implements the Rock.ViewModels.Utility.EntityBagBase
+ */
+export type PersonalLinkSectionBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets a value indicating whether the current user can take administrative actions. */
+    canAdministrate: boolean;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this Link Section is shared. */
+    isShared: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Cms/PersonalLinkSectionDetail/personalLinkSectionDetailOptionsBag.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 PersonalLinkSectionDetailOptionsBag. */
+export type PersonalLinkSectionDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/SiteDetail/siteBag.d.ts

@@ -0,0 +1,161 @@
+//------------------------------------------------------------------------------
+// <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 SiteBag = {
+    /**
+     * The Allowed Frame Domains designates which external domains/sites are allowed to embed iframes of this site.
+     * It controls what is put into the Content-Security-Policy HTTP response header.
+     * This is in accordance with the Content Security Policy described here http://w3c.github.io/webappsec-csp/#csp-header
+     * and here https://www.owasp.org/index.php/Content_Security_Policy_Cheat_Sheet
+     */
+    allowedFrameDomains?: string | null;
+
+    /** Gets or sets a value indicating whether [allow indexing]. */
+    allowIndexing: boolean;
+
+    /** 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 change password page. */
+    changePasswordPage?: ListItemBag | null;
+
+    /** Gets or sets the change password page route. */
+    changePasswordPageRoute?: ListItemBag | null;
+
+    /** Gets or sets the communication page. */
+    communicationPage?: ListItemBag | null;
+
+    /** Gets or sets the communication page route. */
+    communicationPageRoute?: ListItemBag | null;
+
+    /** Gets or sets the default Rock.Model.Page page for the site. */
+    defaultPage?: ListItemBag | null;
+
+    /** Gets or sets the default Rock.Model.PageRoute page route for this site. If this value is null, the DefaultPage will be used */
+    defaultPageRoute?: ListItemBag | null;
+
+    /** Gets or sets a user defined description/summary  of the Site. */
+    description?: string | null;
+
+    /** Gets or sets whether predictable Ids are disabled. */
+    disablePredictableIds: boolean;
+
+    /** Gets or sets a value indicating whether this site should be available to be used for shortlinks (the shortlink can still reference the URL of other sites). */
+    enabledForShortening: boolean;
+
+    /** Enabling this feature will prevent other sites from using this sites routes and prevent routes from other sites from working on this site. */
+    enableExclusiveRoutes: boolean;
+
+    /** Gets or sets a value indicating whether [enable mobile redirect]. */
+    enableMobileRedirect: boolean;
+
+    /** Gets or sets a value indicating whether geo-location lookups should be performed on interactions. */
+    enablePageViewGeoTracking: boolean;
+
+    /** Gets or sets a value indicating whether to log Page Views into the Interaction tables for pages in this site */
+    enablePageViews: boolean;
+
+    /** Gets or sets a value indicating whether [enable personalization]. */
+    enablePersonalization: boolean;
+
+    /** Gets or sets a value indicating whether /[enable visitor tracking]. */
+    enableVisitorTracking: boolean;
+
+    /** Gets or sets the path to the error page. */
+    errorPage?: string | null;
+
+    /** Gets or sets the external URL. */
+    externalUrl?: string | null;
+
+    /** Gets or sets the favicon binary file. */
+    favIconBinaryFile?: ListItemBag | null;
+
+    /** Gets or sets the Google analytics code. */
+    googleAnalyticsCode?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the index starting location. */
+    indexStartingLocation?: 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 index enabled. */
+    isIndexEnabled: boolean;
+
+    /** Gets or sets a flag indicating if this Site was created by and is part of the Rock core system/framework. This property is required. */
+    isSystem: boolean;
+
+    /** Gets or sets the login Rock.Model.Page page for the site. */
+    loginPage?: ListItemBag | null;
+
+    /** Gets or sets the login Rock.Model.PageRoute page route for this site. If this value is null, the LoginPage will be used */
+    loginPageRoute?: ListItemBag | null;
+
+    /** Gets or sets the mobile page. */
+    mobilePage?: ListItemBag | null;
+
+    /** Gets or sets the name of the Site. This property is required. */
+    name?: string | null;
+
+    /** Gets or sets the content of the page header. */
+    pageHeaderContent?: string | null;
+
+    /** Gets or sets the 404 Rock.Model.Page page for the site. */
+    pageNotFoundPage?: ListItemBag | null;
+
+    /** Gets or sets the 404 Rock.Model.PageRoute page route for this site. */
+    pageNotFoundPageRoute?: ListItemBag | null;
+
+    /** Gets or sets a value indicating whether [redirect tablets]. */
+    redirectTablets: boolean;
+
+    /** Gets or sets the registration Rock.Model.Page page for the site. */
+    registrationPage?: ListItemBag | null;
+
+    /** Gets or sets the registration Rock.Model.PageRoute page route for this site. If this value is null, the RegistrationPage will be used */
+    registrationPageRoute?: ListItemBag | null;
+
+    /** Gets or sets a value indicating whether [requires encryption]. */
+    requiresEncryption: boolean;
+
+    /** Gets or sets the number of days to keep page views logged. */
+    retentionDuration?: number | null;
+
+    /** Gets or sets the site domains. */
+    siteDomains?: string | null;
+
+    /** Gets or sets the site logo binary file. */
+    siteLogoBinaryFile?: ListItemBag | null;
+
+    /** Gets or sets the name of the Theme that is used on the Site. */
+    theme?: string | null;
+};

package/types/ViewModels/Blocks/Cms/SiteDetail/siteDetailOptionsBag.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>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+export type SiteDetailOptionsBag = {
+    /** The site Attributes */
+    siteAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** The themes */
+    themes?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/SiteList/siteListOptionsBag.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>
+//
+
+/** The Site List Options Bag */
+export type SiteListOptionsBag = {
+};