doc_out/OutboundApi.html.md in purecloud-0.61.1 vs doc_out/OutboundApi.html.md in purecloud-0.62.1

- old
+ new

@@ -9,10 +9,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- |[**delete_attemptlimits_attemptlimits_id**](OutboundApi.html#delete_attemptlimits_attemptlimits_id) | **DELETE** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Delete attempt limits| |[**delete_callabletimesets_callabletimeset_id**](OutboundApi.html#delete_callabletimesets_callabletimeset_id) | **DELETE** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Delete callable time set| |[**delete_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#delete_callanalysisresponsesets_callanalysisset_id) | **DELETE** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Delete a dialer call analysis response set.| +|[**delete_campaignrules_campaignrule_id**](OutboundApi.html#delete_campaignrules_campaignrule_id) | **DELETE** /api/v2/outbound/campaignrules/{campaignRuleId} | Delete Campaign Rule| |[**delete_campaigns_campaign_id**](OutboundApi.html#delete_campaigns_campaign_id) | **DELETE** /api/v2/outbound/campaigns/{campaignId} | Delete a campaign.| |[**delete_campaigns_campaign_id_progress**](OutboundApi.html#delete_campaigns_campaign_id_progress) | **DELETE** /api/v2/outbound/campaigns/{campaignId}/progress | Reset campaign progress and recycle the campaign| |[**delete_contactlists_contactlist_id**](OutboundApi.html#delete_contactlists_contactlist_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId} | Delete a contact list.| |[**delete_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#delete_contactlists_contactlist_id_contacts_contact_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Delete a contact.| |[**delete_dnclists_dnclist_id**](OutboundApi.html#delete_dnclists_dnclist_id) | **DELETE** /api/v2/outbound/dnclists/{dncListId} | Delete dialer DNC list| @@ -24,10 +25,12 @@ |[**get_attemptlimits_attemptlimits_id**](OutboundApi.html#get_attemptlimits_attemptlimits_id) | **GET** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Get attempt limits| |[**get_callabletimesets**](OutboundApi.html#get_callabletimesets) | **GET** /api/v2/outbound/callabletimesets | Query callable time set list| |[**get_callabletimesets_callabletimeset_id**](OutboundApi.html#get_callabletimesets_callabletimeset_id) | **GET** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Get callable time set| |[**get_callanalysisresponsesets**](OutboundApi.html#get_callanalysisresponsesets) | **GET** /api/v2/outbound/callanalysisresponsesets | Query a list of dialer call analysis response sets.| |[**get_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#get_callanalysisresponsesets_callanalysisset_id) | **GET** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Get a dialer call analysis response set.| +|[**get_campaignrules**](OutboundApi.html#get_campaignrules) | **GET** /api/v2/outbound/campaignrules | Query Campaign Rule list| +|[**get_campaignrules_campaignrule_id**](OutboundApi.html#get_campaignrules_campaignrule_id) | **GET** /api/v2/outbound/campaignrules/{campaignRuleId} | Get Campaign Rule| |[**get_campaigns**](OutboundApi.html#get_campaigns) | **GET** /api/v2/outbound/campaigns | Query a list of dialer campaigns.| |[**get_campaigns_campaign_id**](OutboundApi.html#get_campaigns_campaign_id) | **GET** /api/v2/outbound/campaigns/{campaignId} | Get dialer campaign.| |[**get_campaigns_campaign_id_diagnostics**](OutboundApi.html#get_campaigns_campaign_id_diagnostics) | **GET** /api/v2/outbound/campaigns/{campaignId}/diagnostics | Get campaign diagnostics| |[**get_campaigns_campaign_id_interactions**](OutboundApi.html#get_campaigns_campaign_id_interactions) | **GET** /api/v2/outbound/campaigns/{campaignId}/interactions | Get dialer campaign interactions.| |[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress| @@ -52,10 +55,11 @@ |[**get_wrapupcodemappings**](OutboundApi.html#get_wrapupcodemappings) | **GET** /api/v2/outbound/wrapupcodemappings | Get the Dialer wrap up code mapping.| |[**post_attemptlimits**](OutboundApi.html#post_attemptlimits) | **POST** /api/v2/outbound/attemptlimits | Create attempt limits| |[**post_audits**](OutboundApi.html#post_audits) | **POST** /api/v2/outbound/audits | Retrieves audits for dialer.| |[**post_callabletimesets**](OutboundApi.html#post_callabletimesets) | **POST** /api/v2/outbound/callabletimesets | Create callable time set| |[**post_callanalysisresponsesets**](OutboundApi.html#post_callanalysisresponsesets) | **POST** /api/v2/outbound/callanalysisresponsesets | Create a dialer call analysis response set.| +|[**post_campaignrules**](OutboundApi.html#post_campaignrules) | **POST** /api/v2/outbound/campaignrules | Create Campaign Rule| |[**post_campaigns**](OutboundApi.html#post_campaigns) | **POST** /api/v2/outbound/campaigns | Create a campaign.| |[**post_campaigns_campaign_id_callback_schedule**](OutboundApi.html#post_campaigns_campaign_id_callback_schedule) | **POST** /api/v2/outbound/campaigns/{campaignId}/callback/schedule | Schedule a Callback for a Dialer Campaign (Deprecated)| |[**post_campaigns_progress**](OutboundApi.html#post_campaigns_progress) | **POST** /api/v2/outbound/campaigns/progress | Get progress for a list of campaigns| |[**post_contactlists**](OutboundApi.html#post_contactlists) | **POST** /api/v2/outbound/contactlists | Create a contact List.| |[**post_contactlists_contactlist_id_contacts**](OutboundApi.html#post_contactlists_contactlist_id_contacts) | **POST** /api/v2/outbound/contactlists/{contactListId}/contacts | Add contacts to a contact list.| @@ -67,10 +71,11 @@ |[**post_rulesets**](OutboundApi.html#post_rulesets) | **POST** /api/v2/outbound/rulesets | Create a Dialer Call Analysis Response Set.| |[**post_sequences**](OutboundApi.html#post_sequences) | **POST** /api/v2/outbound/sequences | Create a new campaign sequence.| |[**put_attemptlimits_attemptlimits_id**](OutboundApi.html#put_attemptlimits_attemptlimits_id) | **PUT** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Update attempt limits| |[**put_callabletimesets_callabletimeset_id**](OutboundApi.html#put_callabletimesets_callabletimeset_id) | **PUT** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Update callable time set| |[**put_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#put_callanalysisresponsesets_callanalysisset_id) | **PUT** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Update a dialer call analysis response set.| +|[**put_campaignrules_campaignrule_id**](OutboundApi.html#put_campaignrules_campaignrule_id) | **PUT** /api/v2/outbound/campaignrules/{campaignRuleId} | Update Campaign Rule| |[**put_campaigns_campaign_id**](OutboundApi.html#put_campaigns_campaign_id) | **PUT** /api/v2/outbound/campaigns/{campaignId} | Update a campaign.| |[**put_campaigns_campaign_id_agents_user_id**](OutboundApi.html#put_campaigns_campaign_id_agents_user_id) | **PUT** /api/v2/outbound/campaigns/{campaignId}/agents/{userId} | Send notification that an agent&#39;s state changed | |[**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | **PUT** /api/v2/outbound/contactlists/{contactListId} | Update a contact list.| |[**put_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#put_contactlists_contactlist_id_contacts_contact_id) | **PUT** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Update a contact.| |[**put_dnclists_dnclist_id**](OutboundApi.html#put_dnclists_dnclist_id) | **PUT** /api/v2/outbound/dnclists/{dncListId} | Update dialer DNC list| @@ -247,10 +252,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="delete_campaignrules_campaignrule_id"></a> + +## -String** delete_campaignrules_campaignrule_id(campaign_rule_id) + +Delete Campaign Rule + + + +### 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 + +campaign_rule_id = "campaign_rule_id_example" # String | Campaign Rule ID + + +begin + #Delete Campaign Rule + result = api_instance.delete_campaignrules_campaignrule_id(campaign_rule_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->delete_campaignrules_campaignrule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_rule_id** | **String**| Campaign Rule ID | +{: class="table table-striped"} + + +### Return type + +**String** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="delete_campaigns_campaign_id"></a> ## -String** delete_campaigns_campaign_id(campaign_id) Delete a campaign. @@ -1123,10 +1184,133 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_campaignrules"></a> + +## -[**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_campaignrules(opts) + +Query Campaign Rule list + + + +### 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 + +opts = { + page_size: 25, # Integer | Page size + page_number: 1, # Integer | Page number + filter_type: "PREFIX", # String | Filter type + name: "name_example", # String | Name + sort_by: "sort_by_example", # String | Sort by + sort_order: "a" # String | Sort order +} + +begin + #Query Campaign Rule list + result = api_instance.get_campaignrules(opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->get_campaignrules: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page_size** | **Integer**| Page size | [optional] [default to 25] + **page_number** | **Integer**| Page number | [optional] [default to 1] + **filter_type** | **String**| Filter type | [optional] [default to PREFIX] + **name** | **String**| Name | [optional] + **sort_by** | **String**| Sort by | [optional] + **sort_order** | **String**| Sort order | [optional] [default to a] +{: class="table table-striped"} + + +### Return type + +[**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="get_campaignrules_campaignrule_id"></a> + +## -[**CampaignRule**](CampaignRule.html) get_campaignrules_campaignrule_id(campaign_rule_id) + +Get Campaign Rule + + + +### 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 + +campaign_rule_id = "campaign_rule_id_example" # String | Campaign Rule ID + + +begin + #Get Campaign Rule + result = api_instance.get_campaignrules_campaignrule_id(campaign_rule_id) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->get_campaignrules_campaignrule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_rule_id** | **String**| Campaign Rule ID | +{: class="table table-striped"} + + +### Return type + +[**CampaignRule**](CampaignRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_campaigns"></a> ## -[**CampaignEntityListing**](CampaignEntityListing.html) get_campaigns(opts) Query a list of dialer campaigns. @@ -2781,10 +2965,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="post_campaignrules"></a> + +## -[**CampaignRule**](CampaignRule.html) post_campaignrules(body) + +Create Campaign Rule + + + +### 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 + +body = PureCloud::CampaignRule.new # CampaignRule | CampaignRule + + +begin + #Create Campaign Rule + result = api_instance.post_campaignrules(body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->post_campaignrules: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CampaignRule**](CampaignRule.html)| CampaignRule | +{: class="table table-striped"} + + +### Return type + +[**CampaignRule**](CampaignRule.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="post_campaigns"></a> ## -[**Campaign**](Campaign.html) post_campaigns(body) Create a campaign. @@ -3635,9 +3875,68 @@ ### Return type [**ResponseSet**](ResponseSet.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_campaignrules_campaignrule_id"></a> + +## -[**CampaignRule**](CampaignRule.html) put_campaignrules_campaignrule_id(campaign_rule_id, body) + +Update Campaign Rule + + + +### 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 + +campaign_rule_id = "campaign_rule_id_example" # String | Campaign Rule ID + +body = PureCloud::CampaignRule.new # CampaignRule | CampaignRule + + +begin + #Update Campaign Rule + result = api_instance.put_campaignrules_campaignrule_id(campaign_rule_id, body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->put_campaignrules_campaignrule_id: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign_rule_id** | **String**| Campaign Rule ID | + **body** | [**CampaignRule**](CampaignRule.html)| CampaignRule | +{: class="table table-striped"} + + +### Return type + +[**CampaignRule**](CampaignRule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json