bandwidth-sdk 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a08fba9df25add3682d001d09a80cc04b5c0565488a4526f06e4bc528dab5492
-  data.tar.gz: 97299422f725aaf94f9d82c63dd042602f310c065f0b21742f5264bf2862fb4c
+  metadata.gz: 18591a5d5044520f1468b2739bf7f7d3f2e55c90256808ee87c88035b2547955
+  data.tar.gz: 94718076a51266243ac4da676d6719ae4c3c8143f1ee41a2d4f74845160f5a7c
 SHA512:
-  metadata.gz: f54a8299f7ccfe91e5085898e5bc857778fccb2700bd8b62f5b18f8a1abad277683a708d18b77e39c4960a80664b4908ebf0b33d70699188b17d47f1c0b955f3
-  data.tar.gz: c5cf922c1d5df2617d98d0efa00084104c27c2edc6a75b0db9d35097aa2ba658e5a78e8645e53900ccd8c264391a98b78118a11d66f475f199d0d07f6a54a9d3
+  metadata.gz: f4a3945a2bdc1dc56df26eaf365a6be187c25949accedcc1b711079273e42b29fcbffcb1a336a0a92f2e563638a01bfdfc0d6c2c2314fa7bb5be11b42f8c4cbe
+  data.tar.gz: 79820119110f3e897e7da7115a957db73ebaa3ad27255c96de2ab7d740415bd85e221aafc72561fdff7ad9666fe845755dd436d8aac071eb9b975ab80b61f566

data/LICENSE

@@ -1,28 +1,28 @@
-License: 
-========
-The MIT License (MIT)
-http://opensource.org/licenses/MIT
-
-Copyright (c) 2014 - 2016 APIMATIC Limited
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-Trade Mark:
-==========
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
 APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -2,69 +2,28 @@
 
 Bandwidth's set of APIs
 
+## Install the Package
 
-## Building
+Install the gem from the command line:
 
-The generated code depends on a few Ruby gems. The references to these gems are added in the gemspec file. The easiest way to resolve the dependencies, build the gem and install it is through Rake:
-
-1. Install Rake if not already installed: `gem install rake`
-  2. Install Bundler if not already installed: `gem install bundler`
-  3. From terminal/cmd navigate to the root directory of the SDK.
-  4. Invoke: `rake install`
-
-Alternatively, you can build and install the gem manually:
-
-1. From terminal/cmd navigate to the root directory of the SDK.
-  2. Run the build command: `gem build bandwidth.gemspec`
-  3. Run the install command: `gem install bandwidth-1.0.1.gem`
-
-![Installing Gem](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&gemVer=1.0.1&gemName=bandwidth&step=buildSDK)
-
-## Installation
-
-The following section explains how to use the bandwidth ruby gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
-
-### 1. Starting a new project
-
-Close any existing projects in RubyMine™ by selecting `File -> Close Project`. Next, click on `Create New Project` to create a new project from scratch.
-
-![Create a new project in RubyMine - Step 1](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&step=createNewProject0)
-
-Next, provide `TestApp` as the project name, choose `Rails Application` as the project type, and click `OK`.
-
-![Create a new Rails Application in RubyMine - Step 2](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&step=createNewProject1)
-
-In the next dialog make sure that the correct Ruby SDK is being used (minimum 2.0.0) and click `OK`.
-
-![Create a new Rails Application in RubyMine - Step 3](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&step=createNewProject2)
-
-### 2. Add reference of the gem
-
-In order to use the Tester gem in the new project we must add a gem reference. Locate the `Gemfile` in the Project Explorer window under the `TestApp` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: `gem 'bandwidth', '~> 1.0.1'`
-
-![Add new reference to the Gemfile](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&gemVer=1.0.1&gemName=bandwidth&step=addReference)
-
-### 3. Adding a new Rails Controller
-
-Once the `TestApp` project is created, a folder named `controllers` will be visible in the *Project Explorer* under the following path: `TestApp > app > controllers`. Right click on this folder and select `New -> Run Rails Generator...`.
-
-![Run Rails Generator on Controllers Folder](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&gemVer=1.0.1&gemName=bandwidth&step=addCode0)
+```ruby
+gem install bandwidth-sdk -v 1.0.2
+```
 
-Selecting the said option will popup a small window where the generator names are displayed. Here, select the `controller` template.
+Or add the gem to your Gemfile and run `bundle`:
 
-![Create a new Controller](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&step=addCode1)
+```ruby
+gem 'bandwidth-sdk', '1.0.2'
+```
 
-Next, a popup window will ask you for a Controller name and included Actions. For controller name provide `Hello` and include an action named `Index` and click `OK`.
+For additional gem details, see the [RubyGems page for the bandwidth-sdk gem](https://rubygems.org/gems/bandwidth-sdk/versions/1.0.2).
 
-![Add a new Controller](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&gemVer=1.0.1&gemName=bandwidth&step=addCode2)
 
-A new controller class named `HelloController` will be created in a file named `hello_controller.rb` containing a method named `Index`. In this method, add code for initialization and a sample for its usage.
 
-![Initialize the library](https://apidocs.io/illustration/ruby?workspaceFolder=Bandwidth&gemName=bandwidth&step=addCode3)
 
-## Usage
+## Initialize the API Client
 
-To initialize the API client, the following parameters need to be passed.
+The following parameters are configurable for the API Client.
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
@@ -72,12 +31,13 @@ To initialize the API client, the following parameters need to be passed.
 | `messaging_basic_auth_password` | `String` | The password to use with basic authentication |
 | `voice_basic_auth_user_name` | `String` | The username to use with basic authentication |
 | `voice_basic_auth_password` | `String` | The password to use with basic authentication |
-| `timeout` | `Float` | The value to use for connection timeout |
-| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails |
-| `retry_interval` | `Float` | Pause in seconds between retries |
-| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff |
+| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 1** |
 
-The API client can be initialized using a Configuration object as following.
+The API client can be initialized as following.
 
 ```ruby
 client = Bandwidth::Client.new(
@@ -101,7 +61,6 @@ API calls return an `ApiResponse` object that includes the following fields:
 | `errors` | Errors, if they exist |
 | `data` | The deserialized body of the HTTP response |
 
-
 ## Authorization
 
 This API does not require authentication.

data/lib/bandwidth/api_helper.rb

@@ -235,6 +235,10 @@ module Bandwidth
           retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
             key.to_s + ']', formatting: formatting))
         end
+      elsif obj.instance_of? File
+        retval[instance_name] = UploadIO.new(
+          obj, 'application/octet-stream', File.basename(obj.path)
+        )
       else
         retval[instance_name] = obj
       end

data/lib/bandwidth/client.rb

@@ -18,7 +18,7 @@ module Bandwidth
       @voice_client ||= Voice::Client.new(config: config)
     end
 
-    def initialize(timeout: 0, max_retries: 0, retry_interval: 1,
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',

data/lib/bandwidth/configuration.rb

@@ -39,7 +39,7 @@ module Bandwidth
       attr_reader :environments
     end
 
-    def initialize(timeout: 0, max_retries: 0, retry_interval: 1,
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
@@ -115,7 +115,7 @@ module Bandwidth
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
-        Server::VOICEDEFAULT => 'https://voice.bandwidth.com/api/v2/'
+        Server::VOICEDEFAULT => 'https://voice.bandwidth.com'
       }
     }
 

data/lib/bandwidth/messaging_lib/messaging/client.rb

@@ -15,7 +15,7 @@ module Bandwidth
           @client ||= APIController.new config
         end
 
-        def initialize(timeout: 0, max_retries: 0, retry_interval: 1,
+        def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                        backoff_factor: 1, environment: Environment::PRODUCTION,
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',

data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb

@@ -29,7 +29,7 @@ module Bandwidth
       @http_call_back.on_before_request(request) if @http_call_back
 
       APIHelper.clean_hash(request.headers)
-      request.headers = @global_headers.clone.merge(request.headers)
+      request.headers.merge!(@global_headers)
 
       response = if binary
                    config.http_client.execute_as_binary(request)

data/lib/bandwidth/voice_lib/bxml/verbs/record.rb

@@ -0,0 +1,26 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth
+  module Voice
+    # The Record verb is used to trigger call recording
+    class Record
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Record(compact_hash({
+         'tag' => tag,
+         'username' => username,
+         'password' => password,
+         'recordCompleteUrl' => record_complete_url,
+         'recordCompleteMethod' => record_complete_method,
+         'recordingAvailableUrl' => recording_available_url,
+         'recordingAvailableMethod' => recording_available_method,
+         'terminatingDigits' => terminating_digits,
+         'maxDuration' => max_duration,
+         'fileFormat' => file_format
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/voice.rb

@@ -7,20 +7,21 @@
 require_relative 'voice/client.rb'
 
 # Models
-require_relative 'voice/models/field_error.rb'
 require_relative 'voice/models/api_call_response.rb'
 require_relative 'voice/models/api_create_call_request.rb'
 require_relative 'voice/models/api_modify_call_request.rb'
-require_relative 'voice/models/bandwidth_callback_message_voice.rb'
+require_relative 'voice/models/duration.rb'
+require_relative 'voice/models/recording_metadata_response.rb'
+require_relative 'voice/models/temporal_unit.rb'
 require_relative 'voice/models/answer_method_enum.rb'
+require_relative 'voice/models/direction_enum.rb'
 require_relative 'voice/models/disconnect_method_enum.rb'
+require_relative 'voice/models/file_format_enum.rb'
 require_relative 'voice/models/redirect_method_enum.rb'
 require_relative 'voice/models/state_enum.rb'
+require_relative 'voice/models/transcription_status_enum.rb'
 
 # Exceptions
-require_relative 'voice/exceptions/bandwidth_exception.rb'
-require_relative 'voice/exceptions/bandwidth_not_found_exception.rb'
-require_relative 'voice/exceptions/bandwidth_rate_limit_error_exception.rb'
 # Controllers
 require_relative 'voice/controllers/base_controller.rb'
 require_relative 'voice/controllers/api_controller.rb'

data/lib/bandwidth/voice_lib/voice/client.rb

@@ -15,7 +15,7 @@ module Bandwidth
           @client ||= APIController.new config
         end
 
-        def initialize(timeout: 0, max_retries: 0, retry_interval: 1,
+        def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                        backoff_factor: 1, environment: Environment::PRODUCTION,
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',

data/lib/bandwidth/voice_lib/voice/controllers/api_controller.rb

@@ -19,7 +19,7 @@ module Voice
                     body: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
-      _query_builder << '/accounts/{accountId}/calls'
+      _query_builder << '/api/v2/accounts/{accountId}/calls'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'accountId' => account_id
@@ -40,54 +40,6 @@ module Voice
       )
       VoiceBasicAuth.apply(config, _request)
       _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
-        raise BandwidthException.new(
-          '400 request is malformed or invalid',
-          _response
-        )
-      elsif _response.status_code == 401
-        raise BandwidthException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      elsif _response.status_code == 403
-        raise BandwidthException.new(
-          '403  The user does not have access to the API',
-          _response
-        )
-      elsif _response.status_code == 404
-        raise BandwidthNotFoundException.new(
-          '404 he call-id is no longer active, or the path is not found',
-          _response
-        )
-      elsif _response.status_code == 409
-        raise BandwidthException.new(
-          '409 Error when modifying a call that is unable to be modified',
-          _response
-        )
-      elsif _response.status_code == 415
-        raise BandwidthException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      elsif _response.status_code == 429
-        raise BandwidthRateLimitErrorException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      elsif _response.status_code == 500
-        raise BandwidthException.new(
-          '500 Unknown server error',
-          _response
-        )
-      elsif _response.status_code == 503
-        raise BandwidthException.new(
-          '503 The service is unavailable for some reason',
-          _response
-        )
-      end
       validate_response(_response)
 
       # Return appropriate response type.
@@ -95,7 +47,7 @@ module Voice
       ApiResponse.new(_response, data: ApiCallResponse.from_hash(decoded))
     end
 
-    # Creates a call request
+    # Interrupts and replaces an active call's BXML document
     # @param [String] account_id Required parameter: Example:
     # @param [String] call_id Required parameter: Example:
     # @param [ApiModifyCallRequest] body Optional parameter: Example:
@@ -105,7 +57,7 @@ module Voice
                     body: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
-      _query_builder << '/accounts/{accountId}/calls/{callId}'
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'accountId' => account_id,
@@ -126,59 +78,187 @@ module Voice
       )
       VoiceBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # Returns a (potentially empty) list of metadata for the recordings that
+    # took place during the specified call
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] call_id Required parameter: Example:
+    # @return [List of RecordingMetadataResponse] response from the API call
+    def get_query_metadata_for_account_and_call(account_id,
+                                                call_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id,
+        'callId' => call_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response,
+        data: decoded.map { |element| RecordingMetadataResponse.from_hash(element) }
+      )
+    end
+
+    # Returns metadata for the specified recording
+    # @param [String] recording_id Required parameter: Example:
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] call_id Required parameter: Example:
+    # @return [RecordingMetadataResponse] response from the API call
+    def get_metadata_for_recording(recording_id,
+                                   account_id,
+                                   call_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'recordingId' => recording_id,
+        'accountId' => account_id,
+        'callId' => call_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(_response,
+                      data: RecordingMetadataResponse.from_hash(decoded))
+    end
 
-      # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
-        raise BandwidthException.new(
-          '400 request is malformed or invalid',
-          _response
-        )
-      elsif _response.status_code == 401
-        raise BandwidthException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      elsif _response.status_code == 403
-        raise BandwidthException.new(
-          '403  The user does not have access to the API',
-          _response
-        )
-      elsif _response.status_code == 404
-        raise BandwidthNotFoundException.new(
-          '404 he call-id is no longer active, or the path is not found',
-          _response
-        )
-      elsif _response.status_code == 409
-        raise BandwidthException.new(
-          '409 Error when modifying a call that is unable to be modified',
-          _response
-        )
-      elsif _response.status_code == 415
-        raise BandwidthException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      elsif _response.status_code == 429
-        raise BandwidthRateLimitErrorException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      elsif _response.status_code == 500
-        raise BandwidthException.new(
-          '500 Unknown server error',
-          _response
-        )
-      elsif _response.status_code == 503
-        raise BandwidthException.new(
-          '503 The service is unavailable for some reason',
-          _response
-        )
-      end
+    # Deletes the specified recording
+    # @param [String] recording_id Required parameter: Example:
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] call_id Required parameter: Example:
+    # @return [void] response from the API call
+    def delete_recording(recording_id,
+                         account_id,
+                         call_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'recordingId' => recording_id,
+        'accountId' => account_id,
+        'callId' => call_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
       validate_response(_response)
 
       # Return appropriate response type.
       ApiResponse.new(_response)
     end
+
+    # Downloads the specified recording
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] call_id Required parameter: Example:
+    # @param [String] recording_id Required parameter: Example:
+    # @return [String] response from the API call
+    def get_stream_recording_media(account_id,
+                                   call_id,
+                                   recording_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id,
+        'callId' => call_id,
+        'recordingId' => recording_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response, data: _response.raw_body)
+    end
+
+    # Returns a (potentially empty; capped at 1000) list of metadata for the
+    # recordings associated with the specified account
+    # @param [String] account_id Required parameter: Example:
+    # @return [List of RecordingMetadataResponse] response from the API call
+    def get_query_metadata_for_account(account_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/recordings'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response,
+        data: decoded.map { |element| RecordingMetadataResponse.from_hash(element) }
+      )
+    end
   end
 end
 end