UNPKG

@microsoft/msgraph-beta-sdk-groups

Version:
98 lines 5.28 kB
import { type DirectorySetting, type DirectorySettingCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type DirectorySettingItemRequestBuilder } from './item/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the settings property of the microsoft.graph.group entity. */ export interface SettingsRequestBuilder extends BaseRequestBuilder<SettingsRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the settings property of the microsoft.graph.group entity. * @param directorySettingId The unique identifier of directorySetting * @returns {DirectorySettingItemRequestBuilder} */ byDirectorySettingId(directorySettingId: string): DirectorySettingItemRequestBuilder; /** * Settings that can govern this group's behavior, like whether members can invite guest users to the group. Nullable. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<DirectorySettingCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code */ get(requestConfiguration?: RequestConfiguration<SettingsRequestBuilderGetQueryParameters> | undefined): Promise<DirectorySettingCollectionResponse | undefined>; /** * Create a new setting based on the templates available in directorySettingTemplates. These settings can be at the tenant-level or at the group level. Group settings apply to only Microsoft 365 groups. The template named Group.Unified can be used to configure tenant-wide Microsoft 365 group settings, while the template named Group.Unified.Guest can be used to configure group-specific settings. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<DirectorySetting>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-post-settings?view=graph-rest-beta|Find more info here} */ post(body: DirectorySetting, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<DirectorySetting | undefined>; /** * Settings that can govern this group's behavior, like whether members can invite guest users to the group. Nullable. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<SettingsRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Create a new setting based on the templates available in directorySettingTemplates. These settings can be at the tenant-level or at the group level. Group settings apply to only Microsoft 365 groups. The template named Group.Unified can be used to configure tenant-wide Microsoft 365 group settings, while the template named Group.Unified.Guest can be used to configure group-specific settings. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: DirectorySetting, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Settings that can govern this group's behavior, like whether members can invite guest users to the group. Nullable. */ export interface SettingsRequestBuilderGetQueryParameters { /** * Include count of items */ count?: boolean; /** * Expand related entities */ expand?: string[]; /** * Filter items by property values */ filter?: string; /** * Order items by property values */ orderby?: string[]; /** * Search items by search phrases */ search?: string; /** * Select properties to be returned */ select?: string[]; /** * Skip the first n items */ skip?: number; /** * Show only the first n items */ top?: number; } /** * Uri template for the request builder. */ export declare const SettingsRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/settings{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const SettingsRequestBuilderNavigationMetadata: Record<Exclude<keyof SettingsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const SettingsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map