purecloudplatformclientv2 13.1.0 → 14.0.0

data/lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb

@@ -0,0 +1,376 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class TrusteeAuditQueryRequest
+    # Limit returned audits to these trustee organizationIds.
+    attr_accessor :trustee_organization_ids
+
+    # Limit returned audits to these trustee userIds.
+    attr_accessor :trustee_user_ids
+
+    # Starting date/time for the audit search. ISO-8601 formatted date-time, UTC.
+    attr_accessor :start_date
+
+    # Ending date/time for the audit search. ISO-8601 formatted date-time, UTC.
+    attr_accessor :end_date
+
+    # Word or phrase to look for in audit bodies.
+    attr_accessor :query_phrase
+
+    # Facet information to be returned with the query results.
+    attr_accessor :facets
+
+    # Additional custom filters to be applied to the query.
+    attr_accessor :filters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'trustee_organization_ids' => :'trusteeOrganizationIds',
+        
+        :'trustee_user_ids' => :'trusteeUserIds',
+        
+        :'start_date' => :'startDate',
+        
+        :'end_date' => :'endDate',
+        
+        :'query_phrase' => :'queryPhrase',
+        
+        :'facets' => :'facets',
+        
+        :'filters' => :'filters'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'trustee_organization_ids' => :'Array<String>',
+        
+        :'trustee_user_ids' => :'Array<String>',
+        
+        :'start_date' => :'DateTime',
+        
+        :'end_date' => :'DateTime',
+        
+        :'query_phrase' => :'String',
+        
+        :'facets' => :'Array<Facet>',
+        
+        :'filters' => :'Array<Filter>'
+        
+      }
+    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?(:'trusteeOrganizationIds')
+        
+        if (value = attributes[:'trusteeOrganizationIds']).is_a?(Array)
+          self.trustee_organization_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'trusteeUserIds')
+        
+        if (value = attributes[:'trusteeUserIds']).is_a?(Array)
+          self.trustee_user_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'startDate')
+        
+        
+        self.start_date = attributes[:'startDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'endDate')
+        
+        
+        self.end_date = attributes[:'endDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'queryPhrase')
+        
+        
+        self.query_phrase = attributes[:'queryPhrase']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'facets')
+        
+        if (value = attributes[:'facets']).is_a?(Array)
+          self.facets = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'filters')
+        
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = 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?
+      
+      
+      if @trustee_organization_ids.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @trustee_user_ids.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          trustee_organization_ids == o.trustee_organization_ids &&
+          trustee_user_ids == o.trustee_user_ids &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          query_phrase == o.query_phrase &&
+          facets == o.facets &&
+          filters == o.filters
+    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
+      [trustee_organization_ids, trustee_user_ids, start_date, end_date, query_phrase, facets, filters].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/trustor_audit_query_request.rb

@@ -0,0 +1,374 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class TrustorAuditQueryRequest
+    # Limit returned audits to this trustor organizationId.
+    attr_accessor :trustor_organization_id
+
+    # Limit returned audits to these trustee userIds.
+    attr_accessor :trustee_user_ids
+
+    # Starting date/time for the audit search. ISO-8601 formatted date-time, UTC.
+    attr_accessor :start_date
+
+    # Ending date/time for the audit search. ISO-8601 formatted date-time, UTC.
+    attr_accessor :end_date
+
+    # Word or phrase to look for in audit bodies.
+    attr_accessor :query_phrase
+
+    # Facet information to be returned with the query results.
+    attr_accessor :facets
+
+    # Additional custom filters to be applied to the query.
+    attr_accessor :filters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'trustor_organization_id' => :'trustorOrganizationId',
+        
+        :'trustee_user_ids' => :'trusteeUserIds',
+        
+        :'start_date' => :'startDate',
+        
+        :'end_date' => :'endDate',
+        
+        :'query_phrase' => :'queryPhrase',
+        
+        :'facets' => :'facets',
+        
+        :'filters' => :'filters'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'trustor_organization_id' => :'String',
+        
+        :'trustee_user_ids' => :'Array<String>',
+        
+        :'start_date' => :'DateTime',
+        
+        :'end_date' => :'DateTime',
+        
+        :'query_phrase' => :'String',
+        
+        :'facets' => :'Array<Facet>',
+        
+        :'filters' => :'Array<Filter>'
+        
+      }
+    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?(:'trustorOrganizationId')
+        
+        
+        self.trustor_organization_id = attributes[:'trustorOrganizationId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'trusteeUserIds')
+        
+        if (value = attributes[:'trusteeUserIds']).is_a?(Array)
+          self.trustee_user_ids = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'startDate')
+        
+        
+        self.start_date = attributes[:'startDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'endDate')
+        
+        
+        self.end_date = attributes[:'endDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'queryPhrase')
+        
+        
+        self.query_phrase = attributes[:'queryPhrase']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'facets')
+        
+        if (value = attributes[:'facets']).is_a?(Array)
+          self.facets = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'filters')
+        
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = 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?
+      
+      
+      if @trustor_organization_id.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @trustee_user_ids.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          trustor_organization_id == o.trustor_organization_id &&
+          trustee_user_ids == o.trustee_user_ids &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          query_phrase == o.query_phrase &&
+          facets == o.facets &&
+          filters == o.filters
+    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
+      [trustor_organization_id, trustee_user_ids, start_date, end_date, query_phrase, facets, filters].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