purecloud 0.38.1 → 0.39.1

data/lib/purecloud/models/dialer_action.rb

@@ -18,12 +18,16 @@ require 'date'
 
 module PureCloud
   class DialerAction
+    # Type of the action
     attr_accessor :type
 
+    # Identifier of the action
     attr_accessor :action_type_name
 
+    # Indicator of the type of update action (applicable only to certain types of actions)
     attr_accessor :update_option
 
+    # Map of key-value pairs pertinent to the action (different actions require different properties)
     attr_accessor :properties
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -79,6 +83,33 @@ module PureCloud
       
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    def type=(type)
+      allowed_values = ["Action", "modifyContactAttribute"]
+      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 action_type_name=(action_type_name)
+      allowed_values = ["DO_NOT_DIAL", "MODIFY_CONTACT_ATTRIBUTE", "SWITCH_TO_PREVIEW", "APPEND_NUMBER_TO_DNC_LIST", "SCHEDULE_CALLBACK"]
+      if action_type_name && !allowed_values.include?(action_type_name)
+        fail "invalid value for 'action_type_name', must be one of #{allowed_values}"
+      end
+      @action_type_name = action_type_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def update_option=(update_option)
+      allowed_values = ["SET", "INCREMENT", "DECREMENT", "CURRENT_TIME"]
+      if update_option && !allowed_values.include?(update_option)
+        fail "invalid value for 'update_option', must be one of #{allowed_values}"
+      end
+      @update_option = update_option
+    end
+
     # Check equality by comparing each attribute.
     def ==(o)
       return true if self.equal?(o)

data/lib/purecloud/models/dialer_contact.rb

@@ -23,14 +23,19 @@ module PureCloud
 
     attr_accessor :name
 
+    # Identifier of the contact list containing this contact
     attr_accessor :contact_list_id
 
+    # A map of the contact's data attributes and values
     attr_accessor :data
 
+    # A map of call records for the contact phone columns
     attr_accessor :call_records
 
+    # false if the contact is not to be called
     attr_accessor :callable
 
+    # A map of statuses for the contact phone columns
     attr_accessor :phone_number_status
 
     # The URI for this object

data/lib/purecloud/models/dialer_rule.rb

@@ -18,16 +18,22 @@ require 'date'
 
 module PureCloud
   class DialerRule
+    # The identifier of the rule
     attr_accessor :id
 
+    # The name of the rule
     attr_accessor :name
 
+    # The ranked order of the rule; rules are processed from lowest number to highest
     attr_accessor :order
 
+    # The category of the rule
     attr_accessor :category
 
+    # The list of rule conditions; all must evaluate to true to trigger the rule actions
     attr_accessor :conditions
 
+    # The list of rule actions to be taken if the conditions are true
     attr_accessor :actions
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -99,6 +105,15 @@ module PureCloud
       
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    def category=(category)
+      allowed_values = ["DIALER_PRECALL", "DIALER_WRAPUP"]
+      if category && !allowed_values.include?(category)
+        fail "invalid value for 'category', must be one of #{allowed_values}"
+      end
+      @category = category
+    end
+
     # Check equality by comparing each attribute.
     def ==(o)
       return true if self.equal?(o)

data/lib/purecloud/models/dnc_list.rb

@@ -23,21 +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
 
+    # the name of the columns containing the numbers not to be called
     attr_accessor :phone_number_columns
 
+    # the status of the import process
     attr_accessor :import_status
 
-    attr_accessor :file_key
-
+    # the number of phone numbers in the do not call list
     attr_accessor :size
 
     # The URI for this object
@@ -61,8 +62,6 @@ module PureCloud
         
         :'import_status' => :'importStatus',
         
-        :'file_key' => :'fileKey',
-        
         :'size' => :'size',
         
         :'self_uri' => :'selfUri'
@@ -80,7 +79,6 @@ module PureCloud
         :'version' => :'Integer',
         :'phone_number_columns' => :'Array<String>',
         :'import_status' => :'ImportStatus',
-        :'file_key' => :'String',
         :'size' => :'Integer',
         :'self_uri' => :'String'
         
@@ -124,10 +122,6 @@ module PureCloud
         self.import_status = attributes[:'importStatus']
       end
       
-      if attributes[:'fileKey']
-        self.file_key = attributes[:'fileKey']
-      end
-      
       if attributes[:'size']
         self.size = attributes[:'size']
       end
@@ -149,7 +143,6 @@ module PureCloud
           version == o.version &&
           phone_number_columns == o.phone_number_columns &&
           import_status == o.import_status &&
-          file_key == o.file_key &&
           size == o.size &&
           self_uri == o.self_uri
     end
@@ -161,7 +154,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, date_created, date_modified, version, phone_number_columns, import_status, file_key, size, self_uri].hash
+      [id, name, date_created, date_modified, version, phone_number_columns, import_status, size, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/external_contact.rb

@@ -55,6 +55,9 @@ module PureCloud
 
     attr_accessor :external_organization
 
+    # Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.
+    attr_accessor :external_data_sources
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -96,6 +99,8 @@ module PureCloud
         
         :'external_organization' => :'externalOrganization',
         
+        :'external_data_sources' => :'externalDataSources',
+        
         :'self_uri' => :'selfUri'
         
       }
@@ -121,6 +126,7 @@ module PureCloud
         :'modify_date' => :'DateTime',
         :'create_date' => :'DateTime',
         :'external_organization' => :'ExternalOrganization',
+        :'external_data_sources' => :'Array<ExternalDataSource>',
         :'self_uri' => :'String'
         
       }
@@ -201,6 +207,12 @@ module PureCloud
         self.external_organization = attributes[:'externalOrganization']
       end
       
+      if attributes[:'externalDataSources']
+        if (value = attributes[:'externalDataSources']).is_a?(Array)
+          self.external_data_sources = value
+        end
+      end
+      
       if attributes[:'selfUri']
         self.self_uri = attributes[:'selfUri']
       end
@@ -228,6 +240,7 @@ module PureCloud
           modify_date == o.modify_date &&
           create_date == o.create_date &&
           external_organization == o.external_organization &&
+          external_data_sources == o.external_data_sources &&
           self_uri == o.self_uri
     end
 
@@ -238,7 +251,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, modify_date, create_date, external_organization, self_uri].hash
+      [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, modify_date, create_date, external_organization, external_data_sources, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/external_data_source.rb

@@ -0,0 +1,176 @@
+=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
+  # Describes a link to a record in an external system that contributed data to a Relate record
+  class ExternalDataSource
+    attr_accessor :platform
+
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'platform' => :'platform',
+        
+        :'url' => :'url'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'platform' => :'String',
+        :'url' => :'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[:'platform']
+        self.platform = attributes[:'platform']
+      end
+      
+      if attributes[:'url']
+        self.url = attributes[:'url']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          platform == o.platform &&
+          url == o.url
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [platform, url].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

data/lib/purecloud/models/external_organization.rb

@@ -51,6 +51,9 @@ module PureCloud
     # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :create_date
 
+    # Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param.
+    attr_accessor :external_data_sources
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -88,6 +91,8 @@ module PureCloud
         
         :'create_date' => :'createDate',
         
+        :'external_data_sources' => :'externalDataSources',
+        
         :'self_uri' => :'selfUri'
         
       }
@@ -111,6 +116,7 @@ module PureCloud
         :'tickers' => :'Array<Ticker>',
         :'modify_date' => :'DateTime',
         :'create_date' => :'DateTime',
+        :'external_data_sources' => :'Array<ExternalDataSource>',
         :'self_uri' => :'String'
         
       }
@@ -189,6 +195,12 @@ module PureCloud
         self.create_date = attributes[:'createDate']
       end
       
+      if attributes[:'externalDataSources']
+        if (value = attributes[:'externalDataSources']).is_a?(Array)
+          self.external_data_sources = value
+        end
+      end
+      
       if attributes[:'selfUri']
         self.self_uri = attributes[:'selfUri']
       end
@@ -214,6 +226,7 @@ module PureCloud
           tickers == o.tickers &&
           modify_date == o.modify_date &&
           create_date == o.create_date &&
+          external_data_sources == o.external_data_sources &&
           self_uri == o.self_uri
     end
 
@@ -224,7 +237,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, company_type, industry, primary_contact_id, address, phone_number, fax_number, employee_count, revenue, tags, websites, tickers, modify_date, create_date, self_uri].hash
+      [id, name, company_type, industry, primary_contact_id, address, phone_number, fax_number, employee_count, revenue, tags, websites, tickers, modify_date, create_date, external_data_sources, self_uri].hash
     end
 
     # build the object from hash