bandwidth-sdk 6.2.0 → 9.0.0

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

@@ -0,0 +1,284 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Bandwidth
+  # CallState Model.
+  class CallState < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :call_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :parent_call_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :application_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :to
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :from
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direction
+
+    # The current state of the call. Current possible values are 'initiated',
+    # 'answered' and 'disconnected'. Additional states may be added in the
+    # future, so your application must be tolerant of unknown values.
+    # @return [String]
+    attr_accessor :state
+
+    # The current state of the call. Current possible values are 'initiated',
+    # 'answered' and 'disconnected'. Additional states may be added in the
+    # future, so your application must be tolerant of unknown values.
+    # @return [String]
+    attr_accessor :identity
+
+    # The current state of the call. Current possible values are 'initiated',
+    # 'answered' and 'disconnected'. Additional states may be added in the
+    # future, so your application must be tolerant of unknown values.
+    # @return [Hash]
+    attr_accessor :stir_shaken
+
+    # The current state of the call. Current possible values are 'initiated',
+    # 'answered' and 'disconnected'. Additional states may be added in the
+    # future, so your application must be tolerant of unknown values.
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # The current state of the call. Current possible values are 'initiated',
+    # 'answered' and 'disconnected'. Additional states may be added in the
+    # future, so your application must be tolerant of unknown values.
+    # @return [DateTime]
+    attr_accessor :answer_time
+
+    # The current state of the call. Current possible values are 'initiated',
+    # 'answered' and 'disconnected'. Additional states may be added in the
+    # future, so your application must be tolerant of unknown values.
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # The reason the call was disconnected, or null if the call is still active.
+    # Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup',
+    # 'invalid-bxml', 'callback-error', 'application-error', 'error',
+    # 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes
+    # may be added in the future, so your application must be tolerant of
+    # unknown values.
+    # @return [String]
+    attr_accessor :disconnect_cause
+
+    # The reason the call was disconnected, or null if the call is still active.
+    # Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup',
+    # 'invalid-bxml', 'callback-error', 'application-error', 'error',
+    # 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes
+    # may be added in the future, so your application must be tolerant of
+    # unknown values.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The reason the call was disconnected, or null if the call is still active.
+    # Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup',
+    # 'invalid-bxml', 'callback-error', 'application-error', 'error',
+    # 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes
+    # may be added in the future, so your application must be tolerant of
+    # unknown values.
+    # @return [String]
+    attr_accessor :error_id
+
+    # The reason the call was disconnected, or null if the call is still active.
+    # Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup',
+    # 'invalid-bxml', 'callback-error', 'application-error', 'error',
+    # 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes
+    # may be added in the future, so your application must be tolerant of
+    # unknown values.
+    # @return [DateTime]
+    attr_accessor :last_update
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['call_id'] = 'callId'
+      @_hash['parent_call_id'] = 'parentCallId'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['account_id'] = 'accountId'
+      @_hash['to'] = 'to'
+      @_hash['from'] = 'from'
+      @_hash['direction'] = 'direction'
+      @_hash['state'] = 'state'
+      @_hash['identity'] = 'identity'
+      @_hash['stir_shaken'] = 'stirShaken'
+      @_hash['start_time'] = 'startTime'
+      @_hash['answer_time'] = 'answerTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['disconnect_cause'] = 'disconnectCause'
+      @_hash['error_message'] = 'errorMessage'
+      @_hash['error_id'] = 'errorId'
+      @_hash['last_update'] = 'lastUpdate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        call_id
+        parent_call_id
+        application_id
+        account_id
+        to
+        from
+        direction
+        state
+        identity
+        stir_shaken
+        start_time
+        answer_time
+        end_time
+        disconnect_cause
+        error_message
+        error_id
+        last_update
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        parent_call_id
+        identity
+        answer_time
+        end_time
+        disconnect_cause
+        error_message
+        error_id
+      ]
+    end
+
+    def initialize(call_id = nil,
+                   parent_call_id = nil,
+                   application_id = nil,
+                   account_id = nil,
+                   to = nil,
+                   from = nil,
+                   direction = nil,
+                   state = nil,
+                   identity = nil,
+                   stir_shaken = nil,
+                   start_time = nil,
+                   answer_time = nil,
+                   end_time = nil,
+                   disconnect_cause = nil,
+                   error_message = nil,
+                   error_id = nil,
+                   last_update = nil)
+      @call_id = call_id unless call_id == SKIP
+      @parent_call_id = parent_call_id unless parent_call_id == SKIP
+      @application_id = application_id unless application_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @to = to unless to == SKIP
+      @from = from unless from == SKIP
+      @direction = direction unless direction == SKIP
+      @state = state unless state == SKIP
+      @identity = identity unless identity == SKIP
+      @stir_shaken = stir_shaken unless stir_shaken == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @answer_time = answer_time unless answer_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @disconnect_cause = disconnect_cause unless disconnect_cause == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @error_id = error_id unless error_id == SKIP
+      @last_update = last_update unless last_update == 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.
+      call_id = hash.key?('callId') ? hash['callId'] : SKIP
+      parent_call_id = hash.key?('parentCallId') ? hash['parentCallId'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      identity = hash.key?('identity') ? hash['identity'] : SKIP
+      stir_shaken = hash.key?('stirShaken') ? hash['stirShaken'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      answer_time = if hash.key?('answerTime')
+                      (DateTimeHelper.from_rfc3339(hash['answerTime']) if hash['answerTime'])
+                    else
+                      SKIP
+                    end
+      end_time = if hash.key?('endTime')
+                   (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
+                 else
+                   SKIP
+                 end
+      disconnect_cause =
+        hash.key?('disconnectCause') ? hash['disconnectCause'] : SKIP
+      error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      error_id = hash.key?('errorId') ? hash['errorId'] : SKIP
+      last_update = if hash.key?('lastUpdate')
+                      (DateTimeHelper.from_rfc3339(hash['lastUpdate']) if hash['lastUpdate'])
+                    else
+                      SKIP
+                    end
+
+      # Create object from extracted values.
+      CallState.new(call_id,
+                    parent_call_id,
+                    application_id,
+                    account_id,
+                    to,
+                    from,
+                    direction,
+                    state,
+                    identity,
+                    stir_shaken,
+                    start_time,
+                    answer_time,
+                    end_time,
+                    disconnect_cause,
+                    error_message,
+                    error_id,
+                    last_update)
+    end
+
+    def to_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_answer_time
+      DateTimeHelper.to_rfc3339(answer_time)
+    end
+
+    def to_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    end
+
+    def to_last_update
+      DateTimeHelper.to_rfc3339(last_update)
+    end
+  end
+end

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

@@ -7,29 +7,11 @@ module Bandwidth
   # CallbackMethod.
   class CallbackMethodEnum
     CALLBACK_METHOD_ENUM = [
-      # TODO: Write general description for GET
-      GET = 'GET'.freeze,
-
-      # TODO: Write general description for HEAD
-      HEAD = 'HEAD'.freeze,
-
       # TODO: Write general description for POST
       POST = 'POST'.freeze,
 
-      # TODO: Write general description for PUT
-      PUT = 'PUT'.freeze,
-
-      # TODO: Write general description for PATCH
-      PATCH = 'PATCH'.freeze,
-
-      # TODO: Write general description for DELETE
-      DELETE = 'DELETE'.freeze,
-
-      # TODO: Write general description for OPTIONS
-      OPTIONS = 'OPTIONS'.freeze,
-
-      # TODO: Write general description for TRACE
-      TRACE = 'TRACE'.freeze
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze
     ].freeze
   end
 end

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

@@ -0,0 +1,211 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # This object represents all possible fields that may be included in callbacks
+  # related to conference events
+  class ConferenceCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 :event_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :event_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tag
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :call_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :to
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :from
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :recording_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :channels
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :start_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :end_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :duration
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :file_format
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :media_url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['conference_id'] = 'conferenceId'
+      @_hash['name'] = 'name'
+      @_hash['event_type'] = 'eventType'
+      @_hash['event_time'] = 'eventTime'
+      @_hash['tag'] = 'tag'
+      @_hash['call_id'] = 'callId'
+      @_hash['to'] = 'to'
+      @_hash['from'] = 'from'
+      @_hash['account_id'] = 'accountId'
+      @_hash['recording_id'] = 'recordingId'
+      @_hash['channels'] = 'channels'
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['duration'] = 'duration'
+      @_hash['file_format'] = 'fileFormat'
+      @_hash['media_url'] = 'mediaUrl'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        conference_id
+        name
+        event_type
+        event_time
+        tag
+        call_id
+        to
+        from
+        account_id
+        recording_id
+        channels
+        start_time
+        end_time
+        duration
+        file_format
+        media_url
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(conference_id = nil,
+                   name = nil,
+                   event_type = nil,
+                   event_time = nil,
+                   tag = nil,
+                   call_id = nil,
+                   to = nil,
+                   from = nil,
+                   account_id = nil,
+                   recording_id = nil,
+                   channels = nil,
+                   start_time = nil,
+                   end_time = nil,
+                   duration = nil,
+                   file_format = nil,
+                   media_url = nil,
+                   status = nil)
+      @conference_id = conference_id unless conference_id == SKIP
+      @name = name unless name == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @event_time = event_time unless event_time == SKIP
+      @tag = tag unless tag == SKIP
+      @call_id = call_id unless call_id == SKIP
+      @to = to unless to == SKIP
+      @from = from unless from == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @recording_id = recording_id unless recording_id == SKIP
+      @channels = channels unless channels == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @duration = duration unless duration == SKIP
+      @file_format = file_format unless file_format == SKIP
+      @media_url = media_url unless media_url == SKIP
+      @status = status unless status == 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.
+      conference_id = hash.key?('conferenceId') ? hash['conferenceId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      event_type = hash.key?('eventType') ? hash['eventType'] : SKIP
+      event_time = hash.key?('eventTime') ? hash['eventTime'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+      call_id = hash.key?('callId') ? hash['callId'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      recording_id = hash.key?('recordingId') ? hash['recordingId'] : SKIP
+      channels = hash.key?('channels') ? hash['channels'] : SKIP
+      start_time = hash.key?('startTime') ? hash['startTime'] : SKIP
+      end_time = hash.key?('endTime') ? hash['endTime'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      file_format = hash.key?('fileFormat') ? hash['fileFormat'] : SKIP
+      media_url = hash.key?('mediaUrl') ? hash['mediaUrl'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      ConferenceCallback.new(conference_id,
+                             name,
+                             event_type,
+                             event_time,
+                             tag,
+                             call_id,
+                             to,
+                             from,
+                             account_id,
+                             recording_id,
+                             channels,
+                             start_time,
+                             end_time,
+                             duration,
+                             file_format,
+                             media_url,
+                             status)
+    end
+  end
+end

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

@@ -7,29 +7,11 @@ module Bandwidth
   # ConferenceEventMethod.
   class ConferenceEventMethodEnum
     CONFERENCE_EVENT_METHOD_ENUM = [
-      # TODO: Write general description for GET
-      GET = 'GET'.freeze,
-
-      # TODO: Write general description for HEAD
-      HEAD = 'HEAD'.freeze,
-
       # TODO: Write general description for POST
       POST = 'POST'.freeze,
 
-      # TODO: Write general description for PUT
-      PUT = 'PUT'.freeze,
-
-      # TODO: Write general description for PATCH
-      PATCH = 'PATCH'.freeze,
-
-      # TODO: Write general description for DELETE
-      DELETE = 'DELETE'.freeze,
-
-      # TODO: Write general description for OPTIONS
-      OPTIONS = 'OPTIONS'.freeze,
-
-      # TODO: Write general description for TRACE
-      TRACE = 'TRACE'.freeze
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze
     ].freeze
   end
 end

data/lib/bandwidth/voice_lib/voice/models/{conference_member_detail.rb → conference_member_state.rb}

@@ -4,8 +4,11 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # ConferenceMemberDetail Model.
-  class ConferenceMemberDetail < BaseModel
+  # ConferenceMemberState Model.
+  class ConferenceMemberState < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :call_id
@@ -42,18 +45,37 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        call_id
+        conference_id
+        member_url
+        mute
+        hold
+        call_ids_to_coach
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        call_ids_to_coach
+      ]
+    end
+
     def initialize(call_id = nil,
                    conference_id = nil,
                    member_url = nil,
                    mute = nil,
                    hold = nil,
                    call_ids_to_coach = nil)
-      @call_id = call_id
-      @conference_id = conference_id
-      @member_url = member_url
-      @mute = mute
-      @hold = hold
-      @call_ids_to_coach = call_ids_to_coach
+      @call_id = call_id unless call_id == SKIP
+      @conference_id = conference_id unless conference_id == SKIP
+      @member_url = member_url unless member_url == SKIP
+      @mute = mute unless mute == SKIP
+      @hold = hold unless hold == SKIP
+      @call_ids_to_coach = call_ids_to_coach unless call_ids_to_coach == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -61,20 +83,21 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      call_id = hash['callId']
-      conference_id = hash['conferenceId']
-      member_url = hash['memberUrl']
-      mute = hash['mute']
-      hold = hash['hold']
-      call_ids_to_coach = hash['callIdsToCoach']
+      call_id = hash.key?('callId') ? hash['callId'] : SKIP
+      conference_id = hash.key?('conferenceId') ? hash['conferenceId'] : SKIP
+      member_url = hash.key?('memberUrl') ? hash['memberUrl'] : SKIP
+      mute = hash.key?('mute') ? hash['mute'] : SKIP
+      hold = hash.key?('hold') ? hash['hold'] : SKIP
+      call_ids_to_coach =
+        hash.key?('callIdsToCoach') ? hash['callIdsToCoach'] : SKIP
 
       # Create object from extracted values.
-      ConferenceMemberDetail.new(call_id,
-                                 conference_id,
-                                 member_url,
-                                 mute,
-                                 hold,
-                                 call_ids_to_coach)
+      ConferenceMemberState.new(call_id,
+                                conference_id,
+                                member_url,
+                                mute,
+                                hold,
+                                call_ids_to_coach)
     end
   end
 end