purecloudplatformclientv2 21.0.0 → 22.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0290484bac4ae9254616679078b43623f6c371a
-  data.tar.gz: fcc472ff711c91a9021acbab6e5d319e5949c59f
+  metadata.gz: 9910871f363db0adf820ad5887a74923109372f5
+  data.tar.gz: c46a51061d6d5446b0d36c735a90a1a6b5612a4f
 SHA512:
-  metadata.gz: 95fa2f0bf645387b68dc002e480815da61ba493bfc2d43c18034c3c69409ae337f25fedee5c3b5de0ae5c2a60902ec3542488ea2a963a35cd071ac8de4c658c6
-  data.tar.gz: c922fbc8e316d7919cf6c692d53d963cc2cc64210dfee9c43fb76226276040792718ff526ba37f29a7b0416c19d157717b6269aa4813275a00109de6d29d6639
+  metadata.gz: b01ac29f66b90fc9200b76003a1b01541163ea54d2f3f2bc381453eae50c5a50228862eecb37f3d056850c7ae9ef1e6825dcce303bc88305e81977c0d590a6c0
+  data.tar.gz: 7cfbede19f9b301a6174a91095dd8e7046312926dc9f67e3a45253a147e30b929a1e2767367d620cc5411563a87a3635ea2483a06596a979a923e60737a75a53

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=21.0.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=22.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', '~> 21.0.0'
+gem install 'purecloudplatformclientv2', '~> 22.0.0'
 ~~~
 
 ### Install from Git

data/docs/Entity.md

@@ -8,7 +8,6 @@ title: Entity
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/GroupProfile.md

@@ -0,0 +1,18 @@
+---
+title: GroupProfile
+---
+## PureCloud::GroupProfile
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **state** | **String** | The state of the user resource | [optional] |
+| **date_modified** | **DateTime** | Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **version** | **Integer** | The version of the group resource | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/GroupsApi.md

@@ -13,6 +13,7 @@ Method | Description
 [**get_fieldconfig**](GroupsApi.html#get_fieldconfig) | Fetch field config for an entity type
 [**get_group**](GroupsApi.html#get_group) | Get group
 [**get_group_members**](GroupsApi.html#get_group_members) | Get group members
+[**get_group_profile**](GroupsApi.html#get_group_profile) | Get group profile
 [**get_groups**](GroupsApi.html#get_groups) | Get a group list
 [**get_groups_search**](GroupsApi.html#get_groups_search) | Search groups using the q64 value returned from a previous search
 [**post_group_members**](GroupsApi.html#post_group_members) | Add members
@@ -328,6 +329,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_group_profile"></a>
+
+## -[**GroupProfile**](GroupProfile.html) get_group_profile(group_id)
+
+Get group profile
+
+
+
+Wraps GET /api/v2/groups/{groupId}/profile 
+
+
+### 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::GroupsApi.new
+
+group_id = "group_id_example" # String | groupId
+
+
+begin
+  #Get group profile
+  result = api_instance.get_group_profile(group_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling GroupsApi->get_group_profile: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| groupId |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**GroupProfile**](GroupProfile.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_groups"></a>
 
 ## -[**GroupEntityListing**](GroupEntityListing.html) get_groups(opts)

data/docs/InboundRoute.md

@@ -17,7 +17,7 @@ title: InboundRoute
 | **from_name** | **String** | The sender name to use for outgoing replies. | |
 | **from_email** | **String** | The sender email to use for outgoing replies. | |
 | **flow** | [**UriReference**](UriReference.html) | The flow to use for processing the email. | [optional] |
-| **reply_route** | [**UriReference**](UriReference.html) | The route to use for email replies. | [optional] |
+| **reply_email_address** | [**QueueEmailAddress**](QueueEmailAddress.html) | The route to use for email replies. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/JsonNode.md

@@ -14,12 +14,12 @@ title: JsonNode
 | **object** | **BOOLEAN** |  | [optional] |
 | **boolean** | **BOOLEAN** |  | [optional] |
 | **number** | **BOOLEAN** |  | [optional] |
-| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **value_node** | **BOOLEAN** |  | [optional] |
 | **container_node** | **BOOLEAN** |  | [optional] |
 | **missing_node** | **BOOLEAN** |  | [optional] |
 | **pojo** | **BOOLEAN** |  | [optional] |
 | **integral_number** | **BOOLEAN** |  | [optional] |
+| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **short** | **BOOLEAN** |  | [optional] |
 | **int** | **BOOLEAN** |  | [optional] |
 | **long** | **BOOLEAN** |  | [optional] |

data/docs/MediaPolicies.md

@@ -10,6 +10,7 @@ title: MediaPolicies
 | **call_policy** | [**CallMediaPolicy**](CallMediaPolicy.html) | Conditions and actions for calls | [optional] |
 | **chat_policy** | [**ChatMediaPolicy**](ChatMediaPolicy.html) | Conditions and actions for chats | [optional] |
 | **email_policy** | [**EmailMediaPolicy**](EmailMediaPolicy.html) | Conditions and actions for emails | [optional] |
+| **message_policy** | [**MessageMediaPolicy**](MessageMediaPolicy.html) | Conditions and actions for messages | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MessageMediaPolicy.md

@@ -0,0 +1,14 @@
+---
+title: MessageMediaPolicy
+---
+## PureCloud::MessageMediaPolicy
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **actions** | [**PolicyActions**](PolicyActions.html) | Actions applied when specified conditions are met | [optional] |
+| **conditions** | [**MessageMediaPolicyConditions**](MessageMediaPolicyConditions.html) | Conditions for when actions should be applied | [optional] |
+{: class="table table-striped"}
+
+

data/docs/MessageMediaPolicyConditions.md

@@ -0,0 +1,17 @@
+---
+title: MessageMediaPolicyConditions
+---
+## PureCloud::MessageMediaPolicyConditions
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **for_users** | [**Array<User>**](User.html) |  | [optional] |
+| **date_ranges** | **Array<String>** |  | [optional] |
+| **for_queues** | [**Array<Queue>**](Queue.html) |  | [optional] |
+| **wrapup_codes** | [**Array<WrapupCode>**](WrapupCode.html) |  | [optional] |
+| **time_allowed** | [**TimeAllowed**](TimeAllowed.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NamedEntity.md

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

data/docs/OrgOAuthClient.md

@@ -14,7 +14,7 @@ title: OrgOAuthClient
 | **created_by** | [**UriReference**](UriReference.html) | User that created this client | [optional] |
 | **modified_by** | [**UriReference**](UriReference.html) | User that last modified this client | [optional] |
 | **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client.  | |
-| **organization** | [**Entity**](Entity.html) | The  oauth client's organization. | [optional] |
+| **organization** | [**NamedEntity**](NamedEntity.html) | The  oauth client's organization. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/RoutingApi.md

@@ -2170,7 +2170,7 @@ api_instance = PureCloud::RoutingApi.new
 
 queue_id = "queue_id_example" # String | Queue ID
 
-body = [PureCloud::WrapupCode.new] # Array<WrapupCode> | List of wrapup codes
+body = [PureCloud::Entity.new] # Array<Entity> | List of wrapup codes
 
 
 begin
@@ -2187,7 +2187,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **queue_id** | **String**| Queue ID |  |
- **body** | [**Array&lt;WrapupCode&gt;**](WrapupCode.html)| List of wrapup codes |  |
+ **body** | [**Array&lt;Entity&gt;**](Entity.html)| List of wrapup codes |  |
 {: class="table table-striped"}
 
 

data/docs/TokenInfo.md

@@ -7,8 +7,8 @@ title: TokenInfo
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **organization** | [**Entity**](Entity.html) | The current organization | [optional] |
-| **home_organization** | [**Entity**](Entity.html) | The token's home organization | [optional] |
+| **organization** | [**NamedEntity**](NamedEntity.html) | The current organization | [optional] |
+| **home_organization** | [**NamedEntity**](NamedEntity.html) | The token's home organization | [optional] |
 | **o_auth_client** | [**OrgOAuthClient**](OrgOAuthClient.html) |  | [optional] |
 {: class="table table-striped"}
 

data/docs/UserConversationSummary.md

@@ -11,6 +11,7 @@ title: UserConversationSummary
 | **call** | [**MediaSummary**](MediaSummary.html) |  | [optional] |
 | **callback** | [**MediaSummary**](MediaSummary.html) |  | [optional] |
 | **email** | [**MediaSummary**](MediaSummary.html) |  | [optional] |
+| **message** | [**MediaSummary**](MediaSummary.html) |  | [optional] |
 | **chat** | [**MediaSummary**](MediaSummary.html) |  | [optional] |
 | **social_expression** | [**MediaSummary**](MediaSummary.html) |  | [optional] |
 | **video** | [**MediaSummary**](MediaSummary.html) |  | [optional] |

data/docs/UserExpands.md

@@ -0,0 +1,19 @@
+---
+title: UserExpands
+---
+## PureCloud::UserExpands
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **routing_status** | [**RoutingStatus**](RoutingStatus.html) | ACD routing status | [optional] |
+| **presence** | [**UserPresence**](UserPresence.html) | Active presence | [optional] |
+| **conversation_summary** | [**UserConversationSummary**](UserConversationSummary.html) | Summary of conversion statistics for conversation types. | [optional] |
+| **out_of_office** | [**OutOfOffice**](OutOfOffice.html) | Determine if out of office is enabled | [optional] |
+| **geolocation** | [**Geolocation**](Geolocation.html) | Current geolocation position | [optional] |
+| **station** | [**UserStations**](UserStations.html) | Effective, default, and last station information | [optional] |
+| **authorization** | [**UserAuthorization**](UserAuthorization.html) | Roles and permissions assigned to the user | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserProfile.md

@@ -0,0 +1,19 @@
+---
+title: UserProfile
+---
+## PureCloud::UserProfile
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **state** | **String** | The state of the user resource | [optional] |
+| **date_modified** | **DateTime** | Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **version** | **Integer** | The version of the group resource | |
+| **expands** | [**UserExpands**](UserExpands.html) | User information expansions | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserProfileEntityListing.md

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

data/docs/UsersApi.md

@@ -14,6 +14,7 @@ Method | Description
 [**delete_user_station_associatedstation**](UsersApi.html#delete_user_station_associatedstation) | Clear associated station
 [**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station
 [**get_fieldconfig**](UsersApi.html#get_fieldconfig) | Fetch field config for an entity type
+[**get_profiles_users**](UsersApi.html#get_profiles_users) | Get a user profile listing
 [**get_user**](UsersApi.html#get_user) | Get user.
 [**get_user_adjacents**](UsersApi.html#get_user_adjacents) | Get adjacents
 [**get_user_callforwarding**](UsersApi.html#get_user_callforwarding) | Get a user's CallForwarding
@@ -21,6 +22,7 @@ Method | Description
 [**get_user_favorites**](UsersApi.html#get_user_favorites) | Get favorites
 [**get_user_geolocation**](UsersApi.html#get_user_geolocation) | Get a user's Geolocation
 [**get_user_outofoffice**](UsersApi.html#get_user_outofoffice) | Get a OutOfOffice
+[**get_user_profile**](UsersApi.html#get_user_profile) | Get user profile
 [**get_user_profileskills**](UsersApi.html#get_user_profileskills) | List profile skills for a user
 [**get_user_queues**](UsersApi.html#get_user_queues) | Get queues for user
 [**get_user_roles**](UsersApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
@@ -406,6 +408,78 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_profiles_users"></a>
+
+## -[**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
+
+Get a user profile listing
+
+
+
+Wraps GET /api/v2/profiles/users 
+
+
+### 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::UsersApi.new
+
+opts = { 
+  page_size: 25, # Integer | Page size
+  page_number: 1, # Integer | Page number
+  id: ["id_example"], # Array<String> | id
+  jid: ["jid_example"], # Array<String> | jid
+  sort_order: "ASC", # String | Ascending or descending sort order
+  expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+  state: "active" # String | Only list users of this state
+}
+
+begin
+  #Get a user profile listing
+  result = api_instance.get_profiles_users(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_profiles_users: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **id** | [**Array&lt;String&gt;**](String.html)| id | [optional]  |
+ **jid** | [**Array&lt;String&gt;**](String.html)| jid | [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 |
+ **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, deleted |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserProfileEntityListing**](UserProfileEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_user"></a>
 
 ## -[**User**](User.html) get_user(user_id, opts)
@@ -846,6 +920,69 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_user_profile"></a>
+
+## -[**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
+
+Get user profile
+
+
+
+Wraps GET /api/v2/users/{userId}/profile 
+
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | userId
+
+opts = { 
+  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+  #Get user profile
+  result = api_instance.get_user_profile(user_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_user_profile: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| userId |  |
+ **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 |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserProfile**](UserProfile.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_user_profileskills"></a>
 
 ## -Array&lt;String&gt;** get_user_profileskills(user_id)