@microsoft/msgraph-beta-sdk-communications
Version:
Communications fluent API for Microsoft Graph
103 lines • 4.91 kB
TypeScript
import { type Call, type CallCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type CallItemRequestBuilder } from './item/index.js';
import { type LogTeleconferenceDeviceQualityRequestBuilder } from './logTeleconferenceDeviceQuality/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the calls property of the microsoft.graph.cloudCommunications entity.
*/
export interface CallsRequestBuilder extends BaseRequestBuilder<CallsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to call the logTeleconferenceDeviceQuality method.
*/
get logTeleconferenceDeviceQuality(): LogTeleconferenceDeviceQualityRequestBuilder;
/**
* Provides operations to manage the calls property of the microsoft.graph.cloudCommunications entity.
* @param callId The unique identifier of call
* @returns {CallItemRequestBuilder}
*/
byCallId(callId: string): CallItemRequestBuilder;
/**
* Retrieve the properties and relationships of a call object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<CallCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<CallsRequestBuilderGetQueryParameters> | undefined): Promise<CallCollectionResponse | undefined>;
/**
* Create call enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. You need to register the calling bot and go through the list of permissions needed. This API supports the following PSTN scenarios:
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Call>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/application-post-calls?view=graph-rest-beta|Find more info here}
*/
post(body: Call, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Call | undefined>;
/**
* Retrieve the properties and relationships of a call object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<CallsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create call enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. You need to register the calling bot and go through the list of permissions needed. This API supports the following PSTN scenarios:
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: Call, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Retrieve the properties and relationships of a call object.
*/
export interface CallsRequestBuilderGetQueryParameters {
/**
* 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 CallsRequestBuilderUriTemplate = "{+baseurl}/communications/calls{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const CallsRequestBuilderNavigationMetadata: Record<Exclude<keyof CallsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const CallsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map