ultracart_api 3.10.79 → 3.10.80

data/lib/ultracart_api/api/conversation_api.rb

@@ -291,6 +291,104 @@ module UltracartClient
       end
       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, Fixnum, 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 = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationDepartmentsResponse')
+      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, Fixnum, 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 = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationEngagementsResponse')
+      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 
@@ -575,10 +673,121 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Insert a department
+    # Insert a department 
+    # @param department 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 Department
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationDepartmentResponse, Fixnum, 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 = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(department)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationDepartmentResponse')
+      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 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 Engagement
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementResponse, Fixnum, 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 = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(engagement)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationEngagementResponse')
+      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 
     # @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)
@@ -589,6 +798,7 @@ module UltracartClient
     # Join a conversation 
     # @param conversation_uuid 
     # @param [Hash] opts the optional parameters
+    # @option opts [ConversationJoinRequest] :join_request Join request
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def join_conversation_with_http_info(conversation_uuid, opts = {})
       if @api_client.config.debugging
@@ -616,7 +826,7 @@ module UltracartClient
       form_params = {}
 
       # http body (model)
-      post_body = nil
+      post_body = @api_client.object_to_http_body(opts[:'join_request'])
       auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
@@ -908,6 +1118,128 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update a department
+    # Update a department 
+    # @param conversation_department_oid 
+    # @param department 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 
+    # @param department Department
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationDepartmentResponse, Fixnum, 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' + '}', conversation_department_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(department)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationDepartmentResponse')
+      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 
+    # @param engagement 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 
+    # @param engagement Engagement
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementResponse, Fixnum, 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' + '}', conversation_engagement_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(engagement)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'ConversationEngagementResponse')
+      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 

data/lib/ultracart_api/models/conversation_canned_message.rb

@@ -37,7 +37,7 @@ module UltracartClient
       {
         :'canned_message' => :'String',
         :'conversation_canned_message_oid' => :'Integer',
-        :'conversation_department_oids' => :'Array<String>',
+        :'conversation_department_oids' => :'Array<Integer>',
         :'short_code' => :'String'
       }
     end

data/lib/ultracart_api/models/conversation_department.rb

@@ -0,0 +1,220 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationDepartment
+    attr_accessor :conversation_department_oid
+
+    attr_accessor :delete_me
+
+    attr_accessor :department_name
+
+    attr_accessor :merchant_id
+
+    attr_accessor :settings
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversation_department_oid' => :'conversation_department_oid',
+        :'delete_me' => :'delete_me',
+        :'department_name' => :'department_name',
+        :'merchant_id' => :'merchant_id',
+        :'settings' => :'settings'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'conversation_department_oid' => :'Integer',
+        :'delete_me' => :'BOOLEAN',
+        :'department_name' => :'String',
+        :'merchant_id' => :'String',
+        :'settings' => :'ConversationDepartmentSettings'
+      }
+    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?(:'conversation_department_oid')
+        self.conversation_department_oid = attributes[:'conversation_department_oid']
+      end
+
+      if attributes.has_key?(:'delete_me')
+        self.delete_me = attributes[:'delete_me']
+      end
+
+      if attributes.has_key?(:'department_name')
+        self.department_name = attributes[:'department_name']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'settings')
+        self.settings = attributes[:'settings']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          conversation_department_oid == o.conversation_department_oid &&
+          delete_me == o.delete_me &&
+          department_name == o.department_name &&
+          merchant_id == o.merchant_id &&
+          settings == o.settings
+    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
+      [conversation_department_oid, delete_me, department_name, merchant_id, settings].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 =~ /\A(true|t|yes|y|1)\z/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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns 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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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