ultracart_api 3.10.103 → 3.10.104

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1038148a4471c091d9393a22bb80f92efb6b6d47423b5a4be7ebc626ccf8997e
-  data.tar.gz: 602448bba19c727f70bf8673852842fa31d68208b63c78f7c0d173119becf8c0
+  metadata.gz: 9e6ed916ee2c1d483d50eaae43ccdfdeb7aa9b8eeee3186bb1de867bb3e885ce
+  data.tar.gz: 59bb7c731337e33f1e21a5745b034ddf77fa070979223e4f99db987884cb5389
 SHA512:
-  metadata.gz: 0eabcd937d665bc447046f67b49eeac23614065f9c41fef5273aa16344095ac0cd621110a4a8b54e1ff58b5b12c5280aee14a13ae96ee4fa95ccb6b4d747669f
-  data.tar.gz: 02d8623da93eb1c1ce507ff022fd1ecf3cfd6e8a20646aa3aeb02a71ded6844cd040dc98bceb46543226f035644d037a42a3ee2858efd69b5d073431b69d3ea5
+  metadata.gz: '068dd4a1f94fa34da588534433e082d8804e37c276cc89bf45293c6aaa7c44b8a50171938f6813a8f4ac660ef11a76ac6bde571c924c95f82dddae5becacb3cf'
+  data.tar.gz: bc133396e089b3cdcf9eb741c713f2ae5761e1836ffceba990970224aa98ce2583a76ea23670b98c2db9627f68f120ac9fea09fa7a9b0d357db70731016edadb

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.103
+- Package version: 3.10.104
 - 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.103.gem
+gem install ./ultracart_api-3.10.104.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.103.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.104.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.103'
+    gem 'ultracart_api', '~> 3.10.104'
 
 ### Install from Git
 
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
 *UltracartClient::ConversationApi* | [**get_conversation_department_member_list**](docs/ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members
 *UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
+*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
 *UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
 *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
@@ -1087,6 +1088,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderTokenResponse](docs/OrderTokenResponse.md)
  - [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
+ - [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
  - [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
  - [UltracartClient::Permission](docs/Permission.md)
  - [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
@@ -1288,6 +1290,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.104 | 01/23/2023 | conversation - method to fetch single engagement record |
 | 3.10.103 | 01/19/2023 | added skip_on_rebill field to coupon object |
 | 3.10.102 | 01/19/2023 | convo - getConversationPermissions added |
 | 3.10.101 | 01/18/2023 | conversation get dept member list method added |

data/docs/ConversationApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
 [**get_conversation_department_member_list**](ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members
 [**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
+[**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
 [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
 [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
@@ -511,6 +512,56 @@ This endpoint does not need any parameter.
 
 
 
+# **get_conversation_engagement**
+> ConversationEngagementResponse get_conversation_engagement(conversation_engagement_oid)
+
+Retrieve an engagement
+
+Retrieve an engagement 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_engagement_oid = 56 # Integer | 
+
+
+begin
+  #Retrieve an engagement
+  result = api_instance.get_conversation_engagement(conversation_engagement_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_conversation_engagement: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_engagement_oid** | **Integer**|  | 
+
+### Return type
+
+[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_conversation_engagements**
 > ConversationEngagementsResponse get_conversation_engagements
 

data/docs/OrderInternal.md

@@ -4,9 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **exported_to_accounting** | **BOOLEAN** | True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true | [optional] 
-**merchant_notes** | **String** | Merchant notes | [optional] 
+**merchant_notes** | **String** | Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled. | [optional] 
 **placed_by_user** | **String** | If placed via the BEOE, this is the user that placed the order | [optional] 
 **refund_by_user** | **String** | User that issued the refund | [optional] 
 **sales_rep_code** | **String** | Sales rep code associated with the order | [optional] 
+**transactional_merchant_notes** | [**Array<OrderTransactionalMerchantNote>**](OrderTransactionalMerchantNote.md) | Transactional merchant notes | [optional] 
 
 

data/docs/OrderTransactionalMerchantNote.md

@@ -0,0 +1,11 @@
+# UltracartClient::OrderTransactionalMerchantNote
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip_address** | **String** | IP Address | [optional] 
+**note** | **String** | note | [optional] 
+**note_dts** | **String** | Timestamp when the note was added | [optional] 
+**user** | **String** | User that wrote the merchant note | [optional] 
+
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -551,6 +551,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve an engagement
+    # Retrieve an engagement 
+    # @param conversation_engagement_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationEngagementResponse]
+    def get_conversation_engagement(conversation_engagement_oid, opts = {})
+      data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
+      data
+    end
+
+    # Retrieve an engagement
+    # Retrieve an engagement 
+    # @param conversation_engagement_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
+    def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
+      end
+      # verify the required parameter 'conversation_engagement_oid' is set
+      if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
+      end
+      # resource path
+      local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationEngagementResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve a list of engagements ordered by name
     # Retrieve a list of engagements ordered by name 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/order_internal.rb

@@ -17,7 +17,7 @@ module UltracartClient
     # True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true
     attr_accessor :exported_to_accounting
 
-    # Merchant notes
+    # Merchant notes.  Full notes in non-transactional mode.  Just used to write a new merchant note when transaction merchant notes enabled.
     attr_accessor :merchant_notes
 
     # If placed via the BEOE, this is the user that placed the order
@@ -29,6 +29,9 @@ module UltracartClient
     # Sales rep code associated with the order
     attr_accessor :sales_rep_code
 
+    # Transactional merchant notes
+    attr_accessor :transactional_merchant_notes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,7 +39,8 @@ module UltracartClient
         :'merchant_notes' => :'merchant_notes',
         :'placed_by_user' => :'placed_by_user',
         :'refund_by_user' => :'refund_by_user',
-        :'sales_rep_code' => :'sales_rep_code'
+        :'sales_rep_code' => :'sales_rep_code',
+        :'transactional_merchant_notes' => :'transactional_merchant_notes'
       }
     end
 
@@ -47,7 +51,8 @@ module UltracartClient
         :'merchant_notes' => :'String',
         :'placed_by_user' => :'String',
         :'refund_by_user' => :'String',
-        :'sales_rep_code' => :'String'
+        :'sales_rep_code' => :'String',
+        :'transactional_merchant_notes' => :'Array<OrderTransactionalMerchantNote>'
       }
     end
 
@@ -78,6 +83,12 @@ module UltracartClient
       if attributes.has_key?(:'sales_rep_code')
         self.sales_rep_code = attributes[:'sales_rep_code']
       end
+
+      if attributes.has_key?(:'transactional_merchant_notes')
+        if (value = attributes[:'transactional_merchant_notes']).is_a?(Array)
+          self.transactional_merchant_notes = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +128,8 @@ module UltracartClient
           merchant_notes == o.merchant_notes &&
           placed_by_user == o.placed_by_user &&
           refund_by_user == o.refund_by_user &&
-          sales_rep_code == o.sales_rep_code
+          sales_rep_code == o.sales_rep_code &&
+          transactional_merchant_notes == o.transactional_merchant_notes
     end
 
     # @see the `==` method
@@ -129,7 +141,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [exported_to_accounting, merchant_notes, placed_by_user, refund_by_user, sales_rep_code].hash
+      [exported_to_accounting, merchant_notes, placed_by_user, refund_by_user, sales_rep_code, transactional_merchant_notes].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_transactional_merchant_note.rb

@@ -0,0 +1,215 @@
+=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 OrderTransactionalMerchantNote
+    # IP Address
+    attr_accessor :ip_address
+
+    # note
+    attr_accessor :note
+
+    # Timestamp when the note was added
+    attr_accessor :note_dts
+
+    # User that wrote the merchant note
+    attr_accessor :user
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ip_address' => :'ip_address',
+        :'note' => :'note',
+        :'note_dts' => :'note_dts',
+        :'user' => :'user'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'ip_address' => :'String',
+        :'note' => :'String',
+        :'note_dts' => :'String',
+        :'user' => :'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?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.has_key?(:'note')
+        self.note = attributes[:'note']
+      end
+
+      if attributes.has_key?(:'note_dts')
+        self.note_dts = attributes[:'note_dts']
+      end
+
+      if attributes.has_key?(:'user')
+        self.user = attributes[:'user']
+      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 &&
+          ip_address == o.ip_address &&
+          note == o.note &&
+          note_dts == o.note_dts &&
+          user == o.user
+    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
+      [ip_address, note, note_dts, user].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

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.103'
+  VERSION = '3.10.104'
 end

data/lib/ultracart_api.rb

@@ -617,6 +617,7 @@ require 'ultracart_api/models/order_taxes'
 require 'ultracart_api/models/order_token_response'
 require 'ultracart_api/models/order_tracking_number_detail'
 require 'ultracart_api/models/order_tracking_number_details'
+require 'ultracart_api/models/order_transactional_merchant_note'
 require 'ultracart_api/models/orders_response'
 require 'ultracart_api/models/permission'
 require 'ultracart_api/models/point_of_sale_location'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.103
+  version: 3.10.104
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -835,6 +835,7 @@ files:
 - docs/OrderTokenResponse.md
 - docs/OrderTrackingNumberDetail.md
 - docs/OrderTrackingNumberDetails.md
+- docs/OrderTransactionalMerchantNote.md
 - docs/OrdersResponse.md
 - docs/Permission.md
 - docs/PointOfSaleLocation.md
@@ -1595,6 +1596,7 @@ files:
 - lib/ultracart_api/models/order_token_response.rb
 - lib/ultracart_api/models/order_tracking_number_detail.rb
 - lib/ultracart_api/models/order_tracking_number_details.rb
+- lib/ultracart_api/models/order_transactional_merchant_note.rb
 - lib/ultracart_api/models/orders_response.rb
 - lib/ultracart_api/models/permission.rb
 - lib/ultracart_api/models/point_of_sale_location.rb