ultracart_api 4.0.95.rc → 4.0.97.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] 
@@ -671,10 +787,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 +940,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 +961,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 +1337,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] 

data/lib/ultracart_api/models/conversation_canned_message.rb

@@ -19,7 +19,7 @@ module UltracartClient
 
     attr_accessor :conversation_canned_message_oid
 
-    attr_accessor :conversation_webchat_queue_uuids
+    attr_accessor :conversation_department_oids
 
     attr_accessor :short_code
 
@@ -28,7 +28,7 @@ module UltracartClient
       {
         :'canned_message' => :'canned_message',
         :'conversation_canned_message_oid' => :'conversation_canned_message_oid',
-        :'conversation_webchat_queue_uuids' => :'conversation_webchat_queue_uuids',
+        :'conversation_department_oids' => :'conversation_department_oids',
         :'short_code' => :'short_code'
       }
     end
@@ -43,7 +43,7 @@ module UltracartClient
       {
         :'canned_message' => :'String',
         :'conversation_canned_message_oid' => :'Integer',
-        :'conversation_webchat_queue_uuids' => :'Array<String>',
+        :'conversation_department_oids' => :'Array<Integer>',
         :'short_code' => :'String'
       }
     end
@@ -77,9 +77,9 @@ module UltracartClient
         self.conversation_canned_message_oid = attributes[:'conversation_canned_message_oid']
       end
 
-      if attributes.key?(:'conversation_webchat_queue_uuids')
-        if (value = attributes[:'conversation_webchat_queue_uuids']).is_a?(Array)
-          self.conversation_webchat_queue_uuids = value
+      if attributes.key?(:'conversation_department_oids')
+        if (value = attributes[:'conversation_department_oids']).is_a?(Array)
+          self.conversation_department_oids = value
         end
       end
 
@@ -108,7 +108,7 @@ module UltracartClient
       self.class == o.class &&
           canned_message == o.canned_message &&
           conversation_canned_message_oid == o.conversation_canned_message_oid &&
-          conversation_webchat_queue_uuids == o.conversation_webchat_queue_uuids &&
+          conversation_department_oids == o.conversation_department_oids &&
           short_code == o.short_code
     end
 
@@ -121,7 +121,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [canned_message, conversation_canned_message_oid, conversation_webchat_queue_uuids, short_code].hash
+      [canned_message, conversation_canned_message_oid, conversation_department_oids, short_code].hash
     end
 
     # Builds the object from hash