doc_out/OutboundApi.html.md in purecloud-0.37.1 vs doc_out/OutboundApi.html.md in purecloud-0.38.1

- old
+ new

@@ -29,13 +29,15 @@ |[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress| |[**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | **GET** /api/v2/outbound/campaigns/{campaignId}/stats | Get statistics about a Dialer Campaign| |[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.| |[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get dialer contactList.| |[**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | **GET** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Get dialer contactList.| +|[**get_contactlists_contactlist_id_export**](OutboundApi.html#get_contactlists_contactlist_id_export) | **GET** /api/v2/outbound/contactlists/{contactListId}/export | Get the URI of a contact list export.| |[**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | **GET** /api/v2/outbound/contactlists/{contactListId}/importstatus | Get dialer contactList import status.| |[**get_dnclists**](OutboundApi.html#get_dnclists) | **GET** /api/v2/outbound/dnclists | Query dialer DNC lists| |[**get_dnclists_dnclist_id**](OutboundApi.html#get_dnclists_dnclist_id) | **GET** /api/v2/outbound/dnclists/{dncListId} | Get dialer DNC list| +|[**get_dnclists_dnclist_id_export**](OutboundApi.html#get_dnclists_dnclist_id_export) | **GET** /api/v2/outbound/dnclists/{dncListId}/export | Get the URI of a DNC list export.| |[**get_dnclists_dnclist_id_importstatus**](OutboundApi.html#get_dnclists_dnclist_id_importstatus) | **GET** /api/v2/outbound/dnclists/{dncListId}/importstatus | Get dialer dncList import status.| |[**get_rulesets**](OutboundApi.html#get_rulesets) | **GET** /api/v2/outbound/rulesets | Query a list of Rule Sets.| |[**get_rulesets_ruleset_id**](OutboundApi.html#get_rulesets_ruleset_id) | **GET** /api/v2/outbound/rulesets/{ruleSetId} | Get a Rule Set by ID.| |[**get_schedules_campaigns**](OutboundApi.html#get_schedules_campaigns) | **GET** /api/v2/outbound/schedules/campaigns | Query for a list of dialer campaign schedules.| |[**get_schedules_campaigns_campaign_id**](OutboundApi.html#get_schedules_campaigns_campaign_id) | **GET** /api/v2/outbound/schedules/campaigns/{campaignId} | Get a dialer campaign schedule.| @@ -1429,10 +1431,70 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_contactlists_contactlist_id_export"></a> + +## -[**ExportUri**](ExportUri.html) get_contactlists_contactlist_id_export(contact_list_id, opts) + +Get the URI of a contact list export. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# 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 | ContactList ID + +opts = { + download: "false" # String | Redirect to download uri +} + +begin + #Get the URI of a contact list export. + result = api_instance.get_contactlists_contactlist_id_export(contact_list_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_export: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contact_list_id** | **String**| ContactList ID | + **download** | **String**| Redirect to download uri | [optional] [default to false] +{: class="table table-striped"} + + +### Return type + +[**ExportUri**](ExportUri.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_contactlists_contactlist_id_importstatus"></a> ## -[**ImportStatus**](ImportStatus.html) get_contactlists_contactlist_id_importstatus(contact_list_id) Get dialer contactList import status. @@ -1610,9 +1672,69 @@ ### Return type [**DncList**](DncList.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_dnclists_dnclist_id_export"></a> + +## -[**ExportUri**](ExportUri.html) get_dnclists_dnclist_id_export(dnc_list_id, opts) + +Get the URI of a DNC list export. + + + +### Example +~~~ruby +# load the gem +require 'purecloud' +# 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 + +dnc_list_id = "dnc_list_id_example" # String | DncList ID + +opts = { + download: "false" # String | Redirect to download uri +} + +begin + #Get the URI of a DNC list export. + result = api_instance.get_dnclists_dnclist_id_export(dnc_list_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->get_dnclists_dnclist_id_export: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **dnc_list_id** | **String**| DncList ID | + **download** | **String**| Redirect to download uri | [optional] [default to false] +{: class="table table-striped"} + + +### Return type + +[**ExportUri**](ExportUri.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json