purecloud 0.38.1 → 0.39.1

data/lib/purecloud/models/callable_contacts_diagnostic.rb

@@ -18,10 +18,13 @@ require 'date'
 
 module PureCloud
   class CallableContactsDiagnostic
+    # Do not call lists for the campaign
     attr_accessor :dnc_lists
 
+    # Callable time sets for the campaign
     attr_accessor :callable_time_set
 
+    # Rule sets for the campaign
     attr_accessor :rule_sets
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/callable_time_set.rb

@@ -23,13 +23,13 @@ module PureCloud
 
     attr_accessor :name
 
-    # creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
-    # required for updates, must match the version number of the most recent update
+    # Required for updates, must match the version number of the most recent update
     attr_accessor :version
 
     # list of time/timezone groupings for which it is acceptable to place outbound calls

data/lib/purecloud/models/campaign.rb

@@ -23,13 +23,13 @@ module PureCloud
 
     attr_accessor :name
 
-    # creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
-    # required for updates, must match the version number of the most recent update
+    # Required for updates, must match the version number of the most recent update
     attr_accessor :version
 
     # identifier of the contact list for the campaign

data/lib/purecloud/models/campaign_diagnostics.rb

@@ -18,10 +18,13 @@ require 'date'
 
 module PureCloud
   class CampaignDiagnostics
+    # Campaign properties that can impact which contacts are callable
     attr_accessor :callable_contacts
 
+    # Information regarding the campaign's queue
     attr_accessor :queue_utilization_diagnostic
 
+    # Current number of outstanding interactions on the campaign
     attr_accessor :outstanding_interactions_count
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/campaign_schedule.rb

@@ -23,19 +23,22 @@ module PureCloud
 
     attr_accessor :name
 
-    # creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
-    # required for updates, must match the version number of the most recent update
+    # Required for updates, must match the version number of the most recent update
     attr_accessor :version
 
+    # a list of start and end times
     attr_accessor :intervals
 
+    # time zone identifier to be applied to the intervals; for example Africa/Abidjan
     attr_accessor :time_zone
 
+    # identifier of the campaign to be scheduled
     attr_accessor :campaign
 
     # The URI for this object
@@ -74,7 +77,7 @@ module PureCloud
         :'date_created' => :'DateTime',
         :'date_modified' => :'DateTime',
         :'version' => :'Integer',
-        :'intervals' => :'Array<CampaignScheduleIntervals>',
+        :'intervals' => :'Array<ScheduleInterval>',
         :'time_zone' => :'String',
         :'campaign' => :'UriReference',
         :'self_uri' => :'String'

data/lib/purecloud/models/campaign_sequence.rb

@@ -23,23 +23,28 @@ module PureCloud
 
     attr_accessor :name
 
-    # creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
-    # required for updates, must match the version number of the most recent update
+    # Required for updates, must match the version number of the most recent update
     attr_accessor :version
 
+    # the ordered list of campaign identifiers
     attr_accessor :campaigns
 
+    # the zero-based index of the current campaign in the campaigns list
     attr_accessor :current_campaign
 
+    # status of the sequence
     attr_accessor :status
 
+    # if a sequence has unexpectedly stopped, this message provides the reason
     attr_accessor :stop_message
 
+    # indicates if a sequence is to repeat from the beginning after the last campaign completes; default is false
     attr_accessor :repeat
 
     # The URI for this object

data/lib/purecloud/models/campaign_stats.rb

@@ -18,12 +18,16 @@ require 'date'
 
 module PureCloud
   class CampaignStats
+    # Information regarding the campaign's connect rate
     attr_accessor :contact_rate
 
+    # Number of available agents not currently being utilized
     attr_accessor :idle_agents
 
+    # Calls per agent adjusted by pace
     attr_accessor :adjusted_calls_per_agent
 
+    # Number of campaign calls currently ongoing
     attr_accessor :outstanding_calls
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/condition.rb

@@ -18,18 +18,25 @@ require 'date'
 
 module PureCloud
   class Condition
+    # The type of the condition
     attr_accessor :type
 
+    # Indicates whether to evaluate for the opposite of the stated condition; default is false
     attr_accessor :inverted
 
+    # An attribute name associated with the condition (applies only to certain rule conditions)
     attr_accessor :attribute_name
 
+    # A value associated with the condition
     attr_accessor :value
 
+    # Determines the type of the value associated with the condition
     attr_accessor :value_type
 
+    # An operation type for condition evaluation
     attr_accessor :operator
 
+    # List of wrap-up code identifiers (used only in conditions of type 'wrapupCondition')
     attr_accessor :codes
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -108,6 +115,15 @@ module PureCloud
       
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    def type=(type)
+      allowed_values = ["wrapupCondition", "contactAttributeCondition", "phoneNumberCondition", "phoneNumberTypeCondition", "callAnalysisCondition"]
+      if type && !allowed_values.include?(type)
+        fail "invalid value for 'type', must be one of #{allowed_values}"
+      end
+      @type = type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     def value_type=(value_type)
       allowed_values = ["STRING", "NUMERIC", "DATETIME", "PERIOD"]

data/lib/purecloud/models/connect_rate.rb

@@ -18,10 +18,13 @@ require 'date'
 
 module PureCloud
   class ConnectRate
+    # Number of call attempts made
     attr_accessor :attempts
 
+    # Number of calls with a live voice detected
     attr_accessor :connects
 
+    # Ratio of connects to attempts
     attr_accessor :connect_ratio
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/contact_callback_request.rb

@@ -18,14 +18,19 @@ require 'date'
 
 module PureCloud
   class ContactCallbackRequest
+    # Campaign identifier
     attr_accessor :campaign_id
 
+    # Contact list identifier
     attr_accessor :contact_list_id
 
+    # Contact identifier
     attr_accessor :contact_id
 
+    # Name of the phone column containing the number to be called
     attr_accessor :phone_column
 
+    # The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\"
     attr_accessor :schedule
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/contact_list.rb

@@ -23,25 +23,31 @@ module PureCloud
 
     attr_accessor :name
 
-    # creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
-    # required for updates, must match the version number of the most recent update
+    # Required for updates, must match the version number of the most recent update
     attr_accessor :version
 
+    # the contact column names
     attr_accessor :column_names
 
+    # the columns containing phone numbers
     attr_accessor :phone_columns
 
+    # the status of the import process
     attr_accessor :import_status
 
+    # the name of the column that holds the indicators for contacts that are to be dialed in preview mode only
     attr_accessor :preview_mode_column_name
 
+    # list of user-defined values indicating the contact is to be dialed in preview mode only
     attr_accessor :preview_mode_accepted_values
 
+    # the number of contacts in the contact list
     attr_accessor :size
 
     # The URI for this object

data/lib/purecloud/models/contact_phone_number_column.rb

@@ -18,10 +18,13 @@ require 'date'
 
 module PureCloud
   class ContactPhoneNumberColumn
+    # name of the phone column
     attr_accessor :column_name
 
+    # type of the phone column, for example, 'cell' or 'home'
     attr_accessor :type
 
+    # name of the column indicating the timezone to be considered for determining callable times
     attr_accessor :callable_time_column
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/create_callback_command.rb

@@ -26,6 +26,9 @@ module PureCloud
 
     attr_accessor :callback_numbers
 
+    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :callback_scheduled_time
+
     attr_accessor :country_code
 
     attr_accessor :skip_enabled
@@ -42,6 +45,8 @@ module PureCloud
         
         :'callback_numbers' => :'callbackNumbers',
         
+        :'callback_scheduled_time' => :'callbackScheduledTime',
+        
         :'country_code' => :'countryCode',
         
         :'skip_enabled' => :'skipEnabled'
@@ -56,6 +61,7 @@ module PureCloud
         :'queue_id' => :'String',
         :'callback_user_name' => :'String',
         :'callback_numbers' => :'Array<String>',
+        :'callback_scheduled_time' => :'DateTime',
         :'country_code' => :'String',
         :'skip_enabled' => :'BOOLEAN'
         
@@ -87,6 +93,10 @@ module PureCloud
         end
       end
       
+      if attributes[:'callbackScheduledTime']
+        self.callback_scheduled_time = attributes[:'callbackScheduledTime']
+      end
+      
       if attributes[:'countryCode']
         self.country_code = attributes[:'countryCode']
       end
@@ -107,6 +117,7 @@ module PureCloud
           queue_id == o.queue_id &&
           callback_user_name == o.callback_user_name &&
           callback_numbers == o.callback_numbers &&
+          callback_scheduled_time == o.callback_scheduled_time &&
           country_code == o.country_code &&
           skip_enabled == o.skip_enabled
     end
@@ -118,7 +129,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [script_id, queue_id, callback_user_name, callback_numbers, country_code, skip_enabled].hash
+      [script_id, queue_id, callback_user_name, callback_numbers, callback_scheduled_time, country_code, skip_enabled].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/create_user.rb

@@ -18,6 +18,7 @@ require 'date'
 
 module PureCloud
   class CreateUser
+    # User's full name
     attr_accessor :name
 
     attr_accessor :department

data/lib/purecloud/models/customer_interaction_center.rb

@@ -0,0 +1,217 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class CustomerInteractionCenter
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :certificate
+
+    attr_accessor :sso_target_uri
+
+    attr_accessor :issuer_uri
+
+    # The URI for this object
+    attr_accessor :self_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'name' => :'name',
+        
+        :'certificate' => :'certificate',
+        
+        :'sso_target_uri' => :'ssoTargetURI',
+        
+        :'issuer_uri' => :'issuerURI',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'certificate' => :'String',
+        :'sso_target_uri' => :'String',
+        :'issuer_uri' => :'String',
+        :'self_uri' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+      
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+      
+      if attributes[:'certificate']
+        self.certificate = attributes[:'certificate']
+      end
+      
+      if attributes[:'ssoTargetURI']
+        self.sso_target_uri = attributes[:'ssoTargetURI']
+      end
+      
+      if attributes[:'issuerURI']
+        self.issuer_uri = attributes[:'issuerURI']
+      end
+      
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          certificate == o.certificate &&
+          sso_target_uri == o.sso_target_uri &&
+          issuer_uri == o.issuer_uri &&
+          self_uri == o.self_uri
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [id, name, certificate, sso_target_uri, issuer_uri, self_uri].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end