@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Rest/Controls/metricItemPickerGetChildrenOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetDataViews API action of
+ * the DataViewPicker control.
+ */
+export type MetricItemPickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the default icon CSS class to use for items that do not
+     * specify their own IconCssClass value.
+     */
+    defaultIconCssClass?: string | null;
+
+    /**
+     * Gets or sets the default icon CSS class to use for items that do not
+     * specify their own IconCssClass value.
+     */
+    includeCategoryGuids?: Guid[] | null;
+
+    /**
+     * Gets or sets the parent unique identifier whose children are to
+     * be retrieved. If null then the root items are being requested.
+     */
+    parentGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/noteEditorMentionSearchOptionsBag.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>
+//
+
+/**
+ * The options that will be provided to the NoteEditorMentionSearch
+ * REST endpoint.
+ */
+export type NoteEditorMentionSearchOptionsBag = {
+    /** Gets or sets the name to use when searching for results. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the encrypted token that contains additional
+     * search details and permissions.
+     */
+    token?: string | null;
+};

package/types/ViewModels/Rest/Controls/noteEditorMentionSearchResultsBag.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 { NoteMentionItemBag } from "@Obsidian/ViewModels/Controls/noteMentionItemBag";
+
+/** The results of the search operation. */
+export type NoteEditorMentionSearchResultsBag = {
+    /** Gets or sets the items that matched the search request. */
+    items?: NoteMentionItemBag[] | null;
+};

package/types/ViewModels/Rest/Controls/pagePickerGetChildrenOptionsBag.d.ts

@@ -0,0 +1,57 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetChildren API action of
+ * the PagePicker control.
+ */
+export type PagePickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the unique identifier of the parent page whose
+     * children are to be enumerated.
+     */
+    guid?: Guid | null;
+
+    /**
+     * Gets or sets the list of unique identifiers of pages that should
+     * be excluded from the results
+     */
+    hidePageGuids?: Guid[] | null;
+
+    /**
+     * Gets or sets the unique identifier of the root page whose
+     * children are to be enumerated.
+     */
+    rootPageGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the site type to filter results by. */
+    siteType?: number | null;
+};

package/types/ViewModels/Rest/Controls/pagePickerGetPageNameOptionsBag.d.ts

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetPageName API action of
+ * the PagePicker control.
+ */
+export type PagePickerGetPageNameOptionsBag = {
+    /**
+     * Gets or sets the unique identifier of the page we're
+     * retrieving the name of.
+     */
+    pageGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/pagePickerGetPageRoutesOptionsBag.d.ts

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetActiveChildren API action of
+ * the LocationPicker control.
+ */
+export type PagePickerGetPageRoutesOptionsBag = {
+    /**
+     * Gets or sets the unique identifier of the page we're
+     * retrieving the routes for.
+     */
+    pageGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/pagePickerGetSelectedPageHierarchyOptionsBag.d.ts

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetActiveChildren API action of
+ * the LocationPicker control.
+ */
+export type PagePickerGetSelectedPageHierarchyOptionsBag = {
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /**
+     * Gets or sets the list of unique identifier of the pages we're
+     * retrieving the the parent hierarchy of.
+     */
+    selectedPageGuids?: Guid[] | null;
+};

package/types/ViewModels/Rest/Controls/pageRouteValueBag.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";
+
+/** The value you'll receive from the Obsidian PagePicker control. */
+export type PageRouteValueBag = {
+    /** The value representing the page, with a name and a GUID. */
+    page?: ListItemBag | null;
+
+    /** The value representing the route, with a name and a GUID. */
+    route?: ListItemBag | null;
+};

package/types/ViewModels/Rest/Controls/personLinkGetPopupHtmlOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the ValidateAddress API action of
+ * the LocationAddressPicker control.
+ */
+export type PersonLinkGetPopupHtmlOptionsBag = {
+    /** Guid of the location the results should be children of */
+    personId: number;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/personPickerSearchOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the Search API action of
+ * the PersonPicker control.
+ */
+export type PersonPickerSearchOptionsBag = {
+    /** Gets or sets the address. */
+    address?: string | null;
+
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets a value indicating whether to include businesses in the results. */
+    includeBusinesses: boolean;
+
+    /** Gets or sets a value indicating whether to include deceased people in the results. */
+    includeDeceased: boolean;
+
+    /** Gets or sets a value indicating whether [include details]. */
+    includeDetails: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the phone. */
+    phone?: string | null;
+};

package/types/ViewModels/Rest/Controls/phoneNumberBoxGetConfigurationOptionsBag.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>
+//
+
+/** Used for configuration options for the PhoneNumberBox */
+export type PhoneNumberBoxGetConfigurationOptionsBag = {
+    /** Gets or sets a value indicating whether [show SMS opt in]. */
+    showSmsOptIn: boolean;
+};

package/types/ViewModels/Rest/Controls/phoneNumberBoxGetConfigurationResultsBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <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 { PhoneNumberCountryCodeRulesConfigurationBag } from "@Obsidian/ViewModels/Rest/Controls/phoneNumberCountryCodeRulesConfigurationBag";
+
+/** The results from the GetConfiguration API action of the PhoneNumberBox control. */
+export type PhoneNumberBoxGetConfigurationResultsBag = {
+    /** The default country code */
+    defaultCountryCode?: string | null;
+
+    /** The list of validation/formatting rules for each country code */
+    rules?: Record<string, PhoneNumberCountryCodeRulesConfigurationBag[]> | null;
+
+    /** Gets or sets the SMS opt in text. */
+    smsOptInText?: string | null;
+};

package/types/ViewModels/Rest/Controls/phoneNumberCountryCodeRulesConfigurationBag.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 rule for validating a phone number and formatting it if it matches */
+export type PhoneNumberCountryCodeRulesConfigurationBag = {
+    /** String used in a string replace call to format a phone number that matches the Match regex. */
+    format?: string | null;
+
+    /** Regex to determine if the a phone number is valid */
+    match?: string | null;
+};

package/types/ViewModels/Rest/Controls/racePickerGetRacesResultsBag.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";
+
+/** The results from the GetRaces API action of the RacePicker control. */
+export type RacePickerGetRacesResultsBag = {
+    /** String label for the control */
+    label?: string | null;
+
+    /** List of ListItemBags representing all the race options */
+    races?: ListItemBag[] | null;
+};

package/types/ViewModels/Rest/Controls/registrationInstancePickerGetRegistrationInstancesOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/** The options that can be passed to the GetRegistrationInstances API action of the RegistrationInstancePicker control. */
+export type RegistrationInstancePickerGetRegistrationInstancesOptionsBag = {
+    /** The unique identifier of the Registration Template you want the instances for. */
+    registrationTemplateGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/registrationInstancePickerGetRegistrationTemplateForInstanceOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/** The options that can be passed to the GetRegistrationTemplateForInstance API action of the RegistrationInstancePicker control. */
+export type RegistrationInstancePickerGetRegistrationTemplateForInstanceOptionsBag = {
+    /** The unique identifier of the Registration Instance you want the template for. */
+    registrationInstanceGuid?: Guid | null;
+
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+};