bandwidth-sdk 3.5.0 → 3.10.0

data/lib/bandwidth/voice_lib/voice/models/redirect_fallback_method_enum.rb

@@ -0,0 +1,17 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # RedirectFallbackMethod.
+  class RedirectFallbackMethodEnum
+    REDIRECT_FALLBACK_METHOD_ENUM = [
+      # TODO: Write general description for POST
+      POST = 'POST'.freeze,
+
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze
+    ].freeze
+  end
+end

data/lib/bandwidth/voice_lib/voice/models/state_enum.rb

@@ -8,13 +8,13 @@ module Bandwidth
   class StateEnum
     STATE_ENUM = [
       # TODO: Write general description for DISCONNECTED
-      DISCONNECTED = 'DISCONNECTED'.freeze,
+      DISCONNECTED = 'disconnected'.freeze,
 
       # TODO: Write general description for ANSWERED
-      ANSWERED = 'ANSWERED'.freeze,
+      ANSWERED = 'answered'.freeze,
 
       # TODO: Write general description for INITIATED
-      INITIATED = 'INITIATED'.freeze
+      INITIATED = 'initiated'.freeze
     ].freeze
   end
 end

data/lib/bandwidth/voice_lib/voice/models/status1_enum.rb

@@ -20,7 +20,10 @@ module Bandwidth
       DELETED = 'deleted'.freeze,
 
       # TODO: Write general description for ERROR
-      ERROR = 'error'.freeze
+      ERROR = 'error'.freeze,
+
+      # TODO: Write general description for ALREADYINPROGRESS
+      ALREADYINPROGRESS = 'already-in-progress'.freeze
     ].freeze
   end
 end

data/lib/bandwidth/voice_lib/voice/models/{status2_enum.rb → status3_enum.rb}

@@ -4,9 +4,9 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # Status2.
-  class Status2Enum
-    STATUS2_ENUM = [
+  # Status3.
+  class Status3Enum
+    STATUS3_ENUM = [
       # TODO: Write general description for NONE
       NONE = 'none'.freeze,
 

data/lib/bandwidth/voice_lib/voice/models/transcription.rb

@@ -11,7 +11,7 @@ module Bandwidth
     attr_accessor :id
 
     # TODO: Write general description for this method
-    # @return [Status2Enum]
+    # @return [Status3Enum]
     attr_accessor :status
 
     # TODO: Write general description for this method

data/lib/bandwidth/web_rtc_lib/web_rtc.rb

@@ -0,0 +1,21 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+
+require_relative 'web_rtc/client.rb'
+
+# Models
+require_relative 'web_rtc/models/session.rb'
+require_relative 'web_rtc/models/participant.rb'
+require_relative 'web_rtc/models/subscriptions.rb'
+require_relative 'web_rtc/models/participant_subscription.rb'
+require_relative 'web_rtc/models/accounts_participants_response.rb'
+require_relative 'web_rtc/models/publish_permission_enum.rb'
+
+# Exceptions
+require_relative 'web_rtc/exceptions/error_exception.rb'
+# Controllers
+require_relative 'web_rtc/controllers/base_controller.rb'
+require_relative 'web_rtc/controllers/api_controller.rb'

data/lib/bandwidth/web_rtc_lib/web_rtc/client.rb

@@ -0,0 +1,51 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+    module WebRtc
+      #  bandwidth client class.
+      class Client
+        attr_reader :config
+
+        # Access to client controller.
+        # @return [APIController] Returns the controller instance.
+        def client
+          @client ||= APIController.new config
+        end
+
+        def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       base_url: 'https://www.example.com',
+                       messaging_basic_auth_user_name: 'TODO: Replace',
+                       messaging_basic_auth_password: 'TODO: Replace',
+                       two_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       two_factor_auth_basic_auth_password: 'TODO: Replace',
+                       voice_basic_auth_user_name: 'TODO: Replace',
+                       voice_basic_auth_password: 'TODO: Replace',
+                       web_rtc_basic_auth_user_name: 'TODO: Replace',
+                       web_rtc_basic_auth_password: 'TODO: Replace',
+                       config: nil)
+          @config = if config.nil?
+                      Configuration.new(timeout: timeout,
+                                        max_retries: max_retries,
+                                        retry_interval: retry_interval,
+                                        backoff_factor: backoff_factor,
+                                        environment: environment,
+                                        base_url: base_url,
+                                        messaging_basic_auth_user_name: messaging_basic_auth_user_name,
+                                        messaging_basic_auth_password: messaging_basic_auth_password,
+                                        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
+                                        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+                                        voice_basic_auth_user_name: voice_basic_auth_user_name,
+                                        voice_basic_auth_password: voice_basic_auth_password,
+                                        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                        web_rtc_basic_auth_password: web_rtc_basic_auth_password)
+                    else
+                      config
+                    end
+        end
+  end
+end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb

@@ -0,0 +1,692 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+module WebRtc
+  # APIController
+  class APIController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Create a new participant under this account
+    # Participants are idempotent, so relevant parameters must be set in this
+    # function if desired
+    # @param [String] account_id Required parameter: Account ID
+    # @param [Participant] body Optional parameter: Participant parameters
+    # @return [AccountsParticipantsResponse] response from the API call
+    def create_participant(account_id,
+                           body: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/participants'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise APIException.new(
+          'Bad Request',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response,
+        data: AccountsParticipantsResponse.from_hash(decoded)
+      )
+    end
+
+    # Get participant by ID
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] participant_id Required parameter: Participant ID
+    # @return [Participant] response from the API call
+    def get_participant(account_id,
+                        participant_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/participants/{participantId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'participantId' => { 'value' => participant_id, 'encode' => true }
+      )
+      _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
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: Participant.from_hash(decoded)
+      )
+    end
+
+    # Delete participant by ID
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] participant_id Required parameter: Example:
+    # @return [void] response from the API call
+    def delete_participant(account_id,
+                           participant_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/participants/{participantId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'participantId' => { 'value' => participant_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # Create a new session
+    # Sessions are idempotent, so relevant parameters must be set in this
+    # function if desired
+    # @param [String] account_id Required parameter: Account ID
+    # @param [Session] body Optional parameter: Session parameters
+    # @return [Session] response from the API call
+    def create_session(account_id,
+                       body: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise APIException.new(
+          'Bad Request',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: Session.from_hash(decoded)
+      )
+    end
+
+    # Get session by ID
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] session_id Required parameter: Session ID
+    # @return [Session] response from the API call
+    def get_session(account_id,
+                    session_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true }
+      )
+      _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
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: Session.from_hash(decoded)
+      )
+    end
+
+    # Delete session by ID
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] session_id Required parameter: Session ID
+    # @return [void] response from the API call
+    def delete_session(account_id,
+                       session_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # List participants in a session
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] session_id Required parameter: Session ID
+    # @return [List of Participant] response from the API call
+    def list_session_participants(account_id,
+                                  session_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true }
+      )
+      _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
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response,
+        data: decoded.map { |element| Participant.from_hash(element) }
+      )
+    end
+
+    # Add a participant to a session
+    # Subscriptions can optionally be provided as part of this call
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] session_id Required parameter: Session ID
+    # @param [String] participant_id Required parameter: Participant ID
+    # @param [Subscriptions] body Optional parameter: Subscriptions the
+    # participant should be created with
+    # @return [void] response from the API call
+    def add_participant_to_session(account_id,
+                                   session_id,
+                                   participant_id,
+                                   body: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true },
+        'participantId' => { 'value' => participant_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # Remove a participant from a session
+    # This will automatically remove any subscriptions the participant has
+    # associated with this session
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] participant_id Required parameter: Participant ID
+    # @param [String] session_id Required parameter: Session ID
+    # @return [void] response from the API call
+    def remove_participant_from_session(account_id,
+                                        participant_id,
+                                        session_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'participantId' => { 'value' => participant_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # Get a participant's subscriptions
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] participant_id Required parameter: Participant ID
+    # @param [String] session_id Required parameter: Session ID
+    # @return [Subscriptions] response from the API call
+    def get_participant_subscriptions(account_id,
+                                      participant_id,
+                                      session_id)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'participantId' => { 'value' => participant_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true }
+      )
+      _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
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: Subscriptions.from_hash(decoded)
+      )
+    end
+
+    # Update a participant's subscriptions
+    # This is a full update that will replace the participant's subscriptions.
+    # First call `getParticipantSubscriptions` if you need the current
+    # subscriptions. Call this function with no `Subscriptions` object to remove
+    # all subscriptions
+    # @param [String] account_id Required parameter: Account ID
+    # @param [String] participant_id Required parameter: Participant ID
+    # @param [String] session_id Required parameter: Session ID
+    # @param [Subscriptions] body Optional parameter: Initial state
+    # @return [void] response from the API call
+    def update_participant_subscriptions(account_id,
+                                         participant_id,
+                                         session_id,
+                                         body: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
+      _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => true },
+        'participantId' => { 'value' => participant_id, 'encode' => true },
+        'sessionId' => { 'value' => session_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      WebRtcBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise APIException.new(
+          'Bad Request',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise APIException.new(
+          'Unauthorized',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise APIException.new(
+          'Access Denied',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise APIException.new(
+          'Not Found',
+          _response
+        )
+      end
+      unless _response.status_code.between?(200, 208)
+        raise ErrorException.new(
+          'Unexpected Error',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+  end
+end
+end