@rockrms/obsidian-framework 1.16.3-rc.1

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

@@ -0,0 +1,82 @@
+//------------------------------------------------------------------------------
+// <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 { RequirementLevel } from "@Obsidian/Enums/Controls/requirementLevel";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * The configuration options returned from the GetConfiguration API action of
+ * the AddressControl control.
+ */
+export type AddressControlConfigurationBag = {
+    /** Requirement level for the address line 1 field */
+    addressLine1Requirement: RequirementLevel;
+
+    /** Requirement level for the address line 2 field */
+    addressLine2Requirement: RequirementLevel;
+
+    /** Configured label for the city field (based on country's configuration) */
+    cityLabel?: string | null;
+
+    /** Requirement level for the city field */
+    cityRequirement: RequirementLevel;
+
+    /** List of countries for the country picker */
+    countries?: ListItemBag[] | null;
+
+    /** If no other country is set, this should be the default one selected */
+    defaultCountry?: string | null;
+
+    /** If no other state is set, this should be the default one selected */
+    defaultState?: string | null;
+
+    /** Whether there are any states for the picker. If not, use a text field */
+    hasStateList: boolean;
+
+    /** Configured label for the locality/county field (based on country's configuration) */
+    localityLabel?: string | null;
+
+    /** Requirement level for the locality field */
+    localityRequirement: RequirementLevel;
+
+    /** Configured label for the postal code field (based on country's configuration) */
+    postalCodeLabel?: string | null;
+
+    /** Requirement level for the postal code field */
+    postalCodeRequirement: RequirementLevel;
+
+    /** Currently selected country */
+    selectedCountry?: string | null;
+
+    /** Whether to show the country picker */
+    showCountrySelection: boolean;
+
+    /** Configured label for the state field (based on country's configuration) */
+    stateLabel?: string | null;
+
+    /** Requirement level for the state field */
+    stateRequirement: RequirementLevel;
+
+    /** List of states for the state picker (if any) */
+    states?: ListItemBag[] | null;
+};

package/types/ViewModels/Rest/Controls/addressControlGetConfigurationOptionsBag.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 GetConfiguration API action of
+ * the AddressControl control.
+ */
+export type AddressControlGetConfigurationOptionsBag = {
+    /** The 2-character code name of the selected country */
+    countryCode?: string | null;
+
+    /** Whether or not to use an abbreviated form of the country name in the list */
+    useCountryAbbreviation: boolean;
+};

package/types/ViewModels/Rest/Controls/addressControlValidateAddressOptionsBag.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 ValidateAddress API action of
+ * the LocationAddressPicker control.
+ */
+export type AddressControlValidateAddressOptionsBag = {
+    /** Gets or sets the city. */
+    city?: string | null;
+
+    /** Gets or sets the country. */
+    country?: string | null;
+
+    /** Gets or sets the locality. */
+    locality?: string | null;
+
+    /** Gets or sets the postal code. */
+    postalCode?: string | null;
+
+    /** Gets or sets the state. */
+    state?: string | null;
+
+    /** Gets or sets the street1. */
+    street1?: string | null;
+
+    /** Gets or sets the street2. */
+    street2?: string | null;
+};

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

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+
+/** The results from the ValidateAddress API action of the LocationAddressPicker control. */
+export type AddressControlValidateAddressResultsBag = {
+    /** If the address is valid, this is an HTML string of the address */
+    address?: AddressControlBag | null;
+
+    /** If the address is valid, this is an HTML string of the address */
+    addressString?: string | null;
+
+    /** If invalid, this is the message stating what is wrong with the given address */
+    errorMessage?: string | null;
+
+    /** Whether the given address is valid or not */
+    isValid: boolean;
+};

package/types/ViewModels/Rest/Controls/assessmentTypePickerGetAssessmentTypesOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the GetAssessmentTypes API action of
+ * the AssessmentTypePicker control.
+ */
+export type AssessmentTypePickerGetAssessmentTypesOptionsBag = {
+    /** Whether to include assessment types that are marked inactive */
+    isInactiveIncluded?: boolean | null;
+};

package/types/ViewModels/Rest/Controls/assetStorageProviderPickerGetAssetStorageProvidersOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the GetAssetStorageProviders API action of
+ * the AssetStorageProviderPicker control.
+ */
+export type AssetStorageProviderPickerGetAssetStorageProvidersOptionsBag = {
+};

package/types/ViewModels/Rest/Controls/auditDetailGetAuditDetailsOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetAuditDetails API action of
+ * the AuditDetail control.
+ */
+export type AuditDetailGetAuditDetailsOptionsBag = {
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.AuditDetailGetAuditDetailsOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/badgeComponentPickerGetBadgeComponentsOptionsBag.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 GetBadgeComponents API action of
+ * the BadgeComponentPicker control.
+ */
+export type BadgeComponentPickerGetBadgeComponentsOptionsBag = {
+    /** GUID of the EntityType that the Badge Components you're fetching are able to apply to */
+    entityTypeGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/badgeListGetBadgesOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetBadges API action of
+ * the BadgeList control.
+ */
+export type BadgeListGetBadgesOptionsBag = {
+    /**
+     * Gets or sets the badge type guids being requested. If null or
+     * empty then all badges are returned.
+     */
+    badgeTypeGuids?: Guid[] | null;
+
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.BadgeListGetBadgesOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/badgePickerGetBadgesOptionsBag.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 GetBadges API action of
+ * the BadgePicker control.
+ */
+export type BadgePickerGetBadgesOptionsBag = {
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/binaryFilePickerGetBinaryFilesOptionsBag.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 GetBinaryFiles API action of
+ * the BinaryFilePicker control.
+ */
+export type BinaryFilePickerGetBinaryFilesOptionsBag = {
+    /** The type of binary files to search for */
+    binaryFileTypeGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/binaryFileTypePickerGetBinaryFileTypesOptionsBag.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>
+//
+
+/**
+ * The options that can be passed to the GetBinaryFileTypes API action of
+ * the BinaryFileTypePicker control.
+ */
+export type BinaryFileTypePickerGetBinaryFileTypesOptionsBag = {
+};

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

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 GetBlockTemplates API action of
+ * the BlockTemplatePicker control.
+ */
+export type BlockTemplatePickerGetBlockTemplatesOptionsBag = {
+    /** he security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /**
+     * Unique identifier of the Template Block Defined Value the templates
+     * we're fetching belong to.
+     */
+    templateBlockValueGuid?: Guid | null;
+};

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

@@ -0,0 +1,35 @@
+//------------------------------------------------------------------------------
+// <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 results from the GetBlockTemplates API action of the BlockTemplatePicker control. */
+export type BlockTemplatePickerGetBlockTemplatesResultsBag = {
+    guid?: Guid | null;
+
+    iconUrl?: string | null;
+
+    name?: string | null;
+
+    template?: string | null;
+};

package/types/ViewModels/Rest/Controls/campusAccountAmountPickerGetAccountsOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetAccounts API action of
+ * the ampusAccountAmountPicker control.
+ */
+export type CampusAccountAmountPickerGetAccountsOptionsBag = {
+    /** The Lava template for text label for each account */
+    accountHeaderTemplate?: string | null;
+
+    /**
+     * Whether to order accounts by the order they were given as SelectableAccountGuids.
+     * If not, will be ordered by Order property.
+     */
+    orderBySelectableAccountsIndex: boolean;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+
+    /** List of GUIDs of accounts to include in the list */
+    selectableAccountGuids?: Guid[] | null;
+};