create_callback_command.rb in purecloud-0.47.1

- old
+ new

@@ -16,30 +16,39 @@
 
 require 'date'
 
 module PureCloud
   class CreateCallbackCommand
+    # The identifier of the script to be used for the callback
     attr_accessor :script_id
 
+    # The identifier of the queue to be used for the callback. Either queueId or routingData is required.
     attr_accessor :queue_id
 
+    # The routing data to be used for the callback. Either queueId or routingData is required.
     attr_accessor :routing_data
 
+    # The name of the party to be called back.
     attr_accessor :callback_user_name
 
+    # A list of phone numbers for the callback.
     attr_accessor :callback_numbers
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :callback_scheduled_time
 
+    # The country code to be associated with the callback numbers.
     attr_accessor :country_code
 
+    # Whether or not to automatically place a call for this callback.
     attr_accessor :is_automated
 
+    # The id of the configuration to handle the response (e.g. live voice, machine) from automatically placing a call for a callback.
     attr_accessor :automated_callback_config_id
 
-    attr_accessor :additional_info
+    # A map of key-value pairs containing additional data that can be associated to the callback. These could be set up for instance to be used in a customized script shown during the call. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }
+    attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
@@ -59,11 +68,11 @@
         
         :'is_automated' => :'isAutomated',
         
         :'automated_callback_config_id' => :'automatedCallbackConfigId',
         
-        :'additional_info' => :'additionalInfo'
+        :'data' => :'data'
         
       }
     end
 
     # Attribute type mapping.
@@ -76,11 +85,11 @@
         :'callback_numbers' => :'Array<String>',
         :'callback_scheduled_time' => :'DateTime',
         :'country_code' => :'String',
         :'is_automated' => :'BOOLEAN',
         :'automated_callback_config_id' => :'String',
-        :'additional_info' => :'AdditionalInfo'
+        :'data' => :'Hash<String, String>'
         
       }
     end
 
     def initialize(attributes = {})
@@ -128,12 +137,14 @@
       
       if attributes[:'automatedCallbackConfigId']
         self.automated_callback_config_id = attributes[:'automatedCallbackConfigId']
       end
       
-      if attributes[:'additionalInfo']
-        self.additional_info = attributes[:'additionalInfo']
+      if attributes[:'data']
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
       end
       
     end
 
     # Check equality by comparing each attribute.
@@ -147,20 +158,20 @@
           callback_numbers == o.callback_numbers &&
           callback_scheduled_time == o.callback_scheduled_time &&
           country_code == o.country_code &&
           is_automated == o.is_automated &&
           automated_callback_config_id == o.automated_callback_config_id &&
-          additional_info == o.additional_info
+          data == o.data
     end
 
     # @see the `==` method
     def eql?(o)
       self == o
     end
 
     # Calculate hash code according to all attributes.
     def hash
-      [script_id, queue_id, routing_data, callback_user_name, callback_numbers, callback_scheduled_time, country_code, is_automated, automated_callback_config_id, additional_info].hash
+      [script_id, queue_id, routing_data, callback_user_name, callback_numbers, callback_scheduled_time, country_code, is_automated, automated_callback_config_id, data].hash
     end
 
     # build the object from hash
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)