@microsoft/msgraph-beta-sdk-solutions/solutions/virtualEvents/townhalls/index.d.ts

Solutions fluent API for Microsoft Graph

import { type VirtualEventTownhall, type VirtualEventTownhallCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type GetByUserIdAndRoleWithUserIdWithRoleRequestBuilder } from './getByUserIdAndRoleWithUserIdWithRole/index.js';
import { type GetByUserRoleWithRoleRequestBuilder } from './getByUserRoleWithRole/index.js';
import { type VirtualEventTownhallItemRequestBuilder } 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 townhalls property of the microsoft.graph.virtualEventsRoot entity.
 */
export interface TownhallsRequestBuilder extends BaseRequestBuilder<TownhallsRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the townhalls property of the microsoft.graph.virtualEventsRoot entity.
     * @param virtualEventTownhallId The unique identifier of virtualEventTownhall
     * @returns {VirtualEventTownhallItemRequestBuilder}
     */
    byVirtualEventTownhallId(virtualEventTownhallId: string): VirtualEventTownhallItemRequestBuilder;
    /**
     * Read the properties and relationships of a virtualEventTownhall object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<VirtualEventTownhallCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    get(requestConfiguration?: RequestConfiguration<TownhallsRequestBuilderGetQueryParameters> | undefined): Promise<VirtualEventTownhallCollectionResponse | undefined>;
    /**
     * Provides operations to call the getByUserIdAndRole method.
     * @param role Usage: role='{role}'
     * @param userId Usage: userId='{userId}'
     * @returns {GetByUserIdAndRoleWithUserIdWithRoleRequestBuilder}
     */
    getByUserIdAndRoleWithUserIdWithRole(role: string | undefined, userId: string | undefined): GetByUserIdAndRoleWithUserIdWithRoleRequestBuilder;
    /**
     * Provides operations to call the getByUserRole method.
     * @param role Usage: role='{role}'
     * @returns {GetByUserRoleWithRoleRequestBuilder}
     */
    getByUserRoleWithRole(role: string | undefined): GetByUserRoleWithRoleRequestBuilder;
    /**
     * Create a new virtualEventTownhall object in draft mode.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<VirtualEventTownhall>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/virtualeventsroot-post-townhalls?view=graph-rest-beta|Find more info here}
     */
    post(body: VirtualEventTownhall, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<VirtualEventTownhall | undefined>;
    /**
     * Read the properties and relationships of a virtualEventTownhall object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<TownhallsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create a new virtualEventTownhall object in draft mode.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: VirtualEventTownhall, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Read the properties and relationships of a virtualEventTownhall object.
 */
export interface TownhallsRequestBuilderGetQueryParameters {
    /**
     * 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 TownhallsRequestBuilderUriTemplate = "{+baseurl}/solutions/virtualEvents/townhalls{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const TownhallsRequestBuilderNavigationMetadata: Record<Exclude<keyof TownhallsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const TownhallsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map