ultracart_api 3.10.70 → 3.10.71

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88f249291871a874dd61ec3e8b99538d35c8ac532cfb9e90fe35ca5d4bef2d4
-  data.tar.gz: 1c4f98d9ec2ddc6c893cc2b476fcf0a0a43dac207cf469a393316485f4bef684
+  metadata.gz: 8c7426f708a2732a49b6b1d0acde9c62450df77d0c306ae15dffd84b5c0087eb
+  data.tar.gz: c868275006dca84d6e5aa55d1714720a664aa1ce054d18d446942b06d91aad67
 SHA512:
-  metadata.gz: 4e25306978125ee5e1f4b57d5d42b508d53f9cd636dfe18b0fb63bb0d87de9f852c00f726399c1fcf024a25ef0e950c07730e41469e3ab24e0b0aecbd8e11080
-  data.tar.gz: 53213c2cf7e48d1b77de06d3437f3cbb7dcaa0be779a1d02fc0f77709d75dac28026125a3270f508fc040bdcfb3838d0f19b9d043c36413d56cfe6f326540297
+  metadata.gz: 6dd95ac18e894a49cafbc4d2901aa50b8b0bb6086f326e6cd19cae049bf531ce7c5763b43d486cfd4c281df16b06b2186b38d71b967e9436886657bd2080f70f
+  data.tar.gz: 19ea9f0798d761d980be54530e0aee1f7c547d1d15ff686b472a124ebc48a8784a86b4b8afe76438e5cdc6ecf75a4ff46a1473320fd15d5666efbd8b19888628

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.70
+- Package version: 3.10.71
 - 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.70.gem
+gem install ./ultracart_api-3.10.71.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.70.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.71.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.70'
+    gem 'ultracart_api', '~> 3.10.71'
 
 ### Install from Git
 
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
 *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
+*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
@@ -1224,6 +1225,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.71 | 11/29/2022 | converstation marked convo read method |
 | 3.10.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
 | 3.10.69 | 11/21/2022 | conversation context method |
 | 3.10.68 | 11/21/2022 | adjusted conversation event model |

data/docs/ConversationApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
 [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
+[**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 
@@ -518,6 +519,55 @@ nil (empty response body)
 
 
 
+# **mark_read_conversation**
+> mark_read_conversation(conversation_uuid)
+
+Mark a conversation as read
+
+Mark a conversation as read 
+
+### 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_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Mark a conversation as read
+  api_instance.mark_read_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->mark_read_conversation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_uuid** | **String**|  | 
+
+### 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
+
+
+
 # **start_conversation**
 > ConversationStartResponse start_conversation(start_request)
 

data/docs/ConversationMessage.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **body** | **String** |  | [optional] 
 **client_message_id** | **String** |  | [optional] 
 **conversation_message_uuid** | **String** |  | [optional] 
+**delay_until_dts** | **String** | Delay message transmission until date/time | [optional] 
 **media_urls** | **Array<String>** |  | [optional] 
 **merchant_id** | **String** |  | [optional] 
 **message_dts** | **String** | Message date/time | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -579,6 +579,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Mark a conversation as read
+    # Mark a conversation as read 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def mark_read_conversation(conversation_uuid, opts = {})
+      mark_read_conversation_with_http_info(conversation_uuid, opts)
+      nil
+    end
+
+    # Mark a conversation as read
+    # Mark a conversation as read 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_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.mark_read_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.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#mark_read_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

data/lib/ultracart_api/models/conversation_message.rb

@@ -24,6 +24,9 @@ module UltracartClient
 
     attr_accessor :conversation_message_uuid
 
+    # Delay message transmission until date/time
+    attr_accessor :delay_until_dts
+
     attr_accessor :media_urls
 
     attr_accessor :merchant_id
@@ -71,6 +74,7 @@ module UltracartClient
         :'body' => :'body',
         :'client_message_id' => :'client_message_id',
         :'conversation_message_uuid' => :'conversation_message_uuid',
+        :'delay_until_dts' => :'delay_until_dts',
         :'media_urls' => :'media_urls',
         :'merchant_id' => :'merchant_id',
         :'message_dts' => :'message_dts',
@@ -89,6 +93,7 @@ module UltracartClient
         :'body' => :'String',
         :'client_message_id' => :'String',
         :'conversation_message_uuid' => :'String',
+        :'delay_until_dts' => :'String',
         :'media_urls' => :'Array<String>',
         :'merchant_id' => :'String',
         :'message_dts' => :'String',
@@ -127,6 +132,10 @@ module UltracartClient
         self.conversation_message_uuid = attributes[:'conversation_message_uuid']
       end
 
+      if attributes.has_key?(:'delay_until_dts')
+        self.delay_until_dts = attributes[:'delay_until_dts']
+      end
+
       if attributes.has_key?(:'media_urls')
         if (value = attributes[:'media_urls']).is_a?(Array)
           self.media_urls = value
@@ -197,6 +206,7 @@ module UltracartClient
           body == o.body &&
           client_message_id == o.client_message_id &&
           conversation_message_uuid == o.conversation_message_uuid &&
+          delay_until_dts == o.delay_until_dts &&
           media_urls == o.media_urls &&
           merchant_id == o.merchant_id &&
           message_dts == o.message_dts &&
@@ -215,7 +225,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, media_urls, merchant_id, message_dts, message_epoch, transport_statuses, type, upload_keys].hash
+      [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, delay_until_dts, media_urls, merchant_id, message_dts, message_epoch, transport_statuses, type, upload_keys].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.70'
+  VERSION = '3.10.71'
 end

metadata

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