purecloud 0.41.1 → 0.42.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 436a2a8469fc9b946bc51096ab299f647af66f2b
-  data.tar.gz: 9410ddd0df5409a9bd69174a865938be7ceb9a60
+  metadata.gz: 6661827bdb19af4bbff03a111d405443b0839aa3
+  data.tar.gz: bb2b9eb2d60981ff80847a9ea76adefaa70cd3da
 SHA512:
-  metadata.gz: ad359681b414d4f71d82b58bd86a66da88fa6a7b7d84bf9028e2a9a77cf3853a22392061aabdde0997ea60effe87544c5f47bb6108e0c446f96cbbd671876cee
-  data.tar.gz: 99ff4f6fd2dfc32b4cb516af6885c7bc4408e0047dd88efba2e940b74f223bac24995de1d79aabed07748cd0f3defc220a659d8ed260e31e8ec8e2746901a0fb
+  metadata.gz: 59519b1aead7fa69c78bbb2d09abdcc66109de36c43a6f7dc9f4ac2b7a6c722e3d33aa7fda6353d41d85e8058b2f330396c04fb1d0454395de12ce935b5c2802
+  data.tar.gz: 4be24251d6ac6ea5869d9471866f35c2290ec3c95862ccea60d45dc33d8501bc5828fd5ae873dcdf2625f5a4b10b3c5f5c3760f71d704b759011e5afcb947219

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.41.1
-- Build date: 2016-05-31T02:28:43.823Z
+- Package version: 0.42.1
+- Build date: 2016-06-05T03:13:29.878Z
 
 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.41.1'
+    gem 'purecloud', '~> 0.42.1'
 
 ### Install from Git
 

data/config-ruby.json

@@ -1 +1 @@
-{"gemVersion":"0.41.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.41.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
+{"gemVersion":"0.42.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.42.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}

data/doc_out/ADFS.html.md

@@ -0,0 +1,20 @@
+---
+title: ADFS
+---
+## PureCloud::ADFS
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **relying_party_identifier** | **String** |  | [optional] |
+| **certificate** | **String** |  | [optional] |
+| **issuer_uri** | **String** |  | [optional] |
+| **sso_target_uri** | **String** |  | [optional] |
+| **disabled** | **BOOLEAN** |  | [optional] [default to false]|
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CodesRequest.html.md

@@ -0,0 +1,14 @@
+---
+title: CodesRequest
+---
+## PureCloud::CodesRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **organization_id** | **String** |  | [optional] |
+| **add_communication_code** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/ContactSort.html.md

@@ -9,6 +9,7 @@ title: ContactSort
 |------------ | ------------- | ------------- | -------------|
 | **field_name** | **String** |  | [optional] |
 | **direction** | **String** |  | [optional] |
+| **numeric** | **BOOLEAN** |  | [optional] [default to false]|
 {: class="table table-striped"}
 
 

data/doc_out/ContentQueryRequest.html.md

@@ -14,6 +14,7 @@ title: ContentQueryRequest
 | **sort** | [**Array<ContentSortItem>**](ContentSortItem.html) |  | [optional] |
 | **filters** | [**Array<ContentFacetFilterItem>**](ContentFacetFilterItem.html) |  | [optional] |
 | **attribute_filters** | [**Array<ContentAttributeFilterItem>**](ContentAttributeFilterItem.html) |  | [optional] |
+| **include_shares** | **BOOLEAN** |  | [optional] [default to false]|
 {: class="table table-striped"}
 
 

data/doc_out/ConversationAssociation.html.md

@@ -0,0 +1,15 @@
+---
+title: ConversationAssociation
+---
+## PureCloud::ConversationAssociation
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **conversation_id** | **String** | Conversation ID | |
+| **communication_id** | **String** | Communication ID | |
+| **media_type** | **String** | Media type | |
+{: class="table table-striped"}
+
+

data/doc_out/CreateCallbackCommand.html.md

@@ -7,15 +7,15 @@ title: CreateCallbackCommand
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **script_id** | **String** |  | [optional] |
-| **queue_id** | **String** |  | [optional] |
-| **routing_data** | [**RoutingData**](RoutingData.html) |  | [optional] |
-| **callback_user_name** | **String** |  | [optional] |
-| **callback_numbers** | **Array<String>** |  | [optional] |
-| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **country_code** | **String** |  | [optional] |
-| **skip_enabled** | **BOOLEAN** |  | [optional] [default to false]|
-| **additional_info** | [**AdditionalInfo**](AdditionalInfo.html) |  | [optional] |
+| **script_id** | **String** | The identifier of the script to be used for the callback | [optional] |
+| **queue_id** | **String** | The identifier of the queue to be used for the callback. Either queueId or routingData is required. | [optional] |
+| **routing_data** | [**RoutingData**](RoutingData.html) | The routing data to be used for the callback. Either queueId or routingData is required. | [optional] |
+| **callback_user_name** | **String** | The name of the party to be called back. | [optional] |
+| **callback_numbers** | **Array<String>** | A list of phone numbers for the callback. | |
+| **callback_scheduled_time** | **DateTime** | The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **country_code** | **String** | The country code to be associated with the callback numbers. | [optional] |
+| **skip_enabled** | **BOOLEAN** | Indicates if the agent is allowed to skip the callback. | [optional] [default to false]|
+| **data** | **Hash<String, String>** | A map of key-value pairs containing additional data that can be associated to the callback. These could be set up for instance to be used in a customized script shown during the call. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" } | [optional] |
 {: class="table table-striped"}
 
 

data/doc_out/CreateIntegrationRequest.html.md

@@ -0,0 +1,16 @@
+---
+title: CreateIntegrationRequest
+---
+## PureCloud::CreateIntegrationRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** | The name of the integration, used to distinguish this integration from others of the same type. | |
+| **integration_type** | [**IntegrationType**](IntegrationType.html) | Type of the integration to create. | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/CustomerInteractionCenter.html.md

@@ -12,6 +12,7 @@ title: CustomerInteractionCenter
 | **certificate** | **String** |  | [optional] |
 | **issuer_uri** | **String** |  | [optional] |
 | **sso_target_uri** | **String** |  | [optional] |
+| **disabled** | **BOOLEAN** |  | [optional] [default to false]|
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/DocusignTemplateMapping.html.md

@@ -0,0 +1,16 @@
+---
+title: DocusignTemplateMapping
+---
+## PureCloud::DocusignTemplateMapping
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **docusign_template_id** | **String** |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/DomainEdgeSoftwareVersionDto.html.md

@@ -12,8 +12,8 @@ title: DomainEdgeSoftwareVersionDto
 | **edge_version** | **String** |  | [optional] |
 | **publish_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **edge_uri** | **String** |  | [optional] |
-| **latest_release** | **BOOLEAN** |  | [optional] [default to false]|
 | **current** | **BOOLEAN** |  | [optional] [default to false]|
+| **latest_release** | **BOOLEAN** |  | [optional] [default to false]|
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/EmbeddedSignatureView.html.md

@@ -8,6 +8,7 @@ title: EmbeddedSignatureView
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **view** | [**View**](View.html) |  | [optional] |
+| **envelope_id** | **String** | Envelope id for the terms and conditions associated with this request. | [optional] |
 {: class="table table-striped"}
 
 

data/doc_out/IdentityProviderApi.html.md

@@ -8,12 +8,14 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+|[**delete_adfs**](IdentityProviderApi.html#delete_adfs) | **DELETE** /api/v2/identityproviders/adfs | Delete ADFS Identity Provider|
 |[**delete_cic**](IdentityProviderApi.html#delete_cic) | **DELETE** /api/v2/identityproviders/cic | Delete Customer Interaction Center (CIC) Identity Provider|
 |[**delete_okta**](IdentityProviderApi.html#delete_okta) | **DELETE** /api/v2/identityproviders/okta | Delete Okta Identity Provider|
 |[**delete_onelogin**](IdentityProviderApi.html#delete_onelogin) | **DELETE** /api/v2/identityproviders/onelogin | Delete OneLogin Identity Provider|
 |[**delete_provider_id**](IdentityProviderApi.html#delete_provider_id) | **DELETE** /api/v2/identityproviders/{providerId} | Delete an identity provider|
 |[**delete_purecloud**](IdentityProviderApi.html#delete_purecloud) | **DELETE** /api/v2/identityproviders/purecloud | Delete PureCloud Identity Provider|
 |[**delete_salesforce**](IdentityProviderApi.html#delete_salesforce) | **DELETE** /api/v2/identityproviders/salesforce | Delete Salesforce Identity Provider|
+|[**get_adfs**](IdentityProviderApi.html#get_adfs) | **GET** /api/v2/identityproviders/adfs | Get ADFS Identity Provider|
 |[**get_cic**](IdentityProviderApi.html#get_cic) | **GET** /api/v2/identityproviders/cic | Get Customer Interaction Center (CIC) Identity Provider|
 |[**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | **GET** /api/v2/identityproviders | The list of identity providers|
 |[**get_okta**](IdentityProviderApi.html#get_okta) | **GET** /api/v2/identityproviders/okta | Get Okta Identity Provider|
@@ -21,6 +23,7 @@ Method | HTTP request | Description
 |[**get_provider_id**](IdentityProviderApi.html#get_provider_id) | **GET** /api/v2/identityproviders/{providerId} | Get an identity provider|
 |[**get_purecloud**](IdentityProviderApi.html#get_purecloud) | **GET** /api/v2/identityproviders/purecloud | Get PureCloud Identity Provider|
 |[**get_salesforce**](IdentityProviderApi.html#get_salesforce) | **GET** /api/v2/identityproviders/salesforce | Get Salesforce Identity Provider|
+|[**put_adfs**](IdentityProviderApi.html#put_adfs) | **PUT** /api/v2/identityproviders/adfs | Update/Create ADFS Identity Provider|
 |[**put_cic**](IdentityProviderApi.html#put_cic) | **PUT** /api/v2/identityproviders/cic | Update/Create Customer Interaction Center (CIC) Identity Provider|
 |[**put_okta**](IdentityProviderApi.html#put_okta) | **PUT** /api/v2/identityproviders/okta | Update/Create Okta Identity Provider|
 |[**put_onelogin**](IdentityProviderApi.html#put_onelogin) | **PUT** /api/v2/identityproviders/onelogin | Update/Create OneLogin Identity Provider|
@@ -29,6 +32,55 @@ Method | HTTP request | Description
 |[**put_salesforce**](IdentityProviderApi.html#put_salesforce) | **PUT** /api/v2/identityproviders/salesforce | Update/Create Salesforce Identity Provider|
 {: class="table table-striped"}
 
+<a name="delete_adfs"></a>
+
+## - delete_adfs
+
+Delete ADFS Identity Provider
+
+
+
+### 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::IdentityProviderApi.new
+
+begin
+  #Delete ADFS Identity Provider
+  api_instance.delete_adfs
+rescue PureCloud::ApiError => e
+  puts "Exception when calling IdentityProviderApi->delete_adfs: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="delete_cic"></a>
 
 ## - delete_cic
@@ -323,6 +375,56 @@ nil (empty response body)
 
 
 
+<a name="get_adfs"></a>
+
+## -[**ADFS**](ADFS.html) get_adfs
+
+Get ADFS Identity Provider
+
+
+
+### 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::IdentityProviderApi.new
+
+begin
+  #Get ADFS Identity Provider
+  result = api_instance.get_adfs
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling IdentityProviderApi->get_adfs: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ADFS**](ADFS.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_cic"></a>
 
 ## -[**CustomerInteractionCenter**](CustomerInteractionCenter.html) get_cic
@@ -673,6 +775,62 @@ This endpoint does not need any parameter.
 
 
 
+<a name="put_adfs"></a>
+
+## - put_adfs(opts)
+
+Update/Create ADFS Identity Provider
+
+
+
+### 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::IdentityProviderApi.new
+
+opts = { 
+  body: PureCloud::ADFS.new # ADFS | Provider
+}
+
+begin
+  #Update/Create ADFS Identity Provider
+  api_instance.put_adfs(opts)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling IdentityProviderApi->put_adfs: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ADFS**](ADFS.html)| Provider | [optional] 
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="put_cic"></a>
 
 ## - put_cic(opts)

data/doc_out/Integration.html.md

@@ -8,12 +8,12 @@ title: Integration
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
-| **integration_type** | [**IntegrationType**](IntegrationType.html) | Type of the integration. | |
-| **state** | **String** | Configured state of the integration. | [optional] |
+| **name** | **String** | The name of the integration, used to distinguish this integration from others of the same type. | |
+| **integration_type** | [**IntegrationType**](IntegrationType.html) | Type of the integration | [optional] |
+| **state** | **String** | Configured state of the integration. | |
 | **config** | [**IntegrationConfiguration**](IntegrationConfiguration.html) | Configuration for the integration. | [optional] |
 | **last_status** | [**IntegrationStatusInfo**](IntegrationStatusInfo.html) | Last reported status of the integration. | [optional] |
-| **version** | **Integer** | Version number required for updates. | [optional] |
+| **version** | **Integer** | Version number required for updates. | |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/IntegrationConfiguration.html.md

@@ -9,11 +9,11 @@ title: IntegrationConfiguration
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **version** | **Integer** | Version number required for updates. | [optional] |
+| **version** | **Integer** | Version number required for updates. | |
 | **properties_schema_uri** | **String** | URI for the JSON Schema describing the configuration properties in the properties field. | [optional] |
 | **advanced_schema_uri** | **String** | URI for the JSON Schema describing the advanced configuration | [optional] |
-| **properties** | **Object** | Key-value configuration settings described by the schema in the propertiesSchemaUri field. | [optional] |
-| **advanced** | **Object** | Advanced configuration described by the schema in the advancedSchemaUri field. | [optional] |
+| **properties** | **Object** | Key-value configuration settings described by the schema in the propertiesSchemaUri field. | |
+| **advanced** | **Object** | Advanced configuration described by the schema in the advancedSchemaUri field. | |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/IntegrationStatusInfo.html.md

@@ -7,10 +7,10 @@ title: IntegrationStatusInfo
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **internal** | **String** | Machine-readable status as reported by the integration. | |
-| **effective** | **String** | Localized, human-readable, effective status of the integration. | |
+| **internal** | **String** | Machine-readable status as reported by the integration. | [optional] |
+| **effective** | **String** | Localized, human-readable, effective status of the integration. | [optional] |
 | **detail** | **String** | Localized status details for the integration. | [optional] |
-| **last_updated** | **DateTime** | Date and time (in UTC) when the integration status (i.e. the internal field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **last_updated** | **DateTime** | Date and time (in UTC) when the integration status (i.e. the internal field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 {: class="table table-striped"}
 
 

data/doc_out/IntegrationType.html.md

@@ -7,11 +7,11 @@ title: IntegrationType
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **id** | **String** | The ID of the integration type. | |
 | **name** | **String** |  | [optional] |
-| **description** | **String** | Localized description of the integration type. | |
-| **provider** | **String** | PureCloud provider of the integration type. | |
-| **images** | [**Array<UserImage>**](UserImage.html) | Collection of logos. | |
+| **description** | **String** | Localized description of the integration type. | [optional] |
+| **provider** | **String** | PureCloud provider of the integration type. | [optional] |
+| **images** | [**Array<UserImage>**](UserImage.html) | Collection of logos. | [optional] |
 | **config_properties_schema_uri** | **String** | URI of the schema describing the key-value properties needed to configure an integration of this type. | [optional] |
 | **config_advanced_schema_uri** | **String** | URI of the schema describing the advanced JSON document needed to configure an integration of this type. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |