@microsoft/msgraph-beta-sdk-admin
Version:
Admin fluent API for Microsoft Graph
93 lines • 4.46 kB
TypeScript
import { type MailboxFolderCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type DeltaRequestBuilder } from './delta/index.js';
import { type MailboxFolderItemRequestBuilder } 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 folders property of the microsoft.graph.mailbox entity.
*/
export interface FoldersRequestBuilder extends BaseRequestBuilder<FoldersRequestBuilder> {
/**
* 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 call the delta method.
* @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 delta(): DeltaRequestBuilder;
/**
* Provides operations to manage the folders property of the microsoft.graph.mailbox entity.
* @param mailboxFolderId The unique identifier of mailboxFolder
* @returns {MailboxFolderItemRequestBuilder}
* @deprecated Private preview for Import Export APIs as of 2021-08/PrivatePreview:importExport on 2021-08-19 and will be removed 2021-11-15
*/
byMailboxFolderId(mailboxFolderId: string): MailboxFolderItemRequestBuilder;
/**
* Get all the mailboxFolder objects in the specified mailbox, including any search folders.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<MailboxFolderCollectionResponse>}
* @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
* @see {@link https://learn.microsoft.com/graph/api/mailbox-list-folders?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<FoldersRequestBuilderGetQueryParameters> | undefined): Promise<MailboxFolderCollectionResponse | undefined>;
/**
* Get all the mailboxFolder objects in the specified mailbox, including any search folders.
* @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<FoldersRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
* Get all the mailboxFolder objects in the specified mailbox, including any search folders.
*/
export interface FoldersRequestBuilderGetQueryParameters {
/**
* 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 FoldersRequestBuilderUriTemplate = "{+baseurl}/admin/exchange/mailboxes/{mailbox%2Did}/folders{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const FoldersRequestBuilderNavigationMetadata: Record<Exclude<keyof FoldersRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const FoldersRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map