ultracart_api 4.0.50.rc → 4.0.53.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20f4107abe5c5c048d1dc72eeb90abe36267fcf46e6a0ee229a61de254aad73f
-  data.tar.gz: b0189c7f51337c28dc5a0e6fc1d7490e2b89b3fdbd465e1c05fa5ad651fa1d89
+  metadata.gz: 90c1f1f46b19290dbacc7ddd905336cc88761c048dd9fd6186b8804cc6ea3f3a
+  data.tar.gz: e5d62d5ceada964dda81b4acccc568a214032452befa4ee76bb1e83134b3053a
 SHA512:
-  metadata.gz: 0cb722ef4e5653b42c999763f81276e56832de9b017ad234f56ccc2e523d1ca32ff82650d2c6f1226541107094af4457f2b6312c532bd6575427f8b892e61767
-  data.tar.gz: f94050a8d39e0dcee5b540e9085bc887312fd2320e3ae4be5a6186aff401b8e0b2b2db22ff987d972b762da06309ac30744e4b4b5afb3a7ef9e179a791c7a960
+  metadata.gz: 5a3fa783076a129e2db48df1d87d0795cbb406a6094a2925e81b3466d3ebad7b13e84f87b12d394d085d7c20901a0bbb13dc3b7f5b697c9e11a6ac6c7efa01a3
+  data.tar.gz: 298e8bbe856eb22a26b95a770b1e67bbd8ea684a048693e7964b7d4b9e77ba49c75c60ec00dc7946075dafdd1efbbebac04c78d449f0b9a8e65719b2114166c3

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.50.rc
+- Package version: 4.0.53.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.50.rc.gem
+gem install ./ultracart_api-4.0.53.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.50.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.53.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.50.rc'
+    gem 'ultracart_api', '~> 4.0.53.rc'
 
 ### Install from Git
 
@@ -570,6 +570,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
  - [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
+ - [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
@@ -624,6 +625,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CouponItemSearchResult](docs/CouponItemSearchResult.md)
  - [UltracartClient::CouponItemSearchResultsResponse](docs/CouponItemSearchResultsResponse.md)
  - [UltracartClient::CouponMultipleAmountsOffItems](docs/CouponMultipleAmountsOffItems.md)
+ - [UltracartClient::CouponNoDiscount](docs/CouponNoDiscount.md)
  - [UltracartClient::CouponPercentOffItemWithItemsQuantityPurchase](docs/CouponPercentOffItemWithItemsQuantityPurchase.md)
  - [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
  - [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
@@ -1180,6 +1182,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.53-RC | 08/10/2022 | conversation event refactoring |
+| 4.0.52-RC | 08/05/2022 | conversation adjustments for ES integration |
+| 4.0.51-RC | 08/05/2022 | conversations query by medium and stats fixes |
 | 4.0.50-RC | 08/03/2022 | conversation summary participants |
 | 4.0.49-RC | 08/03/2022 | more conversation events |
 | 4.0.48-RC | 08/02/2022 | storefront communication sequence test method |

data/docs/Conversation.md

@@ -7,9 +7,18 @@
 | **closed** | **Boolean** |  | [optional] |
 | **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] |
+| **medium** | **String** | The communication medium of the customer. | [optional] |
 | **merchant_id** | **String** |  | [optional] |
+| **message_count** | **Integer** |  | [optional] |
 | **messages** | [**Array<ConversationMessage>**](ConversationMessage.md) |  | [optional] |
 | **participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) |  | [optional] |
+| **start_dts** | **String** | Start of the conversation date/time | [optional] |
+| **unread_messages** | **Boolean** |  | [optional] |
+| **visible** | **Boolean** |  | [optional] |
 
 ## Example
 
@@ -20,9 +29,18 @@ instance = UltracartClient::Conversation.new(
   closed: null,
   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,
+  medium: null,
   merchant_id: null,
+  message_count: null,
   messages: null,
-  participants: null
+  participants: null,
+  start_dts: null,
+  unread_messages: null,
+  visible: null
 )
 ```
 

data/docs/ConversationApi.md

@@ -316,6 +316,7 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
 
 api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
 opts = {
+  medium: 'medium_example', # String | 
   _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
   _offset: 56 # Integer | Pagination of the record set.  Offset is a zero based index.
 }
@@ -351,6 +352,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **medium** | **String** |  | [optional] |
 | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
 | **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
 

data/docs/ConversationEventReadMessage.md

@@ -0,0 +1,22 @@
+# UltracartClient::ConversationEventReadMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_message_uuid** | **String** |  | [optional] |
+| **message_dts** | **String** | Message date/time | [optional] |
+| **message_epoch** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationEventReadMessage.new(
+  conversation_message_uuid: null,
+  message_dts: null,
+  message_epoch: null
+)
+```
+

data/docs/ConversationMessage.md

@@ -8,8 +8,11 @@
 | **author_conversation_participant_name** | **String** |  | [optional] |
 | **body** | **String** |  | [optional] |
 | **client_message_id** | **String** |  | [optional] |
+| **conversation_message_uuid** | **String** |  | [optional] |
 | **media_urls** | **Array<String>** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
 | **message_dts** | **String** | Message date/time | [optional] |
+| **message_epoch** | **Integer** | Message epoch milliseconds | [optional] |
 | **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) |  | [optional] |
 | **type** | **String** | Message type | [optional] |
 | **upload_keys** | **Array<String>** |  | [optional] |
@@ -24,8 +27,11 @@ instance = UltracartClient::ConversationMessage.new(
   author_conversation_participant_name: null,
   body: null,
   client_message_id: null,
+  conversation_message_uuid: null,
   media_urls: null,
+  merchant_id: null,
   message_dts: null,
+  message_epoch: null,
   transport_statuses: null,
   type: null,
   upload_keys: null

data/docs/ConversationMessageTransportStatus.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **conversation_participant_arn** | **String** |  | [optional] |
-| **status** | **String** |  | [optional] |
+| **status** | **String** | The status of the message transport | [optional] |
 
 ## Example
 

data/docs/ConversationParticipant.md

@@ -11,6 +11,7 @@
 | **last_message_dts** | **String** | Last message date/time | [optional] |
 | **left_dts** | **String** | Left conversation date/time | [optional] |
 | **status** | **String** |  | [optional] |
+| **unread_messages** | **Integer** |  | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = UltracartClient::ConversationParticipant.new(
   joined_dts: null,
   last_message_dts: null,
   left_dts: null,
-  status: null
+  status: null,
+  unread_messages: null
 )
 ```
 

data/docs/ConversationSummary.md

@@ -11,6 +11,7 @@
 | **last_conversation_participant_arn** | **String** |  | [optional] |
 | **last_conversation_participant_name** | **String** |  | [optional] |
 | **last_message_dts** | **String** | Last message date/time | [optional] |
+| **medium** | **String** | The communication medium of the customer. | [optional] |
 | **merchant_id** | **String** |  | [optional] |
 | **message_count** | **Integer** |  | [optional] |
 | **participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) |  | [optional] |
@@ -31,6 +32,7 @@ instance = UltracartClient::ConversationSummary.new(
   last_conversation_participant_arn: null,
   last_conversation_participant_name: null,
   last_message_dts: null,
+  medium: null,
   merchant_id: null,
   message_count: null,
   participants: null,

data/docs/ConversationWebsocketMessage.md

@@ -11,6 +11,7 @@
 | **event_participant_update** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] |
 | **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) |  | [optional] |
 | **event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) |  | [optional] |
+| **event_read_message** | [**ConversationEventReadMessage**](ConversationEventReadMessage.md) |  | [optional] |
 | **event_rrweb** | [**ConversationEventRRWeb**](ConversationEventRRWeb.md) |  | [optional] |
 | **event_type** | **String** | Type of event | [optional] |
 | **event_typing** | [**ConversationEventTyping**](ConversationEventTyping.md) |  | [optional] |
@@ -31,6 +32,7 @@ instance = UltracartClient::ConversationWebsocketMessage.new(
   event_participant_update: null,
   event_queue_position: null,
   event_queue_status_update: null,
+  event_read_message: null,
   event_rrweb: null,
   event_type: null,
   event_typing: null,

data/docs/Coupon.md

@@ -39,7 +39,7 @@
 | **merchant_code** | **String** | Merchant code of coupon up to 20 characters. | [optional] |
 | **merchant_notes** | **String** | Internal notes about this coupon.  These are not visible to customer. | [optional] |
 | **multiple_amounts_off_items** | [**CouponMultipleAmountsOffItems**](CouponMultipleAmountsOffItems.md) |  | [optional] |
-| **no_discount** | **Object** |  | [optional] |
+| **no_discount** | [**CouponNoDiscount**](CouponNoDiscount.md) |  | [optional] |
 | **percent_off_item_with_items_quantity_purchase** | [**CouponPercentOffItemWithItemsQuantityPurchase**](CouponPercentOffItemWithItemsQuantityPurchase.md) |  | [optional] |
 | **percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) |  | [optional] |
 | **percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) |  | [optional] |

data/docs/CouponNoDiscount.md

@@ -0,0 +1,18 @@
+# UltracartClient::CouponNoDiscount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ignore_this_property** | **Boolean** | This property does nothing but is included in this object to ensure the object is generated by our sdk builders. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::CouponNoDiscount.new(
+  ignore_this_property: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -279,6 +279,7 @@ module UltracartClient
     # 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 [String] :medium 
     # @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]
@@ -290,6 +291,7 @@ module UltracartClient
     # 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 [String] :medium 
     # @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
@@ -302,6 +304,7 @@ module UltracartClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'medium'] = opts[:'medium'] if !opts[:'medium'].nil?
       query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
       query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
 

data/lib/ultracart_api/models/conversation.rb

@@ -21,21 +21,73 @@ module UltracartClient
 
     attr_accessor :conversation_uuid
 
+    attr_accessor :last_conversation_message_body
+
+    attr_accessor :last_conversation_participant_arn
+
+    attr_accessor :last_conversation_participant_name
+
+    # Last message date/time
+    attr_accessor :last_message_dts
+
+    # The communication medium of the customer.
+    attr_accessor :medium
+
     attr_accessor :merchant_id
 
+    attr_accessor :message_count
+
     attr_accessor :messages
 
     attr_accessor :participants
 
+    # Start of the conversation date/time
+    attr_accessor :start_dts
+
+    attr_accessor :unread_messages
+
+    attr_accessor :visible
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'closed' => :'closed',
         :'conversation_arn' => :'conversation_arn',
         :'conversation_uuid' => :'conversation_uuid',
+        :'last_conversation_message_body' => :'last_conversation_message_body',
+        :'last_conversation_participant_arn' => :'last_conversation_participant_arn',
+        :'last_conversation_participant_name' => :'last_conversation_participant_name',
+        :'last_message_dts' => :'last_message_dts',
+        :'medium' => :'medium',
         :'merchant_id' => :'merchant_id',
+        :'message_count' => :'message_count',
         :'messages' => :'messages',
-        :'participants' => :'participants'
+        :'participants' => :'participants',
+        :'start_dts' => :'start_dts',
+        :'unread_messages' => :'unread_messages',
+        :'visible' => :'visible'
       }
     end
 
@@ -50,9 +102,18 @@ module UltracartClient
         :'closed' => :'Boolean',
         :'conversation_arn' => :'String',
         :'conversation_uuid' => :'String',
+        :'last_conversation_message_body' => :'String',
+        :'last_conversation_participant_arn' => :'String',
+        :'last_conversation_participant_name' => :'String',
+        :'last_message_dts' => :'String',
+        :'medium' => :'String',
         :'merchant_id' => :'String',
+        :'message_count' => :'Integer',
         :'messages' => :'Array<ConversationMessage>',
-        :'participants' => :'Array<ConversationParticipant>'
+        :'participants' => :'Array<ConversationParticipant>',
+        :'start_dts' => :'String',
+        :'unread_messages' => :'Boolean',
+        :'visible' => :'Boolean'
       }
     end
 
@@ -89,10 +150,34 @@ module UltracartClient
         self.conversation_uuid = attributes[:'conversation_uuid']
       end
 
+      if attributes.key?(:'last_conversation_message_body')
+        self.last_conversation_message_body = attributes[:'last_conversation_message_body']
+      end
+
+      if attributes.key?(:'last_conversation_participant_arn')
+        self.last_conversation_participant_arn = attributes[:'last_conversation_participant_arn']
+      end
+
+      if attributes.key?(:'last_conversation_participant_name')
+        self.last_conversation_participant_name = attributes[:'last_conversation_participant_name']
+      end
+
+      if attributes.key?(:'last_message_dts')
+        self.last_message_dts = attributes[:'last_message_dts']
+      end
+
+      if attributes.key?(:'medium')
+        self.medium = attributes[:'medium']
+      end
+
       if attributes.key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
 
+      if attributes.key?(:'message_count')
+        self.message_count = attributes[:'message_count']
+      end
+
       if attributes.key?(:'messages')
         if (value = attributes[:'messages']).is_a?(Array)
           self.messages = value
@@ -104,6 +189,18 @@ module UltracartClient
           self.participants = value
         end
       end
+
+      if attributes.key?(:'start_dts')
+        self.start_dts = attributes[:'start_dts']
+      end
+
+      if attributes.key?(:'unread_messages')
+        self.unread_messages = attributes[:'unread_messages']
+      end
+
+      if attributes.key?(:'visible')
+        self.visible = attributes[:'visible']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -116,9 +213,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      medium_validator = EnumAttributeValidator.new('String', ["sms", "websocket"])
+      return false unless medium_validator.valid?(@medium)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] medium Object to be assigned
+    def medium=(medium)
+      validator = EnumAttributeValidator.new('String', ["sms", "websocket"])
+      unless validator.valid?(medium)
+        fail ArgumentError, "invalid value for \"medium\", must be one of #{validator.allowable_values}."
+      end
+      @medium = medium
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -127,9 +236,18 @@ module UltracartClient
           closed == o.closed &&
           conversation_arn == o.conversation_arn &&
           conversation_uuid == o.conversation_uuid &&
+          last_conversation_message_body == o.last_conversation_message_body &&
+          last_conversation_participant_arn == o.last_conversation_participant_arn &&
+          last_conversation_participant_name == o.last_conversation_participant_name &&
+          last_message_dts == o.last_message_dts &&
+          medium == o.medium &&
           merchant_id == o.merchant_id &&
+          message_count == o.message_count &&
           messages == o.messages &&
-          participants == o.participants
+          participants == o.participants &&
+          start_dts == o.start_dts &&
+          unread_messages == o.unread_messages &&
+          visible == o.visible
     end
 
     # @see the `==` method
@@ -141,7 +259,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [closed, conversation_arn, conversation_uuid, merchant_id, messages, participants].hash
+      [closed, conversation_arn, conversation_uuid, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_message_dts, medium, merchant_id, message_count, messages, participants, start_dts, unread_messages, visible].hash
     end
 
     # Builds the object from hash