ultracart_api 3.10.83 → 3.10.85

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f9861b7b08df849bc2db24b1a7b4810fd9ddad3b674f5b0b7eb4c39c26c4b05
-  data.tar.gz: d52f5231010245d2d78d84fa72460ced53f05834bd89d97088d754b21165a192
+  metadata.gz: 61e6e044644499969a52bb919cb429021158e2dfda4d3e1bd0825828eea5e1a6
+  data.tar.gz: d3bc073ee7e30067b227ced05ca567f07e7eae7bab697820aad350192d96682a
 SHA512:
-  metadata.gz: f3c835a52ff5e056143d6e756e60d059672135e0085df3c73210601bb9439449ef7a6d5ab3955f515d2591801af5398cb4ba4db4be43205f704dd0ab1a567632
-  data.tar.gz: 0263f337c65ce160ae4a29aafaa7505c3c486f3a50cf509aeb9d1dcb5f91a0d1ff5f407f518ec32f2421c9d922ad51d8260067cfc84fd4318db61e2a8fd08351
+  metadata.gz: c125cdd0d5d3dbdff8cf523e0105df454cd01158711270501bfe33ea58b11a1ebb8658c41cb4f3c18c4023254e860d73d9c77fa7d9b00a0f1acff2d2c739fdcc
+  data.tar.gz: baa81bf91501424b220693bb38c0b1157bbb0a8f9909a040a3cf7e16ba8be5d15efe3cebd7c7ebb9247f8f4b8624f8ef01a47748209b176b6363c89b04214fd0

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.83
+- Package version: 3.10.85
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.83.gem
+gem install ./ultracart_api-3.10.85.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.83.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.85.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.10.83'
+    gem 'ultracart_api', '~> 3.10.85'
 
 ### Install from Git
 
@@ -125,6 +125,9 @@ Class | Method | HTTP request | Description
 *UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
 *UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
 *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
+*UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
+*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
+*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
 *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
@@ -1260,6 +1263,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.85 | 12/21/2022 | conversation development |
+| 3.10.84 | 12/20/2022 | conversation engagement update |
 | 3.10.83 | 12/20/2022 | conversation engagement update |
 | 3.10.82 | 12/15/2022 | conversation search - added start date filtering |
 | 3.10.81 | 12/15/2022 | conversation searching |

data/docs/ConversationApi.md

@@ -4,6 +4,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
+[**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
+[**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
 [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
@@ -31,6 +34,153 @@ Method | HTTP request | Description
 [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 
 
+# **delete_conversation_canned_message**
+> delete_conversation_canned_message(conversation_canned_message_oid)
+
+Delete a conversation canned message
+
+Delete a conversation canned message 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_canned_message_oid = 56 # Integer | 
+
+
+begin
+  #Delete a conversation canned message
+  api_instance.delete_conversation_canned_message(conversation_canned_message_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->delete_conversation_canned_message: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_canned_message_oid** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_department**
+> delete_department(conversation_department_oid)
+
+Delete a conversation department
+
+Delete a conversation department 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_department_oid = 56 # Integer | 
+
+
+begin
+  #Delete a conversation department
+  api_instance.delete_department(conversation_department_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->delete_department: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_department_oid** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_engagement**
+> delete_engagement(conversation_engagement_oid)
+
+Delete a conversation engagement
+
+Delete a conversation engagement 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_engagement_oid = 56 # Integer | 
+
+
+begin
+  #Delete a conversation engagement
+  api_instance.delete_engagement(conversation_engagement_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->delete_engagement: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_engagement_oid** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_agent_keep_alive**
 > get_agent_keep_alive
 

data/docs/ConversationDepartment.md

@@ -4,7 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation_department_oid** | **Integer** |  | [optional] 
-**delete_me** | **BOOLEAN** |  | [optional] 
 **department_name** | **String** |  | [optional] 
 **merchant_id** | **String** |  | [optional] 
 **settings** | [**ConversationDepartmentSettings**](ConversationDepartmentSettings.md) |  | [optional] 

data/docs/ConversationEngagement.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** |  | [optional] 
 **conversation_engagement_oid** | **Integer** |  | [optional] 
 **customer_greeting** | **String** |  | [optional] 
 **department_oids** | **Array<Integer>** |  | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -32,6 +32,168 @@ module UltracartClient
       UltracartClient::ConversationApi.new(api_client)
     end
 
+    # Delete a conversation canned message
+    # Delete a conversation canned message 
+    # @param conversation_canned_message_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_conversation_canned_message(conversation_canned_message_oid, opts = {})
+      delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts)
+      nil
+    end
+
+    # Delete a conversation canned message
+    # Delete a conversation canned message 
+    # @param conversation_canned_message_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.delete_conversation_canned_message ...'
+      end
+      # verify the required parameter 'conversation_canned_message_oid' is set
+      if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.delete_conversation_canned_message"
+      end
+      # resource path
+      local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_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 = 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#delete_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Delete a conversation department
+    # Delete a conversation department 
+    # @param conversation_department_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_department(conversation_department_oid, opts = {})
+      delete_department_with_http_info(conversation_department_oid, opts)
+      nil
+    end
+
+    # Delete a conversation department
+    # Delete a conversation department 
+    # @param conversation_department_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_department_with_http_info(conversation_department_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.delete_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.delete_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 = 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#delete_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Delete a conversation engagement
+    # Delete a conversation engagement 
+    # @param conversation_engagement_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_engagement(conversation_engagement_oid, opts = {})
+      delete_engagement_with_http_info(conversation_engagement_oid, opts)
+      nil
+    end
+
+    # Delete a conversation engagement
+    # Delete a conversation engagement 
+    # @param conversation_engagement_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_engagement_with_http_info(conversation_engagement_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.delete_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.delete_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 = 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#delete_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Agent keep alive
     # Called periodically by the conversation API to keep the session alive. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/conversation_department.rb

@@ -16,8 +16,6 @@ module UltracartClient
   class ConversationDepartment
     attr_accessor :conversation_department_oid
 
-    attr_accessor :delete_me
-
     attr_accessor :department_name
 
     attr_accessor :merchant_id
@@ -28,7 +26,6 @@ module UltracartClient
     def self.attribute_map
       {
         :'conversation_department_oid' => :'conversation_department_oid',
-        :'delete_me' => :'delete_me',
         :'department_name' => :'department_name',
         :'merchant_id' => :'merchant_id',
         :'settings' => :'settings'
@@ -39,7 +36,6 @@ module UltracartClient
     def self.swagger_types
       {
         :'conversation_department_oid' => :'Integer',
-        :'delete_me' => :'BOOLEAN',
         :'department_name' => :'String',
         :'merchant_id' => :'String',
         :'settings' => :'ConversationDepartmentSettings'
@@ -58,10 +54,6 @@ module UltracartClient
         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
@@ -94,7 +86,6 @@ module UltracartClient
       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
@@ -109,7 +100,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_department_oid, delete_me, department_name, merchant_id, settings].hash
+      [conversation_department_oid, department_name, merchant_id, settings].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_engagement.rb

@@ -14,6 +14,8 @@ require 'date'
 
 module UltracartClient
   class ConversationEngagement
+    attr_accessor :active
+
     attr_accessor :conversation_engagement_oid
 
     attr_accessor :customer_greeting
@@ -54,6 +56,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'active' => :'active',
         :'conversation_engagement_oid' => :'conversation_engagement_oid',
         :'customer_greeting' => :'customer_greeting',
         :'department_oids' => :'department_oids',
@@ -67,6 +70,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'active' => :'BOOLEAN',
         :'conversation_engagement_oid' => :'Integer',
         :'customer_greeting' => :'String',
         :'department_oids' => :'Array<Integer>',
@@ -85,6 +89,10 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'active')
+        self.active = attributes[:'active']
+      end
+
       if attributes.has_key?(:'conversation_engagement_oid')
         self.conversation_engagement_oid = attributes[:'conversation_engagement_oid']
       end
@@ -146,6 +154,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          active == o.active &&
           conversation_engagement_oid == o.conversation_engagement_oid &&
           customer_greeting == o.customer_greeting &&
           department_oids == o.department_oids &&
@@ -164,7 +173,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [conversation_engagement_oid, customer_greeting, department_oids, engagement_name, equation, time_on_page, visitor_type].hash
+      [active, conversation_engagement_oid, customer_greeting, department_oids, engagement_name, equation, time_on_page, visitor_type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.83'
+  VERSION = '3.10.85'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.83
+  version: 3.10.85
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus