UNPKG

@microsoft/msgraph-beta-sdk-communications

Version:
93 lines 5.4 kB
import { type Prompt, type RecordOperation } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type AdditionalDataHolder, type BackedModel, type BaseRequestBuilder, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions'; /** * Creates a new instance of the appropriate class based on discriminator value * @param parseNode The parse node to use to read the discriminator value and create the object * @returns {RecordResponsePostRequestBody} */ export declare function createRecordResponsePostRequestBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>); /** * The deserialization information for the current model * @param RecordResponsePostRequestBody The instance to deserialize into. * @returns {Record<string, (node: ParseNode) => void>} */ export declare function deserializeIntoRecordResponsePostRequestBody(recordResponsePostRequestBody?: Partial<RecordResponsePostRequestBody> | undefined): Record<string, (node: ParseNode) => void>; export interface RecordResponsePostRequestBody extends AdditionalDataHolder, BackedModel, Parsable { /** * Stores model information. */ backingStoreEnabled?: boolean | null; /** * The bargeInAllowed property */ bargeInAllowed?: boolean | null; /** * The clientContext property */ clientContext?: string | null; /** * The initialSilenceTimeoutInSeconds property */ initialSilenceTimeoutInSeconds?: number | null; /** * The maxRecordDurationInSeconds property */ maxRecordDurationInSeconds?: number | null; /** * The maxSilenceTimeoutInSeconds property */ maxSilenceTimeoutInSeconds?: number | null; /** * The playBeep property */ playBeep?: boolean | null; /** * The prompts property */ prompts?: Prompt[] | null; /** * The stopTones property */ stopTones?: string[] | null; /** * The streamWhileRecording property */ streamWhileRecording?: boolean | null; } /** * Provides operations to call the recordResponse method. */ export interface RecordResponseRequestBuilder extends BaseRequestBuilder<RecordResponseRequestBuilder> { /** * Record a short audio response from the caller. A bot can use this API to capture a voice response from a caller after they're prompted for a response. For more information about how to handle operations, see commsOperation. This action isn't intended to record the entire call. The maximum length of recording is 2 minutes.The Cloud Communications Platform doesn't save the recording permanently and discards it shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value provided in the completed notification. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<RecordOperation>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/call-record?view=graph-rest-beta|Find more info here} */ post(body: RecordResponsePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<RecordOperation | undefined>; /** * Record a short audio response from the caller. A bot can use this API to capture a voice response from a caller after they're prompted for a response. For more information about how to handle operations, see commsOperation. This action isn't intended to record the entire call. The maximum length of recording is 2 minutes.The Cloud Communications Platform doesn't save the recording permanently and discards it shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value provided in the completed notification. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: RecordResponsePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Serializes information the current object * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type. * @param RecordResponsePostRequestBody The instance to serialize from. * @param writer Serialization writer to use to serialize this model */ export declare function serializeRecordResponsePostRequestBody(writer: SerializationWriter, recordResponsePostRequestBody?: Partial<RecordResponsePostRequestBody> | undefined | null, isSerializingDerivedType?: boolean): void; /** * Uri template for the request builder. */ export declare const RecordResponseRequestBuilderUriTemplate = "{+baseurl}/communications/calls/{call%2Did}/recordResponse"; /** * Metadata for all the requests in the request builder. */ export declare const RecordResponseRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map