purecloud 0.53.1 → 0.54.1

data/lib/purecloud/api/users_api.rb

@@ -511,6 +511,68 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get adjacents
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [nil]
+    def get_user_id_adjacents(user_id, opts = {})
+      get_user_id_adjacents_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # Get adjacents
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_user_id_adjacents_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_adjacents ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_id_adjacents" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/adjacents".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_id_adjacents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a user's CallForwarding
     # 
     # @param user_id User ID
@@ -571,6 +633,139 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get direct reports
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [nil]
+    def get_user_id_directreports(user_id, opts = {})
+      get_user_id_directreports_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # Get direct reports
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_user_id_directreports_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_directreports ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_id_directreports" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/directreports".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_id_directreports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get favorites
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [String] :sort_order Sort order (default to ASC)
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [nil]
+    def get_user_id_favorites(user_id, opts = {})
+      get_user_id_favorites_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # Get favorites
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [String] :sort_order Sort order
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_user_id_favorites_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_favorites ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_id_favorites" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/favorites".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_id_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a user's Geolocation
     # 
     # @param user_id user Id
@@ -1078,6 +1273,68 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get superiors
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [nil]
+    def get_user_id_superiors(user_id, opts = {})
+      get_user_id_superiors_with_http_info(user_id, opts)
+      return nil
+    end
+
+    # Get superiors
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_user_id_superiors_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_id_superiors ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_id_superiors" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/superiors".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_id_superiors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the list of available users.
     # 
     # @param [Hash] opts the optional parameters

data/lib/purecloud/api_client.rb

@@ -33,7 +33,7 @@ module PureCloud
 
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "PureCloud SDK/Ruby 0.53.1"
+      @user_agent = "PureCloud SDK/Ruby 0.54.1"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/purecloud/models/adfs.rb

@@ -27,10 +27,10 @@ module PureCloud
 
     attr_accessor :certificate
 
-    attr_accessor :issuer_uri
-
     attr_accessor :sso_target_uri
 
+    attr_accessor :issuer_uri
+
     attr_accessor :disabled
 
     # The URI for this object
@@ -48,10 +48,10 @@ module PureCloud
         
         :'certificate' => :'certificate',
         
-        :'issuer_uri' => :'issuerURI',
-        
         :'sso_target_uri' => :'ssoTargetURI',
         
+        :'issuer_uri' => :'issuerURI',
+        
         :'disabled' => :'disabled',
         
         :'self_uri' => :'selfUri'
@@ -66,8 +66,8 @@ module PureCloud
         :'name' => :'String',
         :'relying_party_identifier' => :'String',
         :'certificate' => :'String',
-        :'issuer_uri' => :'String',
         :'sso_target_uri' => :'String',
+        :'issuer_uri' => :'String',
         :'disabled' => :'BOOLEAN',
         :'self_uri' => :'String'
         
@@ -97,14 +97,14 @@ module PureCloud
         self.certificate = attributes[:'certificate']
       end
       
-      if attributes[:'issuerURI']
-        self.issuer_uri = attributes[:'issuerURI']
-      end
-      
       if attributes[:'ssoTargetURI']
         self.sso_target_uri = attributes[:'ssoTargetURI']
       end
       
+      if attributes[:'issuerURI']
+        self.issuer_uri = attributes[:'issuerURI']
+      end
+      
       if attributes[:'disabled']
         self.disabled = attributes[:'disabled']
       else
@@ -125,8 +125,8 @@ module PureCloud
           name == o.name &&
           relying_party_identifier == o.relying_party_identifier &&
           certificate == o.certificate &&
-          issuer_uri == o.issuer_uri &&
           sso_target_uri == o.sso_target_uri &&
+          issuer_uri == o.issuer_uri &&
           disabled == o.disabled &&
           self_uri == o.self_uri
     end
@@ -138,7 +138,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, relying_party_identifier, certificate, issuer_uri, sso_target_uri, disabled, self_uri].hash
+      [id, name, relying_party_identifier, certificate, sso_target_uri, issuer_uri, disabled, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/adjacents.rb

@@ -0,0 +1,191 @@
+=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@inin.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 Adjacents
+    attr_accessor :superiors
+
+    attr_accessor :siblings
+
+    attr_accessor :direct_reports
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'superiors' => :'superiors',
+        
+        :'siblings' => :'siblings',
+        
+        :'direct_reports' => :'directReports'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'superiors' => :'Array<User>',
+        :'siblings' => :'Array<User>',
+        :'direct_reports' => :'Array<User>'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'superiors']
+        if (value = attributes[:'superiors']).is_a?(Array)
+          self.superiors = value
+        end
+      end
+      
+      if attributes[:'siblings']
+        if (value = attributes[:'siblings']).is_a?(Array)
+          self.siblings = value
+        end
+      end
+      
+      if attributes[:'directReports']
+        if (value = attributes[:'directReports']).is_a?(Array)
+          self.direct_reports = value
+        end
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          superiors == o.superiors &&
+          siblings == o.siblings &&
+          direct_reports == o.direct_reports
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [superiors, siblings, direct_reports].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