OutboundApi.md in purecloudplatformclientv2-45.0.0

- old
+ new

@@ -45,10 +45,11 @@
 [**get_outbound_contactlist_importstatus**](OutboundApi.html#get_outbound_contactlist_importstatus) | Get dialer contactList import status.
 [**get_outbound_contactlist_timezonemappingpreview**](OutboundApi.html#get_outbound_contactlist_timezonemappingpreview) | Preview the result of applying Automatic Time Zone Mapping to a contact list
 [**get_outbound_contactlistfilter**](OutboundApi.html#get_outbound_contactlistfilter) | Get Contact list filter
 [**get_outbound_contactlistfilters**](OutboundApi.html#get_outbound_contactlistfilters) | Query Contact list filters
 [**get_outbound_contactlists**](OutboundApi.html#get_outbound_contactlists) | Query a list of contact lists.
+[**get_outbound_contactlists_divisionviews**](OutboundApi.html#get_outbound_contactlists_divisionviews) | Query a list of simplified contact list objects.
 [**get_outbound_dnclist**](OutboundApi.html#get_outbound_dnclist) | Get dialer DNC list
 [**get_outbound_dnclist_export**](OutboundApi.html#get_outbound_dnclist_export) | Get the URI of a DNC list export.
 [**get_outbound_dnclist_importstatus**](OutboundApi.html#get_outbound_dnclist_importstatus) | Get dialer dncList import status.
 [**get_outbound_dnclists**](OutboundApi.html#get_outbound_dnclists) | Query dialer DNC lists
 [**get_outbound_event**](OutboundApi.html#get_outbound_event) | Get Dialer Event
@@ -70,10 +71,11 @@
 [**post_outbound_callanalysisresponsesets**](OutboundApi.html#post_outbound_callanalysisresponsesets) | Create a dialer call analysis response set.
 [**post_outbound_campaign_callback_schedule**](OutboundApi.html#post_outbound_campaign_callback_schedule) | Schedule a Callback for a Dialer Campaign (Deprecated)
 [**post_outbound_campaignrules**](OutboundApi.html#post_outbound_campaignrules) | Create Campaign Rule
 [**post_outbound_campaigns**](OutboundApi.html#post_outbound_campaigns) | Create a campaign.
 [**post_outbound_campaigns_progress**](OutboundApi.html#post_outbound_campaigns_progress) | Get progress for a list of campaigns
+[**post_outbound_contactlist_clear**](OutboundApi.html#post_outbound_contactlist_clear) | 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.
 [**post_outbound_contactlist_contacts**](OutboundApi.html#post_outbound_contactlist_contacts) | Add contacts to a contact list.
 [**post_outbound_contactlist_contacts_bulk**](OutboundApi.html#post_outbound_contactlist_contacts_bulk) | Get contacts from a contact list.
 [**post_outbound_contactlist_export**](OutboundApi.html#post_outbound_contactlist_export) | Initiate the export of a contact list.
 [**post_outbound_contactlistfilters**](OutboundApi.html#post_outbound_contactlistfilters) | Create Contact List Filter
 [**post_outbound_contactlistfilters_preview**](OutboundApi.html#post_outbound_contactlistfilters_preview) | Get a preview of the output of a contact list filter
@@ -2751,10 +2753,92 @@
  - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 
+<a name="get_outbound_contactlists_divisionviews"></a>
+
+## -[**ContactListDivisionViewListing**](ContactListDivisionViewListing.html) get_outbound_contactlists_divisionviews(opts)
+
+
+
+Query a list of simplified contact list objects.
+
+This return a simplified version of contact lists, consisting of the name, divisions, columns, and phone columns.
+
+Wraps GET /api/v2/outbound/contactlists/divisionviews 
+
+Requires ANY permissions: 
+
+* outbound:contactList:search
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::OutboundApi.new
+
+opts = { 
+  include_import_status: false, # BOOLEAN | Include import status
+  include_size: false, # BOOLEAN | Include size
+  page_size: 25, # Integer | Page size. The max that will be returned is 100.
+  page_number: 1, # Integer | Page number
+  filter_type: "Prefix", # String | Filter type
+  name: "name_example", # String | Name
+  id: ["id_example"], # Array<String> | id
+  sort_by: "sort_by_example", # String | Sort by
+  sort_order: "a" # String | Sort order
+}
+
+begin
+  #Query a list of simplified contact list objects.
+  result = api_instance.get_outbound_contactlists_divisionviews(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionviews: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
+ **include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
+ **page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
+ **name** | **String**| Name | [optional]  |
+ **id** | [**Array&lt;String&gt;**](String.html)| id | [optional]  |
+ **sort_by** | **String**| Sort by | [optional]  |
+ **sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ContactListDivisionViewListing**](ContactListDivisionViewListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_outbound_dnclist"></a>
 
 ## -[**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts)
 
 
@@ -2998,10 +3082,12 @@
   include_size: false, # BOOLEAN | Include size
   page_size: 25, # Integer | Page size. The max that will be returned is 100.
   page_number: 1, # Integer | Page number
   filter_type: "Prefix", # String | Filter type
   name: "name_example", # String | Name
+  dnc_source_type: "dnc_source_type_example", # String | DncSourceType
+  division_id: ["division_id_example"], # Array<String> | Division ID(s)
   sort_by: "sort_by_example", # String | Sort by
   sort_order: "sort_order_example" # String | Sort order
 }
 
 begin
@@ -3021,10 +3107,12 @@
  **include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
  **page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
  **name** | **String**| Name | [optional]  |
+ **dnc_source_type** | **String**| DncSourceType | [optional] <br />**Values**: rds, dnc.com, gryphon |
+ **division_id** | [**Array&lt;String&gt;**](String.html)| Division ID(s) | [optional]  |
  **sort_by** | **String**| Sort by | [optional]  |
  **sort_order** | **String**| Sort order | [optional] <br />**Values**: ascending, descending |
 {: class="table table-striped"}
 
 
@@ -4418,9 +4506,73 @@
 
 
 ### Return type
 
 [**Array&lt;CampaignProgress&gt;**](CampaignProgress.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_outbound_contactlist_clear"></a>
+
+## - post_outbound_contactlist_clear(contact_list_id)
+
+
+
+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.
+
+
+
+Wraps POST /api/v2/outbound/contactlists/{contactListId}/clear 
+
+Requires ANY permissions: 
+
+* outbound:contact:delete
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::OutboundApi.new
+
+contact_list_id = "contact_list_id_example" # String | Contact List ID
+
+
+begin
+  #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.
+  api_instance.post_outbound_contactlist_clear(contact_list_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->post_outbound_contactlist_clear: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_list_id** | **String**| Contact List ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
  - **Accept**: application/json