purecloudplatformclientv2 62.0.0 → 66.0.0

data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb

@@ -0,0 +1,203 @@
+=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
+  # Configuration options.
+  class ScimServiceProviderConfigSimpleFeature
+    # Indicates whether configuration options are supported.
+    attr_accessor :supported
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'supported' => :'supported'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'supported' => :'BOOLEAN'
+        
+      }
+    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?(:'supported')
+        
+        
+        self.supported = attributes[:'supported']
+        
+      
+      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 &&
+          supported == o.supported
+    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
+      [supported].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/scim_user_list_response.rb

@@ -22,13 +22,13 @@ module PureCloud
     # The total number of results.
     attr_accessor :total_results
 
-    # The 1-based index of the first result returned by this request. Add this to itemsPerPage when requesting the next page of results.
+    # The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.
     attr_accessor :start_index
 
     # The number of resources returned per page.
     attr_accessor :items_per_page
 
-    # Resources
+    # The list of requested resources. If \"count\" is 0, then the list will be empty.
     attr_accessor :resources
 
     # The list of supported schemas.

data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb

@@ -28,31 +28,31 @@ module PureCloud
     # The user's PureCloud email address. Must be unique.
     attr_accessor :user_name
 
-    # The display name for the user.
+    # The display name of the user.
     attr_accessor :display_name
 
-    # A new password for a PureCloud user. Does not return an existing password.
+    # The new password for the PureCloud user. Does not return an existing password.
     attr_accessor :password
 
     # The user's title.
     attr_accessor :title
 
-    # A list of the user's phone numbers.
+    # The list of the user's phone numbers.
     attr_accessor :phone_numbers
 
-    # A list of the user's email addresses.
+    # The list of the user's email addresses.
     attr_accessor :emails
 
-    # A list of the user's photos.
+    # The list of the user's photos.
     attr_accessor :photos
 
-    # The external ID of the user. Set by the provisioning client. caseExact is set to true. mutability is set to readWrite.
+    # The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\".
     attr_accessor :external_id
 
-    # A list of groups that the user is a member of.
+    # The list of groups that the user is a member of.
     attr_accessor :groups
 
-    # A list of roles assigned to the user.
+    # The list of roles assigned to the user.
     attr_accessor :roles
 
     attr_accessor :urnietfparamsscimschemasextensionenterprise2_0_user

data/lib/purecloudplatformclientv2/models/scim_v2_group.rb

@@ -19,16 +19,16 @@ require 'date'
 module PureCloud
   # SCIM version 2 Group
   class ScimV2Group
-    # The ID of the SCIM resource. Set by the service provider. caseExact is set to true. Mutability is set to readOnly. Returned is set to always.
+    # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
     attr_accessor :id
 
     # The list of supported schemas.
     attr_accessor :schemas
 
-    # The display name for the group.
+    # The display name of the group.
     attr_accessor :display_name
 
-    # A list of members in a SCIM group.
+    # The list of members in the group.
     attr_accessor :members
 
     # Resource SCIM meta

data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb

@@ -19,10 +19,10 @@ require 'date'
 module PureCloud
   # SCIM Group Reference
   class ScimV2GroupReference
-    # The SCIM resource type. Can be user or group.
+    # The type of SCIM resource.
     attr_accessor :type
 
-    # The ID of the group member. Can be userId or groupId.
+    # The ID of the group member. Can be \"userId\" or \"groupId\".
     attr_accessor :value
 
     # The reference URI of the SCIM resource.
@@ -107,7 +107,7 @@ module PureCloud
       
       
       
-      allowed_values = ["User", "Group", "ServiceProviderConfig"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -129,7 +129,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["User", "Group", "ServiceProviderConfig"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb

@@ -19,10 +19,10 @@ require 'date'
 module PureCloud
   # SCIM Members of Group Reference
   class ScimV2MemberReference
-    # The SCIM resource type. Can be user or group.
+    # The type of SCIM resource.
     attr_accessor :type
 
-    # The ID of the group member. Can be userId or groupId.
+    # The ID of the group member. Can be \"userId\" or \"groupId\".
     attr_accessor :value
 
     # The reference URI of the SCIM resource.
@@ -107,7 +107,7 @@ module PureCloud
       
       
       
-      allowed_values = ["User", "Group", "ServiceProviderConfig"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -129,7 +129,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["User", "Group", "ServiceProviderConfig"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb

@@ -17,12 +17,12 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  # Represents an individual patch operation. Path and value have very specific rules based on operation type. See https://tools.ietf.org/html/rfc7644#section-3.5.2 for details.
+  # Represents an individual PATCH operation. Path and value have very specific rules based on operation type. See https://tools.ietf.org/html/rfc7644#section-3.5.2 for details.
   class ScimV2PatchOperation
-    # The patch operation to perform.
+    # The PATCH operation to perform.
     attr_accessor :op
 
-    # The attribute path that describes the target of the operation. Required for a 'remove' operation.
+    # The attribute path that describes the target of the operation. Required for a \"remove\" operation.
     attr_accessor :path
 
     # The value to set in the path.

data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb

@@ -19,9 +19,10 @@ require 'date'
 module PureCloud
   # Represents a SCIM V2 Patch Request (See RFC7644 for detailed usage)
   class ScimV2PatchRequest
-    # A list of schemas used in the patch request.
+    # The list of schemas used in the PATCH request.
     attr_accessor :schemas
 
+    # The list of operations to perform for the PATCH request.
     attr_accessor :operations
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloudplatformclientv2/models/scim_v2_user.rb

@@ -19,7 +19,7 @@ require 'date'
 module PureCloud
   # SCIM V2 User
   class ScimV2User
-    # The ID of the SCIM resource. Set by the service provider. caseExact is set to true. Mutability is set to readOnly. Returned is set to always.
+    # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
     attr_accessor :id
 
     # The list of supported schemas.
@@ -31,31 +31,31 @@ module PureCloud
     # The user's PureCloud email address. Must be unique.
     attr_accessor :user_name
 
-    # The display name for the user.
+    # The display name of the user.
     attr_accessor :display_name
 
-    # A new password for a PureCloud user. Does not return an existing password.
+    # The new password for the PureCloud user. Does not return an existing password.
     attr_accessor :password
 
     # The user's title.
     attr_accessor :title
 
-    # A list of the user's phone numbers.
+    # The list of the user's phone numbers.
     attr_accessor :phone_numbers
 
-    # A list of the user's email addresses.
+    # The list of the user's email addresses.
     attr_accessor :emails
 
-    # A list of the user's photos.
+    # The list of the user's photos.
     attr_accessor :photos
 
-    # The external ID of the user. Set by the provisioning client. caseExact is set to true. mutability is set to readWrite.
+    # The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\".
     attr_accessor :external_id
 
-    # A list of groups that the user is a member of.
+    # The list of groups that the user is a member of.
     attr_accessor :groups
 
-    # A list of roles assigned to the user.
+    # The list of roles assigned to the user.
     attr_accessor :roles
 
     attr_accessor :urnietfparamsscimschemasextensionenterprise2_0_user

data/lib/purecloudplatformclientv2/models/segment_detail_query_clause.rb

@@ -0,0 +1,254 @@
+=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 SegmentDetailQueryClause
+    # Boolean operation to apply to the provided predicates
+    attr_accessor :type
+
+    # Like a three-word sentence: (attribute-name) (operator) (target-value).
+    attr_accessor :predicates
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'type' => :'type',
+        
+        :'predicates' => :'predicates'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'type' => :'String',
+        
+        :'predicates' => :'Array<SegmentDetailQueryPredicate>'
+        
+      }
+    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?(:'type')
+        
+        
+        self.type = attributes[:'type']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'predicates')
+        
+        if (value = attributes[:'predicates']).is_a?(Array)
+          self.predicates = 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 @type.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["and", "or"]
+      if @type && !allowed_values.include?(@type)
+        return false
+      end
+      
+      
+      
+      
+      if @predicates.nil?
+        return false
+      end
+
+      
+      
+      
+      
+    end
+
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      allowed_values = ["and", "or"]
+      if type && !allowed_values.include?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
+      end
+      @type = 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 &&
+          type == o.type &&
+          predicates == o.predicates
+    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
+      [type, predicates].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