lib/purecloud/models/call.rb in purecloud-0.50.1 vs lib/purecloud/models/call.rb in purecloud-0.51.1

@@ -16,47 +16,61 @@
 
 require 'date'
 
 module PureCloud
   class Call
+    # The connection state of this communication.
     attr_accessor :state
 
+    # A globally unique identifier for this communication.
     attr_accessor :id
 
+    # The direction of the call
     attr_accessor :direction
 
+    # True if this call is being recorded.
     attr_accessor :recording
 
+    # State of recording on this call.
     attr_accessor :recording_state
 
+    # True if this call is muted so that remote participants can't hear any audio from this end.
     attr_accessor :muted
 
+    # True if this call is held and the person on this side hears hold music.
     attr_accessor :confined
 
+    # True if this call is held and the person on this side hears silence.
     attr_accessor :held
 
+    # A globally unique identifier for the recording associated with this call.
     attr_accessor :recording_id
 
+    # The time line of the participant's call, divided into activity segments.
     attr_accessor :segments
 
     attr_accessor :error_info
 
+    # System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
     attr_accessor :disconnect_type
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :start_hold_time
 
+    # If call is an outbound fax of a document from content management, then this is the id in content management.
     attr_accessor :document_id
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :connected_time
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :disconnected_time
 
+    # List of reasons that this call was disconnected. This will be set once the call disconnects.
     attr_accessor :disconnect_reasons
 
+    # Extra information on fax transmission.
     attr_accessor :fax_status
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -245,10 +259,10 @@
       @recording_state = recording_state
     end
 
     # Custom attribute writer method checking allowed values (enum).
     def disconnect_type=(disconnect_type)
-      allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_FORWARD", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM"]
+      allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_FORWARD", "TRANSFER_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM"]
       if disconnect_type && !allowed_values.include?(disconnect_type)
         fail "invalid value for 'disconnect_type', must be one of #{allowed_values}"
       end
       @disconnect_type = disconnect_type
     end