groups_api.rb in purecloudplatformclientv2-9.0.0

- old
+ new

@@ -41,12 +41,19 @@
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_group_with_http_info(group_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.delete_group ..."
       end
+      
+      
       # verify the required parameter 'group_id' is set
       fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_group" if group_id.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
       # query parameters
       query_params = {}
@@ -65,11 +72,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
@@ -99,14 +107,27 @@
     # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
     def delete_group_members_with_http_info(group_id, ids, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.delete_group_members ..."
       end
+      
+      
       # verify the required parameter 'group_id' is set
       fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_group_members" if group_id.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'ids' is set
       fail ArgumentError, "Missing the required parameter 'ids' when calling GroupsApi.delete_group_members" if ids.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
       # query parameters
       query_params = {}
@@ -126,11 +147,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
@@ -159,16 +181,24 @@
     # @return [Array<(FieldConfig, Fixnum, Hash)>] FieldConfig data, response status code and response headers
     def get_fieldconfig_with_http_info(type, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.get_fieldconfig ..."
       end
+      
+      
       # verify the required parameter 'type' is set
       fail ArgumentError, "Missing the required parameter 'type' when calling GroupsApi.get_fieldconfig" if type.nil?
+      
       # verify enum value
       unless ['person', 'group', 'org', 'externalContact'].include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of person, group, org, externalContact"
       end
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/fieldconfig".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -188,11 +218,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      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,
@@ -221,12 +252,19 @@
     # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
     def get_group_with_http_info(group_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.get_group ..."
       end
+      
+      
       # verify the required parameter 'group_id' is set
       fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group" if group_id.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
       # query parameters
       query_params = {}
@@ -245,11 +283,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      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,
@@ -286,15 +325,47 @@
     # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
     def get_group_members_with_http_info(group_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.get_group_members ..."
       end
+      
+      
       # verify the required parameter 'group_id' is set
       fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group_members" if group_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
         fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
       end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
       # query parameters
       query_params = {}
@@ -317,11 +388,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      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,
@@ -354,13 +426,33 @@
     # @return [Array<(GroupEntityListing, Fixnum, Hash)>] GroupEntityListing data, response status code and response headers
     def get_groups_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.get_groups ..."
       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
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -382,11 +474,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      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,
@@ -417,12 +510,25 @@
     # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
     def get_groups_search_with_http_info(q64, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.get_groups_search ..."
       end
+      
+      
       # verify the required parameter 'q64' is set
       fail ArgumentError, "Missing the required parameter 'q64' when calling GroupsApi.get_groups_search" if q64.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/search".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -443,11 +549,12 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-            auth_names = ['PureCloud Auth']
+      
+      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,
@@ -478,14 +585,27 @@
     # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
     def post_group_members_with_http_info(group_id, body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.post_group_members ..."
       end
+      
+      
       # verify the required parameter 'group_id' is set
       fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.post_group_members" if group_id.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'body' is set
       fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.post_group_members" if body.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
       # query parameters
       query_params = {}
@@ -504,10 +624,11 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
+      
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -537,12 +658,19 @@
     # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
     def post_groups_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.post_groups ..."
       end
+      
+      
       # verify the required parameter 'body' is set
       fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.post_groups" if body.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -561,10 +689,11 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
+      
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -594,12 +723,19 @@
     # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
     def post_groups_search_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.post_groups_search ..."
       end
+      
+      
       # verify the required parameter 'body' is set
       fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.post_groups_search" if body.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/search".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -618,10 +754,11 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
+      
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -653,12 +790,25 @@
     # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
     def put_group_with_http_info(group_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi.put_group ..."
       end
+      
+      
       # verify the required parameter 'group_id' is set
       fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.put_group" if group_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
       # query parameters
       query_params = {}
@@ -677,9 +827,10 @@
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(opts[:'body'])
+      
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,