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

Users fluent API for Microsoft Graph

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