class PureCloud::OutboundApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_outbound_attemptlimit(attempt_limits_id, opts = {}) click to toggle source

Delete attempt limits

@param attempt_limits_id Attempt limits ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 32
def delete_outbound_attemptlimit(attempt_limits_id, opts = {})
  delete_outbound_attemptlimit_with_http_info(attempt_limits_id, opts)
  return nil
end
delete_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {}) click to toggle source

Delete attempt limits

@param attempt_limits_id Attempt limits ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 42
def delete_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_attemptlimit ..."
  end
  
  
  # verify the required parameter 'attempt_limits_id' is set
  fail ArgumentError, "Missing the required parameter 'attempt_limits_id' when calling OutboundApi.delete_outbound_attemptlimit" if attempt_limits_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_attemptlimit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_callabletimeset(callable_time_set_id, opts = {}) click to toggle source

Delete callable time set

@param callable_time_set_id Callable Time Set ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 96
def delete_outbound_callabletimeset(callable_time_set_id, opts = {})
  delete_outbound_callabletimeset_with_http_info(callable_time_set_id, opts)
  return nil
end
delete_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {}) click to toggle source

Delete callable time set

@param callable_time_set_id Callable Time Set ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 106
def delete_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_callabletimeset ..."
  end
  
  
  # verify the required parameter 'callable_time_set_id' is set
  fail ArgumentError, "Missing the required parameter 'callable_time_set_id' when calling OutboundApi.delete_outbound_callabletimeset" if callable_time_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_callanalysisresponseset(call_analysis_set_id, opts = {}) click to toggle source

Delete a dialer call analysis response set.

@param call_analysis_set_id Call Analysis Response Set ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 160
def delete_outbound_callanalysisresponseset(call_analysis_set_id, opts = {})
  delete_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
  return nil
end
delete_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {}) click to toggle source

Delete a dialer call analysis response set.

@param call_analysis_set_id Call Analysis Response Set ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 170
def delete_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_callanalysisresponseset ..."
  end
  
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail ArgumentError, "Missing the required parameter 'call_analysis_set_id' when calling OutboundApi.delete_outbound_callanalysisresponseset" if call_analysis_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_campaign(campaign_id, opts = {}) click to toggle source

Delete a campaign.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Campaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 224
def delete_outbound_campaign(campaign_id, opts = {})
  data, _status_code, _headers = delete_outbound_campaign_with_http_info(campaign_id, opts)
  return data
end
delete_outbound_campaign_progress(campaign_id, opts = {}) click to toggle source

Reset campaign progress and recycle the campaign

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 289
def delete_outbound_campaign_progress(campaign_id, opts = {})
  delete_outbound_campaign_progress_with_http_info(campaign_id, opts)
  return nil
end
delete_outbound_campaign_progress_with_http_info(campaign_id, opts = {}) click to toggle source

Reset campaign progress and recycle the campaign

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 299
def delete_outbound_campaign_progress_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_campaign_progress ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.delete_outbound_campaign_progress" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/progress".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_campaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_campaign_with_http_info(campaign_id, opts = {}) click to toggle source

Delete a campaign.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 234
def delete_outbound_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.delete_outbound_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_campaignrule(campaign_rule_id, opts = {}) click to toggle source

Delete Campaign Rule

@param campaign_rule_id Campaign Rule ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 353
def delete_outbound_campaignrule(campaign_rule_id, opts = {})
  delete_outbound_campaignrule_with_http_info(campaign_rule_id, opts)
  return nil
end
delete_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {}) click to toggle source

Delete Campaign Rule

@param campaign_rule_id Campaign Rule ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 363
def delete_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_campaignrule ..."
  end
  
  
  # verify the required parameter 'campaign_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_rule_id' when calling OutboundApi.delete_outbound_campaignrule" if campaign_rule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_campaignrule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_contactlist(contact_list_id, opts = {}) click to toggle source

Delete a contact list.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 417
def delete_outbound_contactlist(contact_list_id, opts = {})
  delete_outbound_contactlist_with_http_info(contact_list_id, opts)
  return nil
end
delete_outbound_contactlist_contact(contact_list_id, contact_id, opts = {}) click to toggle source

Delete a contact.

@param contact_list_id Contact List ID @param contact_id Contact ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 482
def delete_outbound_contactlist_contact(contact_list_id, contact_id, opts = {})
  delete_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
  return nil
end
delete_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {}) click to toggle source

Delete a contact.

@param contact_list_id Contact List ID @param contact_id Contact ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 493
def delete_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlist_contact ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.delete_outbound_contactlist_contact" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling OutboundApi.delete_outbound_contactlist_contact" if contact_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_contactlist_contacts(contact_list_id, contact_ids, opts = {}) click to toggle source

Delete contacts from a contact list.

@param contact_list_id Contact List ID @param contact_ids ContactIds to delete. @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 556
def delete_outbound_contactlist_contacts(contact_list_id, contact_ids, opts = {})
  delete_outbound_contactlist_contacts_with_http_info(contact_list_id, contact_ids, opts)
  return nil
end
delete_outbound_contactlist_contacts_with_http_info(contact_list_id, contact_ids, opts = {}) click to toggle source

Delete contacts from a contact list.

@param contact_list_id Contact List ID @param contact_ids ContactIds to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 567
def delete_outbound_contactlist_contacts_with_http_info(contact_list_id, contact_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlist_contacts ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.delete_outbound_contactlist_contacts" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_ids' is set
  fail ArgumentError, "Missing the required parameter 'contact_ids' when calling OutboundApi.delete_outbound_contactlist_contacts" if contact_ids.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'contactIds'] = @api_client.build_collection_param(contact_ids, :multi)

  # 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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlist_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_contactlist_with_http_info(contact_list_id, opts = {}) click to toggle source

Delete a contact list.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 427
def delete_outbound_contactlist_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlist ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.delete_outbound_contactlist" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_contactlistfilter(contact_list_filter_id, opts = {}) click to toggle source

Delete Contact List Filter

@param contact_list_filter_id Contact List Filter ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 630
def delete_outbound_contactlistfilter(contact_list_filter_id, opts = {})
  delete_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts)
  return nil
end
delete_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {}) click to toggle source

Delete Contact List Filter

@param contact_list_filter_id Contact List Filter ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 640
def delete_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlistfilter ..."
  end
  
  
  # verify the required parameter 'contact_list_filter_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_filter_id' when calling OutboundApi.delete_outbound_contactlistfilter" if contact_list_filter_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/{contactListFilterId}".sub('{format}','json').sub('{' + 'contactListFilterId' + '}', contact_list_filter_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlistfilter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_contactlists(id, opts = {}) click to toggle source

Delete multiple contact lists.

@param id contact list id(s) to delete @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 694
def delete_outbound_contactlists(id, opts = {})
  delete_outbound_contactlists_with_http_info(id, opts)
  return nil
end
delete_outbound_contactlists_with_http_info(id, opts = {}) click to toggle source

Delete multiple contact lists.

@param id contact list id(s) to delete @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 704
def delete_outbound_contactlists_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlists ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling OutboundApi.delete_outbound_contactlists" if id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = @api_client.build_collection_param(id, :multi)

  # 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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_dnclist(dnc_list_id, opts = {}) click to toggle source

Delete dialer DNC list

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 759
def delete_outbound_dnclist(dnc_list_id, opts = {})
  delete_outbound_dnclist_with_http_info(dnc_list_id, opts)
  return nil
end
delete_outbound_dnclist_with_http_info(dnc_list_id, opts = {}) click to toggle source

Delete dialer DNC list

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 769
def delete_outbound_dnclist_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_dnclist ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.delete_outbound_dnclist" if dnc_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_messagingcampaign(messaging_campaign_id, opts = {}) click to toggle source

Delete an Outbound Messaging Campaign

@param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [MessagingCampaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 823
def delete_outbound_messagingcampaign(messaging_campaign_id, opts = {})
  data, _status_code, _headers = delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts)
  return data
end
delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {}) click to toggle source

Delete an Outbound Messaging Campaign

@param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 833
def delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_messagingcampaign ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.delete_outbound_messagingcampaign" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_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 OAuth']
  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,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_ruleset(rule_set_id, opts = {}) click to toggle source

Delete a Rule set.

@param rule_set_id Rule Set ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 888
def delete_outbound_ruleset(rule_set_id, opts = {})
  delete_outbound_ruleset_with_http_info(rule_set_id, opts)
  return nil
end
delete_outbound_ruleset_with_http_info(rule_set_id, opts = {}) click to toggle source

Delete a Rule set.

@param rule_set_id Rule Set ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 898
def delete_outbound_ruleset_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_ruleset ..."
  end
  
  
  # verify the required parameter 'rule_set_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_set_id' when calling OutboundApi.delete_outbound_ruleset" if rule_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_schedules_campaign(campaign_id, opts = {}) click to toggle source

Delete a dialer campaign schedule.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 952
def delete_outbound_schedules_campaign(campaign_id, opts = {})
  delete_outbound_schedules_campaign_with_http_info(campaign_id, opts)
  return nil
end
delete_outbound_schedules_campaign_with_http_info(campaign_id, opts = {}) click to toggle source

Delete a dialer campaign schedule.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 962
def delete_outbound_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_schedules_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.delete_outbound_schedules_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_schedules_sequence(sequence_id, opts = {}) click to toggle source

Delete a dialer sequence schedule.

@param sequence_id Sequence ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1016
def delete_outbound_schedules_sequence(sequence_id, opts = {})
  delete_outbound_schedules_sequence_with_http_info(sequence_id, opts)
  return nil
end
delete_outbound_schedules_sequence_with_http_info(sequence_id, opts = {}) click to toggle source

Delete a dialer sequence schedule.

@param sequence_id Sequence ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1026
def delete_outbound_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_schedules_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.delete_outbound_schedules_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_outbound_sequence(sequence_id, opts = {}) click to toggle source

Delete a dialer campaign sequence.

@param sequence_id Campaign Sequence ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1080
def delete_outbound_sequence(sequence_id, opts = {})
  delete_outbound_sequence_with_http_info(sequence_id, opts)
  return nil
end
delete_outbound_sequence_with_http_info(sequence_id, opts = {}) click to toggle source

Delete a dialer campaign sequence.

@param sequence_id Campaign Sequence ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1090
def delete_outbound_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.delete_outbound_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_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 OAuth']
  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,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_attemptlimit(attempt_limits_id, opts = {}) click to toggle source

Get attempt limits

@param attempt_limits_id Attempt limits ID @param [Hash] opts the optional parameters @return [AttemptLimits]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1144
def get_outbound_attemptlimit(attempt_limits_id, opts = {})
  data, _status_code, _headers = get_outbound_attemptlimit_with_http_info(attempt_limits_id, opts)
  return data
end
get_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {}) click to toggle source

Get attempt limits

@param attempt_limits_id Attempt limits ID @param [Hash] opts the optional parameters @return [Array<(AttemptLimits, Fixnum, Hash)>] AttemptLimits data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1154
def get_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_attemptlimit ..."
  end
  
  
  # verify the required parameter 'attempt_limits_id' is set
  fail ArgumentError, "Missing the required parameter 'attempt_limits_id' when calling OutboundApi.get_outbound_attemptlimit" if attempt_limits_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_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 OAuth']
  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 => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_attemptlimit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_attemptlimits(opts = {}) click to toggle source

Query attempt limits list

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [AttemptLimitsEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1215
def get_outbound_attemptlimits(opts = {})
  data, _status_code, _headers = get_outbound_attemptlimits_with_http_info(opts)
  return data
end
get_outbound_attemptlimits_with_http_info(opts = {}) click to toggle source

Query attempt limits list

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(AttemptLimitsEntityListing, Fixnum, Hash)>] AttemptLimitsEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1231
def get_outbound_attemptlimits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_attemptlimits ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/attemptlimits".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'AttemptLimitsEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_attemptlimits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_callabletimeset(callable_time_set_id, opts = {}) click to toggle source

Get callable time set

@param callable_time_set_id Callable Time Set ID @param [Hash] opts the optional parameters @return [CallableTimeSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1335
def get_outbound_callabletimeset(callable_time_set_id, opts = {})
  data, _status_code, _headers = get_outbound_callabletimeset_with_http_info(callable_time_set_id, opts)
  return data
end
get_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {}) click to toggle source

Get callable time set

@param callable_time_set_id Callable Time Set ID @param [Hash] opts the optional parameters @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1345
def get_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callabletimeset ..."
  end
  
  
  # verify the required parameter 'callable_time_set_id' is set
  fail ArgumentError, "Missing the required parameter 'callable_time_set_id' when calling OutboundApi.get_outbound_callabletimeset" if callable_time_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_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 OAuth']
  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 => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_callabletimesets(opts = {}) click to toggle source

Query callable time set list

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [CallableTimeSetEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1406
def get_outbound_callabletimesets(opts = {})
  data, _status_code, _headers = get_outbound_callabletimesets_with_http_info(opts)
  return data
end
get_outbound_callabletimesets_with_http_info(opts = {}) click to toggle source

Query callable time set list

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(CallableTimeSetEntityListing, Fixnum, Hash)>] CallableTimeSetEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1422
def get_outbound_callabletimesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callabletimesets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/callabletimesets".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CallableTimeSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_callanalysisresponseset(call_analysis_set_id, opts = {}) click to toggle source

Get a dialer call analysis response set.

@param call_analysis_set_id Call Analysis Response Set ID @param [Hash] opts the optional parameters @return [ResponseSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1526
def get_outbound_callanalysisresponseset(call_analysis_set_id, opts = {})
  data, _status_code, _headers = get_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
  return data
end
get_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {}) click to toggle source

Get a dialer call analysis response set.

@param call_analysis_set_id Call Analysis Response Set ID @param [Hash] opts the optional parameters @return [Array<(ResponseSet, Fixnum, Hash)>] ResponseSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1536
def get_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callanalysisresponseset ..."
  end
  
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail ArgumentError, "Missing the required parameter 'call_analysis_set_id' when calling OutboundApi.get_outbound_callanalysisresponseset" if call_analysis_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_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 OAuth']
  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 => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_callanalysisresponsesets(opts = {}) click to toggle source

Query a list of dialer call analysis response sets.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [ResponseSetEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1597
def get_outbound_callanalysisresponsesets(opts = {})
  data, _status_code, _headers = get_outbound_callanalysisresponsesets_with_http_info(opts)
  return data
end
get_outbound_callanalysisresponsesets_with_http_info(opts = {}) click to toggle source

Query a list of dialer call analysis response sets.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(ResponseSetEntityListing, Fixnum, Hash)>] ResponseSetEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1613
def get_outbound_callanalysisresponsesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callanalysisresponsesets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/callanalysisresponsesets".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'ResponseSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaign(campaign_id, opts = {}) click to toggle source

Get dialer campaign.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Campaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1717
def get_outbound_campaign(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_with_http_info(campaign_id, opts)
  return data
end
get_outbound_campaign_diagnostics(campaign_id, opts = {}) click to toggle source

Get campaign diagnostics

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [CampaignDiagnostics]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1782
def get_outbound_campaign_diagnostics(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_diagnostics_with_http_info(campaign_id, opts)
  return data
end
get_outbound_campaign_diagnostics_with_http_info(campaign_id, opts = {}) click to toggle source

Get campaign diagnostics

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignDiagnostics, Fixnum, Hash)>] CampaignDiagnostics data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1792
def get_outbound_campaign_diagnostics_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_diagnostics ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_diagnostics" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/diagnostics".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'CampaignDiagnostics')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_diagnostics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaign_interactions(campaign_id, opts = {}) click to toggle source

Get dialer campaign interactions.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [CampaignInteractions]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1847
def get_outbound_campaign_interactions(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_interactions_with_http_info(campaign_id, opts)
  return data
end
get_outbound_campaign_interactions_with_http_info(campaign_id, opts = {}) click to toggle source

Get dialer campaign interactions.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignInteractions, Fixnum, Hash)>] CampaignInteractions data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1857
def get_outbound_campaign_interactions_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_interactions ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_interactions" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/interactions".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'CampaignInteractions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaign_progress(campaign_id, opts = {}) click to toggle source

Get campaign progress

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [CampaignProgress]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1912
def get_outbound_campaign_progress(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_progress_with_http_info(campaign_id, opts)
  return data
end
get_outbound_campaign_progress_with_http_info(campaign_id, opts = {}) click to toggle source

Get campaign progress

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignProgress, Fixnum, Hash)>] CampaignProgress data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1922
def get_outbound_campaign_progress_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_progress ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_progress" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/progress".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'CampaignProgress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaign_stats(campaign_id, opts = {}) click to toggle source

Get statistics about a Dialer Campaign

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [CampaignStats]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1977
def get_outbound_campaign_stats(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_stats_with_http_info(campaign_id, opts)
  return data
end
get_outbound_campaign_stats_with_http_info(campaign_id, opts = {}) click to toggle source

Get statistics about a Dialer Campaign

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignStats, Fixnum, Hash)>] CampaignStats data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1987
def get_outbound_campaign_stats_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_stats ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_stats" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/stats".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'CampaignStats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaign_with_http_info(campaign_id, opts = {}) click to toggle source

Get dialer campaign.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 1727
def get_outbound_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaignrule(campaign_rule_id, opts = {}) click to toggle source

Get Campaign Rule

@param campaign_rule_id Campaign Rule ID @param [Hash] opts the optional parameters @return [CampaignRule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2042
def get_outbound_campaignrule(campaign_rule_id, opts = {})
  data, _status_code, _headers = get_outbound_campaignrule_with_http_info(campaign_rule_id, opts)
  return data
end
get_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {}) click to toggle source

Get Campaign Rule

@param campaign_rule_id Campaign Rule ID @param [Hash] opts the optional parameters @return [Array<(CampaignRule, Fixnum, Hash)>] CampaignRule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2052
def get_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaignrule ..."
  end
  
  
  # verify the required parameter 'campaign_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_rule_id' when calling OutboundApi.get_outbound_campaignrule" if campaign_rule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_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 OAuth']
  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 => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaignrule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaignrules(opts = {}) click to toggle source

Query Campaign Rule list

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [CampaignRuleEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2113
def get_outbound_campaignrules(opts = {})
  data, _status_code, _headers = get_outbound_campaignrules_with_http_info(opts)
  return data
end
get_outbound_campaignrules_with_http_info(opts = {}) click to toggle source

Query Campaign Rule list

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(CampaignRuleEntityListing, Fixnum, Hash)>] CampaignRuleEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2129
def get_outbound_campaignrules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaignrules ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/campaignrules".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CampaignRuleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaignrules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaigns(opts = {}) click to toggle source

Query a list of dialer campaigns.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :contact_list_id Contact List ID @option opts [String] :dnc_list_ids DNC list ID @option opts [String] :distribution_queue_id Distribution queue ID @option opts [String] :edge_group_id Edge group ID @option opts [String] :call_analysis_response_set_id Call analysis response set ID @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [CampaignEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2245
def get_outbound_campaigns(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_with_http_info(opts)
  return data
end
get_outbound_campaigns_all(opts = {}) click to toggle source

Query across all types of campaigns by division

@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 Campaign ID(s) @option opts [String] :name Campaign name(s) @option opts [Array<String>] :division_id Division ID(s) @option opts [Array<String>] :media_type Media type(s) @option opts [String] :sort_order Sort order (default to a) @return [CommonCampaignEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2419
def get_outbound_campaigns_all(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_all_with_http_info(opts)
  return data
end
get_outbound_campaigns_all_divisionviews(opts = {}) click to toggle source

Query across all types of campaigns

@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 Campaign ID(s) @option opts [String] :name Campaign name(s) @option opts [Array<String>] :division_id Division ID(s) @option opts [Array<String>] :media_type Media type(s) @option opts [String] :sort_order Sort order (default to a) @return [CommonCampaignDivisionViewEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2541
def get_outbound_campaigns_all_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_all_divisionviews_with_http_info(opts)
  return data
end
get_outbound_campaigns_all_divisionviews_with_http_info(opts = {}) click to toggle source

Query across all types of campaigns

@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 Campaign ID(s) @option opts [String] :name Campaign name(s) @option opts [Array<String>] :division_id Division ID(s) @option opts [Array<String>] :media_type Media type(s) @option opts [String] :sort_order Sort order @return [Array<(CommonCampaignDivisionViewEntityListing, Fixnum, Hash)>] CommonCampaignDivisionViewEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2557
def get_outbound_campaigns_all_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_all_divisionviews ..."
  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/outbound/campaigns/all/divisionviews".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[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'mediaType'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if opts[:'media_type']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CommonCampaignDivisionViewEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_all_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaigns_all_with_http_info(opts = {}) click to toggle source

Query across all types of campaigns by division

@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 Campaign ID(s) @option opts [String] :name Campaign name(s) @option opts [Array<String>] :division_id Division ID(s) @option opts [Array<String>] :media_type Media type(s) @option opts [String] :sort_order Sort order @return [Array<(CommonCampaignEntityListing, Fixnum, Hash)>] CommonCampaignEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2435
def get_outbound_campaigns_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_all ..."
  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/outbound/campaigns/all".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[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'mediaType'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if opts[:'media_type']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CommonCampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaigns_divisionview(campaign_id, opts = {}) click to toggle source

Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division. @param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [CampaignDivisionView]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2657
def get_outbound_campaigns_divisionview(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts)
  return data
end
get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {}) click to toggle source

Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division. @param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignDivisionView, Fixnum, Hash)>] CampaignDivisionView data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2667
def get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionview ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaigns_divisionview" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/divisionviews/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'CampaignDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaigns_divisionviews(opts = {}) click to toggle source

Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division. @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [CampaignDivisionViewListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2728
def get_outbound_campaigns_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_divisionviews_with_http_info(opts)
  return data
end
get_outbound_campaigns_divisionviews_with_http_info(opts = {}) click to toggle source

Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division. @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(CampaignDivisionViewListing, Fixnum, Hash)>] CampaignDivisionViewListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2744
def get_outbound_campaigns_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/campaigns/divisionviews".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[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CampaignDivisionViewListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_campaigns_with_http_info(opts = {}) click to toggle source

Query a list of dialer campaigns.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :contact_list_id Contact List ID @option opts [String] :dnc_list_ids DNC list ID @option opts [String] :distribution_queue_id Distribution queue ID @option opts [String] :edge_group_id Edge group ID @option opts [String] :call_analysis_response_set_id Call analysis response set ID @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(CampaignEntityListing, Fixnum, Hash)>] CampaignEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2267
def get_outbound_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/campaigns".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[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
  query_params[:'dncListIds'] = opts[:'dnc_list_ids'] if opts[:'dnc_list_ids']
  query_params[:'distributionQueueId'] = opts[:'distribution_queue_id'] if opts[:'distribution_queue_id']
  query_params[:'edgeGroupId'] = opts[:'edge_group_id'] if opts[:'edge_group_id']
  query_params[:'callAnalysisResponseSetId'] = opts[:'call_analysis_response_set_id'] if opts[:'call_analysis_response_set_id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlist(contact_list_id, opts = {}) click to toggle source

Get a dialer contact list.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @return [ContactList]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2850
def get_outbound_contactlist(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_with_http_info(contact_list_id, opts)
  return data
end
get_outbound_contactlist_contact(contact_list_id, contact_id, opts = {}) click to toggle source

Get a contact.

@param contact_list_id Contact List ID @param contact_id Contact ID @param [Hash] opts the optional parameters @return [DialerContact]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2932
def get_outbound_contactlist_contact(contact_list_id, contact_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
  return data
end
get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {}) click to toggle source

Get a contact.

@param contact_list_id Contact List ID @param contact_id Contact ID @param [Hash] opts the optional parameters @return [Array<(DialerContact, Fixnum, Hash)>] DialerContact data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2943
def get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_contact ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_contact" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling OutboundApi.get_outbound_contactlist_contact" if contact_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_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 OAuth']
  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 => 'DialerContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlist_export(contact_list_id, opts = {}) click to toggle source

Get the URI of a contact list export.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @option opts [String] :download Redirect to download uri (default to false) @return [ExportUri]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3007
def get_outbound_contactlist_export(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_export_with_http_info(contact_list_id, opts)
  return data
end
get_outbound_contactlist_export_with_http_info(contact_list_id, opts = {}) click to toggle source

Get the URI of a contact list export.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @option opts [String] :download Redirect to download uri @return [Array<(ExportUri, Fixnum, Hash)>] ExportUri data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3018
def get_outbound_contactlist_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_export ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_export" if contact_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'download'] = opts[:'download'] if opts[:'download']

  # 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 OAuth']
  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 => 'ExportUri')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlist_importstatus(contact_list_id, opts = {}) click to toggle source

Get dialer contactList import status.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [ImportStatus]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3080
def get_outbound_contactlist_importstatus(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_importstatus_with_http_info(contact_list_id, opts)
  return data
end
get_outbound_contactlist_importstatus_with_http_info(contact_list_id, opts = {}) click to toggle source

Get dialer contactList import status.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [Array<(ImportStatus, Fixnum, Hash)>] ImportStatus data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3090
def get_outbound_contactlist_importstatus_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_importstatus ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_importstatus" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/importstatus".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 OAuth']
  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 => 'ImportStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlist_timezonemappingpreview(contact_list_id, opts = {}) click to toggle source

Preview the result of applying Automatic Time Zone Mapping to a contact list

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [TimeZoneMappingPreview]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3145
def get_outbound_contactlist_timezonemappingpreview(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_timezonemappingpreview_with_http_info(contact_list_id, opts)
  return data
end
get_outbound_contactlist_timezonemappingpreview_with_http_info(contact_list_id, opts = {}) click to toggle source

Preview the result of applying Automatic Time Zone Mapping to a contact list

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [Array<(TimeZoneMappingPreview, Fixnum, Hash)>] TimeZoneMappingPreview data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3155
def get_outbound_contactlist_timezonemappingpreview_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_timezonemappingpreview ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_timezonemappingpreview" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 OAuth']
  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 => 'TimeZoneMappingPreview')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_timezonemappingpreview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlist_with_http_info(contact_list_id, opts = {}) click to toggle source

Get a dialer contact list.

@param contact_list_id ContactList ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Import status @option opts [BOOLEAN] :include_size Include size @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 2862
def get_outbound_contactlist_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist" if contact_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # 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 OAuth']
  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 => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlistfilter(contact_list_filter_id, opts = {}) click to toggle source

Get Contact list filter

@param contact_list_filter_id Contact List Filter ID @param [Hash] opts the optional parameters @return [ContactListFilter]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3210
def get_outbound_contactlistfilter(contact_list_filter_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts)
  return data
end
get_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {}) click to toggle source

Get Contact list filter

@param contact_list_filter_id Contact List Filter ID @param [Hash] opts the optional parameters @return [Array<(ContactListFilter, Fixnum, Hash)>] ContactListFilter data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3220
def get_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlistfilter ..."
  end
  
  
  # verify the required parameter 'contact_list_filter_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_filter_id' when calling OutboundApi.get_outbound_contactlistfilter" if contact_list_filter_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/{contactListFilterId}".sub('{format}','json').sub('{' + 'contactListFilterId' + '}', contact_list_filter_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 OAuth']
  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 => 'ContactListFilter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlistfilter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlistfilters(opts = {}) click to toggle source

Query Contact list filters

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @option opts [String] :contact_list_id Contact List ID @return [ContactListFilterEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3282
def get_outbound_contactlistfilters(opts = {})
  data, _status_code, _headers = get_outbound_contactlistfilters_with_http_info(opts)
  return data
end
get_outbound_contactlistfilters_with_http_info(opts = {}) click to toggle source

Query Contact list filters

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @option opts [String] :contact_list_id Contact List ID @return [Array<(ContactListFilterEntityListing, Fixnum, Hash)>] ContactListFilterEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3299
def get_outbound_contactlistfilters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlistfilters ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/contactlistfilters".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']

  # 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 OAuth']
  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 => 'ContactListFilterEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlistfilters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlists(opts = {}) click to toggle source

Query a list of contact lists.

@param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [ContactListEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3420
def get_outbound_contactlists(opts = {})
  data, _status_code, _headers = get_outbound_contactlists_with_http_info(opts)
  return data
end
get_outbound_contactlists_divisionview(contact_list_id, opts = {}) click to toggle source

Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size. @param contact_list_id Contactlist ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @return [ContactListDivisionView]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3574
def get_outbound_contactlists_divisionview(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts)
  return data
end
get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts = {}) click to toggle source

Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size. @param contact_list_id Contactlist ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status @option opts [BOOLEAN] :include_size Include size @return [Array<(ContactListDivisionView, Fixnum, Hash)>] ContactListDivisionView data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3586
def get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists_divisionview ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlists_divisionview" if contact_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/divisionviews/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # 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 OAuth']
  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 => 'ContactListDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlists_divisionviews(opts = {}) click to toggle source

Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [ContactListDivisionViewListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3663
def get_outbound_contactlists_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_contactlists_divisionviews_with_http_info(opts)
  return data
end
get_outbound_contactlists_divisionviews_with_http_info(opts = {}) click to toggle source

Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status @option opts [BOOLEAN] :include_size Include size @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(ContactListDivisionViewListing, Fixnum, Hash)>] ContactListDivisionViewListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3681
def get_outbound_contactlists_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/contactlists/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'ContactListDivisionViewListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_contactlists_with_http_info(opts = {}) click to toggle source

Query a list of contact lists.

@param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status @option opts [BOOLEAN] :include_size Include size @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(ContactListEntityListing, Fixnum, Hash)>] ContactListEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3440
def get_outbound_contactlists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'ContactListEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_dnclist(dnc_list_id, opts = {}) click to toggle source

Get dialer DNC list

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @return [DncList]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3801
def get_outbound_dnclist(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclist_with_http_info(dnc_list_id, opts)
  return data
end
get_outbound_dnclist_export(dnc_list_id, opts = {}) click to toggle source

Get the URI of a DNC list export.

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @option opts [String] :download Redirect to download uri (default to false) @return [ExportUri]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3883
def get_outbound_dnclist_export(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclist_export_with_http_info(dnc_list_id, opts)
  return data
end
get_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {}) click to toggle source

Get the URI of a DNC list export.

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @option opts [String] :download Redirect to download uri @return [Array<(ExportUri, Fixnum, Hash)>] ExportUri data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3894
def get_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclist_export ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclist_export" if dnc_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'download'] = opts[:'download'] if opts[:'download']

  # 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 OAuth']
  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 => 'ExportUri')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_dnclist_importstatus(dnc_list_id, opts = {}) click to toggle source

Get dialer dncList import status.

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @return [ImportStatus]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3956
def get_outbound_dnclist_importstatus(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclist_importstatus_with_http_info(dnc_list_id, opts)
  return data
end
get_outbound_dnclist_importstatus_with_http_info(dnc_list_id, opts = {}) click to toggle source

Get dialer dncList import status.

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @return [Array<(ImportStatus, Fixnum, Hash)>] ImportStatus data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3966
def get_outbound_dnclist_importstatus_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclist_importstatus ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclist_importstatus" if dnc_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/importstatus".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_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 OAuth']
  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 => 'ImportStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclist_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_dnclist_with_http_info(dnc_list_id, opts = {}) click to toggle source

Get dialer DNC list

@param dnc_list_id DncList ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Import status @option opts [BOOLEAN] :include_size Include size @return [Array<(DncList, Fixnum, Hash)>] DncList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 3813
def get_outbound_dnclist_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclist ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclist" if dnc_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # 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 OAuth']
  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 => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_dnclists(opts = {}) click to toggle source

Query dialer DNC lists

@param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :dnc_source_type DncSourceType @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [DncListEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4031
def get_outbound_dnclists(opts = {})
  data, _status_code, _headers = get_outbound_dnclists_with_http_info(opts)
  return data
end
get_outbound_dnclists_divisionview(dnc_list_id, opts = {}) click to toggle source

Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size. @param dnc_list_id Dnclist ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @return [DncListDivisionView]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4189
def get_outbound_dnclists_divisionview(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts)
  return data
end
get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts = {}) click to toggle source

Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size. @param dnc_list_id Dnclist ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status @option opts [BOOLEAN] :include_size Include size @return [Array<(DncListDivisionView, Fixnum, Hash)>] DncListDivisionView data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4201
def get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists_divisionview ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclists_divisionview" if dnc_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/divisionviews/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # 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 OAuth']
  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 => 'DncListDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_dnclists_divisionviews(opts = {}) click to toggle source

Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status (default to false) @option opts [BOOLEAN] :include_size Include size (default to false) @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [DncListDivisionViewListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4278
def get_outbound_dnclists_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_dnclists_divisionviews_with_http_info(opts)
  return data
end
get_outbound_dnclists_divisionviews_with_http_info(opts = {}) click to toggle source

Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Include import status @option opts [BOOLEAN] :include_size Include size @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(DncListDivisionViewListing, Fixnum, Hash)>] DncListDivisionViewListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4296
def get_outbound_dnclists_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/dnclists/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'DncListDivisionViewListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_dnclists_with_http_info(opts = {}) click to toggle source

Query dialer DNC lists

@param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_import_status Import status @option opts [BOOLEAN] :include_size Include size @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :dnc_source_type DncSourceType @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(DncListEntityListing, Fixnum, Hash)>] DncListEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4051
def get_outbound_dnclists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'dnc_source_type'] && !['rds', 'dnc.com', 'gryphon'].include?(opts[:'dnc_source_type'])
    fail ArgumentError, 'invalid value for "dnc_source_type", must be one of rds, dnc.com, gryphon'
  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/outbound/dnclists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'dncSourceType'] = opts[:'dnc_source_type'] if opts[:'dnc_source_type']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'DncListEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_event(event_id, opts = {}) click to toggle source

Get Dialer Event

@param event_id Event Log ID @param [Hash] opts the optional parameters @return [EventLog]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4414
def get_outbound_event(event_id, opts = {})
  data, _status_code, _headers = get_outbound_event_with_http_info(event_id, opts)
  return data
end
get_outbound_event_with_http_info(event_id, opts = {}) click to toggle source

Get Dialer Event

@param event_id Event Log ID @param [Hash] opts the optional parameters @return [Array<(EventLog, Fixnum, Hash)>] EventLog data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4424
def get_outbound_event_with_http_info(event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_event ..."
  end
  
  
  # verify the required parameter 'event_id' is set
  fail ArgumentError, "Missing the required parameter 'event_id' when calling OutboundApi.get_outbound_event" if event_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/events/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_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 OAuth']
  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 => 'EventLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_events(opts = {}) click to toggle source

Query Event Logs

@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] :filter_type Filter type (default to Prefix) @option opts [String] :category Category @option opts [String] :level Level @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [DialerEventEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4485
def get_outbound_events(opts = {})
  data, _status_code, _headers = get_outbound_events_with_http_info(opts)
  return data
end
get_outbound_events_with_http_info(opts = {}) click to toggle source

Query Event Logs

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size @option opts [Integer] :page_number Page number @option opts [String] :filter_type Filter type @option opts [String] :category Category @option opts [String] :level Level @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(DialerEventEntityListing, Fixnum, Hash)>] DialerEventEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4501
def get_outbound_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_events ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/events".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[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'level'] = opts[:'level'] if opts[:'level']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'DialerEventEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_messagingcampaign(messaging_campaign_id, opts = {}) click to toggle source

Get an Outbound Messaging Campaign

@param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [MessagingCampaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4605
def get_outbound_messagingcampaign(messaging_campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts)
  return data
end
get_outbound_messagingcampaign_progress(messaging_campaign_id, opts = {}) click to toggle source

Get messaging campaign's progress

@param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [CampaignProgress]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4670
def get_outbound_messagingcampaign_progress(messaging_campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts)
  return data
end
get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts = {}) click to toggle source

Get messaging campaign&#39;s progress

@param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignProgress, Fixnum, Hash)>] CampaignProgress data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4680
def get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaign_progress ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaign_progress" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_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 OAuth']
  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 => 'CampaignProgress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {}) click to toggle source

Get an Outbound Messaging Campaign

@param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4615
def get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaign ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaign" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_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 OAuth']
  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 => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_messagingcampaigns(opts = {}) click to toggle source

Query a list of Messaging Campaigns

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :sort_by The field to sort by (default to name) @option opts [String] :sort_order The direction to sort (default to ascending) @option opts [String] :name Name @option opts [String] :contact_list_id Contact List ID @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :type Campaign Type @option opts [String] :sender_sms_phone_number Sender SMS Phone Number @option opts [Array<String>] :id A list of messaging campaign ids to bulk fetch @return [MessagingCampaignEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4744
def get_outbound_messagingcampaigns(opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaigns_with_http_info(opts)
  return data
end
get_outbound_messagingcampaigns_divisionview(messaging_campaign_id, opts = {}) click to toggle source

Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division. @param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [MessagingCampaignDivisionView]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4892
def get_outbound_messagingcampaigns_divisionview(messaging_campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts)
  return data
end
get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts = {}) click to toggle source

Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division. @param messaging_campaign_id The Messaging Campaign ID @param [Hash] opts the optional parameters @return [Array<(MessagingCampaignDivisionView, Fixnum, Hash)>] MessagingCampaignDivisionView data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4902
def get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns_divisionview ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaigns_divisionview" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_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 OAuth']
  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 => 'MessagingCampaignDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_messagingcampaigns_divisionviews(opts = {}) click to toggle source

Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division. @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :sort_order The direction to sort (default to a) @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sender_sms_phone_number Sender SMS Phone Number @return [MessagingCampaignDivisionViewEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4962
def get_outbound_messagingcampaigns_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaigns_divisionviews_with_http_info(opts)
  return data
end
get_outbound_messagingcampaigns_divisionviews_with_http_info(opts = {}) click to toggle source

Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division. @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [String] :sort_order The direction to sort @option opts [String] :name Name @option opts [Array<String>] :id id @option opts [String] :sender_sms_phone_number Sender SMS Phone Number @return [Array<(MessagingCampaignDivisionViewEntityListing, Fixnum, Hash)>] MessagingCampaignDivisionViewEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4977
def get_outbound_messagingcampaigns_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns_divisionviews ..."
  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/outbound/messagingcampaigns/divisionviews".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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'senderSmsPhoneNumber'] = opts[:'sender_sms_phone_number'] if opts[:'sender_sms_phone_number']

  # 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 OAuth']
  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 => 'MessagingCampaignDivisionViewEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_messagingcampaigns_with_http_info(opts = {}) click to toggle source

Query a list of Messaging Campaigns

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [String] :sort_by The field to sort by @option opts [String] :sort_order The direction to sort @option opts [String] :name Name @option opts [String] :contact_list_id Contact List ID @option opts [Array<String>] :division_id Division ID(s) @option opts [String] :type Campaign Type @option opts [String] :sender_sms_phone_number Sender SMS Phone Number @option opts [Array<String>] :id A list of messaging campaign ids to bulk fetch @return [Array<(MessagingCampaignEntityListing, Fixnum, Hash)>] MessagingCampaignEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 4763
def get_outbound_messagingcampaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['campaignStatus', 'name', 'type'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of campaignStatus, name, type'
  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[:'type'] && !['SMS'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of SMS'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'type'] = opts[:'type'] if opts[:'type']
  query_params[:'senderSmsPhoneNumber'] = opts[:'sender_sms_phone_number'] if opts[:'sender_sms_phone_number']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']

  # 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 OAuth']
  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 => 'MessagingCampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_ruleset(rule_set_id, opts = {}) click to toggle source

Get a Rule Set by ID.

@param rule_set_id Rule Set ID @param [Hash] opts the optional parameters @return [RuleSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5070
def get_outbound_ruleset(rule_set_id, opts = {})
  data, _status_code, _headers = get_outbound_ruleset_with_http_info(rule_set_id, opts)
  return data
end
get_outbound_ruleset_with_http_info(rule_set_id, opts = {}) click to toggle source

Get a Rule Set by ID.

@param rule_set_id Rule Set ID @param [Hash] opts the optional parameters @return [Array<(RuleSet, Fixnum, Hash)>] RuleSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5080
def get_outbound_ruleset_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_ruleset ..."
  end
  
  
  # verify the required parameter 'rule_set_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_set_id' when calling OutboundApi.get_outbound_ruleset" if rule_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_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 OAuth']
  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 => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_rulesets(opts = {}) click to toggle source

Query a list of Rule Sets.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [RuleSetEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5141
def get_outbound_rulesets(opts = {})
  data, _status_code, _headers = get_outbound_rulesets_with_http_info(opts)
  return data
end
get_outbound_rulesets_with_http_info(opts = {}) click to toggle source

Query a list of Rule Sets.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(RuleSetEntityListing, Fixnum, Hash)>] RuleSetEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5157
def get_outbound_rulesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_rulesets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/rulesets".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'RuleSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_schedules_campaign(campaign_id, opts = {}) click to toggle source

Get a dialer campaign schedule.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [CampaignSchedule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5261
def get_outbound_schedules_campaign(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_schedules_campaign_with_http_info(campaign_id, opts)
  return data
end
get_outbound_schedules_campaign_with_http_info(campaign_id, opts = {}) click to toggle source

Get a dialer campaign schedule.

@param campaign_id Campaign ID @param [Hash] opts the optional parameters @return [Array<(CampaignSchedule, Fixnum, Hash)>] CampaignSchedule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5271
def get_outbound_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_schedules_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 OAuth']
  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 => 'CampaignSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_schedules_campaigns(opts = {}) click to toggle source

Query for a list of dialer campaign schedules.

@param [Hash] opts the optional parameters @return [Array<CampaignSchedule>]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5325
def get_outbound_schedules_campaigns(opts = {})
  data, _status_code, _headers = get_outbound_schedules_campaigns_with_http_info(opts)
  return data
end
get_outbound_schedules_campaigns_with_http_info(opts = {}) click to toggle source

Query for a list of dialer campaign schedules.

@param [Hash] opts the optional parameters @return [Array<(Array<CampaignSchedule>, Fixnum, Hash)>] Array<CampaignSchedule> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5334
def get_outbound_schedules_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_campaigns ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns".sub('{format}','json')

  # 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 OAuth']
  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 => 'Array<CampaignSchedule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_schedules_sequence(sequence_id, opts = {}) click to toggle source

Get a dialer sequence schedule.

@param sequence_id Sequence ID @param [Hash] opts the optional parameters @return [SequenceSchedule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5381
def get_outbound_schedules_sequence(sequence_id, opts = {})
  data, _status_code, _headers = get_outbound_schedules_sequence_with_http_info(sequence_id, opts)
  return data
end
get_outbound_schedules_sequence_with_http_info(sequence_id, opts = {}) click to toggle source

Get a dialer sequence schedule.

@param sequence_id Sequence ID @param [Hash] opts the optional parameters @return [Array<(SequenceSchedule, Fixnum, Hash)>] SequenceSchedule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5391
def get_outbound_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.get_outbound_schedules_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_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 OAuth']
  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 => 'SequenceSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_schedules_sequences(opts = {}) click to toggle source

Query for a list of dialer sequence schedules.

@param [Hash] opts the optional parameters @return [Array<SequenceSchedule>]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5445
def get_outbound_schedules_sequences(opts = {})
  data, _status_code, _headers = get_outbound_schedules_sequences_with_http_info(opts)
  return data
end
get_outbound_schedules_sequences_with_http_info(opts = {}) click to toggle source

Query for a list of dialer sequence schedules.

@param [Hash] opts the optional parameters @return [Array<(Array<SequenceSchedule>, Fixnum, Hash)>] Array<SequenceSchedule> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5454
def get_outbound_schedules_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_sequences ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences".sub('{format}','json')

  # 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 OAuth']
  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 => 'Array<SequenceSchedule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_sequence(sequence_id, opts = {}) click to toggle source

Get a dialer campaign sequence.

@param sequence_id Campaign Sequence ID @param [Hash] opts the optional parameters @return [CampaignSequence]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5501
def get_outbound_sequence(sequence_id, opts = {})
  data, _status_code, _headers = get_outbound_sequence_with_http_info(sequence_id, opts)
  return data
end
get_outbound_sequence_with_http_info(sequence_id, opts = {}) click to toggle source

Get a dialer campaign sequence.

@param sequence_id Campaign Sequence ID @param [Hash] opts the optional parameters @return [Array<(CampaignSequence, Fixnum, Hash)>] CampaignSequence data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5511
def get_outbound_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.get_outbound_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_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 OAuth']
  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 => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_sequences(opts = {}) click to toggle source

Query a list of dialer campaign sequences.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page (default to false) @option opts [String] :filter_type Filter type (default to Prefix) @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order (default to a) @return [CampaignSequenceEntityListing]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5572
def get_outbound_sequences(opts = {})
  data, _status_code, _headers = get_outbound_sequences_with_http_info(opts)
  return data
end
get_outbound_sequences_with_http_info(opts = {}) click to toggle source

Query a list of dialer campaign sequences.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size. The max that will be returned is 100. @option opts [Integer] :page_number Page number @option opts [BOOLEAN] :allow_empty_result Whether to return an empty page when there are no results for that page @option opts [String] :filter_type Filter type @option opts [String] :name Name @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @return [Array<(CampaignSequenceEntityListing, Fixnum, Hash)>] CampaignSequenceEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5588
def get_outbound_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_sequences ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  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/outbound/sequences".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[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # 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 OAuth']
  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 => 'CampaignSequenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_settings(opts = {}) click to toggle source

Get the outbound settings for this organization

@param [Hash] opts the optional parameters @return [OutboundSettings]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5691
def get_outbound_settings(opts = {})
  data, _status_code, _headers = get_outbound_settings_with_http_info(opts)
  return data
end
get_outbound_settings_with_http_info(opts = {}) click to toggle source

Get the outbound settings for this organization

@param [Hash] opts the optional parameters @return [Array<(OutboundSettings, Fixnum, Hash)>] OutboundSettings data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5700
def get_outbound_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/settings".sub('{format}','json')

  # 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 OAuth']
  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 => 'OutboundSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_outbound_wrapupcodemappings(opts = {}) click to toggle source

Get the Dialer wrap up code mapping.

@param [Hash] opts the optional parameters @return [WrapUpCodeMapping]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5746
def get_outbound_wrapupcodemappings(opts = {})
  data, _status_code, _headers = get_outbound_wrapupcodemappings_with_http_info(opts)
  return data
end
get_outbound_wrapupcodemappings_with_http_info(opts = {}) click to toggle source

Get the Dialer wrap up code mapping.

@param [Hash] opts the optional parameters @return [Array<(WrapUpCodeMapping, Fixnum, Hash)>] WrapUpCodeMapping data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5755
def get_outbound_wrapupcodemappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_wrapupcodemappings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/wrapupcodemappings".sub('{format}','json')

  # 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 OAuth']
  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 => 'WrapUpCodeMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_outbound_settings(body, opts = {}) click to toggle source

Update the outbound settings for this organization

@param body outboundSettings @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5802
def patch_outbound_settings(body, opts = {})
  patch_outbound_settings_with_http_info(body, opts)
  return nil
end
patch_outbound_settings_with_http_info(body, opts = {}) click to toggle source

Update the outbound settings for this organization

@param body outboundSettings @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5812
def patch_outbound_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.patch_outbound_settings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.patch_outbound_settings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/settings".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, 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: OutboundApi#patch_outbound_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_attemptlimits(body, opts = {}) click to toggle source

Create attempt limits

@param body AttemptLimits @param [Hash] opts the optional parameters @return [AttemptLimits]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5866
def post_outbound_attemptlimits(body, opts = {})
  data, _status_code, _headers = post_outbound_attemptlimits_with_http_info(body, opts)
  return data
end
post_outbound_attemptlimits_with_http_info(body, opts = {}) click to toggle source

Create attempt limits

@param body AttemptLimits @param [Hash] opts the optional parameters @return [Array<(AttemptLimits, Fixnum, Hash)>] AttemptLimits data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5876
def post_outbound_attemptlimits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_attemptlimits ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_attemptlimits" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_attemptlimits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_audits(body, opts = {}) click to toggle source

Retrieves audits for dialer.

@param body AuditSearch @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_by Sort by (default to entity.name) @option opts [String] :sort_order Sort order (default to ascending) @option opts [BOOLEAN] :facets_only Facets only (default to false) @return [AuditSearchResult]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5936
def post_outbound_audits(body, opts = {})
  data, _status_code, _headers = post_outbound_audits_with_http_info(body, opts)
  return data
end
post_outbound_audits_with_http_info(body, opts = {}) click to toggle source

Retrieves audits for dialer.

@param body AuditSearch @param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size @option opts [Integer] :page_number Page number @option opts [String] :sort_by Sort by @option opts [String] :sort_order Sort order @option opts [BOOLEAN] :facets_only Facets only @return [Array<(AuditSearchResult, Fixnum, Hash)>] AuditSearchResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 5951
def post_outbound_audits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_audits ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_audits" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/audits".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'facetsOnly'] = opts[:'facets_only'] if opts[:'facets_only']

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuditSearchResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_callabletimesets(body, opts = {}) click to toggle source

Create callable time set

@param body DialerCallableTimeSet @param [Hash] opts the optional parameters @return [CallableTimeSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6041
def post_outbound_callabletimesets(body, opts = {})
  data, _status_code, _headers = post_outbound_callabletimesets_with_http_info(body, opts)
  return data
end
post_outbound_callabletimesets_with_http_info(body, opts = {}) click to toggle source

Create callable time set

@param body DialerCallableTimeSet @param [Hash] opts the optional parameters @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6051
def post_outbound_callabletimesets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_callabletimesets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_callabletimesets" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_callanalysisresponsesets(body, opts = {}) click to toggle source

Create a dialer call analysis response set.

@param body ResponseSet @param [Hash] opts the optional parameters @return [ResponseSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6106
def post_outbound_callanalysisresponsesets(body, opts = {})
  data, _status_code, _headers = post_outbound_callanalysisresponsesets_with_http_info(body, opts)
  return data
end
post_outbound_callanalysisresponsesets_with_http_info(body, opts = {}) click to toggle source

Create a dialer call analysis response set.

@param body ResponseSet @param [Hash] opts the optional parameters @return [Array<(ResponseSet, Fixnum, Hash)>] ResponseSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6116
def post_outbound_callanalysisresponsesets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_callanalysisresponsesets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_callanalysisresponsesets" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_campaign_callback_schedule(campaign_id, body, opts = {}) click to toggle source

Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead." @param campaign_id Campaign ID @param body ContactCallbackRequest @param [Hash] opts the optional parameters @return [ContactCallbackRequest]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6172
def post_outbound_campaign_callback_schedule(campaign_id, body, opts = {})
  data, _status_code, _headers = post_outbound_campaign_callback_schedule_with_http_info(campaign_id, body, opts)
  return data
end
post_outbound_campaign_callback_schedule_with_http_info(campaign_id, body, opts = {}) click to toggle source

Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead.&quot; @param campaign_id Campaign ID @param body ContactCallbackRequest @param [Hash] opts the optional parameters @return [Array<(ContactCallbackRequest, Fixnum, Hash)>] ContactCallbackRequest data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6183
def post_outbound_campaign_callback_schedule_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaign_callback_schedule ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.post_outbound_campaign_callback_schedule" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaign_callback_schedule" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/callback/schedule".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactCallbackRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaign_callback_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_campaignrules(body, opts = {}) click to toggle source

Create Campaign Rule

@param body CampaignRule @param [Hash] opts the optional parameters @return [CampaignRule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6246
def post_outbound_campaignrules(body, opts = {})
  data, _status_code, _headers = post_outbound_campaignrules_with_http_info(body, opts)
  return data
end
post_outbound_campaignrules_with_http_info(body, opts = {}) click to toggle source

Create Campaign Rule

@param body CampaignRule @param [Hash] opts the optional parameters @return [Array<(CampaignRule, Fixnum, Hash)>] CampaignRule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6256
def post_outbound_campaignrules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaignrules ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaignrules" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaignrules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_campaigns(body, opts = {}) click to toggle source

Create a campaign.

@param body Campaign @param [Hash] opts the optional parameters @return [Campaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6311
def post_outbound_campaigns(body, opts = {})
  data, _status_code, _headers = post_outbound_campaigns_with_http_info(body, opts)
  return data
end
post_outbound_campaigns_progress(body, opts = {}) click to toggle source

Get progress for a list of campaigns

@param body Campaign IDs @param [Hash] opts the optional parameters @return [Array<CampaignProgress>]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6376
def post_outbound_campaigns_progress(body, opts = {})
  data, _status_code, _headers = post_outbound_campaigns_progress_with_http_info(body, opts)
  return data
end
post_outbound_campaigns_progress_with_http_info(body, opts = {}) click to toggle source

Get progress for a list of campaigns

@param body Campaign IDs @param [Hash] opts the optional parameters @return [Array<(Array<CampaignProgress>, Fixnum, Hash)>] Array<CampaignProgress> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6386
def post_outbound_campaigns_progress_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaigns_progress ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaigns_progress" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/progress".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<CampaignProgress>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_campaigns_with_http_info(body, opts = {}) click to toggle source

Create a campaign.

@param body Campaign @param [Hash] opts the optional parameters @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6321
def post_outbound_campaigns_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaigns ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaigns" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlist_clear(contact_list_id, opts = {}) click to toggle source

Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.

@param contact_list_id Contact List ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6441
def post_outbound_contactlist_clear(contact_list_id, opts = {})
  post_outbound_contactlist_clear_with_http_info(contact_list_id, opts)
  return nil
end
post_outbound_contactlist_clear_with_http_info(contact_list_id, opts = {}) click to toggle source

Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.

@param contact_list_id Contact List ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6451
def post_outbound_contactlist_clear_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_clear ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_clear" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/clear".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, 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: OutboundApi#post_outbound_contactlist_clear\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlist_contacts(contact_list_id, body, opts = {}) click to toggle source

Add contacts to a contact list.

@param contact_list_id Contact List ID @param body Contact @param [Hash] opts the optional parameters @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t. @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the &#39;priority&#39; parameter. @return [Array<DialerContact>]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6509
def post_outbound_contactlist_contacts(contact_list_id, body, opts = {})
  data, _status_code, _headers = post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts)
  return data
end
post_outbound_contactlist_contacts_bulk(contact_list_id, body, opts = {}) click to toggle source

Get contacts from a contact list.

@param contact_list_id Contact List ID @param body ContactIds to get. @param [Hash] opts the optional parameters @return [Array<DialerContact>]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6608
def post_outbound_contactlist_contacts_bulk(contact_list_id, body, opts = {})
  data, _status_code, _headers = post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts)
  return data
end
post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts = {}) click to toggle source

Get contacts from a contact list.

@param contact_list_id Contact List ID @param body ContactIds to get. @param [Hash] opts the optional parameters @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6619
def post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_contacts_bulk ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_contacts_bulk" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlist_contacts_bulk" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/bulk".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<DialerContact>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_contacts_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {}) click to toggle source

Add contacts to a contact list.

@param contact_list_id Contact List ID @param body Contact @param [Hash] opts the optional parameters @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t. @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the &#39;priority&#39; parameter. @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6523
def post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_contacts ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_contacts" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlist_contacts" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
  query_params[:'clearSystemData'] = opts[:'clear_system_data'] if opts[:'clear_system_data']
  query_params[:'doNotQueue'] = opts[:'do_not_queue'] if opts[:'do_not_queue']

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<DialerContact>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlist_export(contact_list_id, opts = {}) click to toggle source

Initiate the export of a contact list. Returns 200 if received OK. @param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [DomainEntityRef]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6682
def post_outbound_contactlist_export(contact_list_id, opts = {})
  data, _status_code, _headers = post_outbound_contactlist_export_with_http_info(contact_list_id, opts)
  return data
end
post_outbound_contactlist_export_with_http_info(contact_list_id, opts = {}) click to toggle source

Initiate the export of a contact list. Returns 200 if received OK. @param contact_list_id ContactList ID @param [Hash] opts the optional parameters @return [Array<(DomainEntityRef, Fixnum, Hash)>] DomainEntityRef data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6692
def post_outbound_contactlist_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_export ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_export" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEntityRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlistfilters(body, opts = {}) click to toggle source

Create Contact List Filter

@param body ContactListFilter @param [Hash] opts the optional parameters @return [ContactListFilter]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6747
def post_outbound_contactlistfilters(body, opts = {})
  data, _status_code, _headers = post_outbound_contactlistfilters_with_http_info(body, opts)
  return data
end
post_outbound_contactlistfilters_preview(body, opts = {}) click to toggle source

Get a preview of the output of a contact list filter

@param body ContactListFilter @param [Hash] opts the optional parameters @return [FilterPreviewResponse]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6812
def post_outbound_contactlistfilters_preview(body, opts = {})
  data, _status_code, _headers = post_outbound_contactlistfilters_preview_with_http_info(body, opts)
  return data
end
post_outbound_contactlistfilters_preview_with_http_info(body, opts = {}) click to toggle source

Get a preview of the output of a contact list filter

@param body ContactListFilter @param [Hash] opts the optional parameters @return [Array<(FilterPreviewResponse, Fixnum, Hash)>] FilterPreviewResponse data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6822
def post_outbound_contactlistfilters_preview_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlistfilters_preview ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlistfilters_preview" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/preview".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FilterPreviewResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlistfilters_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlistfilters_with_http_info(body, opts = {}) click to toggle source

Create Contact List Filter

@param body ContactListFilter @param [Hash] opts the optional parameters @return [Array<(ContactListFilter, Fixnum, Hash)>] ContactListFilter data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6757
def post_outbound_contactlistfilters_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlistfilters ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlistfilters" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListFilter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlistfilters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_contactlists(body, opts = {}) click to toggle source

Create a contact List.

@param body ContactList @param [Hash] opts the optional parameters @return [ContactList]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6877
def post_outbound_contactlists(body, opts = {})
  data, _status_code, _headers = post_outbound_contactlists_with_http_info(body, opts)
  return data
end
post_outbound_contactlists_with_http_info(body, opts = {}) click to toggle source

Create a contact List.

@param body ContactList @param [Hash] opts the optional parameters @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6887
def post_outbound_contactlists_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlists ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlists" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_conversation_dnc(conversation_id, opts = {}) click to toggle source

Add phone numbers to a Dialer DNC list.

@param conversation_id Conversation ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6942
def post_outbound_conversation_dnc(conversation_id, opts = {})
  post_outbound_conversation_dnc_with_http_info(conversation_id, opts)
  return nil
end
post_outbound_conversation_dnc_with_http_info(conversation_id, opts = {}) click to toggle source

Add phone numbers to a Dialer DNC list.

@param conversation_id Conversation ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 6952
def post_outbound_conversation_dnc_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_conversation_dnc ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling OutboundApi.post_outbound_conversation_dnc" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/conversations/{conversationId}/dnc".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, 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: OutboundApi#post_outbound_conversation_dnc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_dnclist_export(dnc_list_id, opts = {}) click to toggle source

Initiate the export of a dnc list. Returns 200 if received OK. @param dnc_list_id DncList ID @param [Hash] opts the optional parameters @return [DomainEntityRef]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7006
def post_outbound_dnclist_export(dnc_list_id, opts = {})
  data, _status_code, _headers = post_outbound_dnclist_export_with_http_info(dnc_list_id, opts)
  return data
end
post_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {}) click to toggle source

Initiate the export of a dnc list. Returns 200 if received OK. @param dnc_list_id DncList ID @param [Hash] opts the optional parameters @return [Array<(DomainEntityRef, Fixnum, Hash)>] DomainEntityRef data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7016
def post_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclist_export ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.post_outbound_dnclist_export" if dnc_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEntityRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_dnclist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_dnclist_phonenumbers(dnc_list_id, body, opts = {}) click to toggle source

Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to @param dnc_list_id DncList ID @param body DNC Phone Numbers @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7072
def post_outbound_dnclist_phonenumbers(dnc_list_id, body, opts = {})
  post_outbound_dnclist_phonenumbers_with_http_info(dnc_list_id, body, opts)
  return nil
end
post_outbound_dnclist_phonenumbers_with_http_info(dnc_list_id, body, opts = {}) click to toggle source

Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to @param dnc_list_id DncList ID @param body DNC Phone Numbers @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7083
def post_outbound_dnclist_phonenumbers_with_http_info(dnc_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclist_phonenumbers ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.post_outbound_dnclist_phonenumbers" if dnc_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_dnclist_phonenumbers" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/phonenumbers".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, 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: OutboundApi#post_outbound_dnclist_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_dnclists(body, opts = {}) click to toggle source

Create dialer DNC list

@param body DncList @param [Hash] opts the optional parameters @return [DncList]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7145
def post_outbound_dnclists(body, opts = {})
  data, _status_code, _headers = post_outbound_dnclists_with_http_info(body, opts)
  return data
end
post_outbound_dnclists_with_http_info(body, opts = {}) click to toggle source

Create dialer DNC list

@param body DncList @param [Hash] opts the optional parameters @return [Array<(DncList, Fixnum, Hash)>] DncList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7155
def post_outbound_dnclists_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclists ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_dnclists" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_messagingcampaigns(body, opts = {}) click to toggle source

Create a Messaging Campaign

@param body Messaging Campaign @param [Hash] opts the optional parameters @return [MessagingCampaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7210
def post_outbound_messagingcampaigns(body, opts = {})
  data, _status_code, _headers = post_outbound_messagingcampaigns_with_http_info(body, opts)
  return data
end
post_outbound_messagingcampaigns_progress(body, opts = {}) click to toggle source

Get progress for a list of messaging campaigns

@param body Messaging Campaign IDs @param [Hash] opts the optional parameters @return [Array<CampaignProgress>]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7275
def post_outbound_messagingcampaigns_progress(body, opts = {})
  data, _status_code, _headers = post_outbound_messagingcampaigns_progress_with_http_info(body, opts)
  return data
end
post_outbound_messagingcampaigns_progress_with_http_info(body, opts = {}) click to toggle source

Get progress for a list of messaging campaigns

@param body Messaging Campaign IDs @param [Hash] opts the optional parameters @return [Array<(Array<CampaignProgress>, Fixnum, Hash)>] Array<CampaignProgress> data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7285
def post_outbound_messagingcampaigns_progress_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_messagingcampaigns_progress ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_messagingcampaigns_progress" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/progress".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<CampaignProgress>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_messagingcampaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_messagingcampaigns_with_http_info(body, opts = {}) click to toggle source

Create a Messaging Campaign

@param body Messaging Campaign @param [Hash] opts the optional parameters @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7220
def post_outbound_messagingcampaigns_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_messagingcampaigns ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_messagingcampaigns" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_messagingcampaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_rulesets(body, opts = {}) click to toggle source

Create a Dialer Call Analysis Response Set.

@param body RuleSet @param [Hash] opts the optional parameters @return [RuleSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7340
def post_outbound_rulesets(body, opts = {})
  data, _status_code, _headers = post_outbound_rulesets_with_http_info(body, opts)
  return data
end
post_outbound_rulesets_with_http_info(body, opts = {}) click to toggle source

Create a Dialer Call Analysis Response Set.

@param body RuleSet @param [Hash] opts the optional parameters @return [Array<(RuleSet, Fixnum, Hash)>] RuleSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7350
def post_outbound_rulesets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_rulesets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_rulesets" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_outbound_sequences(body, opts = {}) click to toggle source

Create a new campaign sequence.

@param body Organization @param [Hash] opts the optional parameters @return [CampaignSequence]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7405
def post_outbound_sequences(body, opts = {})
  data, _status_code, _headers = post_outbound_sequences_with_http_info(body, opts)
  return data
end
post_outbound_sequences_with_http_info(body, opts = {}) click to toggle source

Create a new campaign sequence.

@param body Organization @param [Hash] opts the optional parameters @return [Array<(CampaignSequence, Fixnum, Hash)>] CampaignSequence data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7415
def post_outbound_sequences_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_sequences ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_sequences" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_attemptlimit(attempt_limits_id, body, opts = {}) click to toggle source

Update attempt limits

@param attempt_limits_id Attempt limits ID @param body AttemptLimits @param [Hash] opts the optional parameters @return [AttemptLimits]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7471
def put_outbound_attemptlimit(attempt_limits_id, body, opts = {})
  data, _status_code, _headers = put_outbound_attemptlimit_with_http_info(attempt_limits_id, body, opts)
  return data
end
put_outbound_attemptlimit_with_http_info(attempt_limits_id, body, opts = {}) click to toggle source

Update attempt limits

@param attempt_limits_id Attempt limits ID @param body AttemptLimits @param [Hash] opts the optional parameters @return [Array<(AttemptLimits, Fixnum, Hash)>] AttemptLimits data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7482
def put_outbound_attemptlimit_with_http_info(attempt_limits_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_attemptlimit ..."
  end
  
  
  # verify the required parameter 'attempt_limits_id' is set
  fail ArgumentError, "Missing the required parameter 'attempt_limits_id' when calling OutboundApi.put_outbound_attemptlimit" if attempt_limits_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_attemptlimit" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_attemptlimit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_callabletimeset(callable_time_set_id, body, opts = {}) click to toggle source

Update callable time set

@param callable_time_set_id Callable Time Set ID @param body DialerCallableTimeSet @param [Hash] opts the optional parameters @return [CallableTimeSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7546
def put_outbound_callabletimeset(callable_time_set_id, body, opts = {})
  data, _status_code, _headers = put_outbound_callabletimeset_with_http_info(callable_time_set_id, body, opts)
  return data
end
put_outbound_callabletimeset_with_http_info(callable_time_set_id, body, opts = {}) click to toggle source

Update callable time set

@param callable_time_set_id Callable Time Set ID @param body DialerCallableTimeSet @param [Hash] opts the optional parameters @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7557
def put_outbound_callabletimeset_with_http_info(callable_time_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_callabletimeset ..."
  end
  
  
  # verify the required parameter 'callable_time_set_id' is set
  fail ArgumentError, "Missing the required parameter 'callable_time_set_id' when calling OutboundApi.put_outbound_callabletimeset" if callable_time_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_callabletimeset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_callanalysisresponseset(call_analysis_set_id, body, opts = {}) click to toggle source

Update a dialer call analysis response set.

@param call_analysis_set_id Call Analysis Response Set ID @param body ResponseSet @param [Hash] opts the optional parameters @return [ResponseSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7621
def put_outbound_callanalysisresponseset(call_analysis_set_id, body, opts = {})
  data, _status_code, _headers = put_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, body, opts)
  return data
end
put_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, body, opts = {}) click to toggle source

Update a dialer call analysis response set.

@param call_analysis_set_id Call Analysis Response Set ID @param body ResponseSet @param [Hash] opts the optional parameters @return [Array<(ResponseSet, Fixnum, Hash)>] ResponseSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7632
def put_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_callanalysisresponseset ..."
  end
  
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail ArgumentError, "Missing the required parameter 'call_analysis_set_id' when calling OutboundApi.put_outbound_callanalysisresponseset" if call_analysis_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_callanalysisresponseset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_campaign(campaign_id, body, opts = {}) click to toggle source

Update a campaign.

@param campaign_id Campaign ID @param body Campaign @param [Hash] opts the optional parameters @return [Campaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7696
def put_outbound_campaign(campaign_id, body, opts = {})
  data, _status_code, _headers = put_outbound_campaign_with_http_info(campaign_id, body, opts)
  return data
end
put_outbound_campaign_agent(campaign_id, user_id, body, opts = {}) click to toggle source

Send notification that an agent's state changed New agent state. @param campaign_id Campaign ID @param user_id Agent&#39;s user ID @param body agent @param [Hash] opts the optional parameters @return [String]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7772
def put_outbound_campaign_agent(campaign_id, user_id, body, opts = {})
  data, _status_code, _headers = put_outbound_campaign_agent_with_http_info(campaign_id, user_id, body, opts)
  return data
end
put_outbound_campaign_agent_with_http_info(campaign_id, user_id, body, opts = {}) click to toggle source

Send notification that an agent&#39;s state changed New agent state. @param campaign_id Campaign ID @param user_id Agent&#39;s user ID @param body agent @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7784
def put_outbound_campaign_agent_with_http_info(campaign_id, user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_campaign_agent ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.put_outbound_campaign_agent" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling OutboundApi.put_outbound_campaign_agent" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_campaign_agent" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/agents/{userId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s).sub('{' + 'userId' + '}', user_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_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#put_outbound_campaign_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_campaign_with_http_info(campaign_id, body, opts = {}) click to toggle source

Update a campaign.

@param campaign_id Campaign ID @param body Campaign @param [Hash] opts the optional parameters @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7707
def put_outbound_campaign_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.put_outbound_campaign" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_campaign" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_campaignrule(campaign_rule_id, body, opts = {}) click to toggle source

Update Campaign Rule

@param campaign_rule_id Campaign Rule ID @param body CampaignRule @param [Hash] opts the optional parameters @return [CampaignRule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7856
def put_outbound_campaignrule(campaign_rule_id, body, opts = {})
  data, _status_code, _headers = put_outbound_campaignrule_with_http_info(campaign_rule_id, body, opts)
  return data
end
put_outbound_campaignrule_with_http_info(campaign_rule_id, body, opts = {}) click to toggle source

Update Campaign Rule

@param campaign_rule_id Campaign Rule ID @param body CampaignRule @param [Hash] opts the optional parameters @return [Array<(CampaignRule, Fixnum, Hash)>] CampaignRule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7867
def put_outbound_campaignrule_with_http_info(campaign_rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_campaignrule ..."
  end
  
  
  # verify the required parameter 'campaign_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_rule_id' when calling OutboundApi.put_outbound_campaignrule" if campaign_rule_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_campaignrule" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_campaignrule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_contactlist(contact_list_id, body, opts = {}) click to toggle source

Update a contact list.

@param contact_list_id ContactList ID @param body ContactList @param [Hash] opts the optional parameters @return [ContactList]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7931
def put_outbound_contactlist(contact_list_id, body, opts = {})
  data, _status_code, _headers = put_outbound_contactlist_with_http_info(contact_list_id, body, opts)
  return data
end
put_outbound_contactlist_contact(contact_list_id, contact_id, body, opts = {}) click to toggle source

Update a contact.

@param contact_list_id Contact List ID @param contact_id Contact ID @param body Contact @param [Hash] opts the optional parameters @return [DialerContact]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8007
def put_outbound_contactlist_contact(contact_list_id, contact_id, body, opts = {})
  data, _status_code, _headers = put_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, body, opts)
  return data
end
put_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, body, opts = {}) click to toggle source

Update a contact.

@param contact_list_id Contact List ID @param contact_id Contact ID @param body Contact @param [Hash] opts the optional parameters @return [Array<(DialerContact, Fixnum, Hash)>] DialerContact data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8019
def put_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_contactlist_contact ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.put_outbound_contactlist_contact" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling OutboundApi.put_outbound_contactlist_contact" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_contactlist_contact" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DialerContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_contactlist_with_http_info(contact_list_id, body, opts = {}) click to toggle source

Update a contact list.

@param contact_list_id ContactList ID @param body ContactList @param [Hash] opts the optional parameters @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 7942
def put_outbound_contactlist_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_contactlist ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.put_outbound_contactlist" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_contactlist" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_contactlistfilter(contact_list_filter_id, body, opts = {}) click to toggle source

Update Contact List Filter

@param contact_list_filter_id Contact List Filter ID @param body ContactListFilter @param [Hash] opts the optional parameters @return [ContactListFilter]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8091
def put_outbound_contactlistfilter(contact_list_filter_id, body, opts = {})
  data, _status_code, _headers = put_outbound_contactlistfilter_with_http_info(contact_list_filter_id, body, opts)
  return data
end
put_outbound_contactlistfilter_with_http_info(contact_list_filter_id, body, opts = {}) click to toggle source

Update Contact List Filter

@param contact_list_filter_id Contact List Filter ID @param body ContactListFilter @param [Hash] opts the optional parameters @return [Array<(ContactListFilter, Fixnum, Hash)>] ContactListFilter data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8102
def put_outbound_contactlistfilter_with_http_info(contact_list_filter_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_contactlistfilter ..."
  end
  
  
  # verify the required parameter 'contact_list_filter_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_filter_id' when calling OutboundApi.put_outbound_contactlistfilter" if contact_list_filter_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_contactlistfilter" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/{contactListFilterId}".sub('{format}','json').sub('{' + 'contactListFilterId' + '}', contact_list_filter_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListFilter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_contactlistfilter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_dnclist(dnc_list_id, body, opts = {}) click to toggle source

Update dialer DNC list

@param dnc_list_id DncList ID @param body DncList @param [Hash] opts the optional parameters @return [DncList]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8166
def put_outbound_dnclist(dnc_list_id, body, opts = {})
  data, _status_code, _headers = put_outbound_dnclist_with_http_info(dnc_list_id, body, opts)
  return data
end
put_outbound_dnclist_with_http_info(dnc_list_id, body, opts = {}) click to toggle source

Update dialer DNC list

@param dnc_list_id DncList ID @param body DncList @param [Hash] opts the optional parameters @return [Array<(DncList, Fixnum, Hash)>] DncList data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8177
def put_outbound_dnclist_with_http_info(dnc_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_dnclist ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.put_outbound_dnclist" if dnc_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_dnclist" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_messagingcampaign(messaging_campaign_id, body, opts = {}) click to toggle source

Update an Outbound Messaging Campaign

@param messaging_campaign_id The Messaging Campaign ID @param body MessagingCampaign @param [Hash] opts the optional parameters @return [MessagingCampaign]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8241
def put_outbound_messagingcampaign(messaging_campaign_id, body, opts = {})
  data, _status_code, _headers = put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts)
  return data
end
put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts = {}) click to toggle source

Update an Outbound Messaging Campaign

@param messaging_campaign_id The Messaging Campaign ID @param body MessagingCampaign @param [Hash] opts the optional parameters @return [Array<(MessagingCampaign, Fixnum, Hash)>] MessagingCampaign data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8252
def put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_messagingcampaign ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.put_outbound_messagingcampaign" if messaging_campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_messagingcampaign" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_ruleset(rule_set_id, body, opts = {}) click to toggle source

Update a RuleSet.

@param rule_set_id Rule Set ID @param body RuleSet @param [Hash] opts the optional parameters @return [RuleSet]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8316
def put_outbound_ruleset(rule_set_id, body, opts = {})
  data, _status_code, _headers = put_outbound_ruleset_with_http_info(rule_set_id, body, opts)
  return data
end
put_outbound_ruleset_with_http_info(rule_set_id, body, opts = {}) click to toggle source

Update a RuleSet.

@param rule_set_id Rule Set ID @param body RuleSet @param [Hash] opts the optional parameters @return [Array<(RuleSet, Fixnum, Hash)>] RuleSet data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8327
def put_outbound_ruleset_with_http_info(rule_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_ruleset ..."
  end
  
  
  # verify the required parameter 'rule_set_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_set_id' when calling OutboundApi.put_outbound_ruleset" if rule_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_ruleset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_schedules_campaign(campaign_id, body, opts = {}) click to toggle source

Update a new campaign schedule.

@param campaign_id Campaign ID @param body CampaignSchedule @param [Hash] opts the optional parameters @return [CampaignSchedule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8391
def put_outbound_schedules_campaign(campaign_id, body, opts = {})
  data, _status_code, _headers = put_outbound_schedules_campaign_with_http_info(campaign_id, body, opts)
  return data
end
put_outbound_schedules_campaign_with_http_info(campaign_id, body, opts = {}) click to toggle source

Update a new campaign schedule.

@param campaign_id Campaign ID @param body CampaignSchedule @param [Hash] opts the optional parameters @return [Array<(CampaignSchedule, Fixnum, Hash)>] CampaignSchedule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8402
def put_outbound_schedules_campaign_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_schedules_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.put_outbound_schedules_campaign" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_schedules_campaign" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_schedules_sequence(sequence_id, body, opts = {}) click to toggle source

Update a new sequence schedule.

@param sequence_id Sequence ID @param body SequenceSchedule @param [Hash] opts the optional parameters @return [SequenceSchedule]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8466
def put_outbound_schedules_sequence(sequence_id, body, opts = {})
  data, _status_code, _headers = put_outbound_schedules_sequence_with_http_info(sequence_id, body, opts)
  return data
end
put_outbound_schedules_sequence_with_http_info(sequence_id, body, opts = {}) click to toggle source

Update a new sequence schedule.

@param sequence_id Sequence ID @param body SequenceSchedule @param [Hash] opts the optional parameters @return [Array<(SequenceSchedule, Fixnum, Hash)>] SequenceSchedule data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8477
def put_outbound_schedules_sequence_with_http_info(sequence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_schedules_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.put_outbound_schedules_sequence" if sequence_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_schedules_sequence" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SequenceSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_sequence(sequence_id, body, opts = {}) click to toggle source

Update a new campaign sequence.

@param sequence_id Campaign Sequence ID @param body Organization @param [Hash] opts the optional parameters @return [CampaignSequence]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8541
def put_outbound_sequence(sequence_id, body, opts = {})
  data, _status_code, _headers = put_outbound_sequence_with_http_info(sequence_id, body, opts)
  return data
end
put_outbound_sequence_with_http_info(sequence_id, body, opts = {}) click to toggle source

Update a new campaign sequence.

@param sequence_id Campaign Sequence ID @param body Organization @param [Hash] opts the optional parameters @return [Array<(CampaignSequence, Fixnum, Hash)>] CampaignSequence data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8552
def put_outbound_sequence_with_http_info(sequence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.put_outbound_sequence" if sequence_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_sequence" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_outbound_wrapupcodemappings(body, opts = {}) click to toggle source

Update the Dialer wrap up code mapping.

@param body wrapUpCodeMapping @param [Hash] opts the optional parameters @return [WrapUpCodeMapping]

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8615
def put_outbound_wrapupcodemappings(body, opts = {})
  data, _status_code, _headers = put_outbound_wrapupcodemappings_with_http_info(body, opts)
  return data
end
put_outbound_wrapupcodemappings_with_http_info(body, opts = {}) click to toggle source

Update the Dialer wrap up code mapping.

@param body wrapUpCodeMapping @param [Hash] opts the optional parameters @return [Array<(WrapUpCodeMapping, Fixnum, Hash)>] WrapUpCodeMapping data, response status code and response headers

# File lib/purecloudplatformclientv2/api/outbound_api.rb, line 8625
def put_outbound_wrapupcodemappings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_wrapupcodemappings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_wrapupcodemappings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/wrapupcodemappings".sub('{format}','json')

  # 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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapUpCodeMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end