purecloudplatformclientv2 21.0.0 → 22.0.0

data/docs/WorkforceManagementApi.md

@@ -424,8 +424,9 @@ end
 api_instance = PureCloud::WorkforceManagementApi.new
 
 opts = { 
-  page_size: 25, # Integer | 
-  page_number: 1 # Integer | 
+  page_size: 56, # Integer | 
+  page_number: 1, # Integer | 
+  expand: "expand_example" # String | 
 }
 
 begin
@@ -441,8 +442,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **page_size** | **Integer**|  | [optional] [default to 25] |
+ **page_size** | **Integer**|  | [optional]  |
  **page_number** | **Integer**|  | [optional] [default to 1] |
+ **expand** | **String**|  | [optional] <br />**Values**: details |
 {: class="table table-striped"}
 
 

data/lib/purecloudplatformclientv2.rb

@@ -544,6 +544,7 @@ require 'purecloudplatformclientv2/models/group'
 require 'purecloudplatformclientv2/models/group_contact'
 require 'purecloudplatformclientv2/models/group_entity_listing'
 require 'purecloudplatformclientv2/models/group_members_update'
+require 'purecloudplatformclientv2/models/group_profile'
 require 'purecloudplatformclientv2/models/group_search_criteria'
 require 'purecloudplatformclientv2/models/group_search_request'
 require 'purecloudplatformclientv2/models/group_update'
@@ -664,9 +665,12 @@ require 'purecloudplatformclientv2/models/message_conversation_notification_part
 require 'purecloudplatformclientv2/models/message_conversation_notification_uri_reference'
 require 'purecloudplatformclientv2/models/message_conversation_notification_wrapup'
 require 'purecloudplatformclientv2/models/message_details'
+require 'purecloudplatformclientv2/models/message_media_policy'
+require 'purecloudplatformclientv2/models/message_media_policy_conditions'
 require 'purecloudplatformclientv2/models/meta_data'
 require 'purecloudplatformclientv2/models/metabase'
 require 'purecloudplatformclientv2/models/metered_evaluation_assignment'
+require 'purecloudplatformclientv2/models/named_entity'
 require 'purecloudplatformclientv2/models/note'
 require 'purecloudplatformclientv2/models/note_listing'
 require 'purecloudplatformclientv2/models/number'
@@ -987,6 +991,7 @@ require 'purecloudplatformclientv2/models/user_conversation_summary_notification
 require 'purecloudplatformclientv2/models/user_details_query'
 require 'purecloudplatformclientv2/models/user_device'
 require 'purecloudplatformclientv2/models/user_entity_listing'
+require 'purecloudplatformclientv2/models/user_expands'
 require 'purecloudplatformclientv2/models/user_image'
 require 'purecloudplatformclientv2/models/user_list_schedule_request_body'
 require 'purecloudplatformclientv2/models/user_me'
@@ -994,6 +999,8 @@ require 'purecloudplatformclientv2/models/user_param'
 require 'purecloudplatformclientv2/models/user_presence'
 require 'purecloudplatformclientv2/models/user_presence_notification'
 require 'purecloudplatformclientv2/models/user_presence_notification_organization_presence'
+require 'purecloudplatformclientv2/models/user_profile'
+require 'purecloudplatformclientv2/models/user_profile_entity_listing'
 require 'purecloudplatformclientv2/models/user_queue'
 require 'purecloudplatformclientv2/models/user_queue_entity_listing'
 require 'purecloudplatformclientv2/models/user_recording'

data/lib/purecloudplatformclientv2/api/groups_api.rb

@@ -405,6 +405,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get group profile
+    # 
+    # @param group_id groupId
+    # @param [Hash] opts the optional parameters
+    # @return [GroupProfile]
+    def get_group_profile(group_id, opts = {})
+      data, _status_code, _headers = get_group_profile_with_http_info(group_id, opts)
+      return data
+    end
+
+    # Get group profile
+    # 
+    # @param group_id groupId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GroupProfile, Fixnum, Hash)>] GroupProfile data, response status code and response headers
+    def get_group_profile_with_http_info(group_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: GroupsApi.get_group_profile ..."
+      end
+      
+      
+      # verify the required parameter 'group_id' is set
+      fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group_profile" if group_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/groups/{groupId}/profile".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_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,
+        :return_type => 'GroupProfile')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GroupsApi#get_group_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a group list
     # 
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -426,6 +426,132 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a user profile listing
+    # 
+    # @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 [Array<String>] :id id
+    # @option opts [Array<String>] :jid jid
+    # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :state Only list users of this state (default to active)
+    # @return [UserProfileEntityListing]
+    def get_profiles_users(opts = {})
+      data, _status_code, _headers = get_profiles_users_with_http_info(opts)
+      return data
+    end
+
+    # Get a user profile listing
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [Array<String>] :id id
+    # @option opts [Array<String>] :jid jid
+    # @option opts [String] :sort_order Ascending or descending sort order
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :state Only list users of this state
+    # @return [Array<(UserProfileEntityListing, Fixnum, Hash)>] UserProfileEntityListing data, response status code and response headers
+    def get_profiles_users_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_profiles_users ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
+        fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
+        fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
+      end
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/profiles/users".sub('{format}','json')
+
+      # 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[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
+      query_params[:'jid'] = @api_client.build_collection_param(opts[:'jid'], :multi) if opts[:'jid']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
+      query_params[:'state'] = opts[:'state'] if opts[:'state']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_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,
+        :return_type => 'UserProfileEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_profiles_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get user.
     # 
     # @param user_id User ID
@@ -967,6 +1093,80 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get user profile
+    # 
+    # @param user_id userId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [UserProfile]
+    def get_user_profile(user_id, opts = {})
+      data, _status_code, _headers = get_user_profile_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get user profile
+    # 
+    # @param user_id userId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @return [Array<(UserProfile, Fixnum, Hash)>] UserProfile data, response status code and response headers
+    def get_user_profile_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_user_profile ..."
+      end
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_profile" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/profile".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)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_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,
+        :return_type => 'UserProfile')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List profile skills for a user
     # 
     # @param user_id User ID

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -468,8 +468,9 @@ module PureCloud
     # Get management units
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size  (default to 25)
+    # @option opts [Integer] :page_size 
     # @option opts [Integer] :page_number  (default to 1)
+    # @option opts [String] :expand 
     # @return [ManagementUnitListing]
     def get_workforcemanagement_managementunits(opts = {})
       data, _status_code, _headers = get_workforcemanagement_managementunits_with_http_info(opts)
@@ -481,6 +482,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size 
     # @option opts [Integer] :page_number 
+    # @option opts [String] :expand 
     # @return [Array<(ManagementUnitListing, Fixnum, Hash)>] ManagementUnitListing data, response status code and response headers
     def get_workforcemanagement_managementunits_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -499,6 +501,16 @@ module PureCloud
       
       
       
+      
+      
+      
+      if opts[:'expand'] && !['details'].include?(opts[:'expand'])
+        fail ArgumentError, 'invalid value for "expand", must be one of details'
+      end
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/workforcemanagement/managementunits".sub('{format}','json')
 
@@ -506,6 +518,7 @@ module PureCloud
       query_params = {}
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '21.0.0'
+      header_params['purecloud-sdk'] = '22.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/entity.rb

@@ -21,15 +21,11 @@ module PureCloud
     # The globally unique identifier for the object.
     attr_accessor :id
 
-    attr_accessor :name
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'id' => :'id',
-        
-        :'name' => :'name'
+        :'id' => :'id'
         
       }
     end
@@ -38,9 +34,7 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'id' => :'String',
-        
-        :'name' => :'String'
+        :'id' => :'String'
         
       }
     end
@@ -63,15 +57,6 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'name')
-        
-        
-        self.name = attributes[:'name']
-        
-      
-      end
-
-      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,10 +76,6 @@ module PureCloud
       
       
       
-      
-      
-      
-      
     end
 
     
@@ -103,18 +84,12 @@ 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 &&
-          id == o.id &&
-          name == o.name
+          id == o.id
     end
 
     # @see the `==` method
@@ -126,7 +101,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name].hash
+      [id].hash
     end
 
     # build the object from hash