@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Rest/Controls/registrationTemplatePickerGetChildrenOptionsBag.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 GetChildren API action of
+ * the RegistrationTemplatePicker control.
+ */
+export type RegistrationTemplatePickerGetChildrenOptionsBag = {
+    /**
+     * 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/reminderTypePickerGetReminderTypesOptionsBag.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 GetAchievementTypes API action of
+ * the AchievementTypePicker control.
+ */
+export type ReminderTypePickerGetReminderTypesOptionsBag = {
+    /** Gets or sets the Entity Type Guid */
+    entityTypeGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/reportPickerGetChildrenOptionsBag.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 GetChildren API action of
+ * the RegistrationTemplatePicker control.
+ */
+export type ReportPickerGetChildrenOptionsBag = {
+    /** Guid of an Entity Type to filter results by the reports that relate to this entity type. */
+    entityTypeGuid?: Guid | null;
+
+    /** A list of category GUIDs to filter the results. */
+    includeCategoryGuids?: Guid[] | null;
+
+    /**
+     * 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/saveFinancialAccountFormSaveAccountOptionsBag.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 FormSaveAccount API action of
+ * the SaveFinancialAccount control.
+ */
+export type SaveFinancialAccountFormSaveAccountOptionsBag = {
+    /** Gets or sets the gateway unique identifier. */
+    gatewayGuid?: Guid | null;
+
+    /** Gets or sets the gateway token. */
+    gatewayPersonIdentifier?: string | null;
+
+    /** Gets or sets the password. */
+    password?: string | null;
+
+    /** Gets or sets the name of the saved account. */
+    savedAccountName?: string | null;
+
+    /** Gets or sets the transaction code. */
+    transactionCode?: string | null;
+
+    /** Gets or sets the username. */
+    username?: string | null;
+};

package/types/ViewModels/Rest/Controls/saveFinancialAccountFormSaveAccountResultBag.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 result that will be returned from the FormSaveAccount API action of
+ * the SaveFinancialAccount control.
+ */
+export type SaveFinancialAccountFormSaveAccountResultBag = {
+    /** Gets or sets the detail. */
+    detail?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is success. */
+    isSuccess: boolean;
+
+    /** Gets or sets the title. */
+    title?: string | null;
+};

package/types/ViewModels/Rest/Controls/schedulePickerGetChildrenOptionsBag.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 GetChildren API action of
+ * the RegistrationTemplatePicker control.
+ */
+export type SchedulePickerGetChildrenOptionsBag = {
+    /** Whether to include schedules marked as inactive in the results. */
+    includeInactiveItems: boolean;
+
+    /**
+     * 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/stepStatusPickerGetStepStatusesOptionsBag.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 GetStepStatuses API action of
+ * the StepStatusPicker control.
+ */
+export type StepStatusPickerGetStepStatusesOptionsBag = {
+    /** The GUID of the step program that this step status is part of. */
+    stepProgramGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/stepTypePickerGetStepTypesOptionsBag.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 GetStepTypes API action of
+ * the StepTypePicker control.
+ */
+export type StepTypePickerGetStepTypesOptionsBag = {
+    /** The GUID of the step program that this step type is part of. */
+    stepProgramGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/structuredContentEditorConfigurationBag.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 configuration options returned from the GetConfiguration API action of
+ * the StructuredContentEditor control.
+ */
+export type StructuredContentEditorConfigurationBag = {
+    /** Gets or sets the tools script. */
+    toolsScript?: string | null;
+};

package/types/ViewModels/Rest/Controls/structuredContentEditorGetConfigurationOptionsBag.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 GetConfiguration API action of
+ * the StructuredContentEditor control.
+ */
+export type StructuredContentEditorGetConfigurationOptionsBag = {
+    /** Gets or sets the structured content tools value unique identifier. */
+    structuredContentToolsValueGuid?: Guid | null;
+};

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

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <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 GetChildren API action of
+ * the RegistrationTemplatePicker control.
+ */
+export type WorkflowActionTypePickerGetChildrenOptionsBag = {
+    /**
+     * The identifier of the parent folder/category.
+     * If null then the folders are being requested.
+     */
+    parentId: number;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/workflowPickerGetWorkflowTypeForWorkflowOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetWorkflows API action of
+ * the WorkflowPicker control.
+ */
+export type WorkflowPickerGetWorkflowTypeForWorkflowOptionsBag = {
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /** The GUID of the workflow type that this workflow is part of. */
+    workflowGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/workflowPickerGetWorkflowsOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetWorkflows API action of
+ * the WorkflowPicker control.
+ */
+export type WorkflowPickerGetWorkflowsOptionsBag = {
+    /** The security grant token to use when performing authorization checks. */
+    securityGrantToken?: string | null;
+
+    /** The GUID of the workflow type that this workflow is part of. */
+    workflowTypeGuid?: Guid | null;
+};

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

@@ -0,0 +1,90 @@
+//------------------------------------------------------------------------------
+// <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 GetWorkflowTypes API action of
+ * the WorkflowTypePicker control.
+ */
+export type WorkflowTypePickerGetWorkflowTypesOptionsBag = {
+    /**
+     * 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 item property value to compare against. This should
+     * be either an integer-string, Guid-string or plain string for
+     * comparison. And must match the database property type.
+     */
+    entityTypeGuidFilter?: Guid | null;
+
+    /**
+     * Gets or sets a value indicating whether items should be loaded
+     * or only categories.
+     */
+    getCategorizedItems: boolean;
+
+    /**
+     * Gets or sets a value indicating whether categories that have no
+     * child categories and no items should be included.
+     */
+    includeCategoriesWithoutChildren: boolean;
+
+    /**
+     * Gets or sets a value indicating whether inactive items should be
+     * included in the results. If the entity type does not support the
+     * IsActive property then this value will be ignored.
+     */
+    includeInactiveItems: boolean;
+
+    /**
+     * Gets or sets a value indicating whether entity items without a name
+     * should be included in the results. Only applies if
+     * Rock.ViewModels.Rest.Controls.WorkflowTypePickerGetWorkflowTypesOptionsBag.GetCategorizedItems is true.
+     */
+    includeUnnamedEntityItems: boolean;
+
+    /**
+     * Gets or sets a value indicating whether child categories and items
+     * are loaded automatically. If true then all descendant categories
+     * will be loaded along with the items if Rock.ViewModels.Rest.Controls.WorkflowTypePickerGetWorkflowTypesOptionsBag.GetCategorizedItems
+     * is also true. This results in the Children property of the results
+     * being null to indicate they must be loaded on demand.
+     */
+    lazyLoad: boolean;
+
+    /**
+     * 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/Utilities/updatePersonPreferencesAccessedOptionsBag.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>
+//
+
+/**
+ * Defines the options that can be sent to one of the PersonPreferencesAccessed
+ * API endpoints.
+ */
+export type UpdatePersonPreferencesAccessedOptionsBag = {
+    /**
+     * Gets or sets the keys that were accessed and should have their
+     * LastAccessedDateTime value updated.
+     */
+    keys?: string[] | null;
+};

package/types/ViewModels/Rest/Utilities/updatePersonPreferencesOptionsBag.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>
+//
+
+/**
+ * Defines the options that can be sent to one of the PersonPreferences API
+ * endpoints when setting preference values.
+ */
+export type UpdatePersonPreferencesOptionsBag = {
+    /** Gets or sets the preference keys and values that should be set. */
+    preferences?: Record<string, string> | null;
+};