bandwidth-sdk 3.6.0 → 3.7.0

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

@@ -0,0 +1,49 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.7.0'
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back.on_after_response(response) if @http_call_back
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/exceptions/error_exception.rb

@@ -0,0 +1,34 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Error class.
+  class ErrorException < APIException
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @code = hash['code']
+      @message = hash['message']
+    end
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/accounts_participants_response.rb

@@ -0,0 +1,47 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # AccountsParticipantsResponse Model.
+  class AccountsParticipantsResponse < BaseModel
+    # A participant object
+    # @return [Participant]
+    attr_accessor :participant
+
+    # Auth token for the returned participant
+    # This should be passed to the participant so that they can connect to the
+    # platform
+    # @return [String]
+    attr_accessor :token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['participant'] = 'participant'
+      @_hash['token'] = 'token'
+      @_hash
+    end
+
+    def initialize(participant = nil,
+                   token = nil)
+      @participant = participant
+      @token = token
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      participant = Participant.from_hash(hash['participant']) if
+        hash['participant']
+      token = hash['token']
+
+      # Create object from extracted values.
+      AccountsParticipantsResponse.new(participant,
+                                       token)
+    end
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant.rb

@@ -0,0 +1,83 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # A participant object
+  class Participant < BaseModel
+    # Unique id of the participant
+    # @return [String]
+    attr_accessor :id
+
+    # Full callback url to use for notifications about this participant
+    # @return [String]
+    attr_accessor :callback_url
+
+    # Defines if this participant can publish audio or video
+    # @return [List of PublishPermissionEnum]
+    attr_accessor :publish_permissions
+
+    # List of session ids this participant is associated with
+    # Capped to one
+    # @return [List of String]
+    attr_accessor :sessions
+
+    # List of session ids this participant is associated with
+    # Capped to one
+    # @return [Subscriptions]
+    attr_accessor :subscriptions
+
+    # User defined tag to associate with the participant
+    # @return [String]
+    attr_accessor :tag
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['callback_url'] = 'callbackUrl'
+      @_hash['publish_permissions'] = 'publishPermissions'
+      @_hash['sessions'] = 'sessions'
+      @_hash['subscriptions'] = 'subscriptions'
+      @_hash['tag'] = 'tag'
+      @_hash
+    end
+
+    def initialize(id = nil,
+                   callback_url = nil,
+                   publish_permissions = nil,
+                   sessions = nil,
+                   subscriptions = nil,
+                   tag = nil)
+      @id = id
+      @callback_url = callback_url
+      @publish_permissions = publish_permissions
+      @sessions = sessions
+      @subscriptions = subscriptions
+      @tag = tag
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash['id']
+      callback_url = hash['callbackUrl']
+      publish_permissions = hash['publishPermissions']
+      sessions = hash['sessions']
+      subscriptions = Subscriptions.from_hash(hash['subscriptions']) if
+        hash['subscriptions']
+      tag = hash['tag']
+
+      # Create object from extracted values.
+      Participant.new(id,
+                      callback_url,
+                      publish_permissions,
+                      sessions,
+                      subscriptions,
+                      tag)
+    end
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb

@@ -0,0 +1,35 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # ParticipantSubscription Model.
+  class ParticipantSubscription < BaseModel
+    # Participant the subscriber should be subscribed to
+    # @return [String]
+    attr_accessor :participant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['participant_id'] = 'participantId'
+      @_hash
+    end
+
+    def initialize(participant_id = nil)
+      @participant_id = participant_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      participant_id = hash['participantId']
+
+      # Create object from extracted values.
+      ParticipantSubscription.new(participant_id)
+    end
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/publish_permission_enum.rb

@@ -0,0 +1,17 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # PublishPermission.
+  class PublishPermissionEnum
+    PUBLISH_PERMISSION_ENUM = [
+      # TODO: Write general description for AUDIO
+      AUDIO = 'AUDIO'.freeze,
+
+      # TODO: Write general description for VIDEO
+      VIDEO = 'VIDEO'.freeze
+    ].freeze
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb

@@ -0,0 +1,44 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # A session object
+  class Session < BaseModel
+    # Unique id of the session
+    # @return [String]
+    attr_accessor :id
+
+    # User defined tag to associate with the session
+    # @return [String]
+    attr_accessor :tag
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['tag'] = 'tag'
+      @_hash
+    end
+
+    def initialize(id = nil,
+                   tag = nil)
+      @id = id
+      @tag = tag
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash['id']
+      tag = hash['tag']
+
+      # Create object from extracted values.
+      Session.new(id,
+                  tag)
+    end
+  end
+end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/subscriptions.rb

@@ -0,0 +1,54 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Subscriptions Model.
+  class Subscriptions < BaseModel
+    # Session the subscriptions are associated with
+    # If this is the only field, the subscriber will be subscribed to all
+    # participants in the session (including any participants that are later
+    # added to the session)
+    # @return [String]
+    attr_accessor :session_id
+
+    # Subset of participants to subscribe to in the session. Optional.
+    # @return [List of ParticipantSubscription]
+    attr_accessor :participants
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['session_id'] = 'sessionId'
+      @_hash['participants'] = 'participants'
+      @_hash
+    end
+
+    def initialize(session_id = nil,
+                   participants = nil)
+      @session_id = session_id
+      @participants = participants
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      session_id = hash['sessionId']
+      # Parameter is an array, so we need to iterate through it
+      participants = nil
+      unless hash['participants'].nil?
+        participants = []
+        hash['participants'].each do |structure|
+          participants << (ParticipantSubscription.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      Subscriptions.new(session_id,
+                        participants)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - APIMatic SDK Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -111,6 +111,7 @@ files:
 - lib/bandwidth/http/auth/messaging_basic_auth.rb
 - lib/bandwidth/http/auth/two_factor_auth_basic_auth.rb
 - lib/bandwidth/http/auth/voice_basic_auth.rb
+- lib/bandwidth/http/auth/web_rtc_basic_auth.rb
 - lib/bandwidth/http/faraday_client.rb
 - lib/bandwidth/http/http_call_back.rb
 - lib/bandwidth/http/http_client.rb
@@ -188,6 +189,17 @@ files:
 - lib/bandwidth/voice_lib/voice/models/transcript.rb
 - lib/bandwidth/voice_lib/voice/models/transcription.rb
 - lib/bandwidth/voice_lib/voice/models/transcription_response.rb
+- lib/bandwidth/web_rtc_lib/web_rtc.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/client.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/controllers/base_controller.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/exceptions/error_exception.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/models/accounts_participants_response.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/models/participant.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/models/publish_permission_enum.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb
+- lib/bandwidth/web_rtc_lib/web_rtc/models/subscriptions.rb
 homepage: https://apimatic.io
 licenses:
 - MIT