purecloudplatformclientv2 17.0.0 → 18.0.0

data/docs/OutboundRoute.md

@@ -9,15 +9,15 @@ title: OutboundRoute
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **classification_types** | **Array<String>** | The site associated to the outbound route. | |
 | **enabled** | **BOOLEAN** |  | [optional] |
 | **distribution** | **String** |  | [optional] |

data/docs/OutboundRouteBase.md

@@ -9,15 +9,15 @@ title: OutboundRouteBase
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **classification_types** | **Array<String>** | The site associated to the outbound route. | |
 | **enabled** | **BOOLEAN** |  | [optional] |
 | **distribution** | **String** |  | [optional] |

data/docs/OutboundSettings.md

@@ -0,0 +1,20 @@
+---
+title: OutboundSettings
+---
+## PureCloud::OutboundSettings
+
+## 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] |
+| **max_calls_per_agent** | **Integer** | The maximum number of calls that can be placed per agent on any campaign | [optional] |
+| **max_line_utilization** | **Float** | The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0] | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Phone.md

@@ -9,15 +9,15 @@ title: Phone
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **site** | [**UriReference**](UriReference.html) | The site associated to the phone. | |
 | **phone_base_settings** | [**UriReference**](UriReference.html) | Phone Base Settings | |
 | **line_base_settings** | [**UriReference**](UriReference.html) |  | [optional] |

data/docs/PhoneBase.md

@@ -9,15 +9,15 @@ title: PhoneBase
 |------------ | ------------- | ------------- | -------------|
 | **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_meta_base** | [**UriReference**](UriReference.html) | A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process. | |
 | **lines** | [**Array<LineBase>**](LineBase.html) | The list of linebases associated with the phone base. | |
 | **properties** | **Hash<String, Object>** |  | [optional] |

data/docs/Queue.md

@@ -9,15 +9,15 @@ title: Queue
 |------------ | ------------- | ------------- | -------------|
 | **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/Schedule.md

@@ -8,16 +8,16 @@ title: Schedule
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **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] |
+| **name** | **String** | The name of the entity. | |
+| **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** | [**LocalDateTime**](LocalDateTime.html) | Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS | [optional] |
 | **_end** | [**LocalDateTime**](LocalDateTime.html) | Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS | [optional] |
 | **rrule** | **String** | An iCal Recurrence Rule (RRULE) string. | |

data/docs/ScheduleGroup.md

@@ -8,16 +8,16 @@ title: ScheduleGroup
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **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] |
+| **name** | **String** | The name of the entity. | |
+| **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] |
 | **time_zone** | **String** | The timezone the schedules are a part of.  This is not a schedule property to allow a schedule to be used in multiple timezones. | [optional] |
 | **open_schedules** | [**Array<UriReference>**](UriReference.html) | The schedules defining the hours an organization is open. | [optional] |
 | **closed_schedules** | [**Array<UriReference>**](UriReference.html) | The schedules defining the hours an organization is closed. | [optional] |

data/docs/SchemaCategory.md

@@ -9,15 +9,15 @@ title: SchemaCategory
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/Site.md

@@ -9,15 +9,15 @@ title: Site
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **primary_sites** | [**Array<UriReference>**](UriReference.html) |  | [optional] |
 | **secondary_sites** | [**Array<UriReference>**](UriReference.html) |  | [optional] |
 | **primary_edges** | [**Array<Edge>**](Edge.html) |  | [optional] |

data/docs/Trunk.md

@@ -9,15 +9,15 @@ title: Trunk
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **trunk_type** | **String** | The type of this trunk. | [optional] |
 | **edge** | [**UriReference**](UriReference.html) | The Edge using this trunk. | [optional] |
 | **trunk_base** | [**UriReference**](UriReference.html) | The trunk base configuration used on this trunk. | [optional] |

data/docs/TrunkBase.md

@@ -9,15 +9,15 @@ title: TrunkBase
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **trunk_metabase** | [**UriReference**](UriReference.html) | The meta-base this trunk is based on. | |
 | **properties** | **Hash<String, Object>** |  | [optional] |
 | **trunk_type** | **String** | The type of this trunk base. | |

data/docs/UserDevice.md

@@ -0,0 +1,22 @@
+---
+title: UserDevice
+---
+## PureCloud::UserDevice
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **device_token** | **String** | device token sent by mobile clients. | |
+| **notification_id** | **String** | notification id of the device. | |
+| **make** | **String** | make of the device. | |
+| **model** | **String** | Device model | |
+| **accept_notifications** | **BOOLEAN** | if the device accepts notifications | |
+| **type** | **String** | type of the device; ios or android | |
+| **session_hash** | **String** |  | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserQueue.md

@@ -9,15 +9,15 @@ title: UserQueue
 |------------ | ------------- | ------------- | -------------|
 | **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/UsersApi.md

@@ -1334,7 +1334,7 @@ Name | Type | Description  | Notes
  **id** | [**Array<String>**](String.html)| id | [optional]  |
  **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
- **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, deleted |
+ **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted |
 {: class="table table-striped"}
 
 

data/lib/purecloudplatformclientv2.rb

@@ -92,6 +92,9 @@ require 'purecloudplatformclientv2/models/available_language_list'
 require 'purecloudplatformclientv2/models/available_topic'
 require 'purecloudplatformclientv2/models/available_topic_entity_listing'
 require 'purecloudplatformclientv2/models/available_translations'
+require 'purecloudplatformclientv2/models/billing_usage'
+require 'purecloudplatformclientv2/models/billing_usage_report'
+require 'purecloudplatformclientv2/models/billing_usage_resource'
 require 'purecloudplatformclientv2/models/bullseye'
 require 'purecloudplatformclientv2/models/calibration'
 require 'purecloudplatformclientv2/models/calibration_assignment'
@@ -341,6 +344,7 @@ require 'purecloudplatformclientv2/models/dialer_event_entity_listing'
 require 'purecloudplatformclientv2/models/dialer_preview'
 require 'purecloudplatformclientv2/models/dialer_rule'
 require 'purecloudplatformclientv2/models/digit_length'
+require 'purecloudplatformclientv2/models/directory_user_devices_listing'
 require 'purecloudplatformclientv2/models/disconnect_reason'
 require 'purecloudplatformclientv2/models/dnc_list'
 require 'purecloudplatformclientv2/models/dnc_list_create'
@@ -658,6 +662,7 @@ require 'purecloudplatformclientv2/models/outbound_route'
 require 'purecloudplatformclientv2/models/outbound_route_base'
 require 'purecloudplatformclientv2/models/outbound_route_base_entity_listing'
 require 'purecloudplatformclientv2/models/outbound_route_entity_listing'
+require 'purecloudplatformclientv2/models/outbound_settings'
 require 'purecloudplatformclientv2/models/pin_configuration'
 require 'purecloudplatformclientv2/models/page'
 require 'purecloudplatformclientv2/models/paging_spec'
@@ -930,6 +935,7 @@ require 'purecloudplatformclientv2/models/user_conversation_summary_notification
 require 'purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary'
 require 'purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary_detail'
 require 'purecloudplatformclientv2/models/user_details_query'
+require 'purecloudplatformclientv2/models/user_device'
 require 'purecloudplatformclientv2/models/user_entity_listing'
 require 'purecloudplatformclientv2/models/user_image'
 require 'purecloudplatformclientv2/models/user_list_schedule_request_body'
@@ -1019,6 +1025,7 @@ require 'purecloudplatformclientv2/api/analytics_api'
 require 'purecloudplatformclientv2/api/architect_api'
 require 'purecloudplatformclientv2/api/attributes_api'
 require 'purecloudplatformclientv2/api/authorization_api'
+require 'purecloudplatformclientv2/api/billing_api'
 require 'purecloudplatformclientv2/api/content_management_api'
 require 'purecloudplatformclientv2/api/conversations_api'
 require 'purecloudplatformclientv2/api/external_contacts_api'
@@ -1031,6 +1038,7 @@ require 'purecloudplatformclientv2/api/integrations_api'
 require 'purecloudplatformclientv2/api/languages_api'
 require 'purecloudplatformclientv2/api/license_api'
 require 'purecloudplatformclientv2/api/locations_api'
+require 'purecloudplatformclientv2/api/mobile_devices_api'
 require 'purecloudplatformclientv2/api/notifications_api'
 require 'purecloudplatformclientv2/api/o_auth_api'
 require 'purecloudplatformclientv2/api/organization_api'

data/lib/purecloudplatformclientv2/api/billing_api.rb

@@ -0,0 +1,104 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require "uri"
+
+module PureCloud
+  class BillingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
+    # 
+    # @param start_date The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param end_date The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param [Hash] opts the optional parameters
+    # @return [BillingUsageReport]
+    def get_billing_reports_billableusage(start_date, end_date, opts = {})
+      data, _status_code, _headers = get_billing_reports_billableusage_with_http_info(start_date, end_date, opts)
+      return data
+    end
+
+    # Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
+    # 
+    # @param start_date The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param end_date The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BillingUsageReport, Fixnum, Hash)>] BillingUsageReport data, response status code and response headers
+    def get_billing_reports_billableusage_with_http_info(start_date, end_date, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BillingApi.get_billing_reports_billableusage ..."
+      end
+      
+      
+      # verify the required parameter 'start_date' is set
+      fail ArgumentError, "Missing the required parameter 'start_date' when calling BillingApi.get_billing_reports_billableusage" if start_date.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'end_date' is set
+      fail ArgumentError, "Missing the required parameter 'end_date' when calling BillingApi.get_billing_reports_billableusage" if end_date.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/billing/reports/billableusage".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'startDate'] = start_date
+      query_params[:'endDate'] = end_date
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'BillingUsageReport')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BillingApi#get_billing_reports_billableusage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end