@microsoft/msgraph-beta-sdk-admin
Version:
Admin fluent API for Microsoft Graph
103 lines • 5.15 kB
TypeScript
import { type MessageRecipient, type MessageRecipientCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type MessageRecipientItemRequestBuilder } 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 recipients property of the microsoft.graph.messageTrace entity.
*/
export interface RecipientsRequestBuilder extends BaseRequestBuilder<RecipientsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the recipients property of the microsoft.graph.messageTrace entity.
* @param messageRecipientId The unique identifier of messageRecipient
* @returns {MessageRecipientItemRequestBuilder}
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
byMessageRecipientId(messageRecipientId: string): MessageRecipientItemRequestBuilder;
/**
* Get recipients from admin
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<MessageRecipientCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
get(requestConfiguration?: RequestConfiguration<RecipientsRequestBuilderGetQueryParameters> | undefined): Promise<MessageRecipientCollectionResponse | undefined>;
/**
* Create new navigation property to recipients for admin
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<MessageRecipient>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
post(body: MessageRecipient, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<MessageRecipient | undefined>;
/**
* Get recipients from admin
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<RecipientsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to recipients for admin
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
toPostRequestInformation(body: MessageRecipient, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Get recipients from admin
*/
export interface RecipientsRequestBuilderGetQueryParameters {
/**
* 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 RecipientsRequestBuilderUriTemplate = "{+baseurl}/admin/exchange/messageTraces/{messageTrace%2Did}/recipients{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const RecipientsRequestBuilderNavigationMetadata: Record<Exclude<keyof RecipientsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const RecipientsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map