ultracart_api 4.0.34.rc → 4.0.35.rc

data/docs/ConversationSummary.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_arn** | **String** |  | [optional] |
+| **conversation_uuid** | **String** |  | [optional] |
+| **last_conversation_message_body** | **String** |  | [optional] |
+| **last_conversation_participant_arn** | **String** |  | [optional] |
+| **last_conversation_participant_name** | **String** |  | [optional] |
+| **last_message_dts** | **String** | Last message date/time | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **message_count** | **Integer** |  | [optional] |
+| **unread_messages** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationSummary.new(
+  conversation_arn: null,
+  conversation_uuid: null,
+  last_conversation_message_body: null,
+  last_conversation_participant_arn: null,
+  last_conversation_participant_name: null,
+  last_message_dts: null,
+  merchant_id: null,
+  message_count: null,
+  unread_messages: null
+)
+```
+

data/docs/ConversationsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversations** | [**Array<ConversationSummary>**](ConversationSummary.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationsResponse.new(
+  conversations: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -0,0 +1,418 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+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, Integer, 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 = 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] || 'ConversationAgentAuthResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_agent_websocket_authorization",
+        :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#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 [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Conversation, Integer, 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' + '}', CGI.escape(conversation_uuid.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Conversation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversation",
+        :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\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) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @return [Array<(ConversationsResponse, Integer, 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 = opts[:query_params] || {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+
+      # 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] || 'ConversationsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversations",
+        :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_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 [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @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
+        @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' + '}', CGI.escape(conversation_uuid.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.join_conversation",
+        :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#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 [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, 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' + '}', CGI.escape(conversation_uuid.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.leave_conversation",
+        :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(:DELETE, local_var_path, new_options)
+      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 [ConversationStartRequest] 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 [ConversationStartRequest] Start request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationStartResponse, Integer, 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 = 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(start_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationStartResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.start_conversation",
+        :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#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

@@ -17,8 +17,12 @@ module UltracartClient
   class Activity
     attr_accessor :action
 
+    attr_accessor :channel
+
     attr_accessor :metric
 
+    attr_accessor :storefront_oid
+
     attr_accessor :subject
 
     attr_accessor :ts
@@ -31,7 +35,9 @@ module UltracartClient
     def self.attribute_map
       {
         :'action' => :'action',
+        :'channel' => :'channel',
         :'metric' => :'metric',
+        :'storefront_oid' => :'storefront_oid',
         :'subject' => :'subject',
         :'ts' => :'ts',
         :'type' => :'type',
@@ -48,7 +54,9 @@ module UltracartClient
     def self.openapi_types
       {
         :'action' => :'String',
+        :'channel' => :'String',
         :'metric' => :'String',
+        :'storefront_oid' => :'Integer',
         :'subject' => :'String',
         :'ts' => :'Integer',
         :'type' => :'String',
@@ -81,10 +89,18 @@ module UltracartClient
         self.action = attributes[:'action']
       end
 
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
       if attributes.key?(:'metric')
         self.metric = attributes[:'metric']
       end
 
+      if attributes.key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_oid']
+      end
+
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
@@ -121,7 +137,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 &&
@@ -137,7 +155,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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