ultracart_api 3.10.22 → 3.10.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05722e44889d98eac4a8db4a0227dbbdc2469b7f727d73163c519669929de1a2
-  data.tar.gz: c3cd123c695a10b0febf241f82343e52c426df8726ce0dc7dbfdb7e3e1c60961
+  metadata.gz: b4af8b1802f29835912c31dbf47b4a6aace7bde8fe41ba6dc168301bdfc1d32c
+  data.tar.gz: 5c6db27fba9988151c4f8cdb2b2629471c7f3415573bb7f001573a5fea7d52da
 SHA512:
-  metadata.gz: 5374b87901b42001e7faadcd3d128bc1a5e60b8335427af72749745773ad0fa909f5b19638bee04173e8c3c304a7a1895dc5547832e5ba20503685eeb29becad
-  data.tar.gz: c3e2892579f7146cebdab8f6769ddc20e006f7eb7ce50cfdf7be19fb0e6a5cfa9b2271585c8a9f5f0904d3f488d4ba7146917b0ba59211e1939372126df91a6a
+  metadata.gz: 809ed5a47539b0946f910a7b7a7351ee19b95860cece13d8d2dcef63123da38eb58ed555f407767ee3997ddaf04fe0b2bd658b20f73409ac16e60efde550a859
+  data.tar.gz: 42d8b1dc51470d12018937c5723c314db08eab31da54b3ec9e313e60f733e9c230424e3265cfcf2b6b114fcb6518bfa35a18936cf3211949c0e3500326b3dc5b

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.22
+- Package version: 3.10.23
 - 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.22.gem
+gem install ./ultracart_api-3.10.23.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.22.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.23.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.22'
+    gem 'ultracart_api', '~> 3.10.23'
 
 ### Install from Git
 
@@ -466,6 +466,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AutoOrderItemOption](docs/AutoOrderItemOption.md)
  - [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
  - [UltracartClient::AutoOrderLog](docs/AutoOrderLog.md)
+ - [UltracartClient::AutoOrderManagement](docs/AutoOrderManagement.md)
  - [UltracartClient::AutoOrderQuery](docs/AutoOrderQuery.md)
  - [UltracartClient::AutoOrderQueryBatch](docs/AutoOrderQueryBatch.md)
  - [UltracartClient::AutoOrderResponse](docs/AutoOrderResponse.md)
@@ -556,13 +557,19 @@ 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::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
+ - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
+ - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.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)
+ - [UltracartClient::ConversationWebsocketMessage](docs/ConversationWebsocketMessage.md)
  - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
  - [UltracartClient::Country](docs/Country.md)
@@ -1152,6 +1159,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
 | 3.10.22 | 07/20/2022 | conversation participant name added |
 | 3.10.21 | 07/18/2022 | twilio dev |
 | 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |

data/docs/AutoOrder.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **failure_reason** | **String** | The reason this auto order failed during the last rebill attempt | [optional] 
 **items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional] 
 **logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional] 
+**management** | [**AutoOrderManagement**](AutoOrderManagement.md) |  | [optional] 
 **next_attempt** | **String** | The next time that the auto order will be attempted for processing | [optional] 
 **original_order** | [**Order**](Order.md) |  | [optional] 
 **original_order_id** | **String** | The original order id that this auto order is associated with. | [optional] 

data/docs/AutoOrderManagement.md

@@ -0,0 +1,8 @@
+# UltracartClient::AutoOrderManagement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**update_billing_url** | **String** | URL where the customer can go to update their billing information. | [optional] 
+
+

data/docs/ConversationAgentAuth.md

@@ -0,0 +1,13 @@
+# 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] 
+
+

data/docs/ConversationAgentAuthResponse.md

@@ -3,11 +3,10 @@
 ## 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] 
+**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] 
 
 

data/docs/ConversationApi.md

@@ -59,7 +59,7 @@ This endpoint does not need any parameter.
 
 
 # **get_conversation**
-> Conversation get_conversation(conversation_uuid)
+> ConversationResponse get_conversation(conversation_uuid)
 
 Retrieve a conversation
 
@@ -95,7 +95,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Conversation**](Conversation.md)
+[**ConversationResponse**](ConversationResponse.md)
 
 ### Authorization
 
@@ -109,7 +109,7 @@ Name | Type | Description  | Notes
 
 
 # **get_conversation_multimedia_upload_url**
-> get_conversation_multimedia_upload_url(extension)
+> ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
 
 Get a presigned conersation multimedia upload URL
 
@@ -130,7 +130,8 @@ extension = 'extension_example' # String |
 
 begin
   #Get a presigned conersation multimedia upload URL
-  api_instance.get_conversation_multimedia_upload_url(extension)
+  result = api_instance.get_conversation_multimedia_upload_url(extension)
+  p result
 rescue UltracartClient::ApiError => e
   puts "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
 end
@@ -144,7 +145,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-nil (empty response body)
+[**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
 
 ### Authorization
 

data/docs/ConversationEventQueuePosition.md

@@ -0,0 +1,7 @@
+# UltracartClient::ConversationEventQueuePosition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/ConversationMultimediaUploadUrl.md

@@ -0,0 +1,9 @@
+# UltracartClient::ConversationMultimediaUploadUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/ConversationMultimediaUploadUrlResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationMultimediaUploadUrlResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_multimedia_upload_url** | [**ConversationMultimediaUploadUrl**](ConversationMultimediaUploadUrl.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] 
+
+

data/docs/ConversationResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/ConversationStartRequest.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **add_conversation_participant_arns** | **Array<String>** |  | [optional] 
 **conversation_arn** | **String** |  | [optional] 
+**conversation_webchat_queue_uuid** | **String** |  | [optional] 
 
 

data/docs/ConversationStartResponse.md

@@ -3,7 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**conversation_arn** | **String** |  | [optional] 
-**conversation_uuid** | **String** |  | [optional] 
+**conversation** | [**Conversation**](Conversation.md) |  | [optional] 
 
 

data/docs/ConversationWebsocketMessage.md

@@ -0,0 +1,16 @@
+# UltracartClient::ConversationWebsocketMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_uuid** | **String** | Conversation UUID if the websocket message is tied to a specific conversation | [optional] 
+**event_conversation_closed** | [**Conversation**](Conversation.md) |  | [optional] 
+**event_new_conversation** | [**Conversation**](Conversation.md) |  | [optional] 
+**event_new_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 
+**event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) |  | [optional] 
+**event_type** | **String** | Type of event | [optional] 
+**event_updated_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 
+**message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] 
+**type** | **String** | Type of message | [optional] 
+
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -85,7 +85,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid 
     # @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
@@ -95,7 +95,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Conversation, Fixnum, Hash)>] Conversation data, response status code and response headers
+    # @return [Array<(ConversationResponse, Fixnum, 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 ...'
@@ -130,7 +130,7 @@ module UltracartClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Conversation')
+        :return_type => 'ConversationResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ConversationApi#get_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -140,17 +140,17 @@ module UltracartClient
     # Get a presigned conersation multimedia upload URL 
     # @param extension 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [ConversationMultimediaUploadUrlResponse]
     def get_conversation_multimedia_upload_url(extension, opts = {})
-      get_conversation_multimedia_upload_url_with_http_info(extension, opts)
-      nil
+      data, _status_code, _headers = get_conversation_multimedia_upload_url_with_http_info(extension, opts)
+      data
     end
 
     # Get a presigned conersation multimedia upload URL
     # Get a presigned conersation multimedia upload URL 
     # @param extension 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    # @return [Array<(ConversationMultimediaUploadUrlResponse, Fixnum, Hash)>] ConversationMultimediaUploadUrlResponse data, response status code and response headers
     def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
@@ -184,7 +184,8 @@ module UltracartClient
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names)
+        :auth_names => auth_names,
+        :return_type => 'ConversationMultimediaUploadUrlResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/ultracart_api/models/auto_order.rb

@@ -59,6 +59,8 @@ module UltracartClient
     # Logs associated with this auto order
     attr_accessor :logs
 
+    attr_accessor :management
+
     # The next time that the auto order will be attempted for processing
     attr_accessor :next_attempt
 
@@ -119,6 +121,7 @@ module UltracartClient
         :'failure_reason' => :'failure_reason',
         :'items' => :'items',
         :'logs' => :'logs',
+        :'management' => :'management',
         :'next_attempt' => :'next_attempt',
         :'original_order' => :'original_order',
         :'original_order_id' => :'original_order_id',
@@ -147,6 +150,7 @@ module UltracartClient
         :'failure_reason' => :'String',
         :'items' => :'Array<AutoOrderItem>',
         :'logs' => :'Array<AutoOrderLog>',
+        :'management' => :'AutoOrderManagement',
         :'next_attempt' => :'String',
         :'original_order' => :'Order',
         :'original_order_id' => :'String',
@@ -229,6 +233,10 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'management')
+        self.management = attributes[:'management']
+      end
+
       if attributes.has_key?(:'next_attempt')
         self.next_attempt = attributes[:'next_attempt']
       end
@@ -305,6 +313,7 @@ module UltracartClient
           failure_reason == o.failure_reason &&
           items == o.items &&
           logs == o.logs &&
+          management == o.management &&
           next_attempt == o.next_attempt &&
           original_order == o.original_order &&
           original_order_id == o.original_order_id &&
@@ -323,7 +332,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
+      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/auto_order_management.rb

@@ -0,0 +1,185 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class AutoOrderManagement
+    # URL where the customer can go to update their billing information.
+    attr_accessor :update_billing_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'update_billing_url' => :'update_billing_url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'update_billing_url' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'update_billing_url')
+        self.update_billing_url = attributes[:'update_billing_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 &&
+          update_billing_url == o.update_billing_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 [Fixnum] Hash code
+    def hash
+      [update_billing_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 build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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