purecloudplatformclientv2 62.0.0 → 66.0.0

data/lib/purecloudplatformclientv2/models/scim_group_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_metadata.rb

@@ -19,10 +19,10 @@ require 'date'
 module PureCloud
   # The meta object of the SCIM V2 implementation.
   class ScimMetadata
-    # The type of the resource.
+    # The type of SCIM resource.
     attr_accessor :resource_type
 
-    # The last time that the resource was modified. Time in ISO 6501 (UTC) format. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The last time that the resource was modified. Date time is represented as an ISO-8601 string, for example, yyyy-MM-ddTHH:mm:ss.SSSZ.
     attr_accessor :last_modified
 
     # The URI of the resource.
@@ -123,7 +123,7 @@ module PureCloud
       
       
       
-      allowed_values = ["User", "Group", "ServiceProviderConfig"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
       if @resource_type && !allowed_values.include?(@resource_type)
         return false
       end
@@ -149,7 +149,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] resource_type Object to be assigned
     def resource_type=(resource_type)
-      allowed_values = ["User", "Group", "ServiceProviderConfig"]
+      allowed_values = ["User", "Group", "ServiceProviderConfig", "ResourceType"]
       if resource_type && !allowed_values.include?(resource_type)
         fail ArgumentError, "invalid value for 'resource_type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/scim_phone_number.rb

@@ -17,9 +17,9 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  # SCIM V2 ScimEmail
+  # SCIM V2 phone number
   class ScimPhoneNumber
-    # A phone number in E.164 format.
+    # The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx.
     attr_accessor :value
 
     # The type of phone number.

data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb

@@ -17,19 +17,60 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
+  # SCIM Provider Config for PureCloud.
   class ScimServiceProviderConfig
-    # Documentation
+    # The list of supported schemas.
+    attr_accessor :schemas
+
+    # The HTTP-addressable URL that points to the service provider's documentation.
     attr_accessor :documentation_uri
 
-    # Configuration SCIM meta data
+    # \"patch\" configuration options.
+    attr_accessor :patch
+
+    # \"filter\" configuration options.
+    attr_accessor :filter
+
+    # \"ETag\" configuration options.
+    attr_accessor :etag
+
+    # \"sort\" configuration options.
+    attr_accessor :sort
+
+    # \"bulk\" configuration options.
+    attr_accessor :bulk
+
+    # \"changePassword\" configuration options.
+    attr_accessor :change_password
+
+    # The list of supported authentication schemes.
+    attr_accessor :authentication_schemes
+
+    # Resource SCIM meta
     attr_accessor :meta
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
+        :'schemas' => :'schemas',
+        
         :'documentation_uri' => :'documentationUri',
         
+        :'patch' => :'patch',
+        
+        :'filter' => :'filter',
+        
+        :'etag' => :'etag',
+        
+        :'sort' => :'sort',
+        
+        :'bulk' => :'bulk',
+        
+        :'change_password' => :'changePassword',
+        
+        :'authentication_schemes' => :'authenticationSchemes',
+        
         :'meta' => :'meta'
         
       }
@@ -39,8 +80,24 @@ module PureCloud
     def self.swagger_types
       {
         
+        :'schemas' => :'Array<String>',
+        
         :'documentation_uri' => :'String',
         
+        :'patch' => :'ScimServiceProviderConfigSimpleFeature',
+        
+        :'filter' => :'ScimServiceProviderConfigFilterFeature',
+        
+        :'etag' => :'ScimServiceProviderConfigSimpleFeature',
+        
+        :'sort' => :'ScimServiceProviderConfigSimpleFeature',
+        
+        :'bulk' => :'ScimServiceProviderConfigBulkFeature',
+        
+        :'change_password' => :'ScimServiceProviderConfigSimpleFeature',
+        
+        :'authentication_schemes' => :'Array<ScimServiceProviderConfigAuthenticationScheme>',
+        
         :'meta' => :'ScimMetadata'
         
       }
@@ -55,6 +112,17 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
+      if attributes.has_key?(:'schemas')
+        
+        if (value = attributes[:'schemas']).is_a?(Array)
+          self.schemas = value
+        end
+        
+        
+      
+      end
+
+      
       if attributes.has_key?(:'documentationUri')
         
         
@@ -64,6 +132,71 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'patch')
+        
+        
+        self.patch = attributes[:'patch']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'filter')
+        
+        
+        self.filter = attributes[:'filter']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'etag')
+        
+        
+        self.etag = attributes[:'etag']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'sort')
+        
+        
+        self.sort = attributes[:'sort']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'bulk')
+        
+        
+        self.bulk = attributes[:'bulk']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'changePassword')
+        
+        
+        self.change_password = attributes[:'changePassword']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'authenticationSchemes')
+        
+        if (value = attributes[:'authenticationSchemes']).is_a?(Array)
+          self.authentication_schemes = value
+        end
+        
+        
+      
+      end
+
+      
       if attributes.has_key?(:'meta')
         
         
@@ -96,6 +229,38 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
     end
 
     
@@ -109,12 +274,60 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          schemas == o.schemas &&
           documentation_uri == o.documentation_uri &&
+          patch == o.patch &&
+          filter == o.filter &&
+          etag == o.etag &&
+          sort == o.sort &&
+          bulk == o.bulk &&
+          change_password == o.change_password &&
+          authentication_schemes == o.authentication_schemes &&
           meta == o.meta
     end
 
@@ -127,7 +340,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [documentation_uri, meta].hash
+      [schemas, documentation_uri, patch, filter, etag, sort, bulk, change_password, authentication_schemes, meta].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb

@@ -0,0 +1,362 @@
+=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
+  # Authentication schema.
+  class ScimServiceProviderConfigAuthenticationScheme
+    # The name of the authentication scheme, for example, HTTP Basic.
+    attr_accessor :name
+
+    # The description of the authentication scheme.
+    attr_accessor :description
+
+    # The HTTP-addressable URL that points to the authentication scheme's specification.
+    attr_accessor :spec_uri
+
+    # The HTTP-addressable URL that points to the authentication scheme's usage documentation.
+    attr_accessor :documentation_uri
+
+    # The type of authentication scheme.
+    attr_accessor :type
+
+    # Indicates the primary method of authentication.
+    attr_accessor :primary
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'name' => :'name',
+        
+        :'description' => :'description',
+        
+        :'spec_uri' => :'specUri',
+        
+        :'documentation_uri' => :'documentationUri',
+        
+        :'type' => :'type',
+        
+        :'primary' => :'primary'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'name' => :'String',
+        
+        :'description' => :'String',
+        
+        :'spec_uri' => :'String',
+        
+        :'documentation_uri' => :'String',
+        
+        :'type' => :'String',
+        
+        :'primary' => :'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?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'description')
+        
+        
+        self.description = attributes[:'description']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'specUri')
+        
+        
+        self.spec_uri = attributes[:'specUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'documentationUri')
+        
+        
+        self.documentation_uri = attributes[:'documentationUri']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'type')
+        
+        
+        self.type = attributes[:'type']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'primary')
+        
+        
+        self.primary = attributes[:'primary']
+        
+      
+      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 @name.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @description.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if @type.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["oauth", "oauth2", "oauthbearertoken", "httpbasic", "httpdigest"]
+      if @type && !allowed_values.include?(@type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      allowed_values = ["oauth", "oauth2", "oauthbearertoken", "httpbasic", "httpdigest"]
+      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 &&
+          name == o.name &&
+          description == o.description &&
+          spec_uri == o.spec_uri &&
+          documentation_uri == o.documentation_uri &&
+          type == o.type &&
+          primary == o.primary
+    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, description, spec_uri, documentation_uri, type, primary].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