ultracart_api 4.0.37.rc → 4.0.38.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48b47e3d743b9314c562b3ea981b605cee052fc7c3b62fa4f7da74fdf4b5f47
-  data.tar.gz: 924dcfa7461c242d2a003693373f4392b9e5ab7c30b70991579d19ff7b87f3f0
+  metadata.gz: 4f66d20704c5bb1cc75610371df8890543da872135b00e872ae000d6a1c932a4
+  data.tar.gz: 730a9a5582042d832feebac3e619a6352d328b0c5d7d88aedcf4f2dfc01ad4ae
 SHA512:
-  metadata.gz: 9d99937360395a25c786acd38a43836b12ee8b1fb1b98f21baee01105883b62ee9e045e6d8da6c77acefa6055afb4db52b89f985e523aeb6943c957de4bcbfb2
-  data.tar.gz: 4f945414957aed966fe9fb356befaf49b9ee2691139834afb5990edc3ed43e5c9389eedd09997ba05ce48beffad263185f6c9d9e0f870cdc6b991fd78bc3987c
+  metadata.gz: 12969f6465f641fa8c24186a103eae395317cd0e46c7b0dcb248163cbb8dcfc8e09fbf6dde4a1744f7eb03e21383e1290622e8ddbf748eb3a3dad2b21fae79d2
+  data.tar.gz: e8cadff3f645622c757ce6e43cab002b32c23f22a5c8692f28f59d56aa5315eb7b1e0e3c65a2c989724408f4777e0b2b001bdf63a52eec5f43f8c575596e69ad

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.37.rc
+- Package version: 4.0.38.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.37.rc.gem
+gem install ./ultracart_api-4.0.38.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.37.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.38.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.37.rc'
+    gem 'ultracart_api', '~> 4.0.38.rc'
 
 ### Install from Git
 
@@ -562,10 +562,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
  - [UltracartClient::CityStateZip](docs/CityStateZip.md)
  - [UltracartClient::Conversation](docs/Conversation.md)
+ - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
+ - [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
@@ -1160,6 +1162,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.38-RC | 07/21/2022 | conversation bugfix for poor response objects |
 | 4.0.37-RC | 07/20/2022 | conversation participant name added |
 | 4.0.36-RC | 07/18/2022 | twilio dev |
 | 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |

data/docs/AutoOrderItem.md

@@ -11,6 +11,7 @@
 | **arbitrary_unit_cost** | **Float** | Arbitrary unit cost that rebills of this item should occur at | [optional] |
 | **arbitrary_unit_cost_remaining_orders** | **Integer** | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. | [optional] |
 | **auto_order_item_oid** | **Integer** | Primary key of AutoOrderItem | [optional] |
+| **first_order_dts** | **String** | Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet. | [optional] |
 | **frequency** | **String** | Frequency of the rebill if not a fixed schedule | [optional] |
 | **future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional] |
 | **last_order_dts** | **String** | Date/time of the last order of this item | [optional] |
@@ -22,6 +23,7 @@
 | **options** | [**Array<AutoOrderItemOption>**](AutoOrderItemOption.md) | Options associated with this item | [optional] |
 | **original_item_id** | **String** | The original item id purchased.  This item controls scheduling.  If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date. | [optional] |
 | **original_quantity** | **Float** | The original quantity purchased | [optional] |
+| **paused** | **Boolean** | True if paused.  This field is an object instead of a primitive for backwards compatibility. | [optional] |
 | **paypal_payer_id** | **String** | The PayPal Payer ID tied to this item | [optional] |
 | **paypal_recurring_payment_profile_id** | **String** | The PayPal Profile ID tied to this item | [optional] |
 | **preshipment_notice_sent** | **Boolean** | True if the preshipment notice associated with the next rebill has been sent | [optional] |
@@ -42,6 +44,7 @@ instance = UltracartClient::AutoOrderItem.new(
   arbitrary_unit_cost: null,
   arbitrary_unit_cost_remaining_orders: null,
   auto_order_item_oid: null,
+  first_order_dts: null,
   frequency: null,
   future_schedules: null,
   last_order_dts: null,
@@ -53,6 +56,7 @@ instance = UltracartClient::AutoOrderItem.new(
   options: null,
   original_item_id: null,
   original_quantity: null,
+  paused: null,
   paypal_payer_id: null,
   paypal_recurring_payment_profile_id: null,
   preshipment_notice_sent: null,

data/docs/ConversationAgentAuth.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationAgentAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_participant_arn** | **String** |  | [optional] |
+| **conversation_participant_name** | **String** |  | [optional] |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **twilio_phone_numbers** | **Array<String>** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentAuth.new(
+  conversation_participant_arn: null,
+  conversation_participant_name: null,
+  jwt: null,
+  merchant_id: null,
+  twilio_phone_numbers: null,
+  websocket_url: null
+)
+```
+

data/docs/ConversationAgentAuthResponse.md

@@ -4,12 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **conversation_participant_arn** | **String** |  | [optional] |
-| **conversation_participant_name** | **String** |  | [optional] |
-| **jwt** | **String** |  | [optional] |
-| **merchant_id** | **String** |  | [optional] |
-| **twilio_phone_numbers** | **Array<String>** |  | [optional] |
-| **websocket_url** | **String** |  | [optional] |
+| **agent_auth** | [**ConversationAgentAuth**](ConversationAgentAuth.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
 
@@ -17,12 +16,11 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationAgentAuthResponse.new(
-  conversation_participant_arn: null,
-  conversation_participant_name: null,
-  jwt: null,
-  merchant_id: null,
-  twilio_phone_numbers: null,
-  websocket_url: null
+  agent_auth: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
 )
 ```
 

data/docs/ConversationApi.md

@@ -83,7 +83,7 @@ This endpoint does not need any parameter.
 
 ## get_conversation
 
-> <Conversation> get_conversation(conversation_uuid)
+> <ConversationResponse> get_conversation(conversation_uuid)
 
 Retrieve a conversation
 
@@ -118,7 +118,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Conversation>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
+> <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
 
 ```ruby
 begin
@@ -126,7 +126,7 @@ begin
   data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Conversation>
+  p data # => <ConversationResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling ConversationApi->get_conversation_with_http_info: #{e}"
 end
@@ -140,7 +140,7 @@ end
 
 ### Return type
 
-[**Conversation**](Conversation.md)
+[**ConversationResponse**](ConversationResponse.md)
 
 ### Authorization
 

data/docs/ConversationResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation** | [**Conversation**](Conversation.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::ConversationResponse.new(
+  conversation: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationStartResponse.md

@@ -4,8 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **conversation_arn** | **String** |  | [optional] |
-| **conversation_uuid** | **String** |  | [optional] |
+| **conversation** | [**Conversation**](Conversation.md) |  | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationStartResponse.new(
-  conversation_arn: null,
-  conversation_uuid: null
+  conversation: null
 )
 ```
 

data/docs/EmailCommseqPostcard.md

@@ -14,7 +14,7 @@
 | **postcard_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional] |
 | **postcard_front_container_cjson** | **String** | Postcard front container cjson | [optional] |
 | **postcard_front_container_uuid** | **String** | Postcard front container uuid | [optional] |
-| **screenshot_back_url** | **String** | URL to screenshot of the back of the postcard | [optional] |
+| **screenshot_back_url** | **String** | URL to screenshot of the front of the postcard | [optional] |
 | **screenshot_front_url** | **String** | URL to screenshot of the front of the postcard | [optional] |
 | **storefront_oid** | **Integer** | Storefront oid | [optional] |
 

data/lib/ultracart_api/api/conversation_api.rb

@@ -94,7 +94,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Conversation]
+    # @return [ConversationResponse]
     def get_conversation(conversation_uuid, opts = {})
       data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
       data
@@ -104,7 +104,7 @@ module UltracartClient
     # 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
+    # @return [Array<(ConversationResponse, Integer, Hash)>] ConversationResponse 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 ...'
@@ -132,7 +132,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Conversation'
+      return_type = opts[:debug_return_type] || 'ConversationResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

data/lib/ultracart_api/models/auto_order_item.rb

@@ -36,6 +36,9 @@ module UltracartClient
     # Primary key of AutoOrderItem
     attr_accessor :auto_order_item_oid
 
+    # Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet.
+    attr_accessor :first_order_dts
+
     # Frequency of the rebill if not a fixed schedule
     attr_accessor :frequency
 
@@ -69,6 +72,9 @@ module UltracartClient
     # The original quantity purchased
     attr_accessor :original_quantity
 
+    # True if paused.  This field is an object instead of a primitive for backwards compatibility.
+    attr_accessor :paused
+
     # The PayPal Payer ID tied to this item
     attr_accessor :paypal_payer_id
 
@@ -118,6 +124,7 @@ module UltracartClient
         :'arbitrary_unit_cost' => :'arbitrary_unit_cost',
         :'arbitrary_unit_cost_remaining_orders' => :'arbitrary_unit_cost_remaining_orders',
         :'auto_order_item_oid' => :'auto_order_item_oid',
+        :'first_order_dts' => :'first_order_dts',
         :'frequency' => :'frequency',
         :'future_schedules' => :'future_schedules',
         :'last_order_dts' => :'last_order_dts',
@@ -129,6 +136,7 @@ module UltracartClient
         :'options' => :'options',
         :'original_item_id' => :'original_item_id',
         :'original_quantity' => :'original_quantity',
+        :'paused' => :'paused',
         :'paypal_payer_id' => :'paypal_payer_id',
         :'paypal_recurring_payment_profile_id' => :'paypal_recurring_payment_profile_id',
         :'preshipment_notice_sent' => :'preshipment_notice_sent',
@@ -153,6 +161,7 @@ module UltracartClient
         :'arbitrary_unit_cost' => :'Float',
         :'arbitrary_unit_cost_remaining_orders' => :'Integer',
         :'auto_order_item_oid' => :'Integer',
+        :'first_order_dts' => :'String',
         :'frequency' => :'String',
         :'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
         :'last_order_dts' => :'String',
@@ -164,6 +173,7 @@ module UltracartClient
         :'options' => :'Array<AutoOrderItemOption>',
         :'original_item_id' => :'String',
         :'original_quantity' => :'Float',
+        :'paused' => :'Boolean',
         :'paypal_payer_id' => :'String',
         :'paypal_recurring_payment_profile_id' => :'String',
         :'preshipment_notice_sent' => :'Boolean',
@@ -222,6 +232,10 @@ module UltracartClient
         self.auto_order_item_oid = attributes[:'auto_order_item_oid']
       end
 
+      if attributes.key?(:'first_order_dts')
+        self.first_order_dts = attributes[:'first_order_dts']
+      end
+
       if attributes.key?(:'frequency')
         self.frequency = attributes[:'frequency']
       end
@@ -270,6 +284,10 @@ module UltracartClient
         self.original_quantity = attributes[:'original_quantity']
       end
 
+      if attributes.key?(:'paused')
+        self.paused = attributes[:'paused']
+      end
+
       if attributes.key?(:'paypal_payer_id')
         self.paypal_payer_id = attributes[:'paypal_payer_id']
       end
@@ -332,6 +350,7 @@ module UltracartClient
           arbitrary_unit_cost == o.arbitrary_unit_cost &&
           arbitrary_unit_cost_remaining_orders == o.arbitrary_unit_cost_remaining_orders &&
           auto_order_item_oid == o.auto_order_item_oid &&
+          first_order_dts == o.first_order_dts &&
           frequency == o.frequency &&
           future_schedules == o.future_schedules &&
           last_order_dts == o.last_order_dts &&
@@ -343,6 +362,7 @@ module UltracartClient
           options == o.options &&
           original_item_id == o.original_item_id &&
           original_quantity == o.original_quantity &&
+          paused == o.paused &&
           paypal_payer_id == o.paypal_payer_id &&
           paypal_recurring_payment_profile_id == o.paypal_recurring_payment_profile_id &&
           preshipment_notice_sent == o.preshipment_notice_sent &&
@@ -360,7 +380,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
+      [arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, rebill_value, remaining_repeat_count, simple_schedule].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_agent_auth.rb

@@ -0,0 +1,266 @@
+=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 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationAgentAuth
+    attr_accessor :conversation_participant_arn
+
+    attr_accessor :conversation_participant_name
+
+    attr_accessor :jwt
+
+    attr_accessor :merchant_id
+
+    attr_accessor :twilio_phone_numbers
+
+    attr_accessor :websocket_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversation_participant_arn' => :'conversation_participant_arn',
+        :'conversation_participant_name' => :'conversation_participant_name',
+        :'jwt' => :'jwt',
+        :'merchant_id' => :'merchant_id',
+        :'twilio_phone_numbers' => :'twilio_phone_numbers',
+        :'websocket_url' => :'websocket_url'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'conversation_participant_arn' => :'String',
+        :'conversation_participant_name' => :'String',
+        :'jwt' => :'String',
+        :'merchant_id' => :'String',
+        :'twilio_phone_numbers' => :'Array<String>',
+        :'websocket_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationAgentAuth` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationAgentAuth`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'conversation_participant_arn')
+        self.conversation_participant_arn = attributes[:'conversation_participant_arn']
+      end
+
+      if attributes.key?(:'conversation_participant_name')
+        self.conversation_participant_name = attributes[:'conversation_participant_name']
+      end
+
+      if attributes.key?(:'jwt')
+        self.jwt = attributes[:'jwt']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'twilio_phone_numbers')
+        if (value = attributes[:'twilio_phone_numbers']).is_a?(Array)
+          self.twilio_phone_numbers = value
+        end
+      end
+
+      if attributes.key?(:'websocket_url')
+        self.websocket_url = attributes[:'websocket_url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          conversation_participant_arn == o.conversation_participant_arn &&
+          conversation_participant_name == o.conversation_participant_name &&
+          jwt == o.jwt &&
+          merchant_id == o.merchant_id &&
+          twilio_phone_numbers == o.twilio_phone_numbers &&
+          websocket_url == o.websocket_url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [conversation_participant_arn, conversation_participant_name, jwt, merchant_id, twilio_phone_numbers, websocket_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/conversation_agent_auth_response.rb

@@ -15,27 +15,25 @@ require 'time'
 
 module UltracartClient
   class ConversationAgentAuthResponse
-    attr_accessor :conversation_participant_arn
+    attr_accessor :agent_auth
 
-    attr_accessor :conversation_participant_name
+    attr_accessor :error
 
-    attr_accessor :jwt
+    attr_accessor :metadata
 
-    attr_accessor :merchant_id
+    # Indicates if API call was successful
+    attr_accessor :success
 
-    attr_accessor :twilio_phone_numbers
-
-    attr_accessor :websocket_url
+    attr_accessor :warning
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'conversation_participant_arn' => :'conversation_participant_arn',
-        :'conversation_participant_name' => :'conversation_participant_name',
-        :'jwt' => :'jwt',
-        :'merchant_id' => :'merchant_id',
-        :'twilio_phone_numbers' => :'twilio_phone_numbers',
-        :'websocket_url' => :'websocket_url'
+        :'agent_auth' => :'agent_auth',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
       }
     end
 
@@ -47,12 +45,11 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'conversation_participant_arn' => :'String',
-        :'conversation_participant_name' => :'String',
-        :'jwt' => :'String',
-        :'merchant_id' => :'String',
-        :'twilio_phone_numbers' => :'Array<String>',
-        :'websocket_url' => :'String'
+        :'agent_auth' => :'ConversationAgentAuth',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
       }
     end
 
@@ -77,30 +74,24 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'conversation_participant_arn')
-        self.conversation_participant_arn = attributes[:'conversation_participant_arn']
-      end
-
-      if attributes.key?(:'conversation_participant_name')
-        self.conversation_participant_name = attributes[:'conversation_participant_name']
+      if attributes.key?(:'agent_auth')
+        self.agent_auth = attributes[:'agent_auth']
       end
 
-      if attributes.key?(:'jwt')
-        self.jwt = attributes[:'jwt']
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
       end
 
-      if attributes.key?(:'merchant_id')
-        self.merchant_id = attributes[:'merchant_id']
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
       end
 
-      if attributes.key?(:'twilio_phone_numbers')
-        if (value = attributes[:'twilio_phone_numbers']).is_a?(Array)
-          self.twilio_phone_numbers = value
-        end
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
       end
 
-      if attributes.key?(:'websocket_url')
-        self.websocket_url = attributes[:'websocket_url']
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
       end
     end
 
@@ -122,12 +113,11 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          conversation_participant_arn == o.conversation_participant_arn &&
-          conversation_participant_name == o.conversation_participant_name &&
-          jwt == o.jwt &&
-          merchant_id == o.merchant_id &&
-          twilio_phone_numbers == o.twilio_phone_numbers &&
-          websocket_url == o.websocket_url
+          agent_auth == o.agent_auth &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
     end
 
     # @see the `==` method
@@ -139,7 +129,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [conversation_participant_arn, conversation_participant_name, jwt, merchant_id, twilio_phone_numbers, websocket_url].hash
+      [agent_auth, error, metadata, success, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_response.rb

@@ -0,0 +1,256 @@
+=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 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationResponse
+    attr_accessor :conversation
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversation' => :'conversation',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'conversation' => :'Conversation',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'conversation')
+        self.conversation = attributes[:'conversation']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          conversation == o.conversation &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [conversation, error, metadata, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/models/conversation_start_response.rb

@@ -15,15 +15,12 @@ require 'time'
 
 module UltracartClient
   class ConversationStartResponse
-    attr_accessor :conversation_arn
-
-    attr_accessor :conversation_uuid
+    attr_accessor :conversation
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'conversation_arn' => :'conversation_arn',
-        :'conversation_uuid' => :'conversation_uuid'
+        :'conversation' => :'conversation'
       }
     end
 
@@ -35,8 +32,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'conversation_arn' => :'String',
-        :'conversation_uuid' => :'String'
+        :'conversation' => :'Conversation'
       }
     end
 
@@ -61,12 +57,8 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'conversation_arn')
-        self.conversation_arn = attributes[:'conversation_arn']
-      end
-
-      if attributes.key?(:'conversation_uuid')
-        self.conversation_uuid = attributes[:'conversation_uuid']
+      if attributes.key?(:'conversation')
+        self.conversation = attributes[:'conversation']
       end
     end
 
@@ -88,8 +80,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          conversation_arn == o.conversation_arn &&
-          conversation_uuid == o.conversation_uuid
+          conversation == o.conversation
     end
 
     # @see the `==` method
@@ -101,7 +92,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [conversation_arn, conversation_uuid].hash
+      [conversation].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_postcard.rb

@@ -45,7 +45,7 @@ module UltracartClient
     # Postcard front container uuid
     attr_accessor :postcard_front_container_uuid
 
-    # URL to screenshot of the back of the postcard
+    # URL to screenshot of the front of the postcard
     attr_accessor :screenshot_back_url
 
     # URL to screenshot of the front of the postcard

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.37.rc'
+  VERSION = '4.0.38.rc'
 end

data/lib/ultracart_api.rb

@@ -134,10 +134,12 @@ require 'ultracart_api/models/checkout_setup_browser_key_response'
 require 'ultracart_api/models/checkout_state_province_response'
 require 'ultracart_api/models/city_state_zip'
 require 'ultracart_api/models/conversation'
+require 'ultracart_api/models/conversation_agent_auth'
 require 'ultracart_api/models/conversation_agent_auth_response'
 require 'ultracart_api/models/conversation_message'
 require 'ultracart_api/models/conversation_message_transport_status'
 require 'ultracart_api/models/conversation_participant'
+require 'ultracart_api/models/conversation_response'
 require 'ultracart_api/models/conversation_start_request'
 require 'ultracart_api/models/conversation_start_response'
 require 'ultracart_api/models/conversation_summary'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.37.rc
+  version: 4.0.38.rc
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -183,11 +183,13 @@ files:
 - docs/CheckoutStateProvinceResponse.md
 - docs/CityStateZip.md
 - docs/Conversation.md
+- docs/ConversationAgentAuth.md
 - docs/ConversationAgentAuthResponse.md
 - docs/ConversationApi.md
 - docs/ConversationMessage.md
 - docs/ConversationMessageTransportStatus.md
 - docs/ConversationParticipant.md
+- docs/ConversationResponse.md
 - docs/ConversationStartRequest.md
 - docs/ConversationStartResponse.md
 - docs/ConversationSummary.md
@@ -863,10 +865,12 @@ files:
 - lib/ultracart_api/models/checkout_state_province_response.rb
 - lib/ultracart_api/models/city_state_zip.rb
 - lib/ultracart_api/models/conversation.rb
+- lib/ultracart_api/models/conversation_agent_auth.rb
 - lib/ultracart_api/models/conversation_agent_auth_response.rb
 - lib/ultracart_api/models/conversation_message.rb
 - lib/ultracart_api/models/conversation_message_transport_status.rb
 - lib/ultracart_api/models/conversation_participant.rb
+- lib/ultracart_api/models/conversation_response.rb
 - lib/ultracart_api/models/conversation_start_request.rb
 - lib/ultracart_api/models/conversation_start_response.rb
 - lib/ultracart_api/models/conversation_summary.rb