purecloudplatformclientv2 17.0.0 → 18.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74432111406b6b21c3b4a559ce6021181f9a2323
-  data.tar.gz: 5ea605b047d01d07b1ea570fd8e5a7d4f4fce354
+  metadata.gz: b8336bf12693f306bd254531f6174cef51ea2319
+  data.tar.gz: 8943726b5377b1b95e65eb47b2021e4b406820cb
 SHA512:
-  metadata.gz: ea31062e3bba89b3755b7c2ec65fdc57db90a9723c933f34962671d55b72cb7d0838ddb628a32eb876a1416b3e9112db241bfefe93bd0d391e2760218cb9462e
-  data.tar.gz: 360464dc239a594c4f3143e894122b60c4da265c297b7575466c746b1665f672aac69de85316432a63d829103a000f5a6c38a073472c45e1333557be4455bf7a
+  metadata.gz: 599b3aa8a3ff8886088f2be201a23a1d193fabde63b4d186b85e381a2b26e04df90860dfe57313c164763c3d4361f9eca5c682bc68816d34f662dfd5631f320e
+  data.tar.gz: 17b4fe1e2b329f5111c9d6cce1acd9dbde0df8c630100afddccf7134b76f93cefe44e9ef28e5b1b2f7f518ed50bb76efaba318b9f5f73effd73b200115ef52cc

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=17.0.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=18.0.0)
 
 Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
 ### from rubygems.org
 
 ~~~ ruby
-gem install 'purecloudplatformclientv2', '~> 17.0.0'
+gem install 'purecloudplatformclientv2', '~> 18.0.0'
 ~~~
 
 ### Install from Git

data/docs/AnalyticsConversation.md

@@ -7,11 +7,11 @@ title: AnalyticsConversation
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **conversation_id** | **String** |  | [optional] |
-| **conversation_start** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **conversation_end** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **participants** | [**Array<AnalyticsParticipant>**](AnalyticsParticipant.html) |  | [optional] |
-| **evaluations** | [**Array<AnalyticsEvaluation>**](AnalyticsEvaluation.html) |  | [optional] |
+| **conversation_id** | **String** | Unique identifier for the conversation | [optional] |
+| **conversation_start** | **DateTime** | Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **conversation_end** | **DateTime** | Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **participants** | [**Array<AnalyticsParticipant>**](AnalyticsParticipant.html) | Participants in the conversation | [optional] |
+| **evaluations** | [**Array<AnalyticsEvaluation>**](AnalyticsEvaluation.html) | Evaluations tied to this conersation | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsConversationSegment.md

@@ -7,18 +7,18 @@ title: AnalyticsConversationSegment
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **segment_start** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **segment_end** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **queue_id** | **String** |  | [optional] |
-| **wrap_up_code** | **String** |  | [optional] |
-| **wrap_up_note** | **String** |  | [optional] |
+| **segment_start** | **DateTime** | The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **segment_end** | **DateTime** | The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **queue_id** | **String** | Queue identifier | [optional] |
+| **wrap_up_code** | **String** | Wrapup Code id | [optional] |
+| **wrap_up_note** | **String** | Note entered by an agent during after-call work | [optional] |
 | **wrap_up_tags** | **Array<String>** |  | [optional] |
 | **error_code** | **String** |  | [optional] |
-| **disconnect_type** | **String** |  | [optional] |
-| **segment_type** | **String** |  | [optional] |
+| **disconnect_type** | **String** | A description of the event that disconnected the segment | [optional] |
+| **segment_type** | **String** | The activity taking place for the participant in the segment | [optional] |
 | **requested_routing_user_ids** | **Array<String>** |  | [optional] |
 | **requested_routing_skill_ids** | **Array<String>** |  | [optional] |
-| **requested_language_id** | **String** |  | [optional] |
+| **requested_language_id** | **String** | A unique identifier for the language requested for an interaction. | [optional] |
 | **properties** | [**Array<AnalyticsProperty>**](AnalyticsProperty.html) |  | [optional] |
 | **source_conversation_id** | **String** |  | [optional] |
 | **destination_conversation_id** | **String** |  | [optional] |
@@ -26,7 +26,7 @@ title: AnalyticsConversationSegment
 | **destination_session_id** | **String** |  | [optional] |
 | **sip_response_codes** | **Array<Integer>** |  | [optional] |
 | **q850_response_codes** | **Array<Integer>** |  | [optional] |
-| **conference** | **BOOLEAN** |  | [optional] |
+| **conference** | **BOOLEAN** | Indicates whether the segment was a conference | [optional] |
 | **group_id** | **String** |  | [optional] |
 | **subject** | **String** |  | [optional] |
 | **audio_muted** | **BOOLEAN** |  | [optional] |

data/docs/AnalyticsEvaluation.md

@@ -7,16 +7,16 @@ title: AnalyticsEvaluation
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **evaluation_id** | **String** |  | [optional] |
-| **evaluator_id** | **String** |  | [optional] |
-| **user_id** | **String** |  | [optional] |
-| **event_time** | **String** |  | [optional] |
-| **queue_id** | **String** |  | [optional] |
-| **form_id** | **String** |  | [optional] |
-| **context_id** | **String** |  | [optional] |
-| **form_name** | **String** |  | [optional] |
-| **geto_total_score** | **Integer** |  | [optional] |
-| **geto_total_critical_score** | **Integer** |  | [optional] |
+| **evaluation_id** | **String** | Unique identifier for the evaluation | [optional] |
+| **evaluator_id** | **String** | A unique identifier of the PureCloud user who evaluated the interaction | [optional] |
+| **user_id** | **String** | Unique identifier for the user being evaluated | [optional] |
+| **event_time** | **String** | Specifies when an evaluation occurred | [optional] |
+| **queue_id** | **String** | Unique identifier for the queue the conversation was on | [optional] |
+| **form_id** | **String** | Unique identifier for the form used to evaluate the conversation/agent | [optional] |
+| **context_id** | **String** | A unique identifier for an evaluation form, regardless of version | [optional] |
+| **form_name** | **String** | Name of the evaluation form | [optional] |
+| **geto_total_score** | **Integer** | The total evaluation for interactions | [optional] |
+| **geto_total_critical_score** | **Integer** | The score for critical evaluation questions | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsParticipant.md

@@ -7,13 +7,13 @@ title: AnalyticsParticipant
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **participant_id** | **String** |  | [optional] |
-| **participant_name** | **String** |  | [optional] |
-| **user_id** | **String** |  | [optional] |
-| **purpose** | **String** |  | [optional] |
-| **external_contact_id** | **String** |  | [optional] |
-| **external_organization_id** | **String** |  | [optional] |
-| **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) |  | [optional] |
+| **participant_id** | **String** | Unique identifier for the participant | [optional] |
+| **participant_name** | **String** | A human readable name identifying the participant | [optional] |
+| **user_id** | **String** | If a user, then this will be the unique identifier for the user | [optional] |
+| **purpose** | **String** | The participant's purpose | [optional] |
+| **external_contact_id** | **String** | External Contact Identifier | [optional] |
+| **external_organization_id** | **String** | External Organization Identifier | [optional] |
+| **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | List of sessions associated to this participant | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AnalyticsSession.md

@@ -7,38 +7,38 @@ title: AnalyticsSession
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **media_type** | **String** |  | [optional] |
-| **session_id** | **String** |  | [optional] |
+| **media_type** | **String** | The session media type | [optional] |
+| **session_id** | **String** | The unique identifier of this session | [optional] |
 | **address_other** | **String** |  | [optional] |
 | **address_self** | **String** |  | [optional] |
-| **ani** | **String** |  | [optional] |
-| **direction** | **String** |  | [optional] |
-| **dnis** | **String** |  | [optional] |
-| **outbound_campaign_id** | **String** |  | [optional] |
-| **outbound_contact_id** | **String** |  | [optional] |
-| **outbound_contact_list_id** | **String** |  | [optional] |
-| **disposition_analyzer** | **String** |  | [optional] |
-| **disposition_name** | **String** |  | [optional] |
-| **edge_id** | **String** |  | [optional] |
+| **ani** | **String** | Automatic Number Identification (caller's number) | [optional] |
+| **direction** | **String** | Direction | [optional] |
+| **dnis** | **String** | Automatic Number Identification (caller's number) | [optional] |
+| **outbound_campaign_id** | **String** | (Dialer) Unique identifier of the outbound campaign | [optional] |
+| **outbound_contact_id** | **String** | (Dialer) Unique identifier of the contact | [optional] |
+| **outbound_contact_list_id** | **String** | (Dialer) Unique identifier of the contact list that this contact belongs to | [optional] |
+| **disposition_analyzer** | **String** | (Dialer) Unique identifier of the contact list that this contact belongs to | [optional] |
+| **disposition_name** | **String** | (Dialer) Result of the analysis (for example disposition.classification.callable.machine)  | [optional] |
+| **edge_id** | **String** | Unique identifier of the edge device | [optional] |
 | **remote_name_displayable** | **String** |  | [optional] |
-| **room_id** | **String** |  | [optional] |
-| **monitored_session_id** | **String** |  | [optional] |
+| **room_id** | **String** | Unique identifier for the room | [optional] |
+| **monitored_session_id** | **String** | The sessionID being monitored | [optional] |
 | **monitored_participant_id** | **String** |  | [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] |
-| **script_id** | **String** |  | [optional] |
-| **skip_enabled** | **BOOLEAN** |  | [optional] |
-| **timeout_seconds** | **Integer** |  | [optional] |
-| **cobrowse_role** | **String** |  | [optional] |
-| **cobrowse_room_id** | **String** |  | [optional] |
+| **callback_user_name** | **String** | The name of the user requesting a call back | [optional] |
+| **callback_numbers** | **Array<String>** | List of numbers to callback | [optional] |
+| **callback_scheduled_time** | **DateTime** | Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **script_id** | **String** | Scheduled callback date/time, Date time is represented as an ISO-8601 string.  | [optional] |
+| **skip_enabled** | **BOOLEAN** | (Dialer) Whether the agent can skip the dialer contact | [optional] |
+| **timeout_seconds** | **Integer** | The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling | [optional] |
+| **cobrowse_role** | **String** | Describe side of the cobrowse (sharer or viewer) | [optional] |
+| **cobrowse_room_id** | **String** | A unique identifier for a PureCloud Cobrowse room. | [optional] |
 | **media_bridge_id** | **String** |  | [optional] |
-| **screen_share_address_self** | **String** |  | [optional] |
-| **sharing_screen** | **BOOLEAN** |  | [optional] |
-| **screen_share_room_id** | **String** |  | [optional] |
-| **video_room_id** | **String** |  | [optional] |
-| **video_address_self** | **String** |  | [optional] |
-| **segments** | [**Array<AnalyticsConversationSegment>**](AnalyticsConversationSegment.html) |  | [optional] |
+| **screen_share_address_self** | **String** | Direct ScreenShare address | [optional] |
+| **sharing_screen** | **BOOLEAN** | Flag determining if screenShare is started or not (true/false) | [optional] |
+| **screen_share_room_id** | **String** | A unique identifier for a PureCloud ScreenShare room. | [optional] |
+| **video_room_id** | **String** | A unique identifier for a PureCloud video room. | [optional] |
+| **video_address_self** | **String** | Direct Video address | [optional] |
+| **segments** | [**Array<AnalyticsConversationSegment>**](AnalyticsConversationSegment.html) | List of segments for this session | [optional] |
 {: class="table table-striped"}
 
 

data/docs/BillingApi.md

@@ -0,0 +1,75 @@
+---
+title: BillingApi
+---
+
+## PureCloud::BillingApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**get_billing_reports_billableusage**](BillingApi.html#get_billing_reports_billableusage) | Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
+{: class="table table-striped"}
+
+<a name="get_billing_reports_billableusage"></a>
+
+## -[**BillingUsageReport**](BillingUsageReport.html) get_billing_reports_billableusage(start_date, end_date)
+
+Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
+
+
+
+Wraps GET /api/v2/billing/reports/billableusage 
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# 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::BillingApi.new
+
+start_date = DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+
+end_date = DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+
+
+begin
+  #Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
+  result = api_instance.get_billing_reports_billableusage(start_date, end_date)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling BillingApi->get_billing_reports_billableusage: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | **DateTime**| The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |  |
+ **end_date** | **DateTime**| The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**BillingUsageReport**](BillingUsageReport.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/BillingUsage.md

@@ -0,0 +1,15 @@
+---
+title: BillingUsage
+---
+## PureCloud::BillingUsage
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Identifies the billable usage. | |
+| **total_usage** | **String** | The total amount of usage, expressed as a decimal number in string format. | |
+| **resources** | [**Array<BillingUsageResource>**](BillingUsageResource.html) | The resources for which usage was observed (e.g. license users, devices). | |
+{: class="table table-striped"}
+
+

data/docs/BillingUsageReport.md

@@ -0,0 +1,18 @@
+---
+title: BillingUsageReport
+---
+## PureCloud::BillingUsageReport
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **start_date** | **DateTime** | The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **end_date** | **DateTime** | The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **usages** | [**Array<BillingUsage>**](BillingUsage.html) | The usages for the given period. | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BillingUsageResource.md

@@ -0,0 +1,14 @@
+---
+title: BillingUsageResource
+---
+## PureCloud::BillingUsageResource
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Identifies the resource (e.g. license user, device). | |
+| **date** | **DateTime** | The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+{: class="table table-striped"}
+
+

data/docs/CallCommand.md

@@ -8,6 +8,7 @@ title: CallCommand
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **call_number** | **String** | The phone number to dial for this call. | |
+| **phone_column** | **String** | For a dialer preview or scheduled callback, the phone column associated with the phone number | [optional] |
 {: class="table table-striped"}
 
 

data/docs/Conversation.md

@@ -16,7 +16,7 @@ title: Conversation
 | **conversation_ids** | **Array<String>** | A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference. | [optional] |
 | **max_participants** | **Integer** | If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. | [optional] |
 | **recording_state** | **String** | On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording. | [optional] |
-| **state** | **String** | The conversation's state.  Values can be: 'disconnected' | [optional] |
+| **state** | **String** | The conversation's state | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/CreateQueueRequest.md

@@ -9,15 +9,15 @@ title: CreateQueueRequest
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **description** | **String** | The resource's description. | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
 | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
 | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |

data/docs/DID.md

@@ -9,15 +9,15 @@ title: DID
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** | The name of the entity. | |
-| **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **description** | **String** | The resource's description. | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **phone_number** | **String** |  | [optional] |
 | **did_pool** | [**UriReference**](UriReference.html) |  | [optional] |
 | **owner** | [**UriReference**](UriReference.html) | A Uri reference to the owner of this DID, which is either a User or an IVR | [optional] |

data/docs/DIDPool.md

@@ -9,15 +9,15 @@ title: DIDPool
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** | The name of the entity. | |
-| **description** | **String** |  | [optional] |
-| **version** | **Integer** |  | [optional] |
-| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **modified_by** | **String** |  | [optional] |
-| **created_by** | **String** |  | [optional] |
-| **state** | **String** |  | [optional] |
-| **modified_by_app** | **String** |  | [optional] |
-| **created_by_app** | **String** |  | [optional] |
+| **description** | **String** | The resource's description. | [optional] |
+| **version** | **Integer** | The current version of the resource. | [optional] |
+| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
+| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
+| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
+| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
+| **created_by_app** | **String** | The application that created the resource. | [optional] |
 | **start_phone_number** | **String** | The starting phone number for the range of this DID pool. Must be in E.164 format | |
 | **end_phone_number** | **String** | The ending phone number for the range of this DID pool. Must be in E.164 format | |
 | **comments** | **String** |  | [optional] |

data/docs/DirectoryUserDevicesListing.md

@@ -0,0 +1,22 @@
+---
+title: DirectoryUserDevicesListing
+---
+## PureCloud::DirectoryUserDevicesListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<UserDevice>**](UserDevice.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"}
+
+