bandwidth-sdk 6.2.0 → 9.0.0

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

@@ -0,0 +1,173 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Bandwidth
+  # ConferenceRecordingMetadata Model.
+  class ConferenceRecordingMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :conference_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :recording_id
+
+    # Format is ISO-8601
+    # @return [String]
+    attr_accessor :duration
+
+    # Format is ISO-8601
+    # @return [Integer]
+    attr_accessor :channels
+
+    # Format is ISO-8601
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # Format is ISO-8601
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # Format is ISO-8601
+    # @return [FileFormatEnum]
+    attr_accessor :file_format
+
+    # The current status of the recording. Current possible values are
+    # 'processing', 'partial', 'complete', 'deleted', and 'error'. Additional
+    # states may be added in the future, so your application must be tolerant of
+    # unknown values.
+    # @return [String]
+    attr_accessor :status
+
+    # The current status of the recording. Current possible values are
+    # 'processing', 'partial', 'complete', 'deleted', and 'error'. Additional
+    # states may be added in the future, so your application must be tolerant of
+    # unknown values.
+    # @return [String]
+    attr_accessor :media_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['conference_id'] = 'conferenceId'
+      @_hash['name'] = 'name'
+      @_hash['recording_id'] = 'recordingId'
+      @_hash['duration'] = 'duration'
+      @_hash['channels'] = 'channels'
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['file_format'] = 'fileFormat'
+      @_hash['status'] = 'status'
+      @_hash['media_url'] = 'mediaUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        account_id
+        conference_id
+        name
+        recording_id
+        duration
+        channels
+        start_time
+        end_time
+        file_format
+        status
+        media_url
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(account_id = nil,
+                   conference_id = nil,
+                   name = nil,
+                   recording_id = nil,
+                   duration = nil,
+                   channels = nil,
+                   start_time = nil,
+                   end_time = nil,
+                   file_format = nil,
+                   status = nil,
+                   media_url = nil)
+      @account_id = account_id unless account_id == SKIP
+      @conference_id = conference_id unless conference_id == SKIP
+      @name = name unless name == SKIP
+      @recording_id = recording_id unless recording_id == SKIP
+      @duration = duration unless duration == SKIP
+      @channels = channels unless channels == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @file_format = file_format unless file_format == SKIP
+      @status = status unless status == SKIP
+      @media_url = media_url unless media_url == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      conference_id = hash.key?('conferenceId') ? hash['conferenceId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      recording_id = hash.key?('recordingId') ? hash['recordingId'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      channels = hash.key?('channels') ? hash['channels'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      end_time = if hash.key?('endTime')
+                   (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
+                 else
+                   SKIP
+                 end
+      file_format = hash.key?('fileFormat') ? hash['fileFormat'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      media_url = hash.key?('mediaUrl') ? hash['mediaUrl'] : SKIP
+
+      # Create object from extracted values.
+      ConferenceRecordingMetadata.new(account_id,
+                                      conference_id,
+                                      name,
+                                      recording_id,
+                                      duration,
+                                      channels,
+                                      start_time,
+                                      end_time,
+                                      file_format,
+                                      status,
+                                      media_url)
+    end
+
+    def to_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    end
+  end
+end

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

@@ -0,0 +1,153 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Bandwidth
+  # ConferenceState Model.
+  class ConferenceState < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_time
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :completed_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :conference_event_url
+
+    # TODO: Write general description for this method
+    # @return [ConferenceEventMethodEnum]
+    attr_accessor :conference_event_method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tag
+
+    # TODO: Write general description for this method
+    # @return [List of ConferenceMemberState]
+    attr_accessor :active_members
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['created_time'] = 'createdTime'
+      @_hash['completed_time'] = 'completedTime'
+      @_hash['conference_event_url'] = 'conferenceEventUrl'
+      @_hash['conference_event_method'] = 'conferenceEventMethod'
+      @_hash['tag'] = 'tag'
+      @_hash['active_members'] = 'activeMembers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        id
+        name
+        created_time
+        completed_time
+        conference_event_url
+        conference_event_method
+        tag
+        active_members
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        completed_time
+        conference_event_url
+        conference_event_method
+        tag
+      ]
+    end
+
+    def initialize(id = nil,
+                   name = nil,
+                   created_time = nil,
+                   completed_time = nil,
+                   conference_event_url = nil,
+                   conference_event_method = nil,
+                   tag = nil,
+                   active_members = nil)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @created_time = created_time unless created_time == SKIP
+      @completed_time = completed_time unless completed_time == SKIP
+      @conference_event_url = conference_event_url unless conference_event_url == SKIP
+      @conference_event_method = conference_event_method unless conference_event_method == SKIP
+      @tag = tag unless tag == SKIP
+      @active_members = active_members unless active_members == SKIP
+    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.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      created_time = if hash.key?('createdTime')
+                       (DateTimeHelper.from_rfc3339(hash['createdTime']) if hash['createdTime'])
+                     else
+                       SKIP
+                     end
+      completed_time = if hash.key?('completedTime')
+                         (DateTimeHelper.from_rfc3339(hash['completedTime']) if hash['completedTime'])
+                       else
+                         SKIP
+                       end
+      conference_event_url =
+        hash.key?('conferenceEventUrl') ? hash['conferenceEventUrl'] : SKIP
+      conference_event_method =
+        hash.key?('conferenceEventMethod') ? hash['conferenceEventMethod'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      active_members = nil
+      unless hash['activeMembers'].nil?
+        active_members = []
+        hash['activeMembers'].each do |structure|
+          active_members << (ConferenceMemberState.from_hash(structure) if structure)
+        end
+      end
+
+      active_members = SKIP unless hash.key?('activeMembers')
+
+      # Create object from extracted values.
+      ConferenceState.new(id,
+                          name,
+                          created_time,
+                          completed_time,
+                          conference_event_url,
+                          conference_event_method,
+                          tag,
+                          active_members)
+    end
+
+    def to_created_time
+      DateTimeHelper.to_rfc3339(created_time)
+    end
+
+    def to_completed_time
+      DateTimeHelper.to_rfc3339(completed_time)
+    end
+  end
+end

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

@@ -0,0 +1,301 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # CreateCallRequest Model.
+  class CreateCallRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Format is E164
+    # @return [String]
+    attr_accessor :from
+
+    # Format is E164 or SIP URI
+    # @return [String]
+    attr_accessor :to
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :uui
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [Float]
+    attr_accessor :call_timeout
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [Float]
+    attr_accessor :callback_timeout
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :answer_url
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :answer_fallback_url
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :username
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :password
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :fallback_username
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :fallback_password
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [AnswerMethodEnum]
+    attr_accessor :answer_method
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [AnswerFallbackMethodEnum]
+    attr_accessor :answer_fallback_method
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :disconnect_url
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [DisconnectMethodEnum]
+    attr_accessor :disconnect_method
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :tag
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [String]
+    attr_accessor :application_id
+
+    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
+    # when calling a SIP URI. Each value must end with an 'encoding' parameter
+    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
+    # 'base64' encodings are allowed. The entire value cannot exceed 350
+    # characters, including parameters and separators.
+    # @return [MachineDetectionRequest]
+    attr_accessor :machine_detection
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['from'] = 'from'
+      @_hash['to'] = 'to'
+      @_hash['uui'] = 'uui'
+      @_hash['call_timeout'] = 'callTimeout'
+      @_hash['callback_timeout'] = 'callbackTimeout'
+      @_hash['answer_url'] = 'answerUrl'
+      @_hash['answer_fallback_url'] = 'answerFallbackUrl'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash['fallback_username'] = 'fallbackUsername'
+      @_hash['fallback_password'] = 'fallbackPassword'
+      @_hash['answer_method'] = 'answerMethod'
+      @_hash['answer_fallback_method'] = 'answerFallbackMethod'
+      @_hash['disconnect_url'] = 'disconnectUrl'
+      @_hash['disconnect_method'] = 'disconnectMethod'
+      @_hash['tag'] = 'tag'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['machine_detection'] = 'machineDetection'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        uui
+        call_timeout
+        callback_timeout
+        answer_fallback_url
+        username
+        password
+        fallback_username
+        fallback_password
+        answer_method
+        answer_fallback_method
+        disconnect_url
+        disconnect_method
+        tag
+        machine_detection
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        uui
+        call_timeout
+        callback_timeout
+        answer_fallback_url
+        username
+        password
+        fallback_username
+        fallback_password
+        answer_method
+        answer_fallback_method
+        disconnect_url
+        disconnect_method
+        tag
+      ]
+    end
+
+    def initialize(from = nil,
+                   to = nil,
+                   answer_url = nil,
+                   application_id = nil,
+                   uui = nil,
+                   call_timeout = nil,
+                   callback_timeout = nil,
+                   answer_fallback_url = nil,
+                   username = nil,
+                   password = nil,
+                   fallback_username = nil,
+                   fallback_password = nil,
+                   answer_method = nil,
+                   answer_fallback_method = nil,
+                   disconnect_url = nil,
+                   disconnect_method = nil,
+                   tag = nil,
+                   machine_detection = nil)
+      @from = from unless from == SKIP
+      @to = to unless to == SKIP
+      @uui = uui unless uui == SKIP
+      @call_timeout = call_timeout unless call_timeout == SKIP
+      @callback_timeout = callback_timeout unless callback_timeout == SKIP
+      @answer_url = answer_url unless answer_url == SKIP
+      @answer_fallback_url = answer_fallback_url unless answer_fallback_url == SKIP
+      @username = username unless username == SKIP
+      @password = password unless password == SKIP
+      @fallback_username = fallback_username unless fallback_username == SKIP
+      @fallback_password = fallback_password unless fallback_password == SKIP
+      @answer_method = answer_method unless answer_method == SKIP
+      @answer_fallback_method = answer_fallback_method unless answer_fallback_method == SKIP
+      @disconnect_url = disconnect_url unless disconnect_url == SKIP
+      @disconnect_method = disconnect_method unless disconnect_method == SKIP
+      @tag = tag unless tag == SKIP
+      @application_id = application_id unless application_id == SKIP
+      @machine_detection = machine_detection unless machine_detection == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      from = hash.key?('from') ? hash['from'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      answer_url = hash.key?('answerUrl') ? hash['answerUrl'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      uui = hash.key?('uui') ? hash['uui'] : SKIP
+      call_timeout = hash.key?('callTimeout') ? hash['callTimeout'] : SKIP
+      callback_timeout =
+        hash.key?('callbackTimeout') ? hash['callbackTimeout'] : SKIP
+      answer_fallback_url =
+        hash.key?('answerFallbackUrl') ? hash['answerFallbackUrl'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      fallback_username =
+        hash.key?('fallbackUsername') ? hash['fallbackUsername'] : SKIP
+      fallback_password =
+        hash.key?('fallbackPassword') ? hash['fallbackPassword'] : SKIP
+      answer_method = hash.key?('answerMethod') ? hash['answerMethod'] : SKIP
+      answer_fallback_method =
+        hash.key?('answerFallbackMethod') ? hash['answerFallbackMethod'] : SKIP
+      disconnect_url = hash.key?('disconnectUrl') ? hash['disconnectUrl'] : SKIP
+      disconnect_method =
+        hash.key?('disconnectMethod') ? hash['disconnectMethod'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+      machine_detection = MachineDetectionConfiguration.from_hash(hash['machineDetection']) if
+        hash['machineDetection']
+
+      # Create object from extracted values.
+      CreateCallRequest.new(from,
+                            to,
+                            answer_url,
+                            application_id,
+                            uui,
+                            call_timeout,
+                            callback_timeout,
+                            answer_fallback_url,
+                            username,
+                            password,
+                            fallback_username,
+                            fallback_password,
+                            answer_method,
+                            answer_fallback_method,
+                            disconnect_url,
+                            disconnect_method,
+                            tag,
+                            machine_detection)
+    end
+  end
+end