purecloud 0.59.1 → 0.60.1

data/lib/purecloud/api/quality_api.rb

@@ -1141,6 +1141,8 @@ module PureCloud
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [String] :name the keyword set name - used for filtering results in searches.
+    # @option opts [String] :queue_id the queue id - used for filtering results in searches.
+    # @option opts [String] :agent_id the agent id - used for filtering results in searches.
     # @return [KeywordSetEntityListing]
     def get_keywordsets(opts = {})
       data, status_code, headers = get_keywordsets_with_http_info(opts)
@@ -1157,6 +1159,8 @@ module PureCloud
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [String] :name the keyword set name - used for filtering results in searches.
+    # @option opts [String] :queue_id the queue id - used for filtering results in searches.
+    # @option opts [String] :agent_id the agent id - used for filtering results in searches.
     # @return [Array<(KeywordSetEntityListing, Fixnum, Hash)>] KeywordSetEntityListing data, response status code and response headers
     def get_keywordsets_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1175,6 +1179,8 @@ module PureCloud
       query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
       query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
+      query_params[:'agentId'] = opts[:'agent_id'] if opts[:'agent_id']
 
       # header parameters
       header_params = {}

data/lib/purecloud/api/recording_api.rb

@@ -214,7 +214,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    #  deletes a single orphan recording
+    # Deletes a single orphan recording
     # 
     # @param orphan_id Orphan ID
     # @param [Hash] opts the optional parameters
@@ -224,7 +224,7 @@ module PureCloud
       return data
     end
 
-    #  deletes a single orphan recording
+    # Deletes a single orphan recording
     # 
     # @param orphan_id Orphan ID
     # @param [Hash] opts the optional parameters
@@ -877,6 +877,79 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Gets the media of a single orphan recording
+    # A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
+    # @param orphan_id Orphan ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :format_id The desired media format. (default to WEBM)
+    # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
+    # @option opts [String] :file_name the name of the downloaded fileName
+    # @return [Recording]
+    def get_orphan_id_media(orphan_id, opts = {})
+      data, status_code, headers = get_orphan_id_media_with_http_info(orphan_id, opts)
+      return data
+    end
+
+    # Gets the media of a single orphan recording
+    # A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
+    # @param orphan_id Orphan ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :format_id The desired media format.
+    # @option opts [BOOLEAN] :download requesting a download format of the recording
+    # @option opts [String] :file_name the name of the downloaded fileName
+    # @return [Array<(Recording, Fixnum, Hash)>] Recording data, response status code and response headers
+    def get_orphan_id_media_with_http_info(orphan_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id_media ..."
+      end
+      
+      # verify the required parameter 'orphan_id' is set
+      fail "Missing the required parameter 'orphan_id' when calling get_orphan_id_media" if orphan_id.nil?
+      
+      if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
+        fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE'
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/orphanrecordings/{orphanId}/media".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
+      query_params[:'download'] = opts[:'download'] if opts[:'download']
+      query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      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 => 'Recording')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets all orphan recordings
     # 
     # @param [Hash] opts the optional parameters
@@ -886,6 +959,7 @@ module PureCloud
     # @option opts [Array<Object>] :expand variable name requested by expand list
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
+    # @option opts [BOOLEAN] :has_conversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (default to false)
     # @return [OrphanRecordingListing]
     def get_orphanrecordings(opts = {})
       data, status_code, headers = get_orphanrecordings_with_http_info(opts)
@@ -901,6 +975,7 @@ module PureCloud
     # @option opts [Array<Object>] :expand variable name requested by expand list
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
+    # @option opts [BOOLEAN] :has_conversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
     # @return [Array<(OrphanRecordingListing, Fixnum, Hash)>] OrphanRecordingListing data, response status code and response headers
     def get_orphanrecordings_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -918,6 +993,7 @@ module PureCloud
       query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
       query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
       query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
+      query_params[:'hasConversation'] = opts[:'has_conversation'] if opts[:'has_conversation']
 
       # header parameters
       header_params = {}
@@ -1891,6 +1967,68 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Updates an orphan recording to a regular recording with retention values
+    # If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.
+    # @param orphan_id Orphan ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [OrphanUpdateRequest] :body 
+    # @return [Recording]
+    def put_orphan_id(orphan_id, opts = {})
+      data, status_code, headers = put_orphan_id_with_http_info(orphan_id, opts)
+      return data
+    end
+
+    # Updates an orphan recording to a regular recording with retention values
+    # If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.
+    # @param orphan_id Orphan ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [OrphanUpdateRequest] :body 
+    # @return [Array<(Recording, Fixnum, Hash)>] Recording data, response status code and response headers
+    def put_orphan_id_with_http_info(orphan_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecordingApi#put_orphan_id ..."
+      end
+      
+      # verify the required parameter 'orphan_id' is set
+      fail "Missing the required parameter 'orphan_id' when calling put_orphan_id" if orphan_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Recording')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordingApi#put_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update key rotation schedule
     # 
     # @param body KeyRotationSchedule

data/lib/purecloud/api/telephony_providers_edge_api.rb

@@ -1309,6 +1309,7 @@ module PureCloud
     # 
     # @param edge_id Edge ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
     # @return [Edge]
     def get_providers_edges_edge_id(edge_id, opts = {})
       data, status_code, headers = get_providers_edges_edge_id_with_http_info(edge_id, opts)
@@ -1319,6 +1320,7 @@ module PureCloud
     # 
     # @param edge_id Edge ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
     # @return [Array<(Edge, Fixnum, Hash)>] Edge data, response status code and response headers
     def get_providers_edges_edge_id_with_http_info(edge_id, opts = {})
       if @api_client.config.debugging
@@ -1333,6 +1335,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
       header_params = {}
@@ -4327,7 +4330,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Lists available schema categories
+    # Lists available schema categories (Deprecated)
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size (default to 25)
@@ -4338,7 +4341,7 @@ module PureCloud
       return data
     end
 
-    # Lists available schema categories
+    # Lists available schema categories (Deprecated)
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size
@@ -4388,7 +4391,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # List schemas of a specific category
+    # List schemas of a specific category (Deprecated)
     # 
     # @param schema_category Schema category
     # @param [Hash] opts the optional parameters
@@ -4400,7 +4403,7 @@ module PureCloud
       return data
     end
 
-    # List schemas of a specific category
+    # List schemas of a specific category (Deprecated)
     # 
     # @param schema_category Schema category
     # @param [Hash] opts the optional parameters
@@ -4454,7 +4457,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # List schemas of a specific category
+    # List schemas of a specific category (Deprecated)
     # 
     # @param schema_category Schema category
     # @param schema_type Schema type
@@ -4467,7 +4470,7 @@ module PureCloud
       return data
     end
 
-    # List schemas of a specific category
+    # List schemas of a specific category (Deprecated)
     # 
     # @param schema_category Schema category
     # @param schema_type Schema type
@@ -4525,7 +4528,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get a json schema
+    # Get a json schema (Deprecated)
     # 
     # @param schema_category Schema category
     # @param schema_type Schema type
@@ -4537,7 +4540,7 @@ module PureCloud
       return data
     end
 
-    # Get a json schema
+    # Get a json schema (Deprecated)
     # 
     # @param schema_category Schema category
     # @param schema_type Schema type
@@ -4595,7 +4598,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get metadata for a schema
+    # Get metadata for a schema (Deprecated)
     # 
     # @param schema_category Schema category
     # @param schema_type Schema type
@@ -4610,7 +4613,7 @@ module PureCloud
       return data
     end
 
-    # Get metadata for a schema
+    # Get metadata for a schema (Deprecated)
     # 
     # @param schema_category Schema category
     # @param schema_type Schema type

data/lib/purecloud/api/users_api.rb

@@ -1411,7 +1411,7 @@ module PureCloud
     # @option opts [Array<String>] :id id
     # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
     # @option opts [Array<String>] :expand Which fields, if any, to expand
-    # @return [UsersEntityListing]
+    # @return [UserEntityListing]
     def get_users(opts = {})
       data, status_code, headers = get_users_with_http_info(opts)
       return data
@@ -1425,7 +1425,7 @@ module PureCloud
     # @option opts [Array<String>] :id id
     # @option opts [String] :sort_order Ascending or descending sort order
     # @option opts [Array<String>] :expand Which fields, if any, to expand
-    # @return [Array<(UsersEntityListing, Fixnum, Hash)>] UsersEntityListing data, response status code and response headers
+    # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
     def get_users_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: UsersApi#get_users ..."
@@ -1470,7 +1470,7 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'UsersEntityListing')
+        :return_type => 'UserEntityListing')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/purecloud/api_client.rb

@@ -33,7 +33,7 @@ module PureCloud
 
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "PureCloud SDK/Ruby 0.59.1"
+      @user_agent = "PureCloud SDK/Ruby 0.60.1"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/purecloud/models/agent_activity_entity_listing.rb

@@ -26,16 +26,16 @@ module PureCloud
 
     attr_accessor :total
 
+    attr_accessor :first_uri
+
     attr_accessor :self_uri
 
-    attr_accessor :first_uri
+    attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :previous_uri
-
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,16 +50,16 @@ module PureCloud
         
         :'total' => :'total',
         
+        :'first_uri' => :'firstUri',
+        
         :'self_uri' => :'selfUri',
         
-        :'first_uri' => :'firstUri',
+        :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
         :'last_uri' => :'lastUri',
         
-        :'previous_uri' => :'previousUri',
-        
         :'page_count' => :'pageCount'
         
       }
@@ -72,11 +72,11 @@ module PureCloud
         :'page_size' => :'Integer',
         :'page_number' => :'Integer',
         :'total' => :'Integer',
-        :'self_uri' => :'String',
         :'first_uri' => :'String',
+        :'self_uri' => :'String',
+        :'previous_uri' => :'String',
         :'next_uri' => :'String',
         :'last_uri' => :'String',
-        :'previous_uri' => :'String',
         :'page_count' => :'Integer'
         
       }
@@ -107,12 +107,16 @@ module PureCloud
         self.total = attributes[:'total']
       end
       
+      if attributes[:'firstUri']
+        self.first_uri = attributes[:'firstUri']
+      end
+      
       if attributes[:'selfUri']
         self.self_uri = attributes[:'selfUri']
       end
       
-      if attributes[:'firstUri']
-        self.first_uri = attributes[:'firstUri']
+      if attributes[:'previousUri']
+        self.previous_uri = attributes[:'previousUri']
       end
       
       if attributes[:'nextUri']
@@ -123,10 +127,6 @@ module PureCloud
         self.last_uri = attributes[:'lastUri']
       end
       
-      if attributes[:'previousUri']
-        self.previous_uri = attributes[:'previousUri']
-      end
-      
       if attributes[:'pageCount']
         self.page_count = attributes[:'pageCount']
       end
@@ -141,11 +141,11 @@ module PureCloud
           page_size == o.page_size &&
           page_number == o.page_number &&
           total == o.total &&
-          self_uri == o.self_uri &&
           first_uri == o.first_uri &&
+          self_uri == o.self_uri &&
+          previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
           last_uri == o.last_uri &&
-          previous_uri == o.previous_uri &&
           page_count == o.page_count
     end
 
@@ -156,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, next_uri, last_uri, previous_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash