Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions api/transcriptions-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf
return {
/**
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
* @summary Delete a specific transcription
* @summary Delete Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand Down Expand Up @@ -81,7 +81,7 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf
},
/**
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Retrieve a specific transcription
* @summary Get Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand Down Expand Up @@ -126,8 +126,8 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf
};
},
/**
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Enumerate transcriptions made with StartTranscription
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary List Real-time Transcriptions
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -179,7 +179,7 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
return {
/**
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
* @summary Delete a specific transcription
* @summary Delete Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand All @@ -194,7 +194,7 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
},
/**
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Retrieve a specific transcription
* @summary Get Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand All @@ -208,8 +208,8 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Enumerate transcriptions made with StartTranscription
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary List Real-time Transcriptions
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
Expand All @@ -233,7 +233,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
return {
/**
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
* @summary Delete a specific transcription
* @summary Delete Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand All @@ -245,7 +245,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
},
/**
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Retrieve a specific transcription
* @summary Get Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand All @@ -256,8 +256,8 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
return localVarFp.getRealTimeTranscription(accountId, callId, transcriptionId, options).then((request) => request(axios, basePath));
},
/**
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Enumerate transcriptions made with StartTranscription
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary List Real-time Transcriptions
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
Expand All @@ -278,7 +278,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
export class TranscriptionsApi extends BaseAPI {
/**
* Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
* @summary Delete a specific transcription
* @summary Delete Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand All @@ -292,7 +292,7 @@ export class TranscriptionsApi extends BaseAPI {

/**
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Retrieve a specific transcription
* @summary Get Real-time Transcription
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} transcriptionId Programmable Voice API Transcription ID.
Expand All @@ -305,8 +305,8 @@ export class TranscriptionsApi extends BaseAPI {
}

/**
* Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary Enumerate transcriptions made with StartTranscription
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
* @summary List Real-time Transcriptions
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
Expand Down
23 changes: 12 additions & 11 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1157,9 +1157,9 @@ paths:
get:
tags:
- Transcriptions
summary: Enumerate transcriptions made with StartTranscription
summary: List Real-time Transcriptions
description: >-
Enumerates the transcriptions created on this call via
List the transcriptions created on this call via
[startTranscription](/docs/voice/bxml/startTranscription).
operationId: listRealTimeTranscriptions
parameters:
Expand Down Expand Up @@ -1189,7 +1189,7 @@ paths:
get:
tags:
- Transcriptions
summary: Retrieve a specific transcription
summary: Get Real-time Transcription
description: >-
Retrieve the specified transcription that was created on this call via
[startTranscription](/docs/voice/bxml/startTranscription).
Expand Down Expand Up @@ -1220,7 +1220,7 @@ paths:
delete:
tags:
- Transcriptions
summary: Delete a specific transcription
summary: Delete Real-time Transcription
description: >-
Delete the specified transcription that was created on this call via
[startTranscription](/docs/voice/bxml/startTranscription).
Expand Down Expand Up @@ -1929,7 +1929,7 @@ components:
required:
- type
- description
messageId:
id:
type: string
description: The ID of the message.
example: 1589228074636lm4k2je7j7jklbn2
Expand Down Expand Up @@ -2549,8 +2549,8 @@ components:
description: The data returned in a multichannel message response.
type: object
properties:
messageId:
$ref: '#/components/schemas/messageId'
id:
$ref: '#/components/schemas/id'
time:
description: The time the message was received by the Bandwidth API.
type: string
Expand Down Expand Up @@ -2586,7 +2586,7 @@ components:
expiration:
$ref: '#/components/schemas/expiration'
required:
- messageId
- id
- time
- direction
- to
Expand Down Expand Up @@ -3738,11 +3738,12 @@ components:
the state of this conference member. This is the URL of this
member's

[Get Conference Member](/apis/voice/#operation/getConferenceMember)
[Get Conference
Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
endpoint

and [Modify Conference
Member](/apis/voice/#operation/updateConferenceMember)
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)

endpoint.
example: >-
Expand Down Expand Up @@ -4094,7 +4095,7 @@ components:
points to the

[Get Call
Transcription](/apis/voice/#operation/getCallTranscription)
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
endpoint.
example: >-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
Expand Down
2 changes: 1 addition & 1 deletion docs/CallTranscriptionMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional] [default to undefined]
**transcriptionName** | **string** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] [default to undefined]
**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] [default to undefined]
**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. | [optional] [default to undefined]

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined]
**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] [default to undefined]
**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. | [optional] [default to undefined]
**mute** | **boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member\'s mute status. Has no effect if omitted. | [optional] [default to undefined]
**hold** | **boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member\'s hold status. Has no effect if omitted. | [optional] [default to undefined]
**callIdsToCoach** | **Array<string>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] [default to undefined]
Expand Down
4 changes: 2 additions & 2 deletions docs/MultiChannelMessageResponseData.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The data returned in a multichannel message response.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**messageId** | **string** | The ID of the message. | [default to undefined]
**id** | **string** | The ID of the message. | [default to undefined]
**time** | **string** | The time the message was received by the Bandwidth API. | [default to undefined]
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
**to** | **Set<string>** | The destination phone number(s) of the message, in E164 format. | [default to undefined]
Expand All @@ -21,7 +21,7 @@ Name | Type | Description | Notes
import { MultiChannelMessageResponseData } from 'bandwidth-sdk';

const instance: MultiChannelMessageResponseData = {
messageId,
id,
time,
direction,
to,
Expand Down
8 changes: 4 additions & 4 deletions docs/TranscriptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteRealTimeTranscription**](#deleterealtimetranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription|
|[**getRealTimeTranscription**](#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription|
|[**listRealTimeTranscriptions**](#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription|
|[**deleteRealTimeTranscription**](#deleterealtimetranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription|
|[**getRealTimeTranscription**](#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription|
|[**listRealTimeTranscriptions**](#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions|

# **deleteRealTimeTranscription**
> deleteRealTimeTranscription()
Expand Down Expand Up @@ -141,7 +141,7 @@ const { status, data } = await apiInstance.getRealTimeTranscription(
# **listRealTimeTranscriptions**
> Array<CallTranscriptionMetadata> listRealTimeTranscriptions()

Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).

### Example

Expand Down
2 changes: 1 addition & 1 deletion models/call-transcription-metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface CallTranscriptionMetadata {
*/
'transcriptionName'?: string;
/**
* A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
* A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
* @type {string}
* @memberof CallTranscriptionMetadata
*/
Expand Down
2 changes: 1 addition & 1 deletion models/conference-member.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface ConferenceMember {
*/
'conferenceId'?: string;
/**
* A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.
* A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint.
* @type {string}
* @memberof ConferenceMember
*/
Expand Down
2 changes: 1 addition & 1 deletion models/multi-channel-message-response-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export interface MultiChannelMessageResponseData {
* @type {string}
* @memberof MultiChannelMessageResponseData
*/
'messageId': string;
'id': string;
/**
* The time the message was received by the Bandwidth API.
* @type {string}
Expand Down