lib/purecloudplatformclientv2/api/outbound_api.rb in purecloudplatformclientv2-34.0.0 vs lib/purecloudplatformclientv2/api/outbound_api.rb in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -2293,9 +2293,126 @@
@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
+ # 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 (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 [String] :sort_by Sort by
+ # @option opts [String] :sort_order Sort order (default to a)
+ # @return [CampaignDivisionViewListing]
+ def get_outbound_campaigns_divisionviews(opts = {})
+ data, _status_code, _headers = get_outbound_campaigns_divisionviews_with_http_info(opts)
+ return data
+ end
+
+ # 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
+ # @option opts [Integer] :page_number Page number
+ # @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<(CampaignDivisionViewListing, Fixnum, Hash)>] CampaignDivisionViewListing data, response status code and response headers
+ 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[:'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 Auth']
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => '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 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)