bandwidth-sdk 8.1.2 → 8.1.4

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.
Files changed (148) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +1 -0
  3. package/bandwidth.yml +153 -27
  4. package/configuration.ts +1 -1
  5. package/coverage/clover.xml +6 -5
  6. package/coverage/coverage-final.json +2 -2
  7. package/coverage/lcov-report/index.html +5 -5
  8. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  9. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  10. package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/index.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  13. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  14. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/common.ts.html +1 -1
  24. package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
  25. package/coverage/lcov-report/node-sdk/index.html +1 -1
  26. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +1 -1
  27. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +1 -1
  28. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +3 -3
  84. package/coverage/lcov-report/node-sdk/models/index.html +5 -5
  85. package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -4
  86. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  89. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  93. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  94. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  95. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
  96. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  97. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  98. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +1 -1
  99. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +1 -1
  100. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  101. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  102. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  103. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +6 -3
  104. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  105. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  106. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  107. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  108. package/coverage/lcov.info +3 -2
  109. package/dist/configuration.js +1 -1
  110. package/dist/models/callback.d.ts +1 -1
  111. package/dist/models/inbound-callback-type-enum.d.ts +2 -2
  112. package/dist/models/inbound-callback-type-enum.js +2 -2
  113. package/dist/models/index.d.ts +1 -0
  114. package/dist/models/index.js +1 -0
  115. package/dist/models/rbm-suggestion-response.d.ts +4 -0
  116. package/dist/models/recording-transcription-clip.d.ts +33 -0
  117. package/dist/models/recording-transcription-clip.js +15 -0
  118. package/dist/models/recording-transcriptions.d.ts +5 -0
  119. package/dist/models/status-callback-type-enum.d.ts +2 -1
  120. package/dist/models/status-callback-type-enum.js +2 -1
  121. package/dist/models/tfv-status.d.ts +9 -0
  122. package/dist/models/transcription.d.ts +4 -0
  123. package/docs/InboundCallbackTypeEnum.md +2 -2
  124. package/docs/RbmSuggestionResponse.md +2 -0
  125. package/docs/RecordingTranscriptionClip.md +28 -0
  126. package/docs/RecordingTranscriptions.md +2 -0
  127. package/docs/StatusCallbackTypeEnum.md +3 -1
  128. package/docs/TfvStatus.md +4 -0
  129. package/docs/Transcription.md +2 -0
  130. package/models/callback.ts +1 -1
  131. package/models/inbound-callback-type-enum.ts +2 -2
  132. package/models/index.ts +1 -0
  133. package/models/rbm-suggestion-response.ts +4 -0
  134. package/models/recording-transcription-clip.ts +39 -0
  135. package/models/recording-transcriptions.ts +7 -0
  136. package/models/status-callback-type-enum.ts +2 -1
  137. package/models/tfv-status.ts +11 -0
  138. package/models/transcription.ts +4 -0
  139. package/package.json +1 -1
  140. package/tests/unit/api/recordings-api.test.ts +1 -0
  141. package/tests/unit/models/inbound-callback-type-enum.test.ts +2 -2
  142. package/tests/unit/models/rbm-suggestion-response.test.ts +2 -0
  143. package/tests/unit/models/recording-transcription-clip.test.ts +19 -0
  144. package/tests/unit/models/recording-transcriptions.test.ts +2 -0
  145. package/tests/unit/models/status-callback-type-enum.test.ts +2 -0
  146. package/tests/unit/models/tfv-status.test.ts +8 -0
  147. package/tests/unit/models/transcription.test.ts +2 -0
  148. /package/tests/unit/models/{rbm-veb-view-enum.test.ts → rbm-web-view-enum.test.ts} +0 -0
@@ -15,10 +15,10 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.InboundCallbackTypeEnum = void 0;
17
17
  /**
18
- * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
18
+ * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `requested-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
19
19
  */
20
20
  exports.InboundCallbackTypeEnum = {
21
21
  MessageReceived: 'message-received',
22
- RequestLocationResponse: 'request-location-response',
22
+ RequestedLocationResponse: 'requested-location-response',
23
23
  SuggestionResponse: 'suggestion-response'
24
24
  };
@@ -150,6 +150,7 @@ export * from './rbm-web-view-enum';
150
150
  export * from './recording-available-callback';
151
151
  export * from './recording-complete-callback';
152
152
  export * from './recording-state-enum';
153
+ export * from './recording-transcription-clip';
153
154
  export * from './recording-transcription-metadata';
154
155
  export * from './recording-transcriptions';
155
156
  export * from './redirect-callback';
@@ -166,6 +166,7 @@ __exportStar(require("./rbm-web-view-enum"), exports);
166
166
  __exportStar(require("./recording-available-callback"), exports);
167
167
  __exportStar(require("./recording-complete-callback"), exports);
168
168
  __exportStar(require("./recording-state-enum"), exports);
169
+ __exportStar(require("./recording-transcription-clip"), exports);
169
170
  __exportStar(require("./recording-transcription-metadata"), exports);
170
171
  __exportStar(require("./recording-transcriptions"), exports);
171
172
  __exportStar(require("./redirect-callback"), exports);
@@ -18,4 +18,8 @@ export interface RbmSuggestionResponse {
18
18
  * Base64 payload the customer receives when the reply is clicked.
19
19
  */
20
20
  'postbackData'?: string;
21
+ /**
22
+ * Corresponding parent message ID (MT).
23
+ */
24
+ 'pairedMessageId'?: string | null;
21
25
  }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface RecordingTranscriptionClip {
13
+ /**
14
+ * Zero-based index identifying the speaker.
15
+ */
16
+ 'speaker'?: number;
17
+ /**
18
+ * The transcribed text of this clip.
19
+ */
20
+ 'text'?: string;
21
+ /**
22
+ * How confident the transcription engine was in transcribing this clip (from `0.0` to `1.0`).
23
+ */
24
+ 'confidence'?: number;
25
+ /**
26
+ * The start time of this clip within the recording, in seconds.
27
+ */
28
+ 'startTimeSeconds'?: number;
29
+ /**
30
+ * The end time of this clip within the recording, in seconds.
31
+ */
32
+ 'endTimeSeconds'?: number;
33
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Bandwidth
6
+ * Bandwidth\'s Communication APIs
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: letstalk@bandwidth.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -9,7 +9,12 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { RecordingTranscriptionClip } from './recording-transcription-clip';
12
13
  import type { Transcription } from './transcription';
13
14
  export interface RecordingTranscriptions {
14
15
  'transcripts'?: Array<Transcription>;
16
+ /**
17
+ * A list of individual speech clips with speaker, timing, and confidence information.
18
+ */
19
+ 'clips'?: Array<RecordingTranscriptionClip>;
15
20
  }
@@ -10,10 +10,11 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
13
+ * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
14
14
  */
15
15
  export declare const StatusCallbackTypeEnum: {
16
16
  readonly MessageSending: "message-sending";
17
+ readonly MessageSent: "message-sent";
17
18
  readonly MessageDelivered: "message-delivered";
18
19
  readonly MessageFailed: "message-failed";
19
20
  readonly MessageRead: "message-read";
@@ -15,10 +15,11 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.StatusCallbackTypeEnum = void 0;
17
17
  /**
18
- * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
18
+ * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
19
19
  */
20
20
  exports.StatusCallbackTypeEnum = {
21
21
  MessageSending: 'message-sending',
22
+ MessageSent: 'message-sent',
22
23
  MessageDelivered: 'message-delivered',
23
24
  MessageFailed: 'message-failed',
24
25
  MessageRead: 'message-read'
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { AdditionalDenialReason } from './additional-denial-reason';
12
13
  import type { TfvStatusEnum } from './tfv-status-enum';
13
14
  import type { TfvSubmissionInfo } from './tfv-submission-info';
14
15
  export interface TfvStatus {
@@ -25,6 +26,14 @@ export interface TfvStatus {
25
26
  * Explanation for why a verification request was declined.
26
27
  */
27
28
  'declineReasonDescription'?: string;
29
+ /**
30
+ * Reason code for denial.
31
+ */
32
+ 'denialStatusCode'?: number | null;
33
+ /**
34
+ * An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.
35
+ */
36
+ 'additionalDenialReasons'?: Array<AdditionalDenialReason> | null;
28
37
  /**
29
38
  * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
30
39
  */
@@ -10,6 +10,10 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  export interface Transcription {
13
+ /**
14
+ * Zero-based index identifying the speaker.
15
+ */
16
+ 'speaker'?: number;
13
17
  /**
14
18
  * The transcribed text
15
19
  */
@@ -1,12 +1,12 @@
1
1
  # InboundCallbackTypeEnum
2
2
 
3
- The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
3
+ The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `requested-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
4
4
 
5
5
  ## Enum
6
6
 
7
7
  * `MessageReceived` (value: `'message-received'`)
8
8
 
9
- * `RequestLocationResponse` (value: `'request-location-response'`)
9
+ * `RequestedLocationResponse` (value: `'requested-location-response'`)
10
10
 
11
11
  * `SuggestionResponse` (value: `'suggestion-response'`)
12
12
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **text** | **string** | The text associated with the suggestion response. | [optional] [default to undefined]
9
9
  **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [optional] [default to undefined]
10
+ **pairedMessageId** | **string** | Corresponding parent message ID (MT). | [optional] [default to undefined]
10
11
 
11
12
  ## Example
12
13
 
@@ -16,6 +17,7 @@ import { RbmSuggestionResponse } from 'bandwidth-sdk';
16
17
  const instance: RbmSuggestionResponse = {
17
18
  text,
18
19
  postbackData,
20
+ pairedMessageId,
19
21
  };
20
22
  ```
21
23
 
@@ -0,0 +1,28 @@
1
+ # RecordingTranscriptionClip
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **speaker** | **number** | Zero-based index identifying the speaker. | [optional] [default to undefined]
9
+ **text** | **string** | The transcribed text of this clip. | [optional] [default to undefined]
10
+ **confidence** | **number** | How confident the transcription engine was in transcribing this clip (from &#x60;0.0&#x60; to &#x60;1.0&#x60;). | [optional] [default to undefined]
11
+ **startTimeSeconds** | **number** | The start time of this clip within the recording, in seconds. | [optional] [default to undefined]
12
+ **endTimeSeconds** | **number** | The end time of this clip within the recording, in seconds. | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { RecordingTranscriptionClip } from 'bandwidth-sdk';
18
+
19
+ const instance: RecordingTranscriptionClip = {
20
+ speaker,
21
+ text,
22
+ confidence,
23
+ startTimeSeconds,
24
+ endTimeSeconds,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -6,6 +6,7 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **transcripts** | [**Array&lt;Transcription&gt;**](Transcription.md) | | [optional] [default to undefined]
9
+ **clips** | [**Array&lt;RecordingTranscriptionClip&gt;**](RecordingTranscriptionClip.md) | A list of individual speech clips with speaker, timing, and confidence information. | [optional] [default to undefined]
9
10
 
10
11
  ## Example
11
12
 
@@ -14,6 +15,7 @@ import { RecordingTranscriptions } from 'bandwidth-sdk';
14
15
 
15
16
  const instance: RecordingTranscriptions = {
16
17
  transcripts,
18
+ clips,
17
19
  };
18
20
  ```
19
21
 
@@ -1,11 +1,13 @@
1
1
  # StatusCallbackTypeEnum
2
2
 
3
- The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
3
+ The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
4
4
 
5
5
  ## Enum
6
6
 
7
7
  * `MessageSending` (value: `'message-sending'`)
8
8
 
9
+ * `MessageSent` (value: `'message-sent'`)
10
+
9
11
  * `MessageDelivered` (value: `'message-delivered'`)
10
12
 
11
13
  * `MessageFailed` (value: `'message-failed'`)
package/docs/TfvStatus.md CHANGED
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
9
9
  **status** | [**TfvStatusEnum**](TfvStatusEnum.md) | | [optional] [default to undefined]
10
10
  **internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] [default to undefined]
11
11
  **declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined]
12
+ **denialStatusCode** | **number** | Reason code for denial. | [optional] [default to undefined]
13
+ **additionalDenialReasons** | [**Array&lt;AdditionalDenialReason&gt;**](AdditionalDenialReason.md) | An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. | [optional] [default to undefined]
12
14
  **resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined]
13
15
  **createdDateTime** | **string** | Date and time the verification request was created. | [optional] [default to undefined]
14
16
  **modifiedDateTime** | **string** | Date and time the verification request was last modified. | [optional] [default to undefined]
@@ -27,6 +29,8 @@ const instance: TfvStatus = {
27
29
  status,
28
30
  internalTicketNumber,
29
31
  declineReasonDescription,
32
+ denialStatusCode,
33
+ additionalDenialReasons,
30
34
  resubmitAllowed,
31
35
  createdDateTime,
32
36
  modifiedDateTime,
@@ -5,6 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **speaker** | **number** | Zero-based index identifying the speaker. | [optional] [default to undefined]
8
9
  **text** | **string** | The transcribed text | [optional] [default to undefined]
9
10
  **confidence** | **number** | The confidence on the recognized content, ranging from &#x60;0.0&#x60; to &#x60;1.0&#x60; with &#x60;1.0&#x60; being the highest confidence. | [optional] [default to undefined]
10
11
 
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
14
15
  import { Transcription } from 'bandwidth-sdk';
15
16
 
16
17
  const instance: Transcription = {
18
+ speaker,
17
19
  text,
18
20
  confidence,
19
21
  };
@@ -30,6 +30,6 @@ import type { StatusCallback } from './status-callback';
30
30
  * @type Callback
31
31
  * Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request.
32
32
  */
33
- export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
33
+ export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'requested-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
34
34
 
35
35
 
@@ -15,12 +15,12 @@
15
15
 
16
16
 
17
17
  /**
18
- * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
18
+ * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `requested-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
19
19
  */
20
20
 
21
21
  export const InboundCallbackTypeEnum = {
22
22
  MessageReceived: 'message-received',
23
- RequestLocationResponse: 'request-location-response',
23
+ RequestedLocationResponse: 'requested-location-response',
24
24
  SuggestionResponse: 'suggestion-response'
25
25
  } as const;
26
26
 
package/models/index.ts CHANGED
@@ -150,6 +150,7 @@ export * from './rbm-web-view-enum';
150
150
  export * from './recording-available-callback';
151
151
  export * from './recording-complete-callback';
152
152
  export * from './recording-state-enum';
153
+ export * from './recording-transcription-clip';
153
154
  export * from './recording-transcription-metadata';
154
155
  export * from './recording-transcriptions';
155
156
  export * from './redirect-callback';
@@ -23,5 +23,9 @@ export interface RbmSuggestionResponse {
23
23
  * Base64 payload the customer receives when the reply is clicked.
24
24
  */
25
25
  'postbackData'?: string;
26
+ /**
27
+ * Corresponding parent message ID (MT).
28
+ */
29
+ 'pairedMessageId'?: string | null;
26
30
  }
27
31
 
@@ -0,0 +1,39 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ export interface RecordingTranscriptionClip {
18
+ /**
19
+ * Zero-based index identifying the speaker.
20
+ */
21
+ 'speaker'?: number;
22
+ /**
23
+ * The transcribed text of this clip.
24
+ */
25
+ 'text'?: string;
26
+ /**
27
+ * How confident the transcription engine was in transcribing this clip (from `0.0` to `1.0`).
28
+ */
29
+ 'confidence'?: number;
30
+ /**
31
+ * The start time of this clip within the recording, in seconds.
32
+ */
33
+ 'startTimeSeconds'?: number;
34
+ /**
35
+ * The end time of this clip within the recording, in seconds.
36
+ */
37
+ 'endTimeSeconds'?: number;
38
+ }
39
+
@@ -13,11 +13,18 @@
13
13
  */
14
14
 
15
15
 
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { RecordingTranscriptionClip } from './recording-transcription-clip';
16
19
  // May contain unused imports in some cases
17
20
  // @ts-ignore
18
21
  import type { Transcription } from './transcription';
19
22
 
20
23
  export interface RecordingTranscriptions {
21
24
  'transcripts'?: Array<Transcription>;
25
+ /**
26
+ * A list of individual speech clips with speaker, timing, and confidence information.
27
+ */
28
+ 'clips'?: Array<RecordingTranscriptionClip>;
22
29
  }
23
30
 
@@ -15,11 +15,12 @@
15
15
 
16
16
 
17
17
  /**
18
- * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
18
+ * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
19
19
  */
20
20
 
21
21
  export const StatusCallbackTypeEnum = {
22
22
  MessageSending: 'message-sending',
23
+ MessageSent: 'message-sent',
23
24
  MessageDelivered: 'message-delivered',
24
25
  MessageFailed: 'message-failed',
25
26
  MessageRead: 'message-read'
@@ -13,6 +13,9 @@
13
13
  */
14
14
 
15
15
 
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { AdditionalDenialReason } from './additional-denial-reason';
16
19
  // May contain unused imports in some cases
17
20
  // @ts-ignore
18
21
  import type { TfvStatusEnum } from './tfv-status-enum';
@@ -34,6 +37,14 @@ export interface TfvStatus {
34
37
  * Explanation for why a verification request was declined.
35
38
  */
36
39
  'declineReasonDescription'?: string;
40
+ /**
41
+ * Reason code for denial.
42
+ */
43
+ 'denialStatusCode'?: number | null;
44
+ /**
45
+ * An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.
46
+ */
47
+ 'additionalDenialReasons'?: Array<AdditionalDenialReason> | null;
37
48
  /**
38
49
  * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
39
50
  */
@@ -15,6 +15,10 @@
15
15
 
16
16
 
17
17
  export interface Transcription {
18
+ /**
19
+ * Zero-based index identifying the speaker.
20
+ */
21
+ 'speaker'?: number;
18
22
  /**
19
23
  * The transcribed text
20
24
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bandwidth-sdk",
3
- "version": "8.1.2",
3
+ "version": "8.1.4",
4
4
  "description": "OpenAPI client for bandwidth-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -152,6 +152,7 @@ describe('RecordingsApi', () => {
152
152
 
153
153
  expect(status).toEqual(200);
154
154
  expect(data.transcripts).toBeInstanceOf(Array);
155
+ expect(data.transcripts![0].speaker).toBeNumber();
155
156
  expect(data.transcripts![0].text).toBeString();
156
157
  expect(data.transcripts![0].confidence).toBeNumber();
157
158
  });
@@ -3,11 +3,11 @@ import { InboundCallbackTypeEnum } from '../../../models/inbound-callback-type-e
3
3
  describe('InboundCallbackTypeEnum', () => {
4
4
  test('should define the expected values', () => {
5
5
  expect(InboundCallbackTypeEnum.MessageReceived).toBe('message-received');
6
- expect(InboundCallbackTypeEnum.RequestLocationResponse).toBe('request-location-response');
6
+ expect(InboundCallbackTypeEnum.RequestedLocationResponse).toBe('requested-location-response');
7
7
  expect(InboundCallbackTypeEnum.SuggestionResponse).toBe('suggestion-response');
8
8
  expect(Object.values(InboundCallbackTypeEnum)).toEqual([
9
9
  'message-received',
10
- 'request-location-response',
10
+ 'requested-location-response',
11
11
  'suggestion-response'
12
12
  ]);
13
13
  });
@@ -5,9 +5,11 @@ describe('RbmSuggestionResponse', () => {
5
5
  const fixture: RbmSuggestionResponse = {
6
6
  text: 'test-text',
7
7
  postbackData: 'test-postbackData',
8
+ pairedMessageId: 'test-pairedMessageId'
8
9
  };
9
10
 
10
11
  expect(fixture.text).toBe('test-text');
11
12
  expect(fixture.postbackData).toBe('test-postbackData');
13
+ expect(fixture.pairedMessageId).toBe('test-pairedMessageId');
12
14
  });
13
15
  });
@@ -0,0 +1,19 @@
1
+ import { RecordingTranscriptionClip } from '../../../models/recording-transcription-clip';
2
+
3
+ describe('RecordingTranscriptionClip', () => {
4
+ test('should accept the expected shape', () => {
5
+ const fixture: RecordingTranscriptionClip = {
6
+ speaker: 1,
7
+ text: 'test-text',
8
+ confidence: 1.5,
9
+ startTimeSeconds: 0.0,
10
+ endTimeSeconds: 1.0,
11
+ };
12
+
13
+ expect(fixture.speaker).toBe(1);
14
+ expect(fixture.text).toBe('test-text');
15
+ expect(fixture.confidence).toBe(1.5);
16
+ expect(fixture.startTimeSeconds).toBe(0.0);
17
+ expect(fixture.endTimeSeconds).toBe(1.0);
18
+ });
19
+ });
@@ -4,8 +4,10 @@ describe('RecordingTranscriptions', () => {
4
4
  test('should accept the expected shape', () => {
5
5
  const fixture: RecordingTranscriptions = {
6
6
  transcripts: [],
7
+ clips: [],
7
8
  };
8
9
 
9
10
  expect(fixture.transcripts).toEqual([]);
11
+ expect(fixture.clips).toEqual([]);
10
12
  });
11
13
  });
@@ -3,11 +3,13 @@ import { StatusCallbackTypeEnum } from '../../../models/status-callback-type-enu
3
3
  describe('StatusCallbackTypeEnum', () => {
4
4
  test('should define the expected values', () => {
5
5
  expect(StatusCallbackTypeEnum.MessageSending).toBe('message-sending');
6
+ expect(StatusCallbackTypeEnum.MessageSent).toBe('message-sent');
6
7
  expect(StatusCallbackTypeEnum.MessageDelivered).toBe('message-delivered');
7
8
  expect(StatusCallbackTypeEnum.MessageFailed).toBe('message-failed');
8
9
  expect(StatusCallbackTypeEnum.MessageRead).toBe('message-read');
9
10
  expect(Object.values(StatusCallbackTypeEnum)).toEqual([
10
11
  'message-sending',
12
+ 'message-sent',
11
13
  'message-delivered',
12
14
  'message-failed',
13
15
  'message-read'
@@ -1,14 +1,22 @@
1
1
  import { TfvStatus } from '../../../models/tfv-status';
2
2
  import { TfvStatusEnum } from '../../../models/tfv-status-enum';
3
3
  import { TfvSubmissionInfo } from '../../../models/tfv-submission-info';
4
+ import { AdditionalDenialReason } from '../../../models/additional-denial-reason';
4
5
 
5
6
  describe('TfvStatus', () => {
6
7
  test('should accept the expected shape', () => {
8
+ const denialReason: AdditionalDenialReason = {
9
+ statusCode: 1.5,
10
+ reason: 'test-reason',
11
+ resubmitAllowed: true,
12
+ };
7
13
  const fixture: TfvStatus = {
8
14
  phoneNumber: 'test-phoneNumber',
9
15
  status: TfvStatusEnum.Verified,
10
16
  internalTicketNumber: 'test-internalTicketNumber',
11
17
  declineReasonDescription: 'test-declineReasonDescription',
18
+ denialStatusCode: 123,
19
+ additionalDenialReasons: [denialReason],
12
20
  resubmitAllowed: true,
13
21
  createdDateTime: 'test-createdDateTime',
14
22
  modifiedDateTime: 'test-modifiedDateTime',
@@ -3,10 +3,12 @@ import { Transcription } from '../../../models/transcription';
3
3
  describe('Transcription', () => {
4
4
  test('should accept the expected shape', () => {
5
5
  const fixture: Transcription = {
6
+ speaker: 1,
6
7
  text: 'test-text',
7
8
  confidence: 1.5,
8
9
  };
9
10
 
11
+ expect(fixture.speaker).toBe(1);
10
12
  expect(fixture.text).toBe('test-text');
11
13
  expect(fixture.confidence).toBe(1.5);
12
14
  });