RubyGems - purecloudplatformclientv2 - Versions diffs - 60.0.0 → 61.0.0 - Mend

purecloudplatformclientv2 60.0.0 → 61.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (410) hide show

data/docs/BaseProgramEntity.md DELETED

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

data/docs/BaseTopicEntitiy.md DELETED

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

data/docs/CreateTopicRequest.md DELETED

@@ -1,20 +0,0 @@
----
-title: CreateTopicRequest
----
-## PureCloud::CreateTopicRequest
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **name** | **String** | The topic name | |
-| **description** | **String** | The topic description | [optional] |
-| **strictness** | **String** | The topic strictness | |
-| **program_ids** | **Array&lt;String&gt;** | The ids of programs associated to the topic | [optional] |
-| **tags** | **Array&lt;String&gt;** | The topic tags | [optional] |
-| **dialect** | **String** | The topic dialect | |
-| **participants** | **String** | The topic participants | |
-| **phrases** | [**Array&lt;Phrase&gt;**](Phrase.html) | The topic phrases | [optional] |
-{: class="table table-striped"}

data/docs/Phrase.md DELETED

@@ -1,15 +0,0 @@
----
-title: Phrase
----
-## PureCloud::Phrase
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **text** | **String** | The phrase text | |
-| **strictness** | **String** | The phrase strictness | |
-| **sentiment** | **String** | The phrase sentiment | |
-{: class="table table-striped"}

data/docs/Program.md DELETED

@@ -1,22 +0,0 @@
----
-title: Program
----
-## PureCloud::Program
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **applied** | **BOOLEAN** |  | [optional] |
-| **status** | **String** |  | [optional] |
-| **topics** | [**Array&lt;BaseTopicEntitiy&gt;**](BaseTopicEntitiy.html) |  | [optional] |
-| **tags** | **Array&lt;String&gt;** |  | [optional] |
-| **modified_by** | [**User**](User.html) |  | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **self_uri** | **String** | The URI for this object | [optional] |
-{: class="table table-striped"}

data/docs/SpeechTextAnalyticsApi.md DELETED

@@ -1,210 +0,0 @@
----
-title: SpeechTextAnalyticsApi
----
-## PureCloud::SpeechTextAnalyticsApi
-All URIs are relative to *https://api.mypurecloud.com*
-Method | Description
-------------- | ------------- | -------------
-[**get_speechandtextanalytics_program**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_program) | Get a Speech &amp; Text Analytics program by id
-[**get_speechandtextanalytics_topic**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_topic) | Get a Speech &amp; Text Analytics topic by id
-[**post_speechandtextanalytics_topics**](SpeechTextAnalyticsApi.html#post_speechandtextanalytics_topics) | Create new Speech &amp; Text Analytics topic
-{: class="table table-striped"}
-<a name="get_speechandtextanalytics_program"></a>
-## [**Program**](Program.html) get_speechandtextanalytics_program(program_id)
-Get a Speech & Text Analytics program by id
-Wraps GET /api/v2/speechandtextanalytics/programs/{programId}
-Requires ANY permissions:
-* speechAndTextAnalytics:program: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::SpeechTextAnalyticsApi.new
-program_id = "program_id_example" # String | The id of the topic to get
-begin
-  #Get a Speech & Text Analytics program by id
-  result = api_instance.get_speechandtextanalytics_program(program_id)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **program_id** | **String**| The id of the topic to get |  |
-{: class="table table-striped"}
-### Return type
-[**Program**](Program.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="get_speechandtextanalytics_topic"></a>
-## [**Topic**](Topic.html) get_speechandtextanalytics_topic(topic_id)
-Get a Speech & Text Analytics topic by id
-Wraps GET /api/v2/speechandtextanalytics/topics/{topicId}
-Requires ANY permissions:
-* speechAndTextAnalytics:topic: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::SpeechTextAnalyticsApi.new
-topic_id = "topic_id_example" # String | The id of the topic to get
-begin
-  #Get a Speech & Text Analytics topic by id
-  result = api_instance.get_speechandtextanalytics_topic(topic_id)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topic: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **topic_id** | **String**| The id of the topic to get |  |
-{: class="table table-striped"}
-### Return type
-[**Topic**](Topic.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="post_speechandtextanalytics_topics"></a>
-## [**Topic**](Topic.html) post_speechandtextanalytics_topics(body)
-Create new Speech & Text Analytics topic
-Wraps POST /api/v2/speechandtextanalytics/topics
-Requires ANY permissions:
-* speechAndTextAnalytics:topic: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::SpeechTextAnalyticsApi.new
-body = PureCloud::CreateTopicRequest.new # CreateTopicRequest | The topic to create
-begin
-  #Create new Speech & Text Analytics topic
-  result = api_instance.post_speechandtextanalytics_topics(body)
-  p result
-rescue PureCloud::ApiError => e
-  puts "Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_topics: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**CreateTopicRequest**](CreateTopicRequest.html)| The topic to create |  |
-{: class="table table-striped"}
-### Return type
-[**Topic**](Topic.html)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json

data/docs/Topic.md DELETED

@@ -1,25 +0,0 @@
----
-title: Topic
----
-## PureCloud::Topic
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **applied** | **BOOLEAN** |  | [optional] |
-| **strictness** | **String** |  | [optional] |
-| **programs** | [**Array&lt;BaseProgramEntity&gt;**](BaseProgramEntity.html) |  | [optional] |
-| **tags** | **Array&lt;String&gt;** |  | [optional] |
-| **dialect** | **String** |  | [optional] |
-| **participants** | **String** |  | [optional] |
-| **phrases** | [**Array&lt;Phrase&gt;**](Phrase.html) |  | [optional] |
-| **modified_by** | [**User**](User.html) |  | [optional] |
-| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **self_uri** | **String** | The URI for this object | [optional] |
-{: class="table table-striped"}

data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb DELETED

@@ -1,222 +0,0 @@
-=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: UNLICENSED
-https://help.mypurecloud.com/articles/terms-and-conditions/
-Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
-=end
-require "uri"
-module PureCloud
-  class SpeechTextAnalyticsApi
-    attr_accessor :api_client
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get a Speech & Text Analytics program by id
-    #
-    # @param program_id The id of the topic to get
-    # @param [Hash] opts the optional parameters
-    # @return [Program]
-    def get_speechandtextanalytics_program(program_id, opts = {})
-      data, _status_code, _headers = get_speechandtextanalytics_program_with_http_info(program_id, opts)
-      return data
-    end
-    # Get a Speech &amp; Text Analytics program by id
-    #
-    # @param program_id The id of the topic to get
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Program, Fixnum, Hash)>] Program data, response status code and response headers
-    def get_speechandtextanalytics_program_with_http_info(program_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_program ..."
-      end
-      # verify the required parameter 'program_id' is set
-      fail ArgumentError, "Missing the required parameter 'program_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_program" if program_id.nil?
-      # resource path
-      local_var_path = "/api/v2/speechandtextanalytics/programs/{programId}".sub('{format}','json').sub('{' + 'programId' + '}', program_id.to_s)
-      # query parameters
-      query_params = {}
-      # 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 OAuth']
-      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 => 'Program')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_program\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Get a Speech & Text Analytics topic by id
-    #
-    # @param topic_id The id of the topic to get
-    # @param [Hash] opts the optional parameters
-    # @return [Topic]
-    def get_speechandtextanalytics_topic(topic_id, opts = {})
-      data, _status_code, _headers = get_speechandtextanalytics_topic_with_http_info(topic_id, opts)
-      return data
-    end
-    # Get a Speech &amp; Text Analytics topic by id
-    #
-    # @param topic_id The id of the topic to get
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Topic, Fixnum, Hash)>] Topic data, response status code and response headers
-    def get_speechandtextanalytics_topic_with_http_info(topic_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_topic ..."
-      end
-      # verify the required parameter 'topic_id' is set
-      fail ArgumentError, "Missing the required parameter 'topic_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_topic" if topic_id.nil?
-      # resource path
-      local_var_path = "/api/v2/speechandtextanalytics/topics/{topicId}".sub('{format}','json').sub('{' + 'topicId' + '}', topic_id.to_s)
-      # query parameters
-      query_params = {}
-      # 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 OAuth']
-      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 => 'Topic')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Create new Speech & Text Analytics topic
-    #
-    # @param body The topic to create
-    # @param [Hash] opts the optional parameters
-    # @return [Topic]
-    def post_speechandtextanalytics_topics(body, opts = {})
-      data, _status_code, _headers = post_speechandtextanalytics_topics_with_http_info(body, opts)
-      return data
-    end
-    # Create new Speech &amp; Text Analytics topic
-    #
-    # @param body The topic to create
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Topic, Fixnum, Hash)>] Topic data, response status code and response headers
-    def post_speechandtextanalytics_topics_with_http_info(body, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.post_speechandtextanalytics_topics ..."
-      end
-      # verify the required parameter 'body' is set
-      fail ArgumentError, "Missing the required parameter 'body' when calling SpeechTextAnalyticsApi.post_speechandtextanalytics_topics" if body.nil?
-      # resource path
-      local_var_path = "/api/v2/speechandtextanalytics/topics".sub('{format}','json')
-      # query parameters
-      query_params = {}
-      # 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 = @api_client.object_to_http_body(body)
-      auth_names = ['PureCloud OAuth']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Topic')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#post_speechandtextanalytics_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end