purecloud 0.28.0 → 0.29.1

data/lib/purecloud/api/outbound_api.rb

@@ -1650,64 +1650,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Array<PenetrationRateId>] :body PenetrationRateIdentifierList
-    # @return [Array<PenetrationRate>]
-    def post_contactlists_penetrationrates(opts = {})
-      data, status_code, headers = post_contactlists_penetrationrates_with_http_info(opts)
-      return data
-    end
-
-    # Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Array<PenetrationRateId>] :body PenetrationRateIdentifierList
-    # @return [Array<(Array<PenetrationRate>, Fixnum, Hash)>] Array<PenetrationRate> data, response status code and response headers
-    def post_contactlists_penetrationrates_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi#post_contactlists_penetrationrates ..."
-      end
-      
-      # resource path
-      path = "/api/v2/outbound/contactlists/penetrationrates".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # 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 = @api_client.object_to_http_body(opts[:'body'])
-      
-
-      auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:POST, path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Array<PenetrationRate>')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OutboundApi#post_contactlists_penetrationrates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Get dialer contactList.
     # 
     # @param contact_list_id ContactList ID
@@ -1903,9 +1845,9 @@ module PureCloud
     # 
     # @param contact_list_id Contact List ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<Contact>] :body Contact
+    # @option opts [Array<DialerContact>] :body Contact
     # @option opts [BOOLEAN] :priority 
-    # @return [Contact]
+    # @return [DialerContact]
     def post_contactlists_contactlist_id_contacts(contact_list_id, opts = {})
       data, status_code, headers = post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, opts)
       return data
@@ -1915,9 +1857,9 @@ module PureCloud
     # 
     # @param contact_list_id Contact List ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<Contact>] :body Contact
+    # @option opts [Array<DialerContact>] :body Contact
     # @option opts [BOOLEAN] :priority 
-    # @return [Array<(Contact, Fixnum, Hash)>] Contact data, response status code and response headers
+    # @return [Array<(DialerContact, Fixnum, Hash)>] DialerContact data, response status code and response headers
     def post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: OutboundApi#post_contactlists_contactlist_id_contacts ..."
@@ -1958,7 +1900,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Contact')
+        :return_type => 'DialerContact')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#post_contactlists_contactlist_id_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -1970,7 +1912,7 @@ module PureCloud
     # @param contact_list_id Contact List ID
     # @param contact_id Contact ID
     # @param [Hash] opts the optional parameters
-    # @return [Contact]
+    # @return [DialerContact]
     def get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts = {})
       data, status_code, headers = get_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts)
       return data
@@ -1981,7 +1923,7 @@ module PureCloud
     # @param contact_list_id Contact List ID
     # @param contact_id Contact ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Contact, Fixnum, Hash)>] Contact data, response status code and response headers
+    # @return [Array<(DialerContact, Fixnum, Hash)>] DialerContact data, response status code and response headers
     def get_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id_contacts_contact_id ..."
@@ -2024,7 +1966,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Contact')
+        :return_type => 'DialerContact')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -2036,8 +1978,8 @@ module PureCloud
     # @param contact_list_id Contact List ID
     # @param contact_id Contact ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Contact] :body Contact
-    # @return [Contact]
+    # @option opts [DialerContact] :body Contact
+    # @return [DialerContact]
     def put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts = {})
       data, status_code, headers = put_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts)
       return data
@@ -2048,8 +1990,8 @@ module PureCloud
     # @param contact_list_id Contact List ID
     # @param contact_id Contact ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Contact] :body Contact
-    # @return [Array<(Contact, Fixnum, Hash)>] Contact data, response status code and response headers
+    # @option opts [DialerContact] :body Contact
+    # @return [Array<(DialerContact, Fixnum, Hash)>] DialerContact data, response status code and response headers
     def put_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: OutboundApi#put_contactlists_contactlist_id_contacts_contact_id ..."
@@ -2092,7 +2034,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Contact')
+        :return_type => 'DialerContact')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#put_contactlists_contactlist_id_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -2287,72 +2229,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get Dialer campaign&#39;s penetration rate
-    # Get dialer campaign&#39;s penetration rate.
-    # @param contact_list_id ContactList ID
-    # @param campaign_id Campaign ID
-    # @param [Hash] opts the optional parameters
-    # @return [PenetrationRate]
-    def get_contactlists_contactlist_id_campaign_id_penetrationrate(contact_list_id, campaign_id, opts = {})
-      data, status_code, headers = get_contactlists_contactlist_id_campaign_id_penetrationrate_with_http_info(contact_list_id, campaign_id, opts)
-      return data
-    end
-
-    # Get Dialer campaign&#39;s penetration rate
-    # Get dialer campaign&#39;s penetration rate.
-    # @param contact_list_id ContactList ID
-    # @param campaign_id Campaign ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(PenetrationRate, Fixnum, Hash)>] PenetrationRate data, response status code and response headers
-    def get_contactlists_contactlist_id_campaign_id_penetrationrate_with_http_info(contact_list_id, campaign_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id_campaign_id_penetrationrate ..."
-      end
-      
-      # verify the required parameter 'contact_list_id' is set
-      fail "Missing the required parameter 'contact_list_id' when calling get_contactlists_contactlist_id_campaign_id_penetrationrate" if contact_list_id.nil?
-      
-      # verify the required parameter 'campaign_id' is set
-      fail "Missing the required parameter 'campaign_id' when calling get_contactlists_contactlist_id_campaign_id_penetrationrate" if campaign_id.nil?
-      
-      # resource path
-      path = "/api/v2/outbound/contactlists/{contactListId}/{campaignId}/penetrationrate".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'campaignId' + '}', campaign_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # 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, path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'PenetrationRate')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id_campaign_id_penetrationrate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Add phone numbers to a Dialer DNC list.
     # 
     # @param conversation_id Conversation ID
@@ -2934,249 +2810,6 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get dialer preview for user
-    # 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<Preview>]
-    def get_previews(opts = {})
-      data, status_code, headers = get_previews_with_http_info(opts)
-      return data
-    end
-
-    # Get dialer preview for user
-    # 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<Preview>, Fixnum, Hash)>] Array<Preview> data, response status code and response headers
-    def get_previews_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi#get_previews ..."
-      end
-      
-      # resource path
-      path = "/api/v2/outbound/previews".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # 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, path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Array<Preview>')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OutboundApi#get_previews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get dialer preview
-    # 
-    # @param preview_id preview ID
-    # @param [Hash] opts the optional parameters
-    # @return [Preview]
-    def get_previews_preview_id(preview_id, opts = {})
-      data, status_code, headers = get_previews_preview_id_with_http_info(preview_id, opts)
-      return data
-    end
-
-    # Get dialer preview
-    # 
-    # @param preview_id preview ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Preview, Fixnum, Hash)>] Preview data, response status code and response headers
-    def get_previews_preview_id_with_http_info(preview_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi#get_previews_preview_id ..."
-      end
-      
-      # verify the required parameter 'preview_id' is set
-      fail "Missing the required parameter 'preview_id' when calling get_previews_preview_id" if preview_id.nil?
-      
-      # resource path
-      path = "/api/v2/outbound/previews/{previewId}".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # 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, path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Preview')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OutboundApi#get_previews_preview_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Disposition preview call
-    # 
-    # @param preview_id preview ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [DialerDispositionCallCommand] :body 
-    # @return [String]
-    def post_previews_preview_id_dispositioncall(preview_id, opts = {})
-      data, status_code, headers = post_previews_preview_id_dispositioncall_with_http_info(preview_id, opts)
-      return data
-    end
-
-    # Disposition preview call
-    # 
-    # @param preview_id preview ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [DialerDispositionCallCommand] :body 
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
-    def post_previews_preview_id_dispositioncall_with_http_info(preview_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi#post_previews_preview_id_dispositioncall ..."
-      end
-      
-      # verify the required parameter 'preview_id' is set
-      fail "Missing the required parameter 'preview_id' when calling post_previews_preview_id_dispositioncall" if preview_id.nil?
-      
-      # resource path
-      path = "/api/v2/outbound/previews/{previewId}/dispositioncall".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # 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 = @api_client.object_to_http_body(opts[:'body'])
-      
-
-      auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:POST, path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'String')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OutboundApi#post_previews_preview_id_dispositioncall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # place preview call
-    # 
-    # @param preview_id preview ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [DialerPlaceCallCommand] :body 
-    # @return [DialerCall]
-    def post_previews_preview_id_placecall(preview_id, opts = {})
-      data, status_code, headers = post_previews_preview_id_placecall_with_http_info(preview_id, opts)
-      return data
-    end
-
-    # place preview call
-    # 
-    # @param preview_id preview ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [DialerPlaceCallCommand] :body 
-    # @return [Array<(DialerCall, Fixnum, Hash)>] DialerCall data, response status code and response headers
-    def post_previews_preview_id_placecall_with_http_info(preview_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OutboundApi#post_previews_preview_id_placecall ..."
-      end
-      
-      # verify the required parameter 'preview_id' is set
-      fail "Missing the required parameter 'preview_id' when calling post_previews_preview_id_placecall" if preview_id.nil?
-      
-      # resource path
-      path = "/api/v2/outbound/previews/{previewId}/placecall".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # 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 = @api_client.object_to_http_body(opts[:'body'])
-      
-
-      auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:POST, path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'DialerCall')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OutboundApi#post_previews_preview_id_placecall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Query a list of Rule Sets.
     # 
     # @param [Hash] opts the optional parameters