@microsoft/msgraph-beta-sdk-admin/admin/serviceAnnouncement/messages/index.d.ts

Admin fluent API for Microsoft Graph

import { type ServiceUpdateMessage, type ServiceUpdateMessageCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type ArchiveRequestBuilder } from './archive/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type FavoriteRequestBuilder } from './favorite/index.js';
import { type ServiceUpdateMessageItemRequestBuilder } from './item/index.js';
import { type MarkReadRequestBuilder } from './markRead/index.js';
import { type MarkUnreadRequestBuilder } from './markUnread/index.js';
import { type UnarchiveRequestBuilder } from './unarchive/index.js';
import { type UnfavoriteRequestBuilder } from './unfavorite/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the messages property of the microsoft.graph.serviceAnnouncement entity.
 */
export interface MessagesRequestBuilder extends BaseRequestBuilder<MessagesRequestBuilder> {
    /**
     * Provides operations to call the archive method.
     */
    get archive(): ArchiveRequestBuilder;
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to call the favorite method.
     */
    get favorite(): FavoriteRequestBuilder;
    /**
     * Provides operations to call the markRead method.
     */
    get markRead(): MarkReadRequestBuilder;
    /**
     * Provides operations to call the markUnread method.
     */
    get markUnread(): MarkUnreadRequestBuilder;
    /**
     * Provides operations to call the unarchive method.
     */
    get unarchive(): UnarchiveRequestBuilder;
    /**
     * Provides operations to call the unfavorite method.
     */
    get unfavorite(): UnfavoriteRequestBuilder;
    /**
     * Provides operations to manage the messages property of the microsoft.graph.serviceAnnouncement entity.
     * @param serviceUpdateMessageId The unique identifier of serviceUpdateMessage
     * @returns {ServiceUpdateMessageItemRequestBuilder}
     */
    byServiceUpdateMessageId(serviceUpdateMessageId: string): ServiceUpdateMessageItemRequestBuilder;
    /**
     * Retrieve the serviceUpdateMessage resources from the messages navigation property. This operation retrieves all service update messages that exist for the tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<ServiceUpdateMessageCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/serviceannouncement-list-messages?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<MessagesRequestBuilderGetQueryParameters> | undefined): Promise<ServiceUpdateMessageCollectionResponse | undefined>;
    /**
     * Create new navigation property to messages for admin
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<ServiceUpdateMessage>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: ServiceUpdateMessage, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ServiceUpdateMessage | undefined>;
    /**
     * Retrieve the serviceUpdateMessage resources from the messages navigation property. This operation retrieves all service update messages that exist for the tenant.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<MessagesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to messages for admin
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: ServiceUpdateMessage, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve the serviceUpdateMessage resources from the messages navigation property. This operation retrieves all service update messages that exist for the tenant.
 */
export interface MessagesRequestBuilderGetQueryParameters {
    /**
     * 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 MessagesRequestBuilderUriTemplate = "{+baseurl}/admin/serviceAnnouncement/messages{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const MessagesRequestBuilderNavigationMetadata: Record<Exclude<keyof MessagesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const MessagesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map