ultracart_api 4.0.96.rc → 4.0.98.rc

data/lib/ultracart_api/api/conversation_api.rb

@@ -337,6 +337,122 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve a list of departments ordered by name
+    # Retrieve a list of departments ordered by name 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationDepartmentsResponse]
+    def get_conversation_departments(opts = {})
+      data, _status_code, _headers = get_conversation_departments_with_http_info(opts)
+      data
+    end
+
+    # Retrieve a list of departments ordered by name
+    # Retrieve a list of departments ordered by name 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationDepartmentsResponse, Integer, Hash)>] ConversationDepartmentsResponse data, response status code and response headers
+    def get_conversation_departments_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_departments ...'
+      end
+      # resource path
+      local_var_path = '/conversation/departments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationDepartmentsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversation_departments",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation_departments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve a list of engagements ordered by name
+    # Retrieve a list of engagements ordered by name 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationEngagementsResponse]
+    def get_conversation_engagements(opts = {})
+      data, _status_code, _headers = get_conversation_engagements_with_http_info(opts)
+      data
+    end
+
+    # Retrieve a list of engagements ordered by name
+    # Retrieve a list of engagements ordered by name 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementsResponse, Integer, Hash)>] ConversationEngagementsResponse data, response status code and response headers
+    def get_conversation_engagements_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagements ...'
+      end
+      # resource path
+      local_var_path = '/conversation/engagements'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationEngagementsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversation_engagements",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve conversation messages
     # Retrieve conversation messages since a particular time 
     # @param conversation_uuid [String] 
@@ -602,6 +718,144 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve a list of matching terms for a search field
+    # Retrieve a list of matching terms for a search field 
+    # @param autocomplete_request [ConversationAutocompleteRequest] Autocomplete Request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAutocompleteResponse]
+    def get_conversations_autocomplete(autocomplete_request, opts = {})
+      data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
+      data
+    end
+
+    # Retrieve a list of matching terms for a search field
+    # Retrieve a list of matching terms for a search field 
+    # @param autocomplete_request [ConversationAutocompleteRequest] Autocomplete Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAutocompleteResponse, Integer, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
+    def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
+      end
+      # verify the required parameter 'autocomplete_request' is set
+      if @api_client.config.client_side_validation && autocomplete_request.nil?
+        fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/autocomplete'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(autocomplete_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationAutocompleteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversations_autocomplete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search conversations
+    # Search conversations 
+    # @param search_request [ConversationSearchRequest] Search Request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationSearchResponse]
+    def get_conversations_search(search_request, opts = {})
+      data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
+      data
+    end
+
+    # Search conversations
+    # Search conversations 
+    # @param search_request [ConversationSearchRequest] Search Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationSearchResponse, Integer, Hash)>] ConversationSearchResponse data, response status code and response headers
+    def get_conversations_search_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
+      end
+      # verify the required parameter 'search_request' is set
+      if @api_client.config.client_side_validation && search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationSearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversations_search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Insert a canned message
     # Insert a canned message 
     # @param canned_message [ConversationCannedMessage] Canned message
@@ -671,10 +925,149 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Insert a department
+    # Insert a department 
+    # @param department [ConversationDepartment] Department
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationDepartmentResponse]
+    def insert_conversation_department(department, opts = {})
+      data, _status_code, _headers = insert_conversation_department_with_http_info(department, opts)
+      data
+    end
+
+    # Insert a department
+    # Insert a department 
+    # @param department [ConversationDepartment] Department
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationDepartmentResponse, Integer, Hash)>] ConversationDepartmentResponse data, response status code and response headers
+    def insert_conversation_department_with_http_info(department, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_department ...'
+      end
+      # verify the required parameter 'department' is set
+      if @api_client.config.client_side_validation && department.nil?
+        fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.insert_conversation_department"
+      end
+      # resource path
+      local_var_path = '/conversation/departments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(department)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationDepartmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.insert_conversation_department",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Insert a engagement
+    # Insert a engagement 
+    # @param engagement [ConversationEngagement] Engagement
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationEngagementResponse]
+    def insert_conversation_engagement(engagement, opts = {})
+      data, _status_code, _headers = insert_conversation_engagement_with_http_info(engagement, opts)
+      data
+    end
+
+    # Insert a engagement
+    # Insert a engagement 
+    # @param engagement [ConversationEngagement] Engagement
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementResponse, Integer, Hash)>] ConversationEngagementResponse data, response status code and response headers
+    def insert_conversation_engagement_with_http_info(engagement, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_engagement ...'
+      end
+      # verify the required parameter 'engagement' is set
+      if @api_client.config.client_side_validation && engagement.nil?
+        fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.insert_conversation_engagement"
+      end
+      # resource path
+      local_var_path = '/conversation/engagements'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(engagement)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationEngagementResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.insert_conversation_engagement",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#insert_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Join a conversation
     # Join a conversation 
     # @param conversation_uuid [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [ConversationJoinRequest] :join_request Join request
     # @return [nil]
     def join_conversation(conversation_uuid, opts = {})
       join_conversation_with_http_info(conversation_uuid, opts)
@@ -685,6 +1078,7 @@ module UltracartClient
     # Join a conversation 
     # @param conversation_uuid [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [ConversationJoinRequest] :join_request Join request
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def join_conversation_with_http_info(conversation_uuid, opts = {})
       if @api_client.config.debugging
@@ -705,12 +1099,17 @@ module UltracartClient
       header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'join_request'])
 
       # return_type
       return_type = opts[:debug_return_type]
@@ -1076,6 +1475,156 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Update a department
+    # Update a department 
+    # @param conversation_department_oid [Integer] 
+    # @param department [ConversationDepartment] Department
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationDepartmentResponse]
+    def update_conversation_department(conversation_department_oid, department, opts = {})
+      data, _status_code, _headers = update_conversation_department_with_http_info(conversation_department_oid, department, opts)
+      data
+    end
+
+    # Update a department
+    # Update a department 
+    # @param conversation_department_oid [Integer] 
+    # @param department [ConversationDepartment] Department
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationDepartmentResponse, Integer, Hash)>] ConversationDepartmentResponse data, response status code and response headers
+    def update_conversation_department_with_http_info(conversation_department_oid, department, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_department ...'
+      end
+      # verify the required parameter 'conversation_department_oid' is set
+      if @api_client.config.client_side_validation && conversation_department_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.update_conversation_department"
+      end
+      # verify the required parameter 'department' is set
+      if @api_client.config.client_side_validation && department.nil?
+        fail ArgumentError, "Missing the required parameter 'department' when calling ConversationApi.update_conversation_department"
+      end
+      # resource path
+      local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', CGI.escape(conversation_department_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(department)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationDepartmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.update_conversation_department",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_conversation_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a engagement
+    # Update a engagement 
+    # @param conversation_engagement_oid [Integer] 
+    # @param engagement [ConversationEngagement] Engagement
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationEngagementResponse]
+    def update_conversation_engagement(conversation_engagement_oid, engagement, opts = {})
+      data, _status_code, _headers = update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts)
+      data
+    end
+
+    # Update a engagement
+    # Update a engagement 
+    # @param conversation_engagement_oid [Integer] 
+    # @param engagement [ConversationEngagement] Engagement
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementResponse, Integer, Hash)>] ConversationEngagementResponse data, response status code and response headers
+    def update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_engagement ...'
+      end
+      # verify the required parameter 'conversation_engagement_oid' is set
+      if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.update_conversation_engagement"
+      end
+      # verify the required parameter 'engagement' is set
+      if @api_client.config.client_side_validation && engagement.nil?
+        fail ArgumentError, "Missing the required parameter 'engagement' when calling ConversationApi.update_conversation_engagement"
+      end
+      # resource path
+      local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', CGI.escape(conversation_engagement_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(engagement)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationEngagementResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.update_conversation_engagement",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update status within the queue
     # Update status within the queue 
     # @param queue_name [String]