purecloudplatformclientv2 61.0.0 → 62.0.0

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -5823,7 +5823,7 @@ module PureCloud
     # Returns 200 if received OK.
     # @param contact_list_id ContactList ID
     # @param [Hash] opts the optional parameters
-    # @return [UriReference]
+    # @return [DomainEntityRef]
     def post_outbound_contactlist_export(contact_list_id, opts = {})
       data, _status_code, _headers = post_outbound_contactlist_export_with_http_info(contact_list_id, opts)
       return data
@@ -5833,7 +5833,7 @@ module PureCloud
     # Returns 200 if received OK.
     # @param contact_list_id ContactList ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(UriReference, Fixnum, Hash)>] UriReference data, response status code and response headers
+    # @return [Array<(DomainEntityRef, Fixnum, Hash)>] DomainEntityRef data, response status code and response headers
     def post_outbound_contactlist_export_with_http_info(contact_list_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_export ..."
@@ -5877,7 +5877,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'UriReference')
+        :return_type => 'DomainEntityRef')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -6147,7 +6147,7 @@ module PureCloud
     # Returns 200 if received OK.
     # @param dnc_list_id DncList ID
     # @param [Hash] opts the optional parameters
-    # @return [UriReference]
+    # @return [DomainEntityRef]
     def post_outbound_dnclist_export(dnc_list_id, opts = {})
       data, _status_code, _headers = post_outbound_dnclist_export_with_http_info(dnc_list_id, opts)
       return data
@@ -6157,7 +6157,7 @@ module PureCloud
     # Returns 200 if received OK.
     # @param dnc_list_id DncList ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(UriReference, Fixnum, Hash)>] UriReference data, response status code and response headers
+    # @return [Array<(DomainEntityRef, Fixnum, Hash)>] DomainEntityRef data, response status code and response headers
     def post_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclist_export ..."
@@ -6201,7 +6201,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'UriReference')
+        :return_type => 'DomainEntityRef')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OutboundApi#post_outbound_dnclist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/purecloudplatformclientv2/api/routing_api.rb

@@ -1843,6 +1843,7 @@ module PureCloud
     # @option opts [String] :sort_by Sort by (default to name)
     # @option opts [String] :name Name
     # @option opts [BOOLEAN] :active Active
+    # @option opts [Array<String>] :id ID(s)
     # @option opts [Array<String>] :division_id Division ID(s)
     # @return [QueueEntityListing]
     def get_routing_queues(opts = {})
@@ -1858,6 +1859,7 @@ module PureCloud
     # @option opts [String] :sort_by Sort by
     # @option opts [String] :name Name
     # @option opts [BOOLEAN] :active Active
+    # @option opts [Array<String>] :id ID(s)
     # @option opts [Array<String>] :division_id Division ID(s)
     # @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers
     def get_routing_queues_with_http_info(opts = {})
@@ -1894,6 +1896,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1911,6 +1919,7 @@ module PureCloud
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
       query_params[:'active'] = opts[:'active'] if opts[:'active']
+      query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
       query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
 
       # header parameters

data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb

@@ -0,0 +1,102 @@
+=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 the pre-signed S3 URL for the transcript of a specific communication of a conversation
+    # 
+    # @param conversation_id Conversation ID
+    # @param communication_id Communication ID
+    # @param [Hash] opts the optional parameters
+    # @return [TranscriptProperty]
+    def get_conversation_transcriptproperty(conversation_id, communication_id, opts = {})
+      data, _status_code, _headers = get_conversation_transcriptproperty_with_http_info(conversation_id, communication_id, opts)
+      return data
+    end
+
+    # Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
+    # 
+    # @param conversation_id Conversation ID
+    # @param communication_id Communication ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TranscriptProperty, Fixnum, Hash)>] TranscriptProperty data, response status code and response headers
+    def get_conversation_transcriptproperty_with_http_info(conversation_id, communication_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_conversation_transcriptproperty ..."
+      end
+      
+      
+      # verify the required parameter 'conversation_id' is set
+      fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SpeechTextAnalyticsApi.get_conversation_transcriptproperty" if conversation_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'communication_id' is set
+      fail ArgumentError, "Missing the required parameter 'communication_id' when calling SpeechTextAnalyticsApi.get_conversation_transcriptproperty" if communication_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/conversations/{conversationId}/transcriptproperties/{communicationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_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 => 'TranscriptProperty')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_conversation_transcriptproperty\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '61.0.0'
+      header_params['purecloud-sdk'] = '62.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

@@ -30,11 +30,11 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :last_uri
+    attr_accessor :next_uri
 
     attr_accessor :previous_uri
 
-    attr_accessor :next_uri
+    attr_accessor :last_uri
 
     attr_accessor :page_count
 
@@ -54,11 +54,11 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'last_uri' => :'lastUri',
+        :'next_uri' => :'nextUri',
         
         :'previous_uri' => :'previousUri',
         
-        :'next_uri' => :'nextUri',
+        :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
         
@@ -81,11 +81,11 @@ module PureCloud
         
         :'self_uri' => :'String',
         
-        :'last_uri' => :'String',
+        :'next_uri' => :'String',
         
         :'previous_uri' => :'String',
         
-        :'next_uri' => :'String',
+        :'last_uri' => :'String',
         
         :'page_count' => :'Integer'
         
@@ -157,10 +157,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
@@ -175,10 +175,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -312,9 +312,9 @@ module PureCloud
           total == o.total &&
           first_uri == o.first_uri &&
           self_uri == o.self_uri &&
-          last_uri == o.last_uri &&
-          previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
+          previous_uri == o.previous_uri &&
+          last_uri == o.last_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, first_uri, self_uri, last_uri, previous_uri, next_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, next_uri, previous_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -30,11 +30,11 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :last_uri
+    attr_accessor :next_uri
 
     attr_accessor :previous_uri
 
-    attr_accessor :next_uri
+    attr_accessor :last_uri
 
     attr_accessor :page_count
 
@@ -54,11 +54,11 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'last_uri' => :'lastUri',
+        :'next_uri' => :'nextUri',
         
         :'previous_uri' => :'previousUri',
         
-        :'next_uri' => :'nextUri',
+        :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
         
@@ -81,11 +81,11 @@ module PureCloud
         
         :'self_uri' => :'String',
         
-        :'last_uri' => :'String',
+        :'next_uri' => :'String',
         
         :'previous_uri' => :'String',
         
-        :'next_uri' => :'String',
+        :'last_uri' => :'String',
         
         :'page_count' => :'Integer'
         
@@ -157,10 +157,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
@@ -175,10 +175,10 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -312,9 +312,9 @@ module PureCloud
           total == o.total &&
           first_uri == o.first_uri &&
           self_uri == o.self_uri &&
-          last_uri == o.last_uri &&
-          previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
+          previous_uri == o.previous_uri &&
+          last_uri == o.last_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, first_uri, self_uri, last_uri, previous_uri, next_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, next_uri, previous_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb

@@ -0,0 +1,229 @@
+=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 'date'
+
+module PureCloud
+  class AnalyticsConversationAsyncQueryResponse
+    attr_accessor :conversations
+
+    # Optional cursor to indicate where to resume the results
+    attr_accessor :cursor
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'conversations' => :'conversations',
+        
+        :'cursor' => :'cursor'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'conversations' => :'Array<AnalyticsConversation>',
+        
+        :'cursor' => :'String'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'conversations')
+        
+        if (value = attributes[:'conversations']).is_a?(Array)
+          self.conversations = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'cursor')
+        
+        
+        self.cursor = attributes[:'cursor']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          conversations == o.conversations &&
+          cursor == o.cursor
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [conversations, cursor].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end