purecloudplatformclientv2 91.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb

@@ -0,0 +1,323 @@
+=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@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require 'date'
+
+module PureCloud
+  class JourneyAggregationView
+    # Target metric name
+    attr_accessor :target
+
+    # A unique name for this view. Must be distinct from other views and built-in metric names.
+    attr_accessor :name
+
+    # Type of view you wish to create
+    attr_accessor :function
+
+    # Range of numbers for slicing up data
+    attr_accessor :range
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'target' => :'target',
+        
+        :'name' => :'name',
+        
+        :'function' => :'function',
+        
+        :'range' => :'range'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'target' => :'String',
+        
+        :'name' => :'String',
+        
+        :'function' => :'String',
+        
+        :'range' => :'AggregationRange'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'target')
+        
+        
+        self.target = attributes[:'target']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'function')
+        
+        
+        self.function = attributes[:'function']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'range')
+        
+        
+        self.range = attributes[:'range']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      if @target.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["nJourneyOutcomesAchieved", "nJourneySegmentsAssigned", "nJourneySessions", "nWebActionsAbandoned", "nWebActionsAccepted", "nWebActionsEngaged", "nWebActionsErrored", "nWebActionsIgnored", "nWebActionsOffered", "nWebActionsQualified", "nWebActionsQualifiedOutsideSchedule", "nWebActionsRejected", "nWebActionsStarted", "nWebActionsTimedout"]
+      if @target && !allowed_values.include?(@target)
+        return false
+      end
+      
+      
+      
+      
+      if @name.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @function.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["rangeBound"]
+      if @function && !allowed_values.include?(@function)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] target Object to be assigned
+    def target=(target)
+      allowed_values = ["nJourneyOutcomesAchieved", "nJourneySegmentsAssigned", "nJourneySessions", "nWebActionsAbandoned", "nWebActionsAccepted", "nWebActionsEngaged", "nWebActionsErrored", "nWebActionsIgnored", "nWebActionsOffered", "nWebActionsQualified", "nWebActionsQualifiedOutsideSchedule", "nWebActionsRejected", "nWebActionsStarted", "nWebActionsTimedout"]
+      if target && !allowed_values.include?(target)
+        fail ArgumentError, "invalid value for 'target', must be one of #{allowed_values}."
+      end
+      @target = target
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] function Object to be assigned
+    def function=(function)
+      allowed_values = ["rangeBound"]
+      if function && !allowed_values.include?(function)
+        fail ArgumentError, "invalid value for 'function', must be one of #{allowed_values}."
+      end
+      @function = function
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          target == o.target &&
+          name == o.name &&
+          function == o.function &&
+          range == o.range
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [target, name, function, range].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/purecloudplatformclientv2/models/json_node.rb

@@ -28,16 +28,10 @@ module PureCloud
 
     attr_accessor :object
 
-    attr_accessor :value_node
-
-    attr_accessor :container_node
-
-    attr_accessor :missing_node
+    attr_accessor :floating_point_number
 
     attr_accessor :pojo
 
-    attr_accessor :floating_point_number
-
     attr_accessor :integral_number
 
     attr_accessor :short
@@ -56,6 +50,12 @@ module PureCloud
 
     attr_accessor :binary
 
+    attr_accessor :value_node
+
+    attr_accessor :container_node
+
+    attr_accessor :missing_node
+
     attr_accessor :array
 
     attr_accessor :null
@@ -74,16 +74,10 @@ module PureCloud
         
         :'object' => :'object',
         
-        :'value_node' => :'valueNode',
-        
-        :'container_node' => :'containerNode',
-        
-        :'missing_node' => :'missingNode',
+        :'floating_point_number' => :'floatingPointNumber',
         
         :'pojo' => :'pojo',
         
-        :'floating_point_number' => :'floatingPointNumber',
-        
         :'integral_number' => :'integralNumber',
         
         :'short' => :'short',
@@ -102,6 +96,12 @@ module PureCloud
         
         :'binary' => :'binary',
         
+        :'value_node' => :'valueNode',
+        
+        :'container_node' => :'containerNode',
+        
+        :'missing_node' => :'missingNode',
+        
         :'array' => :'array',
         
         :'null' => :'null'
@@ -123,16 +123,10 @@ module PureCloud
         
         :'object' => :'BOOLEAN',
         
-        :'value_node' => :'BOOLEAN',
-        
-        :'container_node' => :'BOOLEAN',
-        
-        :'missing_node' => :'BOOLEAN',
+        :'floating_point_number' => :'BOOLEAN',
         
         :'pojo' => :'BOOLEAN',
         
-        :'floating_point_number' => :'BOOLEAN',
-        
         :'integral_number' => :'BOOLEAN',
         
         :'short' => :'BOOLEAN',
@@ -151,6 +145,12 @@ module PureCloud
         
         :'binary' => :'BOOLEAN',
         
+        :'value_node' => :'BOOLEAN',
+        
+        :'container_node' => :'BOOLEAN',
+        
+        :'missing_node' => :'BOOLEAN',
+        
         :'array' => :'BOOLEAN',
         
         :'null' => :'BOOLEAN'
@@ -212,127 +212,127 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'valueNode')
+      if attributes.has_key?(:'floatingPointNumber')
         
         
-        self.value_node = attributes[:'valueNode']
+        self.floating_point_number = attributes[:'floatingPointNumber']
         
       
       end
 
       
-      if attributes.has_key?(:'containerNode')
+      if attributes.has_key?(:'pojo')
         
         
-        self.container_node = attributes[:'containerNode']
+        self.pojo = attributes[:'pojo']
         
       
       end
 
       
-      if attributes.has_key?(:'missingNode')
+      if attributes.has_key?(:'integralNumber')
         
         
-        self.missing_node = attributes[:'missingNode']
+        self.integral_number = attributes[:'integralNumber']
         
       
       end
 
       
-      if attributes.has_key?(:'pojo')
+      if attributes.has_key?(:'short')
         
         
-        self.pojo = attributes[:'pojo']
+        self.short = attributes[:'short']
         
       
       end
 
       
-      if attributes.has_key?(:'floatingPointNumber')
+      if attributes.has_key?(:'int')
         
         
-        self.floating_point_number = attributes[:'floatingPointNumber']
+        self.int = attributes[:'int']
         
       
       end
 
       
-      if attributes.has_key?(:'integralNumber')
+      if attributes.has_key?(:'long')
         
         
-        self.integral_number = attributes[:'integralNumber']
+        self.long = attributes[:'long']
         
       
       end
 
       
-      if attributes.has_key?(:'short')
+      if attributes.has_key?(:'double')
         
         
-        self.short = attributes[:'short']
+        self.double = attributes[:'double']
         
       
       end
 
       
-      if attributes.has_key?(:'int')
+      if attributes.has_key?(:'bigDecimal')
         
         
-        self.int = attributes[:'int']
+        self.big_decimal = attributes[:'bigDecimal']
         
       
       end
 
       
-      if attributes.has_key?(:'long')
+      if attributes.has_key?(:'bigInteger')
         
         
-        self.long = attributes[:'long']
+        self.big_integer = attributes[:'bigInteger']
         
       
       end
 
       
-      if attributes.has_key?(:'double')
+      if attributes.has_key?(:'textual')
         
         
-        self.double = attributes[:'double']
+        self.textual = attributes[:'textual']
         
       
       end
 
       
-      if attributes.has_key?(:'bigDecimal')
+      if attributes.has_key?(:'binary')
         
         
-        self.big_decimal = attributes[:'bigDecimal']
+        self.binary = attributes[:'binary']
         
       
       end
 
       
-      if attributes.has_key?(:'bigInteger')
+      if attributes.has_key?(:'valueNode')
         
         
-        self.big_integer = attributes[:'bigInteger']
+        self.value_node = attributes[:'valueNode']
         
       
       end
 
       
-      if attributes.has_key?(:'textual')
+      if attributes.has_key?(:'containerNode')
         
         
-        self.textual = attributes[:'textual']
+        self.container_node = attributes[:'containerNode']
         
       
       end
 
       
-      if attributes.has_key?(:'binary')
+      if attributes.has_key?(:'missingNode')
         
         
-        self.binary = attributes[:'binary']
+        self.missing_node = attributes[:'missingNode']
         
       
       end
@@ -587,11 +587,8 @@ module PureCloud
           number == o.number &&
           boolean == o.boolean &&
           object == o.object &&
-          value_node == o.value_node &&
-          container_node == o.container_node &&
-          missing_node == o.missing_node &&
-          pojo == o.pojo &&
           floating_point_number == o.floating_point_number &&
+          pojo == o.pojo &&
           integral_number == o.integral_number &&
           short == o.short &&
           int == o.int &&
@@ -601,6 +598,9 @@ module PureCloud
           big_integer == o.big_integer &&
           textual == o.textual &&
           binary == o.binary &&
+          value_node == o.value_node &&
+          container_node == o.container_node &&
+          missing_node == o.missing_node &&
           array == o.array &&
           null == o.null
     end
@@ -614,7 +614,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [node_type, float, number, boolean, object, value_node, container_node, missing_node, pojo, floating_point_number, integral_number, short, int, long, double, big_decimal, big_integer, textual, binary, array, null].hash
+      [node_type, float, number, boolean, object, floating_point_number, pojo, integral_number, short, int, long, double, big_decimal, big_integer, textual, binary, value_node, container_node, missing_node, array, null].hash
     end
 
     # build the object from hash