purecloudplatformclientv2 48.2.0 → 49.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe2cbdf65c92b1115d36f51ab4734b76a7b59e9c
-  data.tar.gz: 3af099101f33bfc1f29ba2a87fea84c92296e71b
+  metadata.gz: 69b95df13b20a40c40f3450bdb011906d2b755a2
+  data.tar.gz: 8537418c5e96f4563d51857675fbe1966475d8cf
 SHA512:
-  metadata.gz: ebed9f9d4cf6d20ded35a7964d8b86c8eb2dafffa609d9861c8c9e88987c0b54c616f88915732cc0a28d2a60b1f833b888af07db5be0e69aefacedf47904a43f
-  data.tar.gz: 3286593a4471c2b65a0f41ec672bdb3c257462edad16d0c0ba773e1c19e21f0ea148f5d7dc110409d7499be87dbbe8cd090c2d491b9f434c358fe797645112e0
+  metadata.gz: d0d16f811c9835d68b23ceee25b6d761e40b33ccd6874e2b3ee3deb61f8a50225e4c930fca757da4bab5864e2a19ebfa6fa89d66651612b64e5f529cfa2f58d0
+  data.tar.gz: 445775d33df28f803b668e5508d129f0619c0d95f5a0f2839bc7511a50a24143529f534295ab5afa0cd0f580707734da0c7b7f6873b6efda9574970558e17c32

data/README.md

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

data/docs/AnalyticsFlow.md

@@ -12,6 +12,8 @@ title: AnalyticsFlow
 | **flow_version** | **String** | The version of this flow | [optional] |
 | **flow_type** | **String** | The type of this flow | [optional] |
 | **exit_reason** | **String** | The exit reason for this flow, e.g. DISCONNECT | [optional] |
+| **entry_reason** | **String** | The particular entry reason for this flow, e.g. an address, userId, or flowId | [optional] |
+| **entry_type** | **String** | The entry type for this flow | [optional] |
 | **transfer_type** | **String** | The type of transfer for flows that ended with a transfer | [optional] |
 | **transfer_target_name** | **String** | The name of a transfer target | [optional] |
 | **transfer_target_address** | **String** | The address of a transfer target | [optional] |

data/docs/AnalyticsSession.md

@@ -48,6 +48,13 @@ title: AnalyticsSession
 | **flow** | [**AnalyticsFlow**](AnalyticsFlow.html) | IVR flow execution associated with this session | [optional] |
 | **media_endpoint_stats** | [**Array<AnalyticsMediaEndpointStat>**](AnalyticsMediaEndpointStat.html) | Media endpoint stats associated with this session | [optional] |
 | **recording** | **BOOLEAN** | Flag determining if an audio recording was started or not | [optional] |
+| **journey_customer_id** | **String** | ID of the journey customer | [optional] |
+| **journey_customer_id_type** | **String** | Type of the journey customer ID | [optional] |
+| **journey_customer_session_id** | **String** | ID of the journey customer session | [optional] |
+| **journey_customer_session_id_type** | **String** | Type of the journey customer session ID | [optional] |
+| **journey_action_id** | **String** | Journey action ID | [optional] |
+| **journey_action_map_id** | **String** | Journey action map ID | [optional] |
+| **journey_action_map_version** | **String** | Journey action map version | [optional] |
 {: class="table table-striped"}
 
 

data/docs/AuthorizationApi.md

@@ -529,9 +529,8 @@ Returns the maximum allowed number of divisions.
 
 Wraps GET /api/v2/authorization/divisions/limit 
 
-Requires ANY permissions: 
+Requires NO permissions: 
 
-* authorization:division:view
 
 
 ### Example

data/docs/ExternalContact.md

@@ -23,6 +23,7 @@ title: ExternalContact
 | **address** | [**ContactAddress**](ContactAddress.html) |  | [optional] |
 | **twitter_id** | [**TwitterId**](TwitterId.html) |  | [optional] |
 | **line_id** | [**LineId**](LineId.html) |  | [optional] |
+| **whats_app_id** | [**WhatsAppId**](WhatsAppId.html) |  | [optional] |
 | **facebook_id** | [**FacebookId**](FacebookId.html) |  | [optional] |
 | **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |

data/docs/LocationDefinition.md

@@ -8,7 +8,7 @@ title: LocationDefinition
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
+| **name** | **String** | The name of the Location. | |
 | **address** | [**LocationAddress**](LocationAddress.html) |  | [optional] |
 | **address_verified** | **BOOLEAN** |  | [optional] |
 | **emergency_number** | [**LocationEmergencyNumber**](LocationEmergencyNumber.html) |  | [optional] |

data/docs/LocationUpdateDefinition.md

@@ -0,0 +1,19 @@
+---
+title: LocationUpdateDefinition
+---
+## PureCloud::LocationUpdateDefinition
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the Location. | [optional] |
+| **address** | [**LocationAddress**](LocationAddress.html) |  | [optional] |
+| **address_verified** | **BOOLEAN** |  | [optional] |
+| **emergency_number** | [**LocationEmergencyNumber**](LocationEmergencyNumber.html) |  | [optional] |
+| **state** | **String** | Current activity status of the location. | [optional] |
+| **version** | **Integer** |  | [optional] |
+| **path** | **Array<String>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/LocationsApi.md

@@ -8,12 +8,79 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | Description
 ------------- | ------------- | -------------
+[**delete_location**](LocationsApi.html#delete_location) | Delete a location
 [**get_location**](LocationsApi.html#get_location) | Get Location by ID.
 [**get_locations**](LocationsApi.html#get_locations) | Get a list of all locations.
 [**get_locations_search**](LocationsApi.html#get_locations_search) | Search locations using the q64 value returned from a previous search
+[**patch_location**](LocationsApi.html#patch_location) | Update a location
+[**post_locations**](LocationsApi.html#post_locations) | Create a location
 [**post_locations_search**](LocationsApi.html#post_locations_search) | Search locations
 {: class="table table-striped"}
 
+<a name="delete_location"></a>
+
+## - delete_location(location_id)
+
+
+
+Delete a location
+
+
+
+Wraps DELETE /api/v2/locations/{locationId} 
+
+Requires ANY permissions: 
+
+* directory:location:delete
+
+
+### 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::LocationsApi.new
+
+location_id = "location_id_example" # String | Location ID
+
+
+begin
+  #Delete a location
+  api_instance.delete_location(location_id)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->delete_location: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| Location ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_location"></a>
 
 ## -[**LocationDefinition**](LocationDefinition.html) get_location(location_id)
@@ -115,6 +182,7 @@ api_instance = PureCloud::LocationsApi.new
 opts = { 
   page_size: 25, # Integer | Page size
   page_number: 1, # Integer | Page number
+  id: ["id_example"], # Array<String> | id
   sort_order: "sort_order_example" # String | Sort order
 }
 
@@ -133,6 +201,7 @@ 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]  |
  **sort_order** | **String**| Sort order | [optional] <br />**Values**: asc, desc |
 {: class="table table-striped"}
 
@@ -216,6 +285,139 @@ Name | Type | Description  | Notes
 
 
 
+<a name="patch_location"></a>
+
+## -[**LocationDefinition**](LocationDefinition.html) patch_location(location_id, body)
+
+
+
+Update a location
+
+
+
+Wraps PATCH /api/v2/locations/{locationId} 
+
+Requires ANY permissions: 
+
+* directory:location:edit
+
+
+### 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::LocationsApi.new
+
+location_id = "location_id_example" # String | Location ID
+
+body = PureCloud::LocationUpdateDefinition.new # LocationUpdateDefinition | Location
+
+
+begin
+  #Update a location
+  result = api_instance.patch_location(location_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->patch_location: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **location_id** | **String**| Location ID |  |
+ **body** | [**LocationUpdateDefinition**](LocationUpdateDefinition.html)| Location |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**LocationDefinition**](LocationDefinition.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_locations"></a>
+
+## -[**LocationDefinition**](LocationDefinition.html) post_locations(body)
+
+
+
+Create a location
+
+
+
+Wraps POST /api/v2/locations 
+
+Requires ANY permissions: 
+
+* directory:location:add
+
+
+### 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::LocationsApi.new
+
+body = PureCloud::LocationDefinition.new # LocationDefinition | Location
+
+
+begin
+  #Create a location
+  result = api_instance.post_locations(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling LocationsApi->post_locations: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**LocationDefinition**](LocationDefinition.html)| Location |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**LocationDefinition**](LocationDefinition.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_locations_search"></a>
 
 ## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_locations_search(body)

data/docs/OAuthClient.md

@@ -20,6 +20,7 @@ title: OAuthClient
 | **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.  | |
 | **scope** | **Array<String>** | The scope requested by this client | |
+| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/OAuthClientListing.md

@@ -19,6 +19,7 @@ title: OAuthClientListing
 | **created_by** | [**UriReference**](UriReference.html) | User that created this client | [optional] |
 | **modified_by** | [**UriReference**](UriReference.html) | User that last modified this client | [optional] |
 | **scope** | **Array<String>** | The scope requested by this client | |
+| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/ObjectsApi.md

@@ -301,9 +301,8 @@ Returns the maximum allowed number of divisions.
 
 Wraps GET /api/v2/authorization/divisions/limit 
 
-Requires ANY permissions: 
+Requires NO permissions: 
 
-* authorization:division:view
 
 
 ### Example

data/docs/OrgOAuthClient.md

@@ -15,6 +15,7 @@ title: OrgOAuthClient
 | **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.  | |
 | **scope** | **Array<String>** | The scope requested by this client | |
+| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client | [optional] |
 | **organization** | [**NamedEntity**](NamedEntity.html) | The  oauth client's organization. | [optional] |
 {: class="table table-striped"}
 

data/docs/RoleDivision.md

@@ -0,0 +1,14 @@
+---
+title: RoleDivision
+---
+## PureCloud::RoleDivision
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **role_id** | **String** | Role to be associated with the given division which forms a grant | |
+| **division_id** | **String** | Division associated with the given role which forms a grant | |
+{: class="table table-striped"}
+
+

data/docs/ViewFilter.md

@@ -62,6 +62,15 @@ title: ViewFilter
 | **is_consult_transferred** | **BOOLEAN** | Indicates filtering for consult transferred | [optional] |
 | **remote_participants** | **Array<String>** | The list of remote participants used to filter the view | [optional] |
 | **status_list** | **Array<String>** | A list of status for the configuration view | [optional] |
+| **flow_ids** | **Array<String>** | The list of flow Ids | [optional] |
+| **flow_outcome_ids** | **Array<String>** | A list of outcome ids of the flow | [optional] |
+| **flow_outcome_values** | **Array<String>** | A list of outcome values of the flow | [optional] |
+| **flow_destination_types** | **Array<String>** | The list of destination types of the flow | [optional] |
+| **flow_disconnect_reasons** | **Array<String>** | The list of reasons for the flow to disconnect | [optional] |
+| **flow_types** | **Array<String>** | A list of types of the flow | [optional] |
+| **flow_entry_types** | **Array<String>** | A list of types of the flow entry | [optional] |
+| **flow_entry_reasons** | **Array<String>** | A list of reasons of flow entry | [optional] |
+| **group_ids** | **Array<String>** | A list of directory group ids | [optional] |
 {: class="table table-striped"}
 
 

data/docs/WebChatDeployment.md

@@ -14,6 +14,7 @@ title: WebChatDeployment
 | **authentication_url** | **String** | URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples | [optional] |
 | **disabled** | **BOOLEAN** |  | [optional] |
 | **web_chat_config** | [**WebChatConfig**](WebChatConfig.html) |  | [optional] |
+| **allowed_domains** | **Array<String>** |  | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/WhatsAppId.md

@@ -0,0 +1,14 @@
+---
+title: WhatsAppId
+---
+## PureCloud::WhatsAppId
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **phone_number** | [**PhoneNumber**](PhoneNumber.html) | The phone number associated with this WhatsApp account | [optional] |
+| **display_name** | **String** | The displayName of this person's account in WhatsApp | [optional] |
+{: class="table table-striped"}
+
+

data/lib/purecloudplatformclientv2.rb

@@ -119,9 +119,7 @@ require 'purecloudplatformclientv2/models/attachment'
 require 'purecloudplatformclientv2/models/attempt_limits'
 require 'purecloudplatformclientv2/models/attempt_limits_entity_listing'
 require 'purecloudplatformclientv2/models/attribute'
-require 'purecloudplatformclientv2/models/attribute_entity_listing'
 require 'purecloudplatformclientv2/models/attribute_filter_item'
-require 'purecloudplatformclientv2/models/attribute_query_request'
 require 'purecloudplatformclientv2/models/audit_change'
 require 'purecloudplatformclientv2/models/audit_entity'
 require 'purecloudplatformclientv2/models/audit_entity_reference'
@@ -779,6 +777,7 @@ require 'purecloudplatformclientv2/models/location_emergency_number'
 require 'purecloudplatformclientv2/models/location_entity_listing'
 require 'purecloudplatformclientv2/models/location_search_criteria'
 require 'purecloudplatformclientv2/models/location_search_request'
+require 'purecloudplatformclientv2/models/location_update_definition'
 require 'purecloudplatformclientv2/models/locations_search_response'
 require 'purecloudplatformclientv2/models/lock_info'
 require 'purecloudplatformclientv2/models/logical_interface_entity_listing'
@@ -1089,6 +1088,7 @@ require 'purecloudplatformclientv2/models/rest_error_detail'
 require 'purecloudplatformclientv2/models/retention_duration'
 require 'purecloudplatformclientv2/models/reverse_whitepages_lookup_result'
 require 'purecloudplatformclientv2/models/ring'
+require 'purecloudplatformclientv2/models/role_division'
 require 'purecloudplatformclientv2/models/route_group'
 require 'purecloudplatformclientv2/models/route_group_attributes'
 require 'purecloudplatformclientv2/models/route_group_list'
@@ -1398,6 +1398,7 @@ require 'purecloudplatformclientv2/models/wfm_user_entity_listing'
 require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_reference'
 require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update'
 require 'purecloudplatformclientv2/models/wfm_versioned_entity_metadata'
+require 'purecloudplatformclientv2/models/whats_app_id'
 require 'purecloudplatformclientv2/models/work_plan'
 require 'purecloudplatformclientv2/models/work_plan_activity'
 require 'purecloudplatformclientv2/models/work_plan_list_item_response'
@@ -1423,7 +1424,6 @@ require 'purecloudplatformclientv2/models/writable_entity'
 require 'purecloudplatformclientv2/api/alerting_api'
 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'