UNPKG

@microsoft/msgraph-beta-sdk-groups

Version:
118 lines 5.18 kB
import { type DirectoryObjectCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type GraphApplicationRequestBuilder } from './graphApplication/index.js'; import { type GraphDeviceRequestBuilder } from './graphDevice/index.js'; import { type GraphGroupRequestBuilder } from './graphGroup/index.js'; import { type GraphOrgContactRequestBuilder } from './graphOrgContact/index.js'; import { type GraphServicePrincipalRequestBuilder } from './graphServicePrincipal/index.js'; import { type GraphUserRequestBuilder } from './graphUser/index.js'; import { type DirectoryObjectItemRequestBuilder } from './item/index.js'; import { type RefRequestBuilder } from './ref/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the members property of the microsoft.graph.group entity. */ export interface MembersRequestBuilder extends BaseRequestBuilder<MembersRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Casts the previous resource to application. */ get graphApplication(): GraphApplicationRequestBuilder; /** * Casts the previous resource to device. */ get graphDevice(): GraphDeviceRequestBuilder; /** * Casts the previous resource to group. */ get graphGroup(): GraphGroupRequestBuilder; /** * Casts the previous resource to orgContact. */ get graphOrgContact(): GraphOrgContactRequestBuilder; /** * Casts the previous resource to servicePrincipal. */ get graphServicePrincipal(): GraphServicePrincipalRequestBuilder; /** * Casts the previous resource to user. */ get graphUser(): GraphUserRequestBuilder; /** * Provides operations to manage the collection of group entities. */ get ref(): RefRequestBuilder; /** * Gets an item from the github.com/microsoftgraph/msgraph-sdk-typescript/.groups.item.members.item collection * @param directoryObjectId The unique identifier of directoryObject * @returns {DirectoryObjectItemRequestBuilder} */ byDirectoryObjectId(directoryObjectId: string): DirectoryObjectItemRequestBuilder; /** * Get a list of the group's direct members. A group can have users, contacts, devices, service principals, and other groups as members. This operation isn't transitive. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<DirectoryObjectCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-list-members?view=graph-rest-beta|Find more info here} */ get(requestConfiguration?: RequestConfiguration<MembersRequestBuilderGetQueryParameters> | undefined): Promise<DirectoryObjectCollectionResponse | undefined>; /** * Get a list of the group's direct members. A group can have users, contacts, devices, service principals, and other groups as members. This operation isn't transitive. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<MembersRequestBuilderGetQueryParameters> | undefined): RequestInformation; } /** * Get a list of the group's direct members. A group can have users, contacts, devices, service principals, and other groups as members. This operation isn't transitive. */ export interface MembersRequestBuilderGetQueryParameters { /** * 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 MembersRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/members{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const MembersRequestBuilderNavigationMetadata: Record<Exclude<keyof MembersRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const MembersRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map