purecloudplatformclientv2 62.0.0 → 66.0.0

data/docs/SipDownloadResponse.md

@@ -0,0 +1,14 @@
+---
+title: SipDownloadResponse
+---
+## PureCloud::SipDownloadResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **download_id** | **String** | unique id of the downloaded file | [optional] |
+| **document_id** | **String** | Document id of pcap file | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SipSearchResult.md

@@ -0,0 +1,20 @@
+---
+title: SipSearchResult
+---
+## PureCloud::SipSearchResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **status** | **Integer** | Status of the search request | [optional] |
+| **sid** | **String** | Session id associated to the search request | [optional] |
+| **auth** | **String** | Auth token used for this search request | [optional] |
+| **message** | **String** | Any messages returned from homer as part of the response | [optional] |
+| **data** | [**Array<HomerRecord>**](HomerRecord.html) | Homer search data that is returned | [optional] |
+| **count** | **Integer** | Number of records returned | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Site.md

@@ -25,6 +25,7 @@ title: Site
 | **addresses** | [**Array<Contact>**](Contact.html) |  | [optional] |
 | **edges** | [**Array<Edge>**](Edge.html) |  | [optional] |
 | **edge_auto_update_config** | [**EdgeAutoUpdateConfig**](EdgeAutoUpdateConfig.html) | Recurrance rule, time zone, and start/end settings for automatic edge updates for this site | [optional] |
+| **media_regions_use_latency_based** | **BOOLEAN** |  | [optional] |
 | **location** | [**LocationDefinition**](LocationDefinition.html) | Location | |
 | **managed** | **BOOLEAN** |  | [optional] |
 | **ntp_settings** | [**NTPSettings**](NTPSettings.html) | Network Time Protocol settings for the site | [optional] |

data/docs/SmsPhoneNumber.md

@@ -24,6 +24,7 @@ title: SmsPhoneNumber
 | **renewal_date** | **DateTime** | Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **auto_renewable** | **String** | Renewal time period of this phone number, if the phoneNumberType is shortcode. | [optional] |
 | **address_id** | [**SmsAddress**](SmsAddress.html) | The id of an address attached to this phone number. | [optional] |
+| **short_code_billing_type** | **String** | BillingType of this phone number, if the phoneNumberType is shortcode. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/SuggestApi.md

@@ -68,7 +68,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **q64** | **String**| q64 |  |
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation, images |
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
 {: class="table table-striped"}
 
@@ -138,7 +138,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **q64** | **String**| q64 |  |
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation, images |
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
 {: class="table table-striped"}
 

data/docs/SurveyAggregateDataContainer.md

@@ -0,0 +1,14 @@
+---
+title: SurveyAggregateDataContainer
+---
+## PureCloud::SurveyAggregateDataContainer
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** | A mapping from dimension to value | [optional] |
+| **data** | [**Array<StatisticalResponse>**](StatisticalResponse.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyAggregateQueryClause.md

@@ -0,0 +1,14 @@
+---
+title: SurveyAggregateQueryClause
+---
+## PureCloud::SurveyAggregateQueryClause
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates | |
+| **predicates** | [**Array<SurveyAggregateQueryPredicate>**](SurveyAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
+{: class="table table-striped"}
+
+

data/docs/SurveyAggregateQueryFilter.md

@@ -0,0 +1,15 @@
+---
+title: SurveyAggregateQueryFilter
+---
+## PureCloud::SurveyAggregateQueryFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
+| **clauses** | [**Array<SurveyAggregateQueryClause>**](SurveyAggregateQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
+| **predicates** | [**Array<SurveyAggregateQueryPredicate>**](SurveyAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyAggregateQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: SurveyAggregateQueryPredicate
+---
+## PureCloud::SurveyAggregateQueryPredicate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Optional type, can usually be inferred | [optional] |
+| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
+| **operator** | **String** | Optional operator, default is matches | [optional] |
+| **value** | **String** | Right hand side for dimension predicates | [optional] |
+| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyAggregateQueryResponse.md

@@ -0,0 +1,13 @@
+---
+title: SurveyAggregateQueryResponse
+---
+## PureCloud::SurveyAggregateQueryResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **results** | [**Array<SurveyAggregateDataContainer>**](SurveyAggregateDataContainer.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyAggregationQuery.md

@@ -0,0 +1,20 @@
+---
+title: SurveyAggregationQuery
+---
+## PureCloud::SurveyAggregationQuery
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
+| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
+| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
+| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
+| **filter** | [**SurveyAggregateQueryFilter**](SurveyAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
+| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
+| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
+| **views** | [**Array<SurveyAggregationView>**](SurveyAggregationView.html) | Custom derived metric views | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyAggregationView.md

@@ -0,0 +1,16 @@
+---
+title: SurveyAggregationView
+---
+## PureCloud::SurveyAggregationView
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **target** | **String** | Target metric name | |
+| **name** | **String** | A unique name for this view. Must be distinct from other views and built-in metric names. | |
+| **function** | **String** | Type of view you wish to create | |
+| **range** | [**AggregationRange**](AggregationRange.html) | Range of numbers for slicing up data | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyDetailQueryClause.md

@@ -0,0 +1,14 @@
+---
+title: SurveyDetailQueryClause
+---
+## PureCloud::SurveyDetailQueryClause
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates | |
+| **predicates** | [**Array<SurveyDetailQueryPredicate>**](SurveyDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
+{: class="table table-striped"}
+
+

data/docs/SurveyDetailQueryFilter.md

@@ -0,0 +1,15 @@
+---
+title: SurveyDetailQueryFilter
+---
+## PureCloud::SurveyDetailQueryFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
+| **clauses** | [**Array<SurveyDetailQueryClause>**](SurveyDetailQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
+| **predicates** | [**Array<SurveyDetailQueryPredicate>**](SurveyDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyDetailQueryPredicate.md

@@ -0,0 +1,18 @@
+---
+title: SurveyDetailQueryPredicate
+---
+## PureCloud::SurveyDetailQueryPredicate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Optional type, can usually be inferred | [optional] |
+| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
+| **metric** | **String** | Left hand side for metric predicates | [optional] |
+| **operator** | **String** | Optional operator, default is matches | [optional] |
+| **value** | **String** | Right hand side for dimension or metric predicates | [optional] |
+| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension or metric predicates | [optional] |
+{: class="table table-striped"}
+
+

data/docs/TelephonyApi.md

@@ -0,0 +1,223 @@
+---
+title: TelephonyApi
+---
+
+## PureCloud::TelephonyApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**get_telephony_siptraces**](TelephonyApi.html#get_telephony_siptraces) | Fetch SIP metadata
+[**get_telephony_siptraces_download_download_id**](TelephonyApi.html#get_telephony_siptraces_download_download_id) | Get signed S3 URL for a pcap download
+[**post_telephony_siptraces_download**](TelephonyApi.html#post_telephony_siptraces_download) | Request a download of a pcap file to S3
+{: class="table table-striped"}
+
+<a name="get_telephony_siptraces"></a>
+
+## [**SipSearchResult**](SipSearchResult.html) get_telephony_siptraces(date_start, date_end, opts)
+
+
+
+Fetch SIP metadata
+
+Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
+
+Wraps GET /api/v2/telephony/siptraces 
+
+Requires ANY permissions: 
+
+* telephony:pcap:view
+
+
+### Example
+```{"language":"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::TelephonyApi.new
+
+date_start = DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+
+date_end = DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+
+opts = { 
+  call_id: "call_id_example", # String | unique identification of the placed call
+  to_user: "to_user_example", # String | User to who the call was placed
+  from_user: "from_user_example", # String | user who placed the call
+  conversation_id: "conversation_id_example" # String | Unique identification of the conversation
+}
+
+begin
+  #Fetch SIP metadata
+  result = api_instance.get_telephony_siptraces(date_start, date_end, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling TelephonyApi->get_telephony_siptraces: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date_start** | **DateTime**| Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |  |
+ **date_end** | **DateTime**| End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |  |
+ **call_id** | **String**| unique identification of the placed call | [optional]  |
+ **to_user** | **String**| User to who the call was placed | [optional]  |
+ **from_user** | **String**| user who placed the call | [optional]  |
+ **conversation_id** | **String**| Unique identification of the conversation | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SipSearchResult**](SipSearchResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_telephony_siptraces_download_download_id"></a>
+
+## [**SignedUrlResponse**](SignedUrlResponse.html) get_telephony_siptraces_download_download_id(download_id)
+
+
+
+Get signed S3 URL for a pcap download
+
+
+
+Wraps GET /api/v2/telephony/siptraces/download/{downloadId} 
+
+Requires ANY permissions: 
+
+* telephony:pcap:view
+
+
+### Example
+```{"language":"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::TelephonyApi.new
+
+download_id = "download_id_example" # String | unique id for the downloaded file in S3
+
+
+begin
+  #Get signed S3 URL for a pcap download
+  result = api_instance.get_telephony_siptraces_download_download_id(download_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling TelephonyApi->get_telephony_siptraces_download_download_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **download_id** | **String**| unique id for the downloaded file in S3 |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SignedUrlResponse**](SignedUrlResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_telephony_siptraces_download"></a>
+
+## [**SipDownloadResponse**](SipDownloadResponse.html) post_telephony_siptraces_download(sip_search_public_request)
+
+
+
+Request a download of a pcap file to S3
+
+
+
+Wraps POST /api/v2/telephony/siptraces/download 
+
+Requires ANY permissions: 
+
+* telephony:pcap:add
+
+
+### Example
+```{"language":"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::TelephonyApi.new
+
+sip_search_public_request = PureCloud::SIPSearchPublicRequest.new # SIPSearchPublicRequest | 
+
+
+begin
+  #Request a download of a pcap file to S3
+  result = api_instance.post_telephony_siptraces_download(sip_search_public_request)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling TelephonyApi->post_telephony_siptraces_download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sip_search_public_request** | [**SIPSearchPublicRequest**](SIPSearchPublicRequest.html)|  |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**SipDownloadResponse**](SipDownloadResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+