purecloud 0.40.1 → 0.41.1

data/lib/purecloud/models/integration_status_info.rb

@@ -0,0 +1,209 @@
+=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
+  # Status information for an Integration.
+  class IntegrationStatusInfo
+    # Machine-readable status as reported by the integration.
+    attr_accessor :internal
+
+    # Localized, human-readable, effective status of the integration.
+    attr_accessor :effective
+
+    # Localized status details for the integration.
+    attr_accessor :detail
+
+    # Date and time (in UTC) when the integration status (i.e. the internal field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :last_updated
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'internal' => :'internal',
+        
+        :'effective' => :'effective',
+        
+        :'detail' => :'detail',
+        
+        :'last_updated' => :'lastUpdated'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'internal' => :'String',
+        :'effective' => :'String',
+        :'detail' => :'String',
+        :'last_updated' => :'DateTime'
+        
+      }
+    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[:'internal']
+        self.internal = attributes[:'internal']
+      end
+      
+      if attributes[:'effective']
+        self.effective = attributes[:'effective']
+      end
+      
+      if attributes[:'detail']
+        self.detail = attributes[:'detail']
+      end
+      
+      if attributes[:'lastUpdated']
+        self.last_updated = attributes[:'lastUpdated']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def internal=(internal)
+      allowed_values = ["ACTIVE", "ACTIVATING", "INACTIVE", "DEACTIVATING", "ERROR"]
+      if internal && !allowed_values.include?(internal)
+        fail "invalid value for 'internal', must be one of #{allowed_values}"
+      end
+      @internal = internal
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          internal == o.internal &&
+          effective == o.effective &&
+          detail == o.detail &&
+          last_updated == o.last_updated
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [internal, effective, detail, last_updated].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/integration_type.rb

@@ -17,18 +17,28 @@ Terms of Service: https://developer.mypurecloud.com/tos
 require 'date'
 
 module PureCloud
+  # Descriptor for a type of Integration.
   class IntegrationType
     # The globally unique identifier for the object.
     attr_accessor :id
 
     attr_accessor :name
 
+    # Localized description of the integration type.
     attr_accessor :description
 
+    # PureCloud provider of the integration type.
     attr_accessor :provider
 
+    # Collection of logos.
     attr_accessor :images
 
+    # URI of the schema describing the key-value properties needed to configure an integration of this type.
+    attr_accessor :config_properties_schema_uri
+
+    # URI of the schema describing the advanced JSON document needed to configure an integration of this type.
+    attr_accessor :config_advanced_schema_uri
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -46,6 +56,10 @@ module PureCloud
         
         :'images' => :'images',
         
+        :'config_properties_schema_uri' => :'configPropertiesSchemaUri',
+        
+        :'config_advanced_schema_uri' => :'configAdvancedSchemaUri',
+        
         :'self_uri' => :'selfUri'
         
       }
@@ -59,6 +73,8 @@ module PureCloud
         :'description' => :'String',
         :'provider' => :'String',
         :'images' => :'Array<UserImage>',
+        :'config_properties_schema_uri' => :'String',
+        :'config_advanced_schema_uri' => :'String',
         :'self_uri' => :'String'
         
       }
@@ -93,6 +109,14 @@ module PureCloud
         end
       end
       
+      if attributes[:'configPropertiesSchemaUri']
+        self.config_properties_schema_uri = attributes[:'configPropertiesSchemaUri']
+      end
+      
+      if attributes[:'configAdvancedSchemaUri']
+        self.config_advanced_schema_uri = attributes[:'configAdvancedSchemaUri']
+      end
+      
       if attributes[:'selfUri']
         self.self_uri = attributes[:'selfUri']
       end
@@ -117,6 +141,8 @@ module PureCloud
           description == o.description &&
           provider == o.provider &&
           images == o.images &&
+          config_properties_schema_uri == o.config_properties_schema_uri &&
+          config_advanced_schema_uri == o.config_advanced_schema_uri &&
           self_uri == o.self_uri
     end
 
@@ -127,7 +153,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, description, provider, images, self_uri].hash
+      [id, name, description, provider, images, config_properties_schema_uri, config_advanced_schema_uri, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/json_node.rb

@@ -36,6 +36,8 @@ module PureCloud
 
     attr_accessor :integral_number
 
+    attr_accessor :floating_point_number
+
     attr_accessor :short
 
     attr_accessor :int
@@ -54,8 +56,6 @@ module PureCloud
 
     attr_accessor :value_node
 
-    attr_accessor :floating_point_number
-
     attr_accessor :array
 
     attr_accessor :null
@@ -82,6 +82,8 @@ module PureCloud
         
         :'integral_number' => :'integralNumber',
         
+        :'floating_point_number' => :'floatingPointNumber',
+        
         :'short' => :'short',
         
         :'int' => :'int',
@@ -100,8 +102,6 @@ module PureCloud
         
         :'value_node' => :'valueNode',
         
-        :'floating_point_number' => :'floatingPointNumber',
-        
         :'array' => :'array',
         
         :'null' => :'null'
@@ -121,6 +121,7 @@ module PureCloud
         :'missing_node' => :'BOOLEAN',
         :'pojo' => :'BOOLEAN',
         :'integral_number' => :'BOOLEAN',
+        :'floating_point_number' => :'BOOLEAN',
         :'short' => :'BOOLEAN',
         :'int' => :'BOOLEAN',
         :'long' => :'BOOLEAN',
@@ -130,7 +131,6 @@ module PureCloud
         :'textual' => :'BOOLEAN',
         :'binary' => :'BOOLEAN',
         :'value_node' => :'BOOLEAN',
-        :'floating_point_number' => :'BOOLEAN',
         :'array' => :'BOOLEAN',
         :'null' => :'BOOLEAN'
         
@@ -196,6 +196,12 @@ module PureCloud
         self.integral_number = false
       end
       
+      if attributes[:'floatingPointNumber']
+        self.floating_point_number = attributes[:'floatingPointNumber']
+      else
+        self.floating_point_number = false
+      end
+      
       if attributes[:'short']
         self.short = attributes[:'short']
       else
@@ -250,12 +256,6 @@ module PureCloud
         self.value_node = false
       end
       
-      if attributes[:'floatingPointNumber']
-        self.floating_point_number = attributes[:'floatingPointNumber']
-      else
-        self.floating_point_number = false
-      end
-      
       if attributes[:'array']
         self.array = attributes[:'array']
       else
@@ -292,6 +292,7 @@ module PureCloud
           missing_node == o.missing_node &&
           pojo == o.pojo &&
           integral_number == o.integral_number &&
+          floating_point_number == o.floating_point_number &&
           short == o.short &&
           int == o.int &&
           long == o.long &&
@@ -301,7 +302,6 @@ module PureCloud
           textual == o.textual &&
           binary == o.binary &&
           value_node == o.value_node &&
-          floating_point_number == o.floating_point_number &&
           array == o.array &&
           null == o.null
     end
@@ -313,7 +313,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [node_type, float, object, boolean, number, container_node, missing_node, pojo, integral_number, short, int, long, double, big_decimal, big_integer, textual, binary, value_node, floating_point_number, array, null].hash
+      [node_type, float, object, boolean, number, container_node, missing_node, pojo, integral_number, floating_point_number, short, int, long, double, big_decimal, big_integer, textual, binary, value_node, array, null].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/json_node_search_response.rb

@@ -36,6 +36,8 @@ module PureCloud
 
     attr_accessor :results
 
+    attr_accessor :aggregations
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -56,7 +58,9 @@ module PureCloud
         
         :'types' => :'types',
         
-        :'results' => :'results'
+        :'results' => :'results',
+        
+        :'aggregations' => :'aggregations'
         
       }
     end
@@ -72,7 +76,8 @@ module PureCloud
         :'current_page' => :'String',
         :'next_page' => :'String',
         :'types' => :'Array<String>',
-        :'results' => :'JsonNode'
+        :'results' => :'JsonNode',
+        :'aggregations' => :'JsonNode'
         
       }
     end
@@ -122,6 +127,10 @@ module PureCloud
         self.results = attributes[:'results']
       end
       
+      if attributes[:'aggregations']
+        self.aggregations = attributes[:'aggregations']
+      end
+      
     end
 
     # Check equality by comparing each attribute.
@@ -136,7 +145,8 @@ module PureCloud
           current_page == o.current_page &&
           next_page == o.next_page &&
           types == o.types &&
-          results == o.results
+          results == o.results &&
+          aggregations == o.aggregations
     end
 
     # @see the `==` method
@@ -146,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results].hash
+      [total, page_count, page_size, page_number, previous_page, current_page, next_page, types, results, aggregations].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/location_search_criteria.rb

@@ -0,0 +1,260 @@
+=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 LocationSearchCriteria
+    attr_accessor :end_value
+
+    attr_accessor :values
+
+    attr_accessor :start_value
+
+    attr_accessor :fields
+
+    attr_accessor :value
+
+    attr_accessor :operator
+
+    attr_accessor :group
+
+    # Search Type
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'end_value' => :'endValue',
+        
+        :'values' => :'values',
+        
+        :'start_value' => :'startValue',
+        
+        :'fields' => :'fields',
+        
+        :'value' => :'value',
+        
+        :'operator' => :'operator',
+        
+        :'group' => :'group',
+        
+        :'type' => :'type'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'end_value' => :'String',
+        :'values' => :'Array<String>',
+        :'start_value' => :'String',
+        :'fields' => :'Array<String>',
+        :'value' => :'String',
+        :'operator' => :'String',
+        :'group' => :'Array<LocationSearchCriteria>',
+        :'type' => :'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[:'endValue']
+        self.end_value = attributes[:'endValue']
+      end
+      
+      if attributes[:'values']
+        if (value = attributes[:'values']).is_a?(Array)
+          self.values = value
+        end
+      end
+      
+      if attributes[:'startValue']
+        self.start_value = attributes[:'startValue']
+      end
+      
+      if attributes[:'fields']
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      end
+      
+      if attributes[:'value']
+        self.value = attributes[:'value']
+      end
+      
+      if attributes[:'operator']
+        self.operator = attributes[:'operator']
+      end
+      
+      if attributes[:'group']
+        if (value = attributes[:'group']).is_a?(Array)
+          self.group = value
+        end
+      end
+      
+      if attributes[:'type']
+        self.type = attributes[:'type']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def operator=(operator)
+      allowed_values = ["AND", "OR", "NOT"]
+      if operator && !allowed_values.include?(operator)
+        fail "invalid value for 'operator', must be one of #{allowed_values}"
+      end
+      @operator = operator
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def type=(type)
+      allowed_values = ["EXACT", "STARTS_WITH", "CONTAINS", "REGEX", "TERM", "TERMS", "REQUIRED_FIELDS"]
+      if type && !allowed_values.include?(type)
+        fail "invalid value for 'type', must be one of #{allowed_values}"
+      end
+      @type = type
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          end_value == o.end_value &&
+          values == o.values &&
+          start_value == o.start_value &&
+          fields == o.fields &&
+          value == o.value &&
+          operator == o.operator &&
+          group == o.group &&
+          type == o.type
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [end_value, values, start_value, fields, value, operator, group, type].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