purecloud 0.38.1 → 0.39.1

data/doc_out/QueueUtilizationDiagnostic.html.md

@@ -7,14 +7,14 @@ title: QueueUtilizationDiagnostic
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **queue** | [**UriReference**](UriReference.html) |  | [optional] |
-| **users_in_queue** | **Integer** |  | [optional] |
-| **active_users_in_queue** | **Integer** |  | [optional] |
-| **users_on_queue** | **Integer** |  | [optional] |
-| **users_not_utilized** | **Integer** |  | [optional] |
-| **users_on_queue_with_station** | **Integer** |  | [optional] |
-| **users_on_a_campaign_call** | **Integer** |  | [optional] |
-| **users_on_a_non_campaign_call** | **Integer** |  | [optional] |
+| **queue** | [**UriReference**](UriReference.html) | Identifier of the queue | [optional] |
+| **users_in_queue** | **Integer** | The number of users joined to the queue | [optional] |
+| **active_users_in_queue** | **Integer** | The number of users active on the queue | [optional] |
+| **users_on_queue** | **Integer** | The number of users with a status of on-queue | [optional] |
+| **users_not_utilized** | **Integer** | The number of users in the queue currently not engaged | [optional] |
+| **users_on_queue_with_station** | **Integer** | The number of users in the queue with a station | [optional] |
+| **users_on_a_campaign_call** | **Integer** | The number of users currently engaged in a campaign call | [optional] |
+| **users_on_a_non_campaign_call** | **Integer** | The number of users currently engaged in a communication that is not part of the campaign | [optional] |
 {: class="table table-striped"}
 
 

data/doc_out/ResponseSet.html.md

@@ -9,9 +9,9 @@ title: ResponseSet
 |------------ | ------------- | ------------- | -------------|
 | **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] |
+| **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] |
 | **responses** | [**Hash<String, Reaction>**](Reaction.html) | Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}} | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}

data/doc_out/RoutingApi.html.md

@@ -45,7 +45,7 @@ Method | HTTP request | Description
 |[**post_wrapupcodes**](RoutingApi.html#post_wrapupcodes) | **POST** /api/v2/routing/wrapupcodes | Create a wrap-up code|
 |[**put_email_domains_domainname_routes_route_id**](RoutingApi.html#put_email_domains_domainname_routes_route_id) | **PUT** /api/v2/routing/email/domains/{domainName}/routes/{routeId} | Update a route|
 |[**put_queues_queue_id**](RoutingApi.html#put_queues_queue_id) | **PUT** /api/v2/routing/queues/{queueId} | Update a queue|
-|[**put_skills_skill_id**](RoutingApi.html#put_skills_skill_id) | **PUT** /api/v2/routing/skills/{skillId} | Update Routing Skill|
+|[**put_user_id_routingskills_skill_id**](RoutingApi.html#put_user_id_routingskills_skill_id) | **PUT** /api/v2/users/{userId}/routingskills/{skillId} | Update routing skill proficiency or state.|
 |[**put_utilization**](RoutingApi.html#put_utilization) | **PUT** /api/v2/routing/utilization | Update the utilization settings.|
 |[**put_wrapupcodes_code_id**](RoutingApi.html#put_wrapupcodes_code_id) | **PUT** /api/v2/routing/wrapupcodes/{codeId} | Update wrap-up code|
 {: class="table table-striped"}
@@ -2209,11 +2209,11 @@ Name | Type | Description  | Notes
 
 
 
-<a name="put_skills_skill_id"></a>
+<a name="put_user_id_routingskills_skill_id"></a>
 
-## -[**RoutingSkill**](RoutingSkill.html) put_skills_skill_id(skill_id, opts)
+## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_id_routingskills_skill_id(user_id, skill_id, opts)
 
-Update Routing Skill
+Update routing skill proficiency or state.
 
 
 
@@ -2234,18 +2234,20 @@ end
 
 api_instance = PureCloud::RoutingApi.new
 
-skill_id = "skill_id_example" # String | Skill ID
+user_id = "user_id_example" # String | User ID
+
+skill_id = "skill_id_example" # String | 
 
 opts = { 
-  body: PureCloud::RoutingSkill.new # RoutingSkill | Skill
+  body: PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill
 }
 
 begin
-  #Update Routing Skill
-  result = api_instance.put_skills_skill_id(skill_id, opts)
+  #Update routing skill proficiency or state.
+  result = api_instance.put_user_id_routingskills_skill_id(user_id, skill_id, opts)
   p result
 rescue PureCloud::ApiError => e
-  puts "Exception when calling RoutingApi->put_skills_skill_id: #{e}"
+  puts "Exception when calling RoutingApi->put_user_id_routingskills_skill_id: #{e}"
 end
 ~~~
 
@@ -2253,14 +2255,15 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **skill_id** | **String**| Skill ID | 
- **body** | [**RoutingSkill**](RoutingSkill.html)| Skill | [optional] 
+ **user_id** | **String**| User ID | 
+ **skill_id** | **String**|  | 
+ **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | [optional] 
 {: class="table table-striped"}
 
 
 ### Return type
 
-[**RoutingSkill**](RoutingSkill.html)
+[**UserRoutingSkill**](UserRoutingSkill.html)
 
 ### HTTP request headers
 

data/doc_out/RoutingSkill.html.md

@@ -9,10 +9,9 @@ title: RoutingSkill
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | Date last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **state** | **String** | The current state for this skill. | [optional] |
 | **version** | **String** | Required when updating. Version must be the current version. Only the system can assign version. | [optional] |
-| **proficiency** | **String** |  | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/RuleSet.html.md

@@ -9,12 +9,12 @@ title: RuleSet
 |------------ | ------------- | ------------- | -------------|
 | **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] |
-| **contact_list** | [**UriReference**](UriReference.html) |  | [optional] |
-| **queue** | [**UriReference**](UriReference.html) |  | [optional] |
-| **rules** | [**Array<DialerRule>**](DialerRule.html) |  | [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] |
+| **contact_list** | [**UriReference**](UriReference.html) | The identifier of an example contact list that provides user-interface suggestions for contact-based conditions and actions | [optional] |
+| **queue** | [**UriReference**](UriReference.html) | The identifier of an example queue that provides user-interface suggestions for wrap-up associated conditions | [optional] |
+| **rules** | [**Array<DialerRule>**](DialerRule.html) | The list of rules | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/Salesforce.html.md

@@ -10,8 +10,8 @@ title: Salesforce
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
 | **certificate** | **String** |  | [optional] |
-| **issuer_uri** | **String** |  | [optional] |
 | **sso_target_uri** | **String** |  | [optional] |
+| **issuer_uri** | **String** |  | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/ScheduleInterval.html.md

@@ -0,0 +1,14 @@
+---
+title: ScheduleInterval
+---
+## PureCloud::ScheduleInterval
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **start** | **String** | scheduled start time represented as an ISO-8601 string; for example, yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **_end** | **String** | scheduled end time represented as an ISO-8601 string; for example, yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/SequenceSchedule.html.md

@@ -9,12 +9,12 @@ title: SequenceSchedule
 |------------ | ------------- | ------------- | -------------|
 | **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] |
-| **intervals** | [**Array<CampaignScheduleIntervals>**](CampaignScheduleIntervals.html) |  | [optional] |
-| **time_zone** | **String** |  | [optional] |
-| **sequence** | [**UriReference**](UriReference.html) |  | [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] |
+| **intervals** | [**Array<ScheduleInterval>**](ScheduleInterval.html) | a list of start and end times | |
+| **time_zone** | **String** | time zone identifier to be applied to the intervals; for example Africa/Abidjan | |
+| **sequence** | [**UriReference**](UriReference.html) | identifier of the sequence to be scheduled | |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/Station.html.md

@@ -15,6 +15,7 @@ title: Station
 | **primary_edge** | [**UriReference**](UriReference.html) |  | [optional] |
 | **secondary_edge** | [**UriReference**](UriReference.html) |  | [optional] |
 | **type** | **String** |  | [optional] |
+| **line_appearance_id** | **String** |  | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/doc_out/StationsApi.html.md

@@ -154,7 +154,8 @@ opts = {
   page_size: 25, # Integer | Page size
   page_number: 1, # Integer | Page number
   sort_by: "name", # String | Sort by
-  name: "name_example" # String | Name
+  name: "name_example", # String | Name
+  line_appearance_id: "line_appearance_id_example" # String | lineAppearanceId
 }
 
 begin
@@ -174,6 +175,7 @@ Name | Type | Description  | Notes
  **page_number** | **Integer**| Page number | [optional] [default to 1]
  **sort_by** | **String**| Sort by | [optional] [default to name]
  **name** | **String**| Name | [optional] 
+ **line_appearance_id** | **String**| lineAppearanceId | [optional] 
 {: class="table table-striped"}
 
 

data/doc_out/SupportCredit.html.md

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

data/doc_out/SupportCreditListing.html.md

@@ -0,0 +1,22 @@
+---
+title: SupportCreditListing
+---
+## PureCloud::SupportCreditListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **entities** | [**Array<SupportCredit>**](SupportCredit.html) |  | [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/SystemPresence.html.md

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

data/doc_out/TelephonyProvidersEdgeApi.html.md

@@ -22,6 +22,7 @@ Method | HTTP request | Description
 |[**delete_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId} | Delete an ednpoint|
 |[**delete_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_trunkbasesettings_trunkbasesettings_id) | **DELETE** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Delete a Trunk Base Settings object by ID|
 |[**get_providers_edges**](TelephonyProvidersEdgeApi.html#get_providers_edges) | **GET** /api/v2/telephony/providers/edges | Get the list of edges.|
+|[**get_providers_edges_availablelanguages**](TelephonyProvidersEdgeApi.html#get_providers_edges_availablelanguages) | **GET** /api/v2/telephony/providers/edges/availablelanguages | Get the list of available languages.|
 |[**get_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities) | **GET** /api/v2/telephony/providers/edges/certificateauthorities | Get the list of certificate authorities.|
 |[**get_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities_certificate_id) | **GET** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Get a certificate authority.|
 |[**get_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools) | **GET** /api/v2/telephony/providers/edges/didpools | Get a listing of DID Pools|
@@ -73,6 +74,7 @@ Method | HTTP request | Description
 |[**get_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_trunkbasesettings_id) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Get a Trunk Base Settings object by ID|
 |[**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | **GET** /api/v2/telephony/providers/edges/trunks | Get the list of available trunks.|
 |[**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | **GET** /api/v2/telephony/providers/edges/trunks/{trunkId} | Get a Trunk by ID|
+|[**get_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | **GET** /api/v2/telephony/providers/edges/trunkswithrecording | Get Counts of trunks that have recording disabled or enabled|
 |[**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | **GET** /api/v2/configuration/schemas/edges/vnext | Lists available schema categories|
 |[**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory} | List schemas of a specific category|
 |[**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} | List schemas of a specific category|
@@ -914,6 +916,56 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_providers_edges_availablelanguages"></a>
+
+## -[**AvailableLanguageList**](AvailableLanguageList.html) get_providers_edges_availablelanguages
+
+Get the list of available languages.
+
+
+
+### 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::TelephonyProvidersEdgeApi.new
+
+begin
+  #Get the list of available languages.
+  result = api_instance.get_providers_edges_availablelanguages
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_availablelanguages: #{e}"
+end
+~~~
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AvailableLanguageList**](AvailableLanguageList.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_providers_edges_certificateauthorities"></a>
 
 ## -[**CertificateAuthorityEntityListing**](CertificateAuthorityEntityListing.html) get_providers_edges_certificateauthorities
@@ -3586,7 +3638,8 @@ opts = {
   page_number: 1, # Integer | Page number
   page_size: 25, # Integer | Page size
   sort_by: "name", # String | Value by which to sort
-  sort_order: "ASC" # String | Sort order
+  sort_order: "ASC", # String | Sort order
+  recording_enabled: true # BOOLEAN | Filter trunks by recording enabled
 }
 
 begin
@@ -3606,6 +3659,7 @@ Name | Type | Description  | Notes
  **page_size** | **Integer**| Page size | [optional] [default to 25]
  **sort_by** | **String**| Value by which to sort | [optional] [default to name]
  **sort_order** | **String**| Sort order | [optional] [default to ASC]
+ **recording_enabled** | **BOOLEAN**| Filter trunks by recording enabled | [optional] 
 {: class="table table-striped"}
 
 
@@ -3918,6 +3972,63 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_providers_edges_trunkswithrecording"></a>
+
+## -[**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html) get_providers_edges_trunkswithrecording(opts)
+
+Get Counts of trunks that have recording disabled or enabled
+
+
+
+### 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::TelephonyProvidersEdgeApi.new
+
+opts = { 
+  trunk_type: "trunk_type_example" # String | The type of this trunk base.
+}
+
+begin
+  #Get Counts of trunks that have recording disabled or enabled
+  result = api_instance.get_providers_edges_trunkswithrecording(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_trunkswithrecording: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **trunk_type** | **String**| The type of this trunk base. | [optional] 
+{: class="table table-striped"}
+
+
+### Return type
+
+[**TrunkRecordingEnabledCount**](TrunkRecordingEnabledCount.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_schemas_edges_vnext"></a>
 
 ## -[**SchemaCategoryEntityListing**](SchemaCategoryEntityListing.html) get_schemas_edges_vnext(opts)

data/doc_out/TrunkRecordingEnabledCount.html.md

@@ -0,0 +1,14 @@
+---
+title: TrunkRecordingEnabledCount
+---
+## PureCloud::TrunkRecordingEnabledCount
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled_count** | **Integer** | The amount of trunks that have recording enabled | [optional] |
+| **disabled_count** | **Integer** | The amount of trunks that do not have recording enabled | [optional] |
+{: class="table table-striped"}
+
+

data/doc_out/UserImage.html.md

@@ -7,7 +7,7 @@ title: UserImage
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **resolution** | **String** |  | [optional] |
+| **resolution** | **String** | Height and/or width of image. ex: 640x480 or x128 | [optional] |
 | **image_uri** | **String** |  | [optional] |
 {: class="table table-striped"}