bandwidth-sdk 11.3.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e82fa3f28500251d8978057cf60e836efadd5335c63895d69793b3babfb2879
-  data.tar.gz: f1b8c1517cef45ea18a88335234a16366356d28a21efcb46dfac31f7dfb933dd
+  metadata.gz: 8662624b333e7ef9e559a91d8381165ff184c97187500be72d1e9f1304f17273
+  data.tar.gz: 2f676acc2d04e155a090201511f25949fad51f12135763dc39fec2dd011df7d7
 SHA512:
-  metadata.gz: 29305ebdfc62708c6b3220d329c81508fd5ee49f800f962bc476332c9bba112836bd711901ac8524c7a7ec89e3b0b9ac5c1036b45d98f49d93b478c8af568927
-  data.tar.gz: 9d1bcfd27fcaafd79d8cad9807b625f581bd61836463d4bc476e750777a333065306466ad1efeb07581c58d7d1a78413d117ed8534f4f65fd230b9024e197c8c
+  metadata.gz: 78adbddaaf786746802be4b4ec6a6fb8c1c37339d24b21aa0f1e3fe83e3a09d4250038a38d105f9ee13ffd4660945634b31db5a3f5628c51949808cb3f06c572
+  data.tar.gz: dcb453a3e133f0c72680f945bfa968a8762500150110b32c945f004dc088f4bcd492142f7c11aefd7e3ab2204c1936b4f0f0208c1fb2e8e056eb1d5fef8553e6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bandwidth-sdk (11.3.0)
+    bandwidth-sdk (12.0.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
       ox (~> 2.4)
@@ -12,7 +12,7 @@ GEM
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
     crack (1.0.0)
@@ -27,14 +27,14 @@ GEM
     faraday-net_http (3.1.0)
       net-http
     hashdiff (1.1.0)
-    json (2.7.1)
-    method_source (1.0.0)
-    multipart-post (2.4.0)
+    json (2.7.2)
+    method_source (1.1.0)
+    multipart-post (2.4.1)
     net-http (0.4.1)
       uri
-    ox (2.14.17)
+    ox (2.14.18)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -43,12 +43,13 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.4)
-    racc (1.7.3)
+    public_suffix (5.0.5)
+    racc (1.8.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -58,7 +59,7 @@ GEM
     rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
@@ -72,8 +73,8 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -81,6 +82,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
     webmock (3.18.1)

data/README.md

@@ -7,10 +7,10 @@
 
 | **OS** | **Ruby** |
 |:---:|:---:|
-| Windows 2019 | 2.7, 3.0, 3.1, 3.2 |
-| Windows 2022 | 2.7, 3.0, 3.1, 3.2 |
-| Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2 |
-| Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2 |
+| Windows 2019 | 2.7, 3.0, 3.1, 3.2, 3.3 |
+| Windows 2022 | 2.7, 3.0, 3.1, 3.2, 3.3 |
+| Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
+| Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
 
 Bandwidth - the Ruby gem for the Bandwidth SDK
 
@@ -132,17 +132,20 @@ Class | Method | HTTP request | Description
 *Bandwidth::MessagesApi* | [**list_messages**](docs/MessagesApi.md#list_messages) | **GET** /users/{accountId}/messages | List Messages
 *Bandwidth::PhoneNumberLookupApi* | [**create_lookup**](docs/PhoneNumberLookupApi.md#create_lookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup
 *Bandwidth::PhoneNumberLookupApi* | [**get_lookup_status**](docs/PhoneNumberLookupApi.md#get_lookup_status) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status
-*Bandwidth::RecordingsApi* | [**delete_call_transcription**](docs/RecordingsApi.md#delete_call_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription
 *Bandwidth::RecordingsApi* | [**delete_recording**](docs/RecordingsApi.md#delete_recording) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording
 *Bandwidth::RecordingsApi* | [**delete_recording_media**](docs/RecordingsApi.md#delete_recording_media) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media
+*Bandwidth::RecordingsApi* | [**delete_recording_transcription**](docs/RecordingsApi.md#delete_recording_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription
 *Bandwidth::RecordingsApi* | [**download_call_recording**](docs/RecordingsApi.md#download_call_recording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording
 *Bandwidth::RecordingsApi* | [**get_call_recording**](docs/RecordingsApi.md#get_call_recording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording
-*Bandwidth::RecordingsApi* | [**get_call_transcription**](docs/RecordingsApi.md#get_call_transcription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription
+*Bandwidth::RecordingsApi* | [**get_recording_transcription**](docs/RecordingsApi.md#get_recording_transcription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription
 *Bandwidth::RecordingsApi* | [**list_account_call_recordings**](docs/RecordingsApi.md#list_account_call_recordings) | **GET** /accounts/{accountId}/recordings | Get Call Recordings
 *Bandwidth::RecordingsApi* | [**list_call_recordings**](docs/RecordingsApi.md#list_call_recordings) | **GET** /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings
 *Bandwidth::RecordingsApi* | [**transcribe_call_recording**](docs/RecordingsApi.md#transcribe_call_recording) | **POST** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request
 *Bandwidth::RecordingsApi* | [**update_call_recording_state**](docs/RecordingsApi.md#update_call_recording_state) | **PUT** /accounts/{accountId}/calls/{callId}/recording | Update Recording
 *Bandwidth::StatisticsApi* | [**get_statistics**](docs/StatisticsApi.md#get_statistics) | **GET** /accounts/{accountId}/statistics | Get Account Statistics
+*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription
+*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription
+*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription
 
 
 ## Documentation for Models
@@ -155,6 +158,9 @@ Class | Method | HTTP request | Description
  - [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)
  - [Bandwidth::CallState](docs/CallState.md)
  - [Bandwidth::CallStateEnum](docs/CallStateEnum.md)
+ - [Bandwidth::CallTranscription](docs/CallTranscription.md)
+ - [Bandwidth::CallTranscriptionMetadata](docs/CallTranscriptionMetadata.md)
+ - [Bandwidth::CallTranscriptionResponse](docs/CallTranscriptionResponse.md)
  - [Bandwidth::CallbackMethodEnum](docs/CallbackMethodEnum.md)
  - [Bandwidth::CodeRequest](docs/CodeRequest.md)
  - [Bandwidth::Conference](docs/Conference.md)
@@ -214,6 +220,8 @@ Class | Method | HTTP request | Description
  - [Bandwidth::RecordingAvailableCallback](docs/RecordingAvailableCallback.md)
  - [Bandwidth::RecordingCompleteCallback](docs/RecordingCompleteCallback.md)
  - [Bandwidth::RecordingStateEnum](docs/RecordingStateEnum.md)
+ - [Bandwidth::RecordingTranscriptionMetadata](docs/RecordingTranscriptionMetadata.md)
+ - [Bandwidth::RecordingTranscriptions](docs/RecordingTranscriptions.md)
  - [Bandwidth::RedirectCallback](docs/RedirectCallback.md)
  - [Bandwidth::RedirectMethodEnum](docs/RedirectMethodEnum.md)
  - [Bandwidth::StirShaken](docs/StirShaken.md)
@@ -222,8 +230,6 @@ Class | Method | HTTP request | Description
  - [Bandwidth::TranscribeRecording](docs/TranscribeRecording.md)
  - [Bandwidth::Transcription](docs/Transcription.md)
  - [Bandwidth::TranscriptionAvailableCallback](docs/TranscriptionAvailableCallback.md)
- - [Bandwidth::TranscriptionList](docs/TranscriptionList.md)
- - [Bandwidth::TranscriptionMetadata](docs/TranscriptionMetadata.md)
  - [Bandwidth::TransferAnswerCallback](docs/TransferAnswerCallback.md)
  - [Bandwidth::TransferCompleteCallback](docs/TransferCompleteCallback.md)
  - [Bandwidth::TransferDisconnectCallback](docs/TransferDisconnectCallback.md)

data/bandwidth.yml

@@ -16,6 +16,7 @@ tags:
   - name: Conferences
   - name: Recordings
   - name: Statistics
+  - name: Transcriptions
   - name: MFA
   - name: Phone Number Lookup
 paths:
@@ -962,9 +963,7 @@ paths:
       description: >-
         Downloads the specified transcription.
 
-
-        If the transcribed recording was multi-channel, then there will be 2
-        transcripts.
+        If the recording was multi-channel, then there will be 2 transcripts.
 
         The caller/called party transcript will be the first item while
         [`<PlayAudio>`](/docs/voice/bxml/playAudio) and
@@ -974,14 +973,14 @@ paths:
         During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript
         will be the first item while the B-leg transcript will be the second
         item.
-      operationId: getCallTranscription
+      operationId: getRecordingTranscription
       parameters:
         - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
         '200':
-          $ref: '#/components/responses/getCallTranscriptionResponse'
+          $ref: '#/components/responses/getRecordingTranscriptionResponse'
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -1047,7 +1046,7 @@ paths:
         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.
-      operationId: deleteCallTranscription
+      operationId: deleteRecordingTranscription
       parameters:
         - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
@@ -1101,6 +1100,108 @@ paths:
         '500':
           $ref: '#/components/responses/voiceInternalServerError'
     servers: *ref_1
+  /accounts/{accountId}/calls/{callId}/transcriptions:
+    get:
+      tags:
+        - Transcriptions
+      summary: Enumerate transcriptions made with StartTranscription
+      description: >-
+        Enumerates the transcriptions created on this call via
+        [startTranscription](/docs/voice/bxml/startTranscription).
+      operationId: listRealTimeTranscriptions
+      parameters:
+        - $ref: '#/components/parameters/accountId'
+        - $ref: '#/components/parameters/callId'
+      responses:
+        '200':
+          $ref: '#/components/responses/listTranscriptionsResponse'
+        '400':
+          $ref: '#/components/responses/voiceBadRequestError'
+        '401':
+          $ref: '#/components/responses/voiceUnauthorizedError'
+        '403':
+          $ref: '#/components/responses/voiceForbiddenError'
+        '404':
+          $ref: '#/components/responses/voiceNotFoundError'
+        '405':
+          $ref: '#/components/responses/voiceNotAllowedError'
+        '415':
+          $ref: '#/components/responses/voiceUnsupportedMediaTypeError'
+        '429':
+          $ref: '#/components/responses/voiceTooManyRequestsError'
+        '500':
+          $ref: '#/components/responses/voiceInternalServerError'
+    servers: *ref_1
+  /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}:
+    get:
+      tags:
+        - Transcriptions
+      summary: Retrieve a specific transcription
+      description: >-
+        Retrieve the specified transcription that was created on this call via
+        [startTranscription](/docs/voice/bxml/startTranscription).
+      operationId: getRealTimeTranscription
+      parameters:
+        - $ref: '#/components/parameters/accountId'
+        - $ref: '#/components/parameters/callId'
+        - $ref: '#/components/parameters/transcriptionId'
+      responses:
+        '200':
+          $ref: '#/components/responses/getCallTranscriptionResponse'
+        '400':
+          $ref: '#/components/responses/voiceBadRequestError'
+        '401':
+          $ref: '#/components/responses/voiceUnauthorizedError'
+        '403':
+          $ref: '#/components/responses/voiceForbiddenError'
+        '404':
+          $ref: '#/components/responses/voiceNotFoundError'
+        '405':
+          $ref: '#/components/responses/voiceNotAllowedError'
+        '415':
+          $ref: '#/components/responses/voiceUnsupportedMediaTypeError'
+        '429':
+          $ref: '#/components/responses/voiceTooManyRequestsError'
+        '500':
+          $ref: '#/components/responses/voiceInternalServerError'
+    delete:
+      tags:
+        - Transcriptions
+      summary: Delete a specific transcription
+      description: >-
+        Delete the specified transcription that was created on this call via
+        [startTranscription](/docs/voice/bxml/startTranscription).
+
+
+        Note: After the deletion is requested and a `204` 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.
+      operationId: deleteRealTimeTranscription
+      parameters:
+        - $ref: '#/components/parameters/accountId'
+        - $ref: '#/components/parameters/callId'
+        - $ref: '#/components/parameters/transcriptionId'
+      responses:
+        '204':
+          $ref: '#/components/responses/deleteCallTranscriptionResponse'
+        '400':
+          $ref: '#/components/responses/voiceBadRequestError'
+        '401':
+          $ref: '#/components/responses/voiceUnauthorizedError'
+        '403':
+          $ref: '#/components/responses/voiceForbiddenError'
+        '404':
+          $ref: '#/components/responses/voiceNotFoundError'
+        '405':
+          $ref: '#/components/responses/voiceNotAllowedError'
+        '415':
+          $ref: '#/components/responses/voiceUnsupportedMediaTypeError'
+        '429':
+          $ref: '#/components/responses/voiceTooManyRequestsError'
+        '500':
+          $ref: '#/components/responses/voiceInternalServerError'
+    servers: *ref_1
   /accounts/{accountId}/code/voice:
     post:
       tags:
@@ -2677,7 +2778,7 @@ components:
         mediaUrl:
           $ref: '#/components/schemas/mediaUrl'
         transcription:
-          $ref: '#/components/schemas/transcriptionMetadata'
+          $ref: '#/components/schemas/recordingTranscriptionMetadata'
     conference:
       type: object
       properties:
@@ -3114,14 +3215,95 @@ components:
             Current supported languages are English, French, and Spanish.
           default: false
           example: true
-    transcriptionList:
+    recordingTranscriptions:
       type: object
       properties:
         transcripts:
           type: array
           items:
             $ref: '#/components/schemas/transcription'
-    transcriptionMetadata:
+    callTranscriptionMetadataList:
+      type: array
+      items:
+        $ref: '#/components/schemas/callTranscriptionMetadata'
+      example:
+        - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
+          transcriptionUrl: >-
+            https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
+    callTranscriptionMetadata:
+      type: object
+      properties:
+        transcriptionId:
+          type: string
+          description: The programmable voice API transcription ID.
+          example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
+        transcriptionUrl:
+          type: string
+          description: >-
+            A URL that may be used to retrieve the transcription itself. This
+            points to the
+
+            [Get Call
+            Transcription](/apis/voice/#operation/getCallTranscription)
+            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
+    callTranscriptionResponse:
+      type: object
+      properties:
+        accountId:
+          type: string
+          description: The user account associated with the call.
+          example: '920012'
+        callId:
+          type: string
+          description: The call id associated with the event.
+          example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+        transcriptionId:
+          type: string
+          description: The programmable voice API transcription ID.
+          example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
+        tracks:
+          type: array
+          items:
+            $ref: '#/components/schemas/callTranscription'
+          example:
+            - detectedLanguage: en-US
+              track: inbound
+              text: Hello World! This is an example.
+              confidence: 0.9
+    callTranscription:
+      type: object
+      properties:
+        detectedLanguage:
+          type: string
+          enum:
+            - en-US
+            - es-US
+            - fr-FR
+          description: The detected language for this transcription.
+          example: en-US
+        track:
+          type: string
+          enum:
+            - inbound
+            - outbound
+          description: Which `track` this transcription is derived from.
+          example: inbound
+        text:
+          type: string
+          description: The transcription itself.
+          example: Hello World! This is an example.
+        confidence:
+          type: number
+          format: double
+          minimum: 0
+          maximum: 1
+          description: >-
+            How confident the transcription engine was in transcribing the
+            associated audio (from `0` to `1`).
+          example: 0.9
+    recordingTranscriptionMetadata:
       nullable: true
       type: object
       description: If the recording was transcribed, metadata about the transcription
@@ -3693,7 +3875,7 @@ components:
         fileFormat:
           $ref: '#/components/schemas/fileFormatEnum'
         channels:
-          $ref: '#/components/schemas/status'
+          $ref: '#/components/schemas/channels'
         tag:
           $ref: '#/components/schemas/tag1'
         status:
@@ -4582,12 +4764,26 @@ components:
           schema:
             type: string
             format: binary
+    getRecordingTranscriptionResponse:
+      description: Transcription found.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/recordingTranscriptions'
+    listTranscriptionsResponse:
+      description: Transcription found.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/callTranscriptionMetadataList'
     getCallTranscriptionResponse:
-      description: Transcription found
+      description: Transcription found.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/transcriptionList'
+            $ref: '#/components/schemas/callTranscriptionResponse'
+    deleteCallTranscriptionResponse:
+      description: Transcription data was deleted.
     listConferencesResponse:
       description: Conferences retrieved successfully
       content:
@@ -5090,6 +5286,14 @@ components:
         type: string
       description: Programmable Voice API Conference Member ID.
       example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+    transcriptionId:
+      name: transcriptionId
+      in: path
+      required: true
+      schema:
+        type: string
+      description: Programmable Voice API Transcription ID.
+      example: t-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
     to:
       name: to
       in: query
@@ -5517,12 +5721,14 @@ components:
     Basic:
       type: http
       scheme: basic
-      description: |-
+      description: >-
         Basic authentication is a simple authentication scheme built into the
-        HTTP protocol. To use it, send your HTTP requests with an Authorization
-        header that contains the word Basic followed by a space and a
-        base64-encoded string `username:password`Example: `Authorization: Basic
-        ZGVtbZpwQDU1dzByZA==`
+        HTTP protocol. To use it, send your HTTP requests with an
+        `Authorization` header that contains the word `Basic` followed by a
+        space and a Base64-encoded string `username:password`.
+
+
+        - Example: `Authorization: Basic ZGVtbZpwQDU1dzByZA==`
   callbacks:
     inboundCallback:
       '{inboundCallbackUrl}':

data/coverage/.last_run.json

@@ -1,5 +1,5 @@
 {
   "result": {
-    "line": 96.11
+    "line": 96.21
   }
 }