purecloudplatformclientv2 91.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_response.rb

@@ -0,0 +1,204 @@
+=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 CoachingAppointmentAggregateResponse
+    # The results of the query
+    attr_accessor :results
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'results' => :'results'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'results' => :'Array<QueryResponseGroupedData>'
+        
+      }
+    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?(:'results')
+        
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+        
+        
+      
+      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?
+      
+      
+      
+      
+      
+    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 &&
+          results == o.results
+    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
+      [results].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/coaching_appointment_response.rb

@@ -61,6 +61,9 @@ module PureCloud
     # The list of documents associated with coaching appointment.
     attr_accessor :documents
 
+    # Whether the appointment is overdue.
+    attr_accessor :is_overdue
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -96,6 +99,8 @@ module PureCloud
         
         :'documents' => :'documents',
         
+        :'is_overdue' => :'isOverdue',
+        
         :'self_uri' => :'selfUri'
         
       }
@@ -133,6 +138,8 @@ module PureCloud
         
         :'documents' => :'Array<DocumentReference>',
         
+        :'is_overdue' => :'BOOLEAN',
+        
         :'self_uri' => :'String'
         
       }
@@ -279,6 +286,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'isOverdue')
+        
+        
+        self.is_overdue = attributes[:'isOverdue']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'selfUri')
         
         
@@ -363,6 +379,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -449,6 +469,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -474,6 +499,7 @@ module PureCloud
           date_modified == o.date_modified &&
           conversations == o.conversations &&
           documents == o.documents &&
+          is_overdue == o.is_overdue &&
           self_uri == o.self_uri
     end
 
@@ -486,7 +512,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, description, date_start, length_in_minutes, status, facilitator, attendees, created_by, date_created, modified_by, date_modified, conversations, documents, self_uri].hash
+      [id, name, description, date_start, length_in_minutes, status, facilitator, attendees, created_by, date_created, modified_by, date_modified, conversations, documents, is_overdue, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/coaching_notification.rb

@@ -102,7 +102,7 @@ module PureCloud
         
         :'user' => :'UserReference',
         
-        :'appointment' => :'CoachingAppointmentReference',
+        :'appointment' => :'CoachingAppointmentResponse',
         
         :'self_uri' => :'String'
         

data/lib/purecloudplatformclientv2/models/cobrowsesession.rb

@@ -66,6 +66,9 @@ module PureCloud
     # Call wrap up or disposition data.
     attr_accessor :wrapup
 
+    # After-call work for the communication.
+    attr_accessor :after_call_work
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -100,7 +103,9 @@ module PureCloud
         
         :'segments' => :'segments',
         
-        :'wrapup' => :'wrapup'
+        :'wrapup' => :'wrapup',
+        
+        :'after_call_work' => :'afterCallWork'
         
       }
     end
@@ -139,7 +144,9 @@ module PureCloud
         
         :'segments' => :'Array<Segment>',
         
-        :'wrapup' => :'Wrapup'
+        :'wrapup' => :'Wrapup',
+        
+        :'after_call_work' => :'AfterCallWork'
         
       }
     end
@@ -301,6 +308,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'afterCallWork')
+        
+        
+        self.after_call_work = attributes[:'afterCallWork']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -385,6 +401,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -485,6 +505,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -511,7 +536,8 @@ module PureCloud
           provider == o.provider &&
           peer_id == o.peer_id &&
           segments == o.segments &&
-          wrapup == o.wrapup
+          wrapup == o.wrapup &&
+          after_call_work == o.after_call_work
     end
 
     # @see the `==` method
@@ -523,7 +549,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [state, id, disconnect_type, _self, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_time, start_alerting_time, connected_time, disconnected_time, provider, peer_id, segments, wrapup].hash
+      [state, id, disconnect_type, _self, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_time, start_alerting_time, connected_time, disconnected_time, provider, peer_id, segments, wrapup, after_call_work].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/common_campaign.rb

@@ -0,0 +1,320 @@
+=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 CommonCampaign
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    # The name of the Campaign.
+    attr_accessor :name
+
+    # The division to which this entity belongs.
+    attr_accessor :division
+
+    # The media type used for this campaign.
+    attr_accessor :media_type
+
+    # 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',
+        
+        :'division' => :'division',
+        
+        :'media_type' => :'mediaType',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'name' => :'String',
+        
+        :'division' => :'Division',
+        
+        :'media_type' => :'String',
+        
+        :'self_uri' => :'String'
+        
+      }
+    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?(:'id')
+        
+        
+        self.id = attributes[:'id']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'division')
+        
+        
+        self.division = attributes[:'division']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'mediaType')
+        
+        
+        self.media_type = attributes[:'mediaType']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
+        
+      
+      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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["sms", "voice"]
+      if @media_type && !allowed_values.include?(@media_type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] media_type Object to be assigned
+    def media_type=(media_type)
+      allowed_values = ["sms", "voice"]
+      if media_type && !allowed_values.include?(media_type)
+        fail ArgumentError, "invalid value for 'media_type', must be one of #{allowed_values}."
+      end
+      @media_type = media_type
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          division == o.division &&
+          media_type == o.media_type &&
+          self_uri == o.self_uri
+    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
+      [id, name, division, media_type, 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