ultracart_api 3.11.21 → 3.11.23

data/lib/ultracart_api/models/custom_report_usage_breakdown.rb

@@ -0,0 +1,194 @@
+=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 CustomReportUsageBreakdown
+    attr_accessor :usage
+
+    # Date/time that usage occurred
+    attr_accessor :usage_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'usage' => :'usage',
+        :'usage_date' => :'usage_date'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'usage' => :'Float',
+        :'usage_date' => :'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?(:'usage')
+        self.usage = attributes[:'usage']
+      end
+
+      if attributes.has_key?(:'usage_date')
+        self.usage_date = attributes[:'usage_date']
+      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 &&
+          usage == o.usage &&
+          usage_date == o.usage_date
+    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
+      [usage, usage_date].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/models/customer.rb

@@ -81,6 +81,9 @@ module UltracartClient
     # Exempt shipping handling charge
     attr_accessor :exempt_shipping_handling_charge
 
+    # Fax Number
+    attr_accessor :fax
+
     # FedEx account number
     attr_accessor :fedex_account_number
 
@@ -224,6 +227,7 @@ module UltracartClient
         :'edi' => :'edi',
         :'email' => :'email',
         :'exempt_shipping_handling_charge' => :'exempt_shipping_handling_charge',
+        :'fax' => :'fax',
         :'fedex_account_number' => :'fedex_account_number',
         :'free_shipping' => :'free_shipping',
         :'free_shipping_minimum' => :'free_shipping_minimum',
@@ -294,6 +298,7 @@ module UltracartClient
         :'edi' => :'CustomerEDI',
         :'email' => :'String',
         :'exempt_shipping_handling_charge' => :'BOOLEAN',
+        :'fax' => :'String',
         :'fedex_account_number' => :'String',
         :'free_shipping' => :'BOOLEAN',
         :'free_shipping_minimum' => :'Float',
@@ -446,6 +451,10 @@ module UltracartClient
         self.exempt_shipping_handling_charge = attributes[:'exempt_shipping_handling_charge']
       end
 
+      if attributes.has_key?(:'fax')
+        self.fax = attributes[:'fax']
+      end
+
       if attributes.has_key?(:'fedex_account_number')
         self.fedex_account_number = attributes[:'fedex_account_number']
       end
@@ -641,6 +650,10 @@ module UltracartClient
         invalid_properties.push('invalid value for "dhl_duty_account_number", the character length must be smaller than or equal to 20.')
       end
 
+      if !@fax.nil? && @fax.to_s.length > 32
+        invalid_properties.push('invalid value for "fax", the character length must be smaller than or equal to 32.')
+      end
+
       if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
         invalid_properties.push('invalid value for "fedex_account_number", the character length must be smaller than or equal to 20.')
       end
@@ -682,6 +695,7 @@ module UltracartClient
       return false if !@business_notes.nil? && @business_notes.to_s.length > 2000
       return false if !@dhl_account_number.nil? && @dhl_account_number.to_s.length > 20
       return false if !@dhl_duty_account_number.nil? && @dhl_duty_account_number.to_s.length > 20
+      return false if !@fax.nil? && @fax.to_s.length > 32
       return false if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
       return false if !@last_modified_by.nil? && @last_modified_by.to_s.length > 100
       return false if !@password.nil? && @password.to_s.length > 30
@@ -723,6 +737,16 @@ module UltracartClient
       @dhl_duty_account_number = dhl_duty_account_number
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] fax Value to be assigned
+    def fax=(fax)
+      if !fax.nil? && fax.to_s.length > 32
+        fail ArgumentError, 'invalid value for "fax", the character length must be smaller than or equal to 32.'
+      end
+
+      @fax = fax
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] fedex_account_number Value to be assigned
     def fedex_account_number=(fedex_account_number)
@@ -831,6 +855,7 @@ module UltracartClient
           edi == o.edi &&
           email == o.email &&
           exempt_shipping_handling_charge == o.exempt_shipping_handling_charge &&
+          fax == o.fax &&
           fedex_account_number == o.fedex_account_number &&
           free_shipping == o.free_shipping &&
           free_shipping_minimum == o.free_shipping_minimum &&
@@ -883,7 +908,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_drop_shipping, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, dhl_account_number, dhl_duty_account_number, do_not_send_mail, edi, email, exempt_shipping_handling_charge, fedex_account_number, free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, merchant_id, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, properties, qb_class, qb_code, qb_tax_exemption_reason_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, send_signup_notification, shipping, signup_dts, software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, ups_account_number, website_url].hash
+      [activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_drop_shipping, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, dhl_account_number, dhl_duty_account_number, do_not_send_mail, edi, email, exempt_shipping_handling_charge, fax, fedex_account_number, free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, merchant_id, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, properties, qb_class, qb_code, qb_tax_exemption_reason_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, send_signup_notification, shipping, signup_dts, software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, ups_account_number, website_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/item_shipping_method.rb

@@ -56,6 +56,9 @@ module UltracartClient
     # Shipping method validity
     attr_accessor :shipping_method_validity
 
+    # Ships separately
+    attr_accessor :ships_separately
+
     # Signature required
     attr_accessor :signature_required
 
@@ -98,6 +101,7 @@ module UltracartClient
         :'shipping_method' => :'shipping_method',
         :'shipping_method_oid' => :'shipping_method_oid',
         :'shipping_method_validity' => :'shipping_method_validity',
+        :'ships_separately' => :'ships_separately',
         :'signature_required' => :'signature_required'
       }
     end
@@ -119,6 +123,7 @@ module UltracartClient
         :'shipping_method' => :'String',
         :'shipping_method_oid' => :'Integer',
         :'shipping_method_validity' => :'String',
+        :'ships_separately' => :'BOOLEAN',
         :'signature_required' => :'BOOLEAN'
       }
     end
@@ -187,6 +192,10 @@ module UltracartClient
         self.shipping_method_validity = attributes[:'shipping_method_validity']
       end
 
+      if attributes.has_key?(:'ships_separately')
+        self.ships_separately = attributes[:'ships_separately']
+      end
+
       if attributes.has_key?(:'signature_required')
         self.signature_required = attributes[:'signature_required']
       end
@@ -236,6 +245,7 @@ module UltracartClient
           shipping_method == o.shipping_method &&
           shipping_method_oid == o.shipping_method_oid &&
           shipping_method_validity == o.shipping_method_validity &&
+          ships_separately == o.ships_separately &&
           signature_required == o.signature_required
     end
 
@@ -248,7 +258,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cost, each_additional_item_markup, filter_to_if_available, first_item_markup, fixed_shipping_cost, flat_fee_markup, free_shipping, per_item_fee_markup, percentage_markup, percentage_of_item_markup, relax_restrictions_on_upsell, shipping_method, shipping_method_oid, shipping_method_validity, signature_required].hash
+      [cost, each_additional_item_markup, filter_to_if_available, first_item_markup, fixed_shipping_cost, flat_fee_markup, free_shipping, per_item_fee_markup, percentage_markup, percentage_of_item_markup, relax_restrictions_on_upsell, shipping_method, shipping_method_oid, shipping_method_validity, ships_separately, signature_required].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_payment.rb

@@ -241,7 +241,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Goldbelly', 'GoHighLevel', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card', 'PayPal Fastlane'])
+      payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'Crypto', 'eBay', 'eCheck', 'Google Shopping', 'Goldbelly', 'GoHighLevel', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card', 'PayPal Fastlane'])
       return false unless payment_method_validator.valid?(@payment_method)
       payment_status_validator = EnumAttributeValidator.new('String', ['Unprocessed', 'Authorized', 'Capture Failed', 'Processed', 'Declined', 'Voided', 'Refunded', 'Skipped'])
       return false unless payment_status_validator.valid?(@payment_status)
@@ -251,7 +251,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Goldbelly', 'GoHighLevel', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card', 'PayPal Fastlane'])
+      validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon Pay', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'Crypto', 'eBay', 'eCheck', 'Google Shopping', 'Goldbelly', 'GoHighLevel', 'Insurance', 'Link', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card', 'PayPal Fastlane'])
       unless validator.valid?(payment_method)
         fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
       end

data/lib/ultracart_api/models/replace_order_item_id_request.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module UltracartClient
   class ReplaceOrderItemIdRequest
-    # Index of the item on the order (one based index)
+    # Index of the item on the order.  Must match order.items[].item_index
     attr_accessor :item_index
 
     # Item ID

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -157,6 +157,7 @@ require 'ultracart_api/models/conversation_canned_message'
 require 'ultracart_api/models/conversation_canned_message_response'
 require 'ultracart_api/models/conversation_canned_messages_response'
 require 'ultracart_api/models/conversation_canned_messages_search'
+require 'ultracart_api/models/conversation_delete_knowledge_base_document_response'
 require 'ultracart_api/models/conversation_department'
 require 'ultracart_api/models/conversation_department_member'
 require 'ultracart_api/models/conversation_department_members_response'
@@ -176,7 +177,13 @@ require 'ultracart_api/models/conversation_event_rr_web'
 require 'ultracart_api/models/conversation_event_read_message'
 require 'ultracart_api/models/conversation_event_typing'
 require 'ultracart_api/models/conversation_event_webchat_context'
+require 'ultracart_api/models/conversation_insert_knowledge_base_document_request'
+require 'ultracart_api/models/conversation_insert_knowledge_base_document_response'
 require 'ultracart_api/models/conversation_join_request'
+require 'ultracart_api/models/conversation_knowledge_base_document'
+require 'ultracart_api/models/conversation_knowledge_base_document_upload_url'
+require 'ultracart_api/models/conversation_knowledge_base_document_upload_url_response'
+require 'ultracart_api/models/conversation_knowledge_base_documents_response'
 require 'ultracart_api/models/conversation_location_country'
 require 'ultracart_api/models/conversation_location_state_province'
 require 'ultracart_api/models/conversation_locations_response'
@@ -343,6 +350,7 @@ require 'ultracart_api/models/custom_report_parameter_option'
 require 'ultracart_api/models/custom_report_query'
 require 'ultracart_api/models/custom_report_response'
 require 'ultracart_api/models/custom_report_tooltip'
+require 'ultracart_api/models/custom_report_usage_breakdown'
 require 'ultracart_api/models/custom_reports_execution_report_data'
 require 'ultracart_api/models/custom_reports_execution_request'
 require 'ultracart_api/models/custom_reports_execution_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.21
+  version: 3.11.23
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-09 00:00:00.000000000 Z
+date: 2025-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -366,6 +366,7 @@ files:
 - docs/ConversationCannedMessageResponse.md
 - docs/ConversationCannedMessagesResponse.md
 - docs/ConversationCannedMessagesSearch.md
+- docs/ConversationDeleteKnowledgeBaseDocumentResponse.md
 - docs/ConversationDepartment.md
 - docs/ConversationDepartmentMember.md
 - docs/ConversationDepartmentMembersResponse.md
@@ -385,7 +386,13 @@ files:
 - docs/ConversationEventReadMessage.md
 - docs/ConversationEventTyping.md
 - docs/ConversationEventWebchatContext.md
+- docs/ConversationInsertKnowledgeBaseDocumentRequest.md
+- docs/ConversationInsertKnowledgeBaseDocumentResponse.md
 - docs/ConversationJoinRequest.md
+- docs/ConversationKnowledgeBaseDocument.md
+- docs/ConversationKnowledgeBaseDocumentUploadUrl.md
+- docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md
+- docs/ConversationKnowledgeBaseDocumentsResponse.md
 - docs/ConversationLocationCountry.md
 - docs/ConversationLocationStateProvince.md
 - docs/ConversationLocationsResponse.md
@@ -553,6 +560,7 @@ files:
 - docs/CustomReportQuery.md
 - docs/CustomReportResponse.md
 - docs/CustomReportTooltip.md
+- docs/CustomReportUsageBreakdown.md
 - docs/CustomReportsExecutionReportData.md
 - docs/CustomReportsExecutionRequest.md
 - docs/CustomReportsExecutionResponse.md
@@ -1297,6 +1305,7 @@ files:
 - lib/ultracart_api/models/conversation_canned_message_response.rb
 - lib/ultracart_api/models/conversation_canned_messages_response.rb
 - lib/ultracart_api/models/conversation_canned_messages_search.rb
+- lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb
 - lib/ultracart_api/models/conversation_department.rb
 - lib/ultracart_api/models/conversation_department_member.rb
 - lib/ultracart_api/models/conversation_department_members_response.rb
@@ -1316,7 +1325,13 @@ files:
 - lib/ultracart_api/models/conversation_event_rr_web.rb
 - lib/ultracart_api/models/conversation_event_typing.rb
 - lib/ultracart_api/models/conversation_event_webchat_context.rb
+- lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb
+- lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb
 - lib/ultracart_api/models/conversation_join_request.rb
+- lib/ultracart_api/models/conversation_knowledge_base_document.rb
+- lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb
+- lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb
+- lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb
 - lib/ultracart_api/models/conversation_location_country.rb
 - lib/ultracart_api/models/conversation_location_state_province.rb
 - lib/ultracart_api/models/conversation_locations_response.rb
@@ -1483,6 +1498,7 @@ files:
 - lib/ultracart_api/models/custom_report_query.rb
 - lib/ultracart_api/models/custom_report_response.rb
 - lib/ultracart_api/models/custom_report_tooltip.rb
+- lib/ultracart_api/models/custom_report_usage_breakdown.rb
 - lib/ultracart_api/models/custom_reports_execution_report_data.rb
 - lib/ultracart_api/models/custom_reports_execution_request.rb
 - lib/ultracart_api/models/custom_reports_execution_response.rb