bandwidth-sdk 6.1.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/api/messages-api.ts +105 -7
- package/api/transcriptions-api.ts +16 -16
- package/bandwidth.yml +266 -11
- package/configuration.ts +1 -1
- package/coverage/clover.xml +129 -90
- package/coverage/coverage-final.json +7 -4
- package/coverage/lcov-report/block-navigation.js +1 -1
- package/coverage/lcov-report/index.html +17 -17
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/index.html +15 -15
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +309 -15
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +17 -17
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/common.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +187 -0
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +5 -2
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/index.html +50 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +13 -4
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +6 -3
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +199 -0
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
- package/coverage/lcov-report/sorter.js +21 -7
- package/coverage/lcov.info +235 -166
- package/dist/api/messages-api.d.ts +53 -4
- package/dist/api/messages-api.js +94 -10
- package/dist/api/transcriptions-api.d.ts +16 -16
- package/dist/api/transcriptions-api.js +16 -16
- package/dist/configuration.js +1 -1
- package/dist/models/business-entity-type-enum.d.ts +24 -0
- package/dist/models/business-entity-type-enum.js +28 -0
- package/dist/models/business-registration-type-enum.d.ts +21 -0
- package/dist/models/business-registration-type-enum.js +25 -0
- package/dist/models/bxml/verbs/StopStream.d.ts +1 -0
- package/dist/models/call-transcription-metadata.d.ts +1 -1
- package/dist/models/conference-member.d.ts +1 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-message-item.d.ts +36 -0
- package/dist/models/message-type-enum.d.ts +1 -0
- package/dist/models/message-type-enum.js +2 -1
- package/dist/models/multi-channel-message-response-data.d.ts +1 -1
- package/dist/models/opt-in-workflow.d.ts +6 -0
- package/dist/models/product-type-enum.d.ts +28 -0
- package/dist/models/product-type-enum.js +32 -0
- package/dist/models/tfv-submission-info.d.ts +20 -0
- package/dist/models/verification-request.d.ts +32 -0
- package/dist/models/verification-update-request.d.ts +32 -0
- package/docs/BusinessEntityTypeEnum.md +17 -0
- package/docs/BusinessRegistrationTypeEnum.md +11 -0
- package/docs/CallTranscriptionMetadata.md +1 -1
- package/docs/ConferenceMember.md +1 -1
- package/docs/ListMessageItem.md +12 -0
- package/docs/MessageTypeEnum.md +2 -0
- package/docs/MessagesApi.md +36 -0
- package/docs/MultiChannelMessageResponseData.md +2 -2
- package/docs/OptInWorkflow.md +2 -0
- package/docs/ProductTypeEnum.md +25 -0
- package/docs/TfvSubmissionInfo.md +6 -0
- package/docs/TranscriptionsApi.md +4 -4
- package/docs/VerificationRequest.md +10 -0
- package/docs/VerificationUpdateRequest.md +10 -0
- package/models/business-entity-type-enum.ts +34 -0
- package/models/business-registration-type-enum.ts +31 -0
- package/models/bxml/verbs/StopStream.ts +1 -0
- package/models/call-transcription-metadata.ts +1 -1
- package/models/conference-member.ts +1 -1
- package/models/index.ts +3 -0
- package/models/list-message-item.ts +36 -0
- package/models/message-type-enum.ts +2 -1
- package/models/multi-channel-message-response-data.ts +1 -1
- package/models/opt-in-workflow.ts +6 -0
- package/models/product-type-enum.ts +38 -0
- package/models/tfv-submission-info.ts +26 -0
- package/models/verification-request.ts +38 -0
- package/models/verification-update-request.ts +38 -0
- package/package.json +1 -1
- package/tests/smoke/bxml.test.ts +2 -1
- package/tests/smoke/messages-api.test.ts +6 -1
- package/tests/unit/api/messages-api.test.ts +6 -0
- package/tests/unit/models/business-entity-type-enum.test.ts +11 -0
- package/tests/unit/models/business-registration-type-enum.test.ts +8 -0
- package/tests/unit/models/bxml/verbs/StopStream.test.ts +3 -2
- package/tests/unit/models/message-type-enum.test.ts +1 -0
- package/tests/unit/models/product-type-enum.test.ts +15 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -22,6 +22,8 @@ docs/AnswerCallback.md
|
|
|
22
22
|
docs/BlockedWebhook.md
|
|
23
23
|
docs/BridgeCompleteCallback.md
|
|
24
24
|
docs/BridgeTargetCompleteCallback.md
|
|
25
|
+
docs/BusinessEntityTypeEnum.md
|
|
26
|
+
docs/BusinessRegistrationTypeEnum.md
|
|
25
27
|
docs/CallDirectionEnum.md
|
|
26
28
|
docs/CallRecordingMetadata.md
|
|
27
29
|
docs/CallState.md
|
|
@@ -111,6 +113,7 @@ docs/OptInWorkflow.md
|
|
|
111
113
|
docs/PageInfo.md
|
|
112
114
|
docs/PhoneNumberLookupApi.md
|
|
113
115
|
docs/PriorityEnum.md
|
|
116
|
+
docs/ProductTypeEnum.md
|
|
114
117
|
docs/RbmActionBase.md
|
|
115
118
|
docs/RbmActionDial.md
|
|
116
119
|
docs/RbmActionOpenUrl.md
|
|
@@ -186,6 +189,8 @@ models/answer-callback.ts
|
|
|
186
189
|
models/blocked-webhook.ts
|
|
187
190
|
models/bridge-complete-callback.ts
|
|
188
191
|
models/bridge-target-complete-callback.ts
|
|
192
|
+
models/business-entity-type-enum.ts
|
|
193
|
+
models/business-registration-type-enum.ts
|
|
189
194
|
models/call-direction-enum.ts
|
|
190
195
|
models/call-recording-metadata.ts
|
|
191
196
|
models/call-state-enum.ts
|
|
@@ -269,6 +274,7 @@ models/multi-channel-message-response-data.ts
|
|
|
269
274
|
models/opt-in-workflow.ts
|
|
270
275
|
models/page-info.ts
|
|
271
276
|
models/priority-enum.ts
|
|
277
|
+
models/product-type-enum.ts
|
|
272
278
|
models/rbm-action-base.ts
|
|
273
279
|
models/rbm-action-dial.ts
|
|
274
280
|
models/rbm-action-open-url.ts
|
package/api/messages-api.ts
CHANGED
|
@@ -37,6 +37,8 @@ import type { MessageTypeEnum } from '../models';
|
|
|
37
37
|
import type { MessagesList } from '../models';
|
|
38
38
|
// @ts-ignore
|
|
39
39
|
import type { MessagingRequestError } from '../models';
|
|
40
|
+
// @ts-ignore
|
|
41
|
+
import type { ProductTypeEnum } from '../models';
|
|
40
42
|
/**
|
|
41
43
|
* MessagesApi - axios parameter creator
|
|
42
44
|
* @export
|
|
@@ -102,6 +104,18 @@ export const MessagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
102
104
|
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
103
105
|
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
104
106
|
* @param {string} [campaignId] The campaign ID of the message.
|
|
107
|
+
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
|
|
108
|
+
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
|
|
109
|
+
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
|
|
110
|
+
* @param {string} [location] Location Id associated with the message.
|
|
111
|
+
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
112
|
+
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
113
|
+
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
|
|
114
|
+
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
|
|
115
|
+
* @param {number} [fromSegmentCount] Segment count (start range).
|
|
116
|
+
* @param {number} [toSegmentCount] Segment count (end range).
|
|
117
|
+
* @param {number} [fromMessageSize] Message size (start range).
|
|
118
|
+
* @param {number} [toMessageSize] Message size (end range).
|
|
105
119
|
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
106
120
|
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
107
121
|
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
@@ -109,7 +123,7 @@ export const MessagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
109
123
|
* @param {*} [options] Override http request option.
|
|
110
124
|
* @throws {RequiredError}
|
|
111
125
|
*/
|
|
112
|
-
listMessages: async (accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
126
|
+
listMessages: async (accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
113
127
|
// verify required parameter 'accountId' is not null or undefined
|
|
114
128
|
assertParamExists('listMessages', 'accountId', accountId)
|
|
115
129
|
const localVarPath = `/users/{accountId}/messages`
|
|
@@ -173,6 +187,54 @@ export const MessagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
173
187
|
localVarQueryParameter['campaignId'] = campaignId;
|
|
174
188
|
}
|
|
175
189
|
|
|
190
|
+
if (fromBwLatency !== undefined) {
|
|
191
|
+
localVarQueryParameter['fromBwLatency'] = fromBwLatency;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
if (bwQueued !== undefined) {
|
|
195
|
+
localVarQueryParameter['bwQueued'] = bwQueued;
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
if (product !== undefined) {
|
|
199
|
+
localVarQueryParameter['product'] = product;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
if (location !== undefined) {
|
|
203
|
+
localVarQueryParameter['location'] = location;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
if (carrierQueued !== undefined) {
|
|
207
|
+
localVarQueryParameter['carrierQueued'] = carrierQueued;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
if (fromCarrierLatency !== undefined) {
|
|
211
|
+
localVarQueryParameter['fromCarrierLatency'] = fromCarrierLatency;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
if (callingNumberCountryA3 !== undefined) {
|
|
215
|
+
localVarQueryParameter['callingNumberCountryA3'] = callingNumberCountryA3;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
if (calledNumberCountryA3 !== undefined) {
|
|
219
|
+
localVarQueryParameter['calledNumberCountryA3'] = calledNumberCountryA3;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
if (fromSegmentCount !== undefined) {
|
|
223
|
+
localVarQueryParameter['fromSegmentCount'] = fromSegmentCount;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
if (toSegmentCount !== undefined) {
|
|
227
|
+
localVarQueryParameter['toSegmentCount'] = toSegmentCount;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
if (fromMessageSize !== undefined) {
|
|
231
|
+
localVarQueryParameter['fromMessageSize'] = fromMessageSize;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
if (toMessageSize !== undefined) {
|
|
235
|
+
localVarQueryParameter['toMessageSize'] = toMessageSize;
|
|
236
|
+
}
|
|
237
|
+
|
|
176
238
|
if (sort !== undefined) {
|
|
177
239
|
localVarQueryParameter['sort'] = sort;
|
|
178
240
|
}
|
|
@@ -239,6 +301,18 @@ export const MessagesApiFp = function(configuration?: Configuration) {
|
|
|
239
301
|
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
240
302
|
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
241
303
|
* @param {string} [campaignId] The campaign ID of the message.
|
|
304
|
+
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
|
|
305
|
+
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
|
|
306
|
+
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
|
|
307
|
+
* @param {string} [location] Location Id associated with the message.
|
|
308
|
+
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
309
|
+
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
310
|
+
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
|
|
311
|
+
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
|
|
312
|
+
* @param {number} [fromSegmentCount] Segment count (start range).
|
|
313
|
+
* @param {number} [toSegmentCount] Segment count (end range).
|
|
314
|
+
* @param {number} [fromMessageSize] Message size (start range).
|
|
315
|
+
* @param {number} [toMessageSize] Message size (end range).
|
|
242
316
|
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
243
317
|
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
244
318
|
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
@@ -246,8 +320,8 @@ export const MessagesApiFp = function(configuration?: Configuration) {
|
|
|
246
320
|
* @param {*} [options] Override http request option.
|
|
247
321
|
* @throws {RequiredError}
|
|
248
322
|
*/
|
|
249
|
-
async listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagesList>> {
|
|
250
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options);
|
|
323
|
+
async listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagesList>> {
|
|
324
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options);
|
|
251
325
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
252
326
|
const localVarOperationServerBasePath = operationServerMap['MessagesApi.listMessages']?.[localVarOperationServerIndex]?.url;
|
|
253
327
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -288,6 +362,18 @@ export const MessagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
288
362
|
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
289
363
|
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
290
364
|
* @param {string} [campaignId] The campaign ID of the message.
|
|
365
|
+
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
|
|
366
|
+
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
|
|
367
|
+
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
|
|
368
|
+
* @param {string} [location] Location Id associated with the message.
|
|
369
|
+
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
370
|
+
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
371
|
+
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
|
|
372
|
+
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
|
|
373
|
+
* @param {number} [fromSegmentCount] Segment count (start range).
|
|
374
|
+
* @param {number} [toSegmentCount] Segment count (end range).
|
|
375
|
+
* @param {number} [fromMessageSize] Message size (start range).
|
|
376
|
+
* @param {number} [toMessageSize] Message size (end range).
|
|
291
377
|
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
292
378
|
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
293
379
|
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
@@ -295,8 +381,8 @@ export const MessagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
295
381
|
* @param {*} [options] Override http request option.
|
|
296
382
|
* @throws {RequiredError}
|
|
297
383
|
*/
|
|
298
|
-
listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<MessagesList> {
|
|
299
|
-
return localVarFp.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options).then((request) => request(axios, basePath));
|
|
384
|
+
listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<MessagesList> {
|
|
385
|
+
return localVarFp.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options).then((request) => request(axios, basePath));
|
|
300
386
|
},
|
|
301
387
|
};
|
|
302
388
|
};
|
|
@@ -336,6 +422,18 @@ export class MessagesApi extends BaseAPI {
|
|
|
336
422
|
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
337
423
|
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
|
|
338
424
|
* @param {string} [campaignId] The campaign ID of the message.
|
|
425
|
+
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
|
|
426
|
+
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
|
|
427
|
+
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
|
|
428
|
+
* @param {string} [location] Location Id associated with the message.
|
|
429
|
+
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
430
|
+
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
431
|
+
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
|
|
432
|
+
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
|
|
433
|
+
* @param {number} [fromSegmentCount] Segment count (start range).
|
|
434
|
+
* @param {number} [toSegmentCount] Segment count (end range).
|
|
435
|
+
* @param {number} [fromMessageSize] Message size (start range).
|
|
436
|
+
* @param {number} [toMessageSize] Message size (end range).
|
|
339
437
|
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
|
|
340
438
|
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
|
|
341
439
|
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
|
|
@@ -344,8 +442,8 @@ export class MessagesApi extends BaseAPI {
|
|
|
344
442
|
* @throws {RequiredError}
|
|
345
443
|
* @memberof MessagesApi
|
|
346
444
|
*/
|
|
347
|
-
public listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig) {
|
|
348
|
-
return MessagesApiFp(this.configuration).listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, sort, pageToken, limit, limitTotalCount, options).then((request) => request(this.axios, this.basePath));
|
|
445
|
+
public listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig) {
|
|
446
|
+
return MessagesApiFp(this.configuration).listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options).then((request) => request(this.axios, this.basePath));
|
|
349
447
|
}
|
|
350
448
|
}
|
|
351
449
|
|
|
@@ -35,7 +35,7 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
35
35
|
return {
|
|
36
36
|
/**
|
|
37
37
|
* 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.
|
|
38
|
-
* @summary Delete
|
|
38
|
+
* @summary Delete Real-time Transcription
|
|
39
39
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
40
40
|
* @param {string} callId Programmable Voice API Call ID.
|
|
41
41
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -81,7 +81,7 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
81
81
|
},
|
|
82
82
|
/**
|
|
83
83
|
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
84
|
-
* @summary
|
|
84
|
+
* @summary Get Real-time Transcription
|
|
85
85
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
86
86
|
* @param {string} callId Programmable Voice API Call ID.
|
|
87
87
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -126,8 +126,8 @@ export const TranscriptionsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
126
126
|
};
|
|
127
127
|
},
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
130
|
-
* @summary
|
|
129
|
+
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
130
|
+
* @summary List Real-time Transcriptions
|
|
131
131
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
132
132
|
* @param {string} callId Programmable Voice API Call ID.
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
@@ -179,7 +179,7 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
|
|
|
179
179
|
return {
|
|
180
180
|
/**
|
|
181
181
|
* 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.
|
|
182
|
-
* @summary Delete
|
|
182
|
+
* @summary Delete Real-time Transcription
|
|
183
183
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
184
184
|
* @param {string} callId Programmable Voice API Call ID.
|
|
185
185
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -194,7 +194,7 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
|
|
|
194
194
|
},
|
|
195
195
|
/**
|
|
196
196
|
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
197
|
-
* @summary
|
|
197
|
+
* @summary Get Real-time Transcription
|
|
198
198
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
199
199
|
* @param {string} callId Programmable Voice API Call ID.
|
|
200
200
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -208,8 +208,8 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
|
|
|
208
208
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
209
209
|
},
|
|
210
210
|
/**
|
|
211
|
-
*
|
|
212
|
-
* @summary
|
|
211
|
+
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
212
|
+
* @summary List Real-time Transcriptions
|
|
213
213
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
214
214
|
* @param {string} callId Programmable Voice API Call ID.
|
|
215
215
|
* @param {*} [options] Override http request option.
|
|
@@ -233,7 +233,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
|
|
|
233
233
|
return {
|
|
234
234
|
/**
|
|
235
235
|
* 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.
|
|
236
|
-
* @summary Delete
|
|
236
|
+
* @summary Delete Real-time Transcription
|
|
237
237
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
238
238
|
* @param {string} callId Programmable Voice API Call ID.
|
|
239
239
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -245,7 +245,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
|
|
|
245
245
|
},
|
|
246
246
|
/**
|
|
247
247
|
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
248
|
-
* @summary
|
|
248
|
+
* @summary Get Real-time Transcription
|
|
249
249
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
250
250
|
* @param {string} callId Programmable Voice API Call ID.
|
|
251
251
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -256,8 +256,8 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
|
|
|
256
256
|
return localVarFp.getRealTimeTranscription(accountId, callId, transcriptionId, options).then((request) => request(axios, basePath));
|
|
257
257
|
},
|
|
258
258
|
/**
|
|
259
|
-
*
|
|
260
|
-
* @summary
|
|
259
|
+
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
260
|
+
* @summary List Real-time Transcriptions
|
|
261
261
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
262
262
|
* @param {string} callId Programmable Voice API Call ID.
|
|
263
263
|
* @param {*} [options] Override http request option.
|
|
@@ -278,7 +278,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
|
|
|
278
278
|
export class TranscriptionsApi extends BaseAPI {
|
|
279
279
|
/**
|
|
280
280
|
* 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.
|
|
281
|
-
* @summary Delete
|
|
281
|
+
* @summary Delete Real-time Transcription
|
|
282
282
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
283
283
|
* @param {string} callId Programmable Voice API Call ID.
|
|
284
284
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -292,7 +292,7 @@ export class TranscriptionsApi extends BaseAPI {
|
|
|
292
292
|
|
|
293
293
|
/**
|
|
294
294
|
* Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
295
|
-
* @summary
|
|
295
|
+
* @summary Get Real-time Transcription
|
|
296
296
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
297
297
|
* @param {string} callId Programmable Voice API Call ID.
|
|
298
298
|
* @param {string} transcriptionId Programmable Voice API Transcription ID.
|
|
@@ -305,8 +305,8 @@ export class TranscriptionsApi extends BaseAPI {
|
|
|
305
305
|
}
|
|
306
306
|
|
|
307
307
|
/**
|
|
308
|
-
*
|
|
309
|
-
* @summary
|
|
308
|
+
* List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
309
|
+
* @summary List Real-time Transcriptions
|
|
310
310
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
311
311
|
* @param {string} callId Programmable Voice API Call ID.
|
|
312
312
|
* @param {*} [options] Override http request option.
|