purecloud 0.61.1 → 0.62.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e4c449a9c377e603c23079d4e7ad1a26e8dd088
-  data.tar.gz: 786a3f0cbad5b9d123a0178f96454c4311adca37
+  metadata.gz: b46bacd87b4f9a1d88a17296f8cad95eb49f7a80
+  data.tar.gz: a6d7b32ff04575708e03c554f50526ce3563e3b6
 SHA512:
-  metadata.gz: 1b8d2a3b7adbb7a4347c35d7248fe4fa6c84e6b0c4c0affa5099d54a093345ef091844d64fca2470c37e66128f5abc2873277935af27dfcc687cf6ea7e354d21
-  data.tar.gz: 94e4ac80caaba0ce487fff20299bea2f65992a5a9c1e08c97d91c97fb2b2200779584681994618cf6b418499d0ededd834f2c52e68d31b02d403358a768fcd12
+  metadata.gz: 86948295aa10846bebb08bc288d4fa2f3fab69d27cb7d0b0eac20af7656082570f8bc43e9f02fba17bf8fd044ea64bd121324d0b963baeeecc526ce77ab8a4e4
+  data.tar.gz: 8bd5572a260b3e1a642f2fe23232bbdd2b3fac9b107894d8be4c01c409b2777de3a5f94889c793a68ac37bef2085bb71bbede2160533c325b4bfd1d003923b95

data/README.md

@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v2
-- Package version: 0.61.1
-- Build date: 2016-12-20T22:02:42.508Z
+- Package version: 0.62.1
+- Build date: 2016-12-28T20:28:45.785Z
 
 For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
 
 ### from rubygems.org
 
-    gem 'purecloud', '~> 0.61.1'
+    gem 'purecloud', '~> 0.62.1'
 
 ### Install from Git
 

data/bin/notificationMappings.json

@@ -1,5 +1,9 @@
 {
   "notifications": [
+    {
+      "topic": "billing.tasks.{id}",
+      "class": "BillingTaskResultNotification"
+    },
     {
       "topic": "v2.contentmanagement.documents.{id}",
       "class": "DocumentDataNotification"

data/config-ruby.json

@@ -1 +1 @@
-{"gemVersion":"0.61.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.61.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
+{"gemVersion":"0.62.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.62.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}

data/doc_out/BillingTaskResultNotification.html.md

@@ -0,0 +1,21 @@
+---
+title: BillingTaskResultNotification
+---
+## PureCloud::BillingTaskResultNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **task_type** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **result_id** | **String** |  | [optional] |
+| **result_uri** | **String** |  | [optional] |
+| **result_download_url** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **additional_properties** | **Object** |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CampaignRule.html.md

@@ -0,0 +1,23 @@
+---
+title: CampaignRule
+---
+## PureCloud::CampaignRule
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
+| **campaign_rule_entities** | [**CampaignRuleEntities**](CampaignRuleEntities.html) | the list of entities the rule monitors | |
+| **campaign_rule_conditions** | [**Array<CampaignRuleCondition>**](CampaignRuleCondition.html) | the list of conditions the are evaluated | |
+| **campaign_rule_actions** | [**Array<CampaignRuleAction>**](CampaignRuleAction.html) | the list of actions that are executed if the conditions are satisfied | |
+| **match_any_conditions** | **BOOLEAN** |  | [optional] [default to false]|
+| **enabled** | **BOOLEAN** |  | [optional] [default to false]|
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CampaignRuleAction.html.md

@@ -0,0 +1,16 @@
+---
+title: CampaignRuleAction
+---
+## PureCloud::CampaignRuleAction
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **parameters** | **Hash<String, String>** |  | [optional] |
+| **action_type** | **String** |  | [optional] |
+| **campaign_rule_action_entities** | [**CampaignRuleActionEntities**](CampaignRuleActionEntities.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CampaignRuleActionEntities.html.md

@@ -0,0 +1,15 @@
+---
+title: CampaignRuleActionEntities
+---
+## PureCloud::CampaignRuleActionEntities
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **campaigns** | [**Array<UriReference>**](UriReference.html) |  | [optional] |
+| **sequences** | [**Array<UriReference>**](UriReference.html) |  | [optional] |
+| **use_triggering_entity** | **BOOLEAN** |  | [optional] [default to false]|
+{: class="table table-striped"}
+
+

data/doc_out/CampaignRuleCondition.html.md

@@ -0,0 +1,15 @@
+---
+title: CampaignRuleCondition
+---
+## PureCloud::CampaignRuleCondition
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **parameters** | **Hash<String, String>** |  | [optional] |
+| **condition_type** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CampaignRuleEntities.html.md

@@ -0,0 +1,14 @@
+---
+title: CampaignRuleEntities
+---
+## PureCloud::CampaignRuleEntities
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **campaigns** | [**Array<UriReference>**](UriReference.html) |  | [optional] |
+| **sequences** | [**Array<UriReference>**](UriReference.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CampaignRuleEntityListing.html.md

@@ -0,0 +1,22 @@
+---
+title: CampaignRuleEntityListing
+---
+## PureCloud::CampaignRuleEntityListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<CampaignRule>**](CampaignRule.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/OutboundApi.html.md

@@ -11,6 +11,7 @@ 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.|
@@ -26,6 +27,8 @@ Method | HTTP request | Description
 |[**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|
@@ -54,6 +57,7 @@ Method | HTTP request | Description
 |[**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|
@@ -69,6 +73,7 @@ Method | HTTP request | Description
 |[**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's state changed |
 |[**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | **PUT** /api/v2/outbound/contactlists/{contactListId} | Update a contact list.|
@@ -249,6 +254,62 @@ Name | Type | Description  | Notes
 
 
 
+<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)
@@ -1125,6 +1186,129 @@ Name | Type | Description  | Notes
 
 
 
+<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)
@@ -2783,6 +2967,62 @@ Name | Type | Description  | Notes
 
 
 
+<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)
@@ -3645,6 +3885,65 @@ Name | Type | Description  | Notes
 
 
 
+<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
+
+
+
 <a name="put_campaigns_campaign_id"></a>
 
 ## -[**Campaign**](Campaign.html) put_campaigns_campaign_id(campaign_id, body)