ultracart_api 4.0.87.rc → 4.0.88.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc219066ac586692df1300754f45595fffa03ab2734801bd0950156d5b64d3ab
-  data.tar.gz: bea4eee612019ac116e992d5c68ecc4844ee051ce97ff6d7ec37150c1753f67a
+  metadata.gz: 70f39317e942ba4cfd827cef236e6937ab5b284ef21b145acddfda442ed1f9f5
+  data.tar.gz: 2dfbfdfadad666579f4ebdbaf3581465a5b8a6aa18828df25fe510413b257c8f
 SHA512:
-  metadata.gz: 3fb52576a7a509c0664f5b0c51db4679150841c357c003e35feeed6f1c4174f9ca32228c2ad97a7c51877ff550adf7526860682ec2e58ba2e27d68416420cebd
-  data.tar.gz: cc957623034627e837c4a660c9c52c349a82d22527f7aac85bc54cdb1187257119559dfbf1bcf81861562d8a9b7ae960986ca78d5c46cc55d0611f302d137c39
+  metadata.gz: 493368cf8f53a5e116293ffd7acd058559c1f01faafe9e864ca767e101a2b6cb612248a06e8c4af89944dca2070a7c68f201ae5f89733be3aac64b17787ec7dd
+  data.tar.gz: 5723985c0b5173dd5a9213c9a0d3f4a28a85c248278eff01d73b6a28c7abe01508cf7e567ceafaea8f52ea5add6f35dd7f24decbcae5cbe0cdf813b909965072

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.87.rc
+- Package version: 4.0.88.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.87.rc.gem
+gem install ./ultracart_api-4.0.88.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.87.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.88.rc.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', '~> 4.0.87.rc'
+    gem 'ultracart_api', '~> 4.0.88.rc'
 
 ### Install from Git
 
@@ -141,6 +141,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
@@ -1233,6 +1234,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.88-RC | 11/29/2022 | converstation marked convo read method |
 | 4.0.87-RC | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
 | 4.0.86-RC | 11/21/2022 | conversation context method |
 | 4.0.85-RC | 11/21/2022 | adjusted conversation event model |

data/docs/ConversationApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
 
@@ -734,6 +735,76 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## mark_read_conversation
+
+> mark_read_conversation(conversation_uuid)
+
+Mark a conversation as read
+
+Mark a conversation as read 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+begin
+  # Mark a conversation as read
+  api_instance.mark_read_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->mark_read_conversation: #{e}"
+end
+```
+
+#### Using the mark_read_conversation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> mark_read_conversation_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Mark a conversation as read
+  data, status_code, headers = api_instance.mark_read_conversation_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->mark_read_conversation_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## start_conversation
 
 > <ConversationStartResponse> start_conversation(start_request)

data/docs/ConversationMessage.md

@@ -9,6 +9,7 @@
 | **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] |
@@ -28,6 +29,7 @@ instance = UltracartClient::ConversationMessage.new(
   body: null,
   client_message_id: null,
   conversation_message_uuid: null,
+  delay_until_dts: null,
   media_urls: null,
   merchant_id: null,
   message_dts: null,

data/lib/ultracart_api/api/conversation_api.rb

@@ -672,6 +672,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Mark a conversation as read
+    # Mark a conversation as read 
+    # @param conversation_uuid [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, 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' + '}', 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.mark_read_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#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 [ConversationStartRequest] Start request

data/lib/ultracart_api/models/conversation_message.rb

@@ -25,6 +25,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
@@ -72,6 +75,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',
@@ -95,6 +99,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',
@@ -146,6 +151,10 @@ module UltracartClient
         self.conversation_message_uuid = attributes[:'conversation_message_uuid']
       end
 
+      if attributes.key?(:'delay_until_dts')
+        self.delay_until_dts = attributes[:'delay_until_dts']
+      end
+
       if attributes.key?(:'media_urls')
         if (value = attributes[:'media_urls']).is_a?(Array)
           self.media_urls = value
@@ -216,6 +225,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 &&
@@ -234,7 +244,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.87.rc'
+  VERSION = '4.0.88.rc'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.87.rc
+  version: 4.0.88.rc
 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