ultracart_api 3.10.19 → 3.10.20

data/lib/ultracart_api/api/conversation_api.rb

@@ -0,0 +1,358 @@
+=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 'addressable/uri'
+
+module UltracartClient
+  class ConversationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::ConversationApi.new(api_client)
+    end
+
+    # Get agent websocket authorization
+    # Retrieve a JWT to authorize an agent to make a websocket connection. 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationAgentAuthResponse]
+    def get_agent_websocket_authorization(opts = {})
+      data, _status_code, _headers = get_agent_websocket_authorization_with_http_info(opts)
+      data
+    end
+
+    # Get agent websocket authorization
+    # Retrieve a JWT to authorize an agent to make a websocket connection. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationAgentAuthResponse, Fixnum, Hash)>] ConversationAgentAuthResponse data, response status code and response headers
+    def get_agent_websocket_authorization_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_websocket_authorization ...'
+      end
+      # resource path
+      local_var_path = '/conversation/agent/auth'
+
+      # 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(: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 => 'ConversationAgentAuthResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_agent_websocket_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve a conversation
+    # Retrieve a conversation including the participants and messages 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Conversation]
+    def get_conversation(conversation_uuid, opts = {})
+      data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
+      data
+    end
+
+    # Retrieve a conversation
+    # Retrieve a conversation including the participants and messages 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Conversation, Fixnum, Hash)>] Conversation data, response status code and response headers
+    def get_conversation_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.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 = 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 => 'Conversation')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve a list of conversation summaries newest to oldest
+    # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @return [ConversationsResponse]
+    def get_conversations(opts = {})
+      data, _status_code, _headers = get_conversations_with_http_info(opts)
+      data
+    end
+
+    # Retrieve a list of conversation summaries newest to oldest
+    # Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @return [Array<(ConversationsResponse, Fixnum, Hash)>] ConversationsResponse data, response status code and response headers
+    def get_conversations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations ...'
+      end
+      # resource path
+      local_var_path = '/conversation/conversations'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+
+      # 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 => 'ConversationsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversations\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
+    # @return [nil]
+    def join_conversation(conversation_uuid, opts = {})
+      join_conversation_with_http_info(conversation_uuid, opts)
+      nil
+    end
+
+    # Join a conversation
+    # Join a conversation 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @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
+        @api_client.config.logger.debug 'Calling API: ConversationApi.join_conversation ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.join_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/join'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.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 = nil
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#join_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Leave a conversation
+    # Leave a conversation 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def leave_conversation(conversation_uuid, opts = {})
+      leave_conversation_with_http_info(conversation_uuid, opts)
+      nil
+    end
+
+    # Leave a conversation
+    # Leave a conversation 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def leave_conversation_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.leave_conversation ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.leave_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/leave'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.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 = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#leave_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Start a conversation
+    # Start a new conversation 
+    # @param start_request Start request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationStartResponse]
+    def start_conversation(start_request, opts = {})
+      data, _status_code, _headers = start_conversation_with_http_info(start_request, opts)
+      data
+    end
+
+    # Start a conversation
+    # Start a new conversation 
+    # @param start_request Start request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationStartResponse, Fixnum, Hash)>] ConversationStartResponse data, response status code and response headers
+    def start_conversation_with_http_info(start_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.start_conversation ...'
+      end
+      # verify the required parameter 'start_request' is set
+      if @api_client.config.client_side_validation && start_request.nil?
+        fail ArgumentError, "Missing the required parameter 'start_request' when calling ConversationApi.start_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations'
+
+      # 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(start_request)
+      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 => 'ConversationStartResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#start_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ultracart_api/models/activity.rb

@@ -16,8 +16,12 @@ module UltracartClient
   class Activity
     attr_accessor :action
 
+    attr_accessor :channel
+
     attr_accessor :metric
 
+    attr_accessor :storefront_oid
+
     attr_accessor :subject
 
     attr_accessor :ts
@@ -30,7 +34,9 @@ module UltracartClient
     def self.attribute_map
       {
         :'action' => :'action',
+        :'channel' => :'channel',
         :'metric' => :'metric',
+        :'storefront_oid' => :'storefront_oid',
         :'subject' => :'subject',
         :'ts' => :'ts',
         :'type' => :'type',
@@ -42,7 +48,9 @@ module UltracartClient
     def self.swagger_types
       {
         :'action' => :'String',
+        :'channel' => :'String',
         :'metric' => :'String',
+        :'storefront_oid' => :'Integer',
         :'subject' => :'String',
         :'ts' => :'Integer',
         :'type' => :'String',
@@ -62,10 +70,18 @@ module UltracartClient
         self.action = attributes[:'action']
       end
 
+      if attributes.has_key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
       if attributes.has_key?(:'metric')
         self.metric = attributes[:'metric']
       end
 
+      if attributes.has_key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_oid']
+      end
+
       if attributes.has_key?(:'subject')
         self.subject = attributes[:'subject']
       end
@@ -102,7 +118,9 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           action == o.action &&
+          channel == o.channel &&
           metric == o.metric &&
+          storefront_oid == o.storefront_oid &&
           subject == o.subject &&
           ts == o.ts &&
           type == o.type &&
@@ -118,7 +136,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [action, metric, subject, ts, type, uuid].hash
+      [action, channel, metric, storefront_oid, subject, ts, type, uuid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation.rb

@@ -0,0 +1,224 @@
+=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 Conversation
+    attr_accessor :conversation_arn
+
+    attr_accessor :conversation_uuid
+
+    attr_accessor :merchant_id
+
+    attr_accessor :messages
+
+    attr_accessor :participants
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversation_arn' => :'conversation_arn',
+        :'conversation_uuid' => :'conversation_uuid',
+        :'merchant_id' => :'merchant_id',
+        :'messages' => :'messages',
+        :'participants' => :'participants'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'conversation_arn' => :'String',
+        :'conversation_uuid' => :'String',
+        :'merchant_id' => :'String',
+        :'messages' => :'Array<ConversationMessage>',
+        :'participants' => :'Array<ConversationParticipant>'
+      }
+    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_arn')
+        self.conversation_arn = attributes[:'conversation_arn']
+      end
+
+      if attributes.has_key?(:'conversation_uuid')
+        self.conversation_uuid = attributes[:'conversation_uuid']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
+        end
+      end
+
+      if attributes.has_key?(:'participants')
+        if (value = attributes[:'participants']).is_a?(Array)
+          self.participants = value
+        end
+      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_arn == o.conversation_arn &&
+          conversation_uuid == o.conversation_uuid &&
+          merchant_id == o.merchant_id &&
+          messages == o.messages &&
+          participants == o.participants
+    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_arn, conversation_uuid, merchant_id, messages, participants].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