purecloudplatformclientv2 75.1.0 → 79.0.0

data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb

@@ -58,6 +58,8 @@ module PureCloud
     # The URI of the schema for the enterprise user.
     attr_accessor :urnietfparamsscimschemasextensionenterprise2_0_user
 
+    attr_accessor :urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -86,7 +88,9 @@ module PureCloud
         
         :'roles' => :'roles',
         
-        :'urnietfparamsscimschemasextensionenterprise2_0_user' => :'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
+        :'urnietfparamsscimschemasextensionenterprise2_0_user' => :'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User',
+        
+        :'urnietfparamsscimschemasextensiongenesyspurecloud2_0_user' => :'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User'
         
       }
     end
@@ -117,9 +121,11 @@ module PureCloud
         
         :'groups' => :'Array<ScimV2GroupReference>',
         
-        :'roles' => :'Array<String>',
+        :'roles' => :'Array<ScimUserRole>',
+        
+        :'urnietfparamsscimschemasextensionenterprise2_0_user' => :'ScimV2EnterpriseUser',
         
-        :'urnietfparamsscimschemasextensionenterprise2_0_user' => :'ScimV2EnterpriseUser'
+        :'urnietfparamsscimschemasextensiongenesyspurecloud2_0_user' => :'ScimUserExtensions'
         
       }
     end
@@ -262,6 +268,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User')
+        
+        
+        self.urnietfparamsscimschemasextensiongenesyspurecloud2_0_user = attributes[:'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -334,6 +349,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -401,6 +420,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -424,7 +448,8 @@ module PureCloud
           external_id == o.external_id &&
           groups == o.groups &&
           roles == o.roles &&
-          urnietfparamsscimschemasextensionenterprise2_0_user == o.urnietfparamsscimschemasextensionenterprise2_0_user
+          urnietfparamsscimschemasextensionenterprise2_0_user == o.urnietfparamsscimschemasextensionenterprise2_0_user &&
+          urnietfparamsscimschemasextensiongenesyspurecloud2_0_user == o.urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
     end
 
     # @see the `==` method
@@ -436,7 +461,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [schemas, active, user_name, display_name, password, title, phone_numbers, emails, photos, external_id, groups, roles, urnietfparamsscimschemasextensionenterprise2_0_user].hash
+      [schemas, active, user_name, display_name, password, title, phone_numbers, emails, photos, external_id, groups, roles, urnietfparamsscimschemasextensionenterprise2_0_user, urnietfparamsscimschemasextensiongenesyspurecloud2_0_user].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb

@@ -107,7 +107,7 @@ module PureCloud
       
       
       
-      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType", "Schema"]
       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", "ResourceType"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType", "Schema"]
       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

@@ -107,7 +107,7 @@ module PureCloud
       
       
       
-      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType", "Schema"]
       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", "ResourceType"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType", "Schema"]
       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_schema_attribute.rb

@@ -0,0 +1,551 @@
+=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
+  # A complex type that defines service provider attributes, or sub-attributes and their qualities.
+  class ScimV2SchemaAttribute
+    # The attribute's name
+    attr_accessor :name
+
+    # The attribute's data type.  Valid values are \"string\", \"boolean\", \"decimal\", \"integer\", \"dateTime\", \"reference\", and \"complex\".
+    attr_accessor :type
+
+    # When an attribute is of type \"complex\", \"subAttributes\" defines a set of sub-attributes. \"subAttributes\" has the same schema sub-attributes as \"attributes\"
+    attr_accessor :sub_attributes
+
+    # A Boolean value indicating the attribute's plurality.
+    attr_accessor :multi_valued
+
+    # The attribute's human-readable description.
+    attr_accessor :description
+
+    # A Boolean value that specifies whether or not the attribute is required.
+    attr_accessor :required
+
+    # A collection of suggested canonical values that MAY be used (e.g., \"work\" and \"home\").  In some cases, service providers MAY choose to ignore unsupported values.  OPTIONAL.
+    attr_accessor :canonical_values
+
+    # A Boolean value that specifies whether or not a string attribute is case sensitive.  The server SHALL use case sensitivity when evaluating filters.  For attributes that are case exact, the server SHALL preserve case for any value submitted.  If the attribute is case insensitive, the server MAY alter case for a submitted value.  Case sensitivity also impacts how attribute values MAY be compared against filter values (see Section 3.4.2.2 of [RFC7644])
+    attr_accessor :case_exact
+
+    # A single keyword indicating the circumstances under which the value of the attribute can be (re)defined. Value are readOnly, readWrite, immutable, writeOnly
+    attr_accessor :mutability
+
+    # A single keyword that indicates when an attribute and associated values are returned in response to a GET request, or in response to a PUT, POST, or PATCH request.  Valid keywords are as follows: always, never, default, request
+    attr_accessor :returned
+
+    # A single keyword value that specifies how the service provider enforces uniqueness of attribute values.  A server MAY reject an invalid value based on uniqueness by returning HTTP response code 400 (Bad Request).  A client MAY enforce uniqueness on the client side to a greater degree than the service provider enforces.  For example, a client could make a value unique while the server has uniqueness of \"none\".  Valid keywords are as follows: none, server, global
+    attr_accessor :uniqueness
+
+    # A multi-valued array of JSON strings that indicate the SCIM resource types that may be referenced. Values include User, Group, external and uri.
+    attr_accessor :reference_types
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'name' => :'name',
+        
+        :'type' => :'type',
+        
+        :'sub_attributes' => :'subAttributes',
+        
+        :'multi_valued' => :'multiValued',
+        
+        :'description' => :'description',
+        
+        :'required' => :'required',
+        
+        :'canonical_values' => :'canonicalValues',
+        
+        :'case_exact' => :'caseExact',
+        
+        :'mutability' => :'mutability',
+        
+        :'returned' => :'returned',
+        
+        :'uniqueness' => :'uniqueness',
+        
+        :'reference_types' => :'referenceTypes'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'name' => :'String',
+        
+        :'type' => :'String',
+        
+        :'sub_attributes' => :'Array<ScimV2SchemaAttribute>',
+        
+        :'multi_valued' => :'BOOLEAN',
+        
+        :'description' => :'String',
+        
+        :'required' => :'BOOLEAN',
+        
+        :'canonical_values' => :'Array<String>',
+        
+        :'case_exact' => :'BOOLEAN',
+        
+        :'mutability' => :'String',
+        
+        :'returned' => :'String',
+        
+        :'uniqueness' => :'String',
+        
+        :'reference_types' => :'Array<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?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'type')
+        
+        
+        self.type = attributes[:'type']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'subAttributes')
+        
+        if (value = attributes[:'subAttributes']).is_a?(Array)
+          self.sub_attributes = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'multiValued')
+        
+        
+        self.multi_valued = attributes[:'multiValued']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'description')
+        
+        
+        self.description = attributes[:'description']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'required')
+        
+        
+        self.required = attributes[:'required']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'canonicalValues')
+        
+        if (value = attributes[:'canonicalValues']).is_a?(Array)
+          self.canonical_values = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'caseExact')
+        
+        
+        self.case_exact = attributes[:'caseExact']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'mutability')
+        
+        
+        self.mutability = attributes[:'mutability']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'returned')
+        
+        
+        self.returned = attributes[:'returned']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'uniqueness')
+        
+        
+        self.uniqueness = attributes[:'uniqueness']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'referenceTypes')
+        
+        if (value = attributes[:'referenceTypes']).is_a?(Array)
+          self.reference_types = 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?
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["STRING", "BOOLEAN", "DECIMAL", "INTEGER", "DATE_TIME", "REFERENCE", "COMPLEX"]
+      if @type && !allowed_values.include?(@type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["readWrite", "readOnly", "immutable", "writeOnly"]
+      if @mutability && !allowed_values.include?(@mutability)
+        return false
+      end
+      
+      
+      
+      
+      
+      allowed_values = ["ALWAYS", "NEVER", "DEFAULT", "REQUEST"]
+      if @returned && !allowed_values.include?(@returned)
+        return false
+      end
+      
+      
+      
+      
+      
+      allowed_values = ["NONE", "SERVER", "GLOBAL"]
+      if @uniqueness && !allowed_values.include?(@uniqueness)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      allowed_values = ["STRING", "BOOLEAN", "DECIMAL", "INTEGER", "DATE_TIME", "REFERENCE", "COMPLEX"]
+      if type && !allowed_values.include?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
+      end
+      @type = type
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mutability Object to be assigned
+    def mutability=(mutability)
+      allowed_values = ["readWrite", "readOnly", "immutable", "writeOnly"]
+      if mutability && !allowed_values.include?(mutability)
+        fail ArgumentError, "invalid value for 'mutability', must be one of #{allowed_values}."
+      end
+      @mutability = mutability
+    end
+
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] returned Object to be assigned
+    def returned=(returned)
+      allowed_values = ["ALWAYS", "NEVER", "DEFAULT", "REQUEST"]
+      if returned && !allowed_values.include?(returned)
+        fail ArgumentError, "invalid value for 'returned', must be one of #{allowed_values}."
+      end
+      @returned = returned
+    end
+
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] uniqueness Object to be assigned
+    def uniqueness=(uniqueness)
+      allowed_values = ["NONE", "SERVER", "GLOBAL"]
+      if uniqueness && !allowed_values.include?(uniqueness)
+        fail ArgumentError, "invalid value for 'uniqueness', must be one of #{allowed_values}."
+      end
+      @uniqueness = uniqueness
+    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 &&
+          name == o.name &&
+          type == o.type &&
+          sub_attributes == o.sub_attributes &&
+          multi_valued == o.multi_valued &&
+          description == o.description &&
+          required == o.required &&
+          canonical_values == o.canonical_values &&
+          case_exact == o.case_exact &&
+          mutability == o.mutability &&
+          returned == o.returned &&
+          uniqueness == o.uniqueness &&
+          reference_types == o.reference_types
+    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
+      [name, type, sub_attributes, multi_valued, description, required, canonical_values, case_exact, mutability, returned, uniqueness, reference_types].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