@microsoft/msgraph-beta-sdk-users/users/item/profile/names/index.d.ts

Users fluent API for Microsoft Graph

import { type PersonName, type PersonNameCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type PersonNameItemRequestBuilder } 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 names property of the microsoft.graph.profile entity.
 */
export interface NamesRequestBuilder extends BaseRequestBuilder<NamesRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the names property of the microsoft.graph.profile entity.
     * @param personNameId The unique identifier of personName
     * @returns {PersonNameItemRequestBuilder}
     */
    byPersonNameId(personNameId: string): PersonNameItemRequestBuilder;
    /**
     * Represents the names a user has added to their profile.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<PersonNameCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    get(requestConfiguration?: RequestConfiguration<NamesRequestBuilderGetQueryParameters> | undefined): Promise<PersonNameCollectionResponse | undefined>;
    /**
     * Create new navigation property to names for users
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<PersonName>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: PersonName, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PersonName | undefined>;
    /**
     * Represents the names a user has added to their profile.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<NamesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to names for users
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: PersonName, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Represents the names a user has added to their profile.
 */
export interface NamesRequestBuilderGetQueryParameters {
    /**
     * 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 NamesRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/profile/names{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const NamesRequestBuilderNavigationMetadata: Record<Exclude<keyof NamesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const NamesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map