purecloud 0.44.1 → 0.45.1

data/lib/purecloud/api/fax_api.rb

@@ -322,21 +322,21 @@ module PureCloud
     # Update a fax document.
     # 
     # @param document_id Document ID
+    # @param body Document
     # @param [Hash] opts the optional parameters
-    # @option opts [FaxDocument] :body Document
     # @return [FaxDocument]
-    def put_documents_document_id(document_id, opts = {})
-      data, status_code, headers = put_documents_document_id_with_http_info(document_id, opts)
+    def put_documents_document_id(document_id, body, opts = {})
+      data, status_code, headers = put_documents_document_id_with_http_info(document_id, body, opts)
       return data
     end
 
     # Update a fax document.
     # 
     # @param document_id Document ID
+    # @param body Document
     # @param [Hash] opts the optional parameters
-    # @option opts [FaxDocument] :body Document
     # @return [Array<(FaxDocument, Fixnum, Hash)>] FaxDocument data, response status code and response headers
-    def put_documents_document_id_with_http_info(document_id, opts = {})
+    def put_documents_document_id_with_http_info(document_id, body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: FaxApi#put_documents_document_id ..."
       end
@@ -344,6 +344,9 @@ module PureCloud
       # verify the required parameter 'document_id' is set
       fail "Missing the required parameter 'document_id' when calling put_documents_document_id" if document_id.nil?
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_documents_document_id" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
 
@@ -365,7 +368,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,

data/lib/purecloud/api/geolocation_api.rb

@@ -146,24 +146,27 @@ module PureCloud
 
     # Patch a organization's GeolocationSettings
     # 
+    # @param body Geolocation settings
     # @param [Hash] opts the optional parameters
-    # @option opts [GeolocationSettings] :body 
     # @return [GeolocationSettings]
-    def patch_settings(opts = {})
-      data, status_code, headers = patch_settings_with_http_info(opts)
+    def patch_settings(body, opts = {})
+      data, status_code, headers = patch_settings_with_http_info(body, opts)
       return data
     end
 
     # Patch a organization's GeolocationSettings
     # 
+    # @param body Geolocation settings
     # @param [Hash] opts the optional parameters
-    # @option opts [GeolocationSettings] :body 
     # @return [Array<(GeolocationSettings, Fixnum, Hash)>] GeolocationSettings data, response status code and response headers
-    def patch_settings_with_http_info(opts = {})
+    def patch_settings_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GeolocationApi#patch_settings ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling patch_settings" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/geolocations/settings".sub('{format}','json')
 
@@ -185,7 +188,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
@@ -205,11 +208,11 @@ module PureCloud
     # The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source.  Option 2: Provide the 'latitude' and 'longitude' values.  This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'.  Option 3:  Provide the 'city', 'region', 'country' values.  Option 1 can be combined with Option 2 or Option 3.  For example, update the client as primary and provide latitude and longitude values.
     # @param user_id user Id
     # @param client_id client Id
+    # @param body Geolocation
     # @param [Hash] opts the optional parameters
-    # @option opts [Geolocation] :body 
     # @return [Geolocation]
-    def patch_user_id_geolocations_client_id(user_id, client_id, opts = {})
-      data, status_code, headers = patch_user_id_geolocations_client_id_with_http_info(user_id, client_id, opts)
+    def patch_user_id_geolocations_client_id(user_id, client_id, body, opts = {})
+      data, status_code, headers = patch_user_id_geolocations_client_id_with_http_info(user_id, client_id, body, opts)
       return data
     end
 
@@ -217,10 +220,10 @@ module PureCloud
     # The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source.  Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values.  This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;.  Option 3:  Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values.  Option 1 can be combined with Option 2 or Option 3.  For example, update the client as primary and provide latitude and longitude values.
     # @param user_id user Id
     # @param client_id client Id
+    # @param body Geolocation
     # @param [Hash] opts the optional parameters
-    # @option opts [Geolocation] :body 
     # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
-    def patch_user_id_geolocations_client_id_with_http_info(user_id, client_id, opts = {})
+    def patch_user_id_geolocations_client_id_with_http_info(user_id, client_id, body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GeolocationApi#patch_user_id_geolocations_client_id ..."
       end
@@ -231,6 +234,9 @@ module PureCloud
       # verify the required parameter 'client_id' is set
       fail "Missing the required parameter 'client_id' when calling patch_user_id_geolocations_client_id" if client_id.nil?
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling patch_user_id_geolocations_client_id" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
 
@@ -252,7 +258,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,

data/lib/purecloud/api/groups_api.rb

@@ -292,32 +292,35 @@ module PureCloud
 
     # Search using q64
     # 
+    # @param q64 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :q64 
     # @option opts [Array<String>] :expand 
     # @return [GroupsSearchResponse]
-    def get_search(opts = {})
-      data, status_code, headers = get_search_with_http_info(opts)
+    def get_search(q64, opts = {})
+      data, status_code, headers = get_search_with_http_info(q64, opts)
       return data
     end
 
     # Search using q64
     # 
+    # @param q64 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :q64 
     # @option opts [Array<String>] :expand 
     # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
-    def get_search_with_http_info(opts = {})
+    def get_search_with_http_info(q64, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi#get_search ..."
       end
       
+      # verify the required parameter 'q64' is set
+      fail "Missing the required parameter 'q64' when calling get_search" if q64.nil?
+      
       # resource path
       local_var_path = "/api/v2/groups/search".sub('{format}','json')
 
       # query parameters
       query_params = {}
-      query_params[:'q64'] = opts[:'q64'] if opts[:'q64']
+      query_params[:'q64'] = q64
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
@@ -354,21 +357,21 @@ module PureCloud
     # Add members
     # 
     # @param group_id Group ID
+    # @param body Add members
     # @param [Hash] opts the optional parameters
-    # @option opts [GroupMembersUpdate] :body Add members
     # @return [nil]
-    def post_group_id_members(group_id, opts = {})
-      post_group_id_members_with_http_info(group_id, opts)
+    def post_group_id_members(group_id, body, opts = {})
+      post_group_id_members_with_http_info(group_id, body, opts)
       return nil
     end
 
     # Add members
     # 
     # @param group_id Group ID
+    # @param body Add members
     # @param [Hash] opts the optional parameters
-    # @option opts [GroupMembersUpdate] :body Add members
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def post_group_id_members_with_http_info(group_id, opts = {})
+    def post_group_id_members_with_http_info(group_id, body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi#post_group_id_members ..."
       end
@@ -376,6 +379,9 @@ module PureCloud
       # verify the required parameter 'group_id' is set
       fail "Missing the required parameter 'group_id' when calling post_group_id_members" if group_id.nil?
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling post_group_id_members" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
 
@@ -397,7 +403,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      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,
@@ -414,24 +420,27 @@ module PureCloud
 
     # Create a group
     # 
+    # @param body Group
     # @param [Hash] opts the optional parameters
-    # @option opts [Group] :body 
     # @return [Group]
-    def post_groups(opts = {})
-      data, status_code, headers = post_groups_with_http_info(opts)
+    def post_groups(body, opts = {})
+      data, status_code, headers = post_groups_with_http_info(body, opts)
       return data
     end
 
     # Create a group
     # 
+    # @param body Group
     # @param [Hash] opts the optional parameters
-    # @option opts [Group] :body 
     # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
-    def post_groups_with_http_info(opts = {})
+    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 "Missing the required parameter 'body' when calling post_groups" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/groups".sub('{format}','json')
 
@@ -453,7 +462,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      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,
@@ -471,24 +480,27 @@ module PureCloud
 
     # Search
     # 
+    # @param body Search request options
     # @param [Hash] opts the optional parameters
-    # @option opts [GroupSearchRequest] :body Search request options
     # @return [GroupsSearchResponse]
-    def post_search(opts = {})
-      data, status_code, headers = post_search_with_http_info(opts)
+    def post_search(body, opts = {})
+      data, status_code, headers = post_search_with_http_info(body, opts)
       return data
     end
 
     # Search
     # 
+    # @param body Search request options
     # @param [Hash] opts the optional parameters
-    # @option opts [GroupSearchRequest] :body Search request options
     # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
-    def post_search_with_http_info(opts = {})
+    def post_search_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GroupsApi#post_search ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling post_search" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/groups/search".sub('{format}','json')
 
@@ -510,7 +522,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      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,

data/lib/purecloud/api/identity_provider_api.rb

@@ -844,24 +844,27 @@ module PureCloud
 
     # Update/Create ADFS Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [ADFS] :body Provider
     # @return [nil]
-    def put_adfs(opts = {})
-      put_adfs_with_http_info(opts)
+    def put_adfs(body, opts = {})
+      put_adfs_with_http_info(body, opts)
       return nil
     end
 
     # Update/Create ADFS Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [ADFS] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_adfs_with_http_info(opts = {})
+    def put_adfs_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_adfs ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_adfs" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
 
@@ -883,7 +886,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
@@ -900,24 +903,27 @@ module PureCloud
 
     # Update/Create Customer Interaction Center (CIC) Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [CustomerInteractionCenter] :body Provider
     # @return [nil]
-    def put_cic(opts = {})
-      put_cic_with_http_info(opts)
+    def put_cic(body, opts = {})
+      put_cic_with_http_info(body, opts)
       return nil
     end
 
     # Update/Create Customer Interaction Center (CIC) Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [CustomerInteractionCenter] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_cic_with_http_info(opts = {})
+    def put_cic_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_cic ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_cic" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json')
 
@@ -939,7 +945,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
@@ -956,24 +962,27 @@ module PureCloud
 
     # Update/Create Okta Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [Okta] :body Provider
     # @return [nil]
-    def put_okta(opts = {})
-      put_okta_with_http_info(opts)
+    def put_okta(body, opts = {})
+      put_okta_with_http_info(body, opts)
       return nil
     end
 
     # Update/Create Okta Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [Okta] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_okta_with_http_info(opts = {})
+    def put_okta_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_okta ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_okta" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/okta".sub('{format}','json')
 
@@ -995,7 +1004,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
@@ -1012,24 +1021,27 @@ module PureCloud
 
     # Update/Create OneLogin Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [OneLogin] :body Provider
     # @return [nil]
-    def put_onelogin(opts = {})
-      put_onelogin_with_http_info(opts)
+    def put_onelogin(body, opts = {})
+      put_onelogin_with_http_info(body, opts)
       return nil
     end
 
     # Update/Create OneLogin Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [OneLogin] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_onelogin_with_http_info(opts = {})
+    def put_onelogin_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_onelogin ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_onelogin" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/onelogin".sub('{format}','json')
 
@@ -1051,7 +1063,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
@@ -1068,24 +1080,27 @@ module PureCloud
 
     # Update an identity provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [OAuthProvider] :body Provider
     # @return [nil]
-    def put_provider_id(opts = {})
-      put_provider_id_with_http_info(opts)
+    def put_provider_id(body, opts = {})
+      put_provider_id_with_http_info(body, opts)
       return nil
     end
 
     # Update an identity provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [OAuthProvider] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_provider_id_with_http_info(opts = {})
+    def put_provider_id_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_provider_id ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_provider_id" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/{providerId}".sub('{format}','json')
 
@@ -1107,7 +1122,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
@@ -1124,24 +1139,27 @@ module PureCloud
 
     # Update/Create PureCloud Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [PureCloud] :body Provider
     # @return [nil]
-    def put_purecloud(opts = {})
-      put_purecloud_with_http_info(opts)
+    def put_purecloud(body, opts = {})
+      put_purecloud_with_http_info(body, opts)
       return nil
     end
 
     # Update/Create PureCloud Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [PureCloud] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_purecloud_with_http_info(opts = {})
+    def put_purecloud_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_purecloud ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_purecloud" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/purecloud".sub('{format}','json')
 
@@ -1163,7 +1181,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
@@ -1180,24 +1198,27 @@ module PureCloud
 
     # Update/Create Salesforce Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [Salesforce] :body Provider
     # @return [nil]
-    def put_salesforce(opts = {})
-      put_salesforce_with_http_info(opts)
+    def put_salesforce(body, opts = {})
+      put_salesforce_with_http_info(body, opts)
       return nil
     end
 
     # Update/Create Salesforce Identity Provider
     # 
+    # @param body Provider
     # @param [Hash] opts the optional parameters
-    # @option opts [Salesforce] :body Provider
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def put_salesforce_with_http_info(opts = {})
+    def put_salesforce_with_http_info(body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: IdentityProviderApi#put_salesforce ..."
       end
       
+      # verify the required parameter 'body' is set
+      fail "Missing the required parameter 'body' when calling put_salesforce" if body.nil?
+      
       # resource path
       local_var_path = "/api/v2/identityproviders/salesforce".sub('{format}','json')
 
@@ -1219,7 +1240,7 @@ module PureCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = @api_client.object_to_http_body(body)
       
       auth_names = ['PureCloud Auth']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,