@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Rest/Controls/eventItemPickerGetEventItemsOptionsBag.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 GetEventItems API action of
+ * the EventItemPicker control.
+ */
+export type EventItemPickerGetEventItemsOptionsBag = {
+    /** Whether or not to include inactive event items */
+    includeInactive: boolean;
+};

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

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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 GetFinancialGateways API action of
+ * the FinancialGatewayPicker control.
+ */
+export type FinancialGatewayPickerGetFinancialGatewaysOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether inactive gateways should be included.
+     * This checks both the FinancialGateway model and the GatewayComponent.
+     */
+    includeInactive: boolean;
+
+    /**
+     * If set to true then gateways that do not support Rock initiated transactions will be included.
+     * These GatewayComponents are used to download externally created transactions and do not allow Rock
+     * to create the transaction.
+     * This property does not affect if inactive gateways are shown or not.
+     * The inclusion or exclusion of inactive gateways is controlled exclusively by the "IncludeInactive" property.
+     */
+    showAllGatewayComponents: boolean;
+};

package/types/ViewModels/Rest/Controls/followingGetFollowingOptionsBag.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 GetFollowing API action of
+ * the Following control.
+ */
+export type FollowingGetFollowingOptionsBag = {
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.FollowingGetFollowingOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the purpose key to use when checking if the entity is
+     * currently being followed.
+     */
+    purposeKey?: string | null;
+};

package/types/ViewModels/Rest/Controls/followingGetFollowingResponseBag.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 response that can be returned by the GetFollowing API action of
+ * the Following control.
+ */
+export type FollowingGetFollowingResponseBag = {
+    /** Gets or sets a value indicating whether the entity is being followed. */
+    isFollowing: boolean;
+};

package/types/ViewModels/Rest/Controls/followingSetFollowingOptionsBag.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 SetFollowing API action of
+ * the Following control.
+ */
+export type FollowingSetFollowingOptionsBag = {
+    /**
+     * Gets or sets the entity key used with Rock.ViewModels.Rest.Controls.FollowingSetFollowingOptionsBag.EntityTypeGuid
+     * to locate the entity.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the entity type unique identifier. */
+    entityTypeGuid?: Guid | null;
+
+    /** Gets or sets a value indicating whether the entity should be followed. */
+    isFollowing: boolean;
+
+    /**
+     * Gets or sets the purpose key to use when checking if the entity is
+     * currently being followed.
+     */
+    purposeKey?: string | null;
+};

package/types/ViewModels/Rest/Controls/geoPickerGetGoogleMapSettingsOptionsBag.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 GetGoogleMapSettings API action of
+ * the GeoPicker control.
+ */
+export type GeoPickerGetGoogleMapSettingsOptionsBag = {
+    /** Identifier for a Map Styles Defined Value */
+    mapStyleValueGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/geoPickerGetSettingsOptionsBag.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 GetGoogleMapSettings API action of
+ * the GeoPicker control.
+ */
+export type GeoPickerGetSettingsOptionsBag = {
+    /** Identifier for a Map Styles Defined Value */
+    mapStyleValueGuid?: Guid | null;
+};

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

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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 settings returned from the GetGoogleMapSettings API action of
+ * the GeoPicker control.
+ */
+export type GeoPickerGoogleMapSettingsBag = {
+    /** Latitude coordinate that the Google Map should be centered on */
+    centerLatitude?: number | null;
+
+    /** Longitude coordinate that the Google Map should be centered on */
+    centerLongitude?: number | null;
+
+    /** API key for using Google Maps */
+    googleApiKey?: string | null;
+
+    /** Styles for how a Google Map should look */
+    mapStyle?: string | null;
+
+    /** The color of a marker or polygon drawn on a Google Map */
+    markerColor?: string | null;
+};

package/types/ViewModels/Rest/Controls/geoPickerSettingsBag.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 settings returned from the GetGoogleMapSettings API action of
+ * the GeoPicker control.
+ */
+export type GeoPickerSettingsBag = {
+    /** Latitude coordinate that the Google Map should be centered on */
+    centerLatitude?: number | null;
+
+    /** Longitude coordinate that the Google Map should be centered on */
+    centerLongitude?: number | null;
+
+    /** Styles for how a Google Map should look */
+    mapStyle?: string | null;
+
+    /** The color of a marker or polygon drawn on a Google Map */
+    markerColor?: string | null;
+};

package/types/ViewModels/Rest/Controls/gradePickerGetGradesOptionsBag.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 GetGrades API action of
+ * the GradePicker control.
+ */
+export type GradePickerGetGradesOptionsBag = {
+    /** Type of the container the components are within */
+    useAbbreviation: boolean;
+
+    /** Whether to use a GUID instead of a grade offset as the picker value */
+    useGuidAsValue: boolean;
+};

package/types/ViewModels/Rest/Controls/groupAndRolePickerGetRolesOptionsBag.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 GetRoles API action of
+ * the GroupAndRolePicker control.
+ */
+export type GroupAndRolePickerGetRolesOptionsBag = {
+    /** GUID of the group type we want to filter roles by */
+    groupTypeGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/groupMemberPickerGetGroupMembersOptionsBag.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 GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type GroupMemberPickerGetGroupMembersOptionsBag = {
+    /** GUID of the group the member is part of. */
+    groupGuid?: Guid | null;
+};

package/types/ViewModels/Rest/Controls/groupPickerGetChildrenOptionsBag.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 GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type GroupPickerGetChildrenOptionsBag = {
+    /** GUID of the group the member is part of. */
+    guid?: Guid | null;
+
+    /** List of group types IDs to limit to groups of those types. */
+    includedGroupTypeGuids?: Guid[] | null;
+
+    /** Whether to include inactive groups or not. */
+    includeInactiveGroups: boolean;
+
+    /** Whether to limit to only groups that have RSVPs enabled. */
+    limitToRSVPEnabled: boolean;
+
+    /** Whether to limit to only groups that have scheduling enabled. */
+    limitToSchedulingEnabled: boolean;
+
+    /** GUID of the group you want to use as the root. */
+    rootGroupGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/groupRolePickerGetAllForGroupRoleOptionsBag.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 GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type GroupRolePickerGetAllForGroupRoleOptionsBag = {
+    /** Exclude group roles from the returned list that match any of the given identifiers. */
+    excludeGroupRoles?: Guid[] | null;
+
+    /**
+     * Unique identifier of a group role. Used to get the rest of the data
+     * about this role, and the group type it belongs to.
+     */
+    groupRoleGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/groupRolePickerGetAllForGroupRoleResultsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * The options that can be passed to the GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type GroupRolePickerGetAllForGroupRoleResultsBag = {
+    /** List of group roles to include in the group role picker. */
+    groupRoles?: ListItemBag[] | null;
+
+    /** Data for the selected group role, used by the group role picker. */
+    selectedGroupRole?: ListItemBag | null;
+
+    /** Data for the selected group type, used by the group type picker. */
+    selectedGroupType?: ListItemBag | null;
+};

package/types/ViewModels/Rest/Controls/groupRolePickerGetGroupRolesOptionsBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetGroupMembers API action of
+ * the GroupMemberPicker control.
+ */
+export type GroupRolePickerGetGroupRolesOptionsBag = {
+    excludeGroupRoles?: Guid[] | null;
+
+    groupTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};