ultracart_api 4.1.73 → 4.1.76

data/lib/ultracart_api/models/conversation_embed_pbx_auth_response.rb

@@ -0,0 +1,270 @@
+=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 ConversationEmbedPbxAuthResponse
+    # Merchant identifier the agent belongs to.
+    attr_accessor :merchant_id
+
+    # True if this agent has PBX admin privileges.
+    attr_accessor :pbx_admin
+
+    # JWT used by the softphone widget to authenticate to the PBX WebSocket relay.
+    attr_accessor :pbx_jwt
+
+    # True if this agent has PBX supervisor privileges.
+    attr_accessor :pbx_supervisor
+
+    # True if this agent has baseline PBX access.
+    attr_accessor :pbx_user
+
+    # Voice identity string identifying this agent to the PBX (e.g., client:user_123).
+    attr_accessor :pbx_voice_identity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'merchant_id' => :'merchant_id',
+        :'pbx_admin' => :'pbx_admin',
+        :'pbx_jwt' => :'pbx_jwt',
+        :'pbx_supervisor' => :'pbx_supervisor',
+        :'pbx_user' => :'pbx_user',
+        :'pbx_voice_identity' => :'pbx_voice_identity'
+      }
+    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
+      {
+        :'merchant_id' => :'String',
+        :'pbx_admin' => :'Boolean',
+        :'pbx_jwt' => :'String',
+        :'pbx_supervisor' => :'Boolean',
+        :'pbx_user' => :'Boolean',
+        :'pbx_voice_identity' => :'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::ConversationEmbedPbxAuthResponse` 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::ConversationEmbedPbxAuthResponse`. 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?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'pbx_admin')
+        self.pbx_admin = attributes[:'pbx_admin']
+      end
+
+      if attributes.key?(:'pbx_jwt')
+        self.pbx_jwt = attributes[:'pbx_jwt']
+      end
+
+      if attributes.key?(:'pbx_supervisor')
+        self.pbx_supervisor = attributes[:'pbx_supervisor']
+      end
+
+      if attributes.key?(:'pbx_user')
+        self.pbx_user = attributes[:'pbx_user']
+      end
+
+      if attributes.key?(:'pbx_voice_identity')
+        self.pbx_voice_identity = attributes[:'pbx_voice_identity']
+      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 &&
+          merchant_id == o.merchant_id &&
+          pbx_admin == o.pbx_admin &&
+          pbx_jwt == o.pbx_jwt &&
+          pbx_supervisor == o.pbx_supervisor &&
+          pbx_user == o.pbx_user &&
+          pbx_voice_identity == o.pbx_voice_identity
+    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
+      [merchant_id, pbx_admin, pbx_jwt, pbx_supervisor, pbx_user, pbx_voice_identity].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/order_format.rb

@@ -63,6 +63,9 @@ module UltracartClient
     # True to translate the order into the native language of the customer
     attr_accessor :translate
 
+    # True to render phone numbers as <phone-number-format> web components in the HTML output. Only honored by the div format. Default false preserves legacy scalar rendering for receipts and unauthenticated consumers.
+    attr_accessor :use_phone_number_web_component
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -103,7 +106,8 @@ module UltracartClient
         :'show_merchant_notes' => :'show_merchant_notes',
         :'show_non_sensitive_payment_info' => :'show_non_sensitive_payment_info',
         :'show_payment_info' => :'show_payment_info',
-        :'translate' => :'translate'
+        :'translate' => :'translate',
+        :'use_phone_number_web_component' => :'use_phone_number_web_component'
       }
     end
 
@@ -130,7 +134,8 @@ module UltracartClient
         :'show_merchant_notes' => :'Boolean',
         :'show_non_sensitive_payment_info' => :'Boolean',
         :'show_payment_info' => :'Boolean',
-        :'translate' => :'Boolean'
+        :'translate' => :'Boolean',
+        :'use_phone_number_web_component' => :'Boolean'
       }
     end
 
@@ -218,6 +223,10 @@ module UltracartClient
       if attributes.key?(:'translate')
         self.translate = attributes[:'translate']
       end
+
+      if attributes.key?(:'use_phone_number_web_component')
+        self.use_phone_number_web_component = attributes[:'use_phone_number_web_component']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -265,7 +274,8 @@ module UltracartClient
           show_merchant_notes == o.show_merchant_notes &&
           show_non_sensitive_payment_info == o.show_non_sensitive_payment_info &&
           show_payment_info == o.show_payment_info &&
-          translate == o.translate
+          translate == o.translate &&
+          use_phone_number_web_component == o.use_phone_number_web_component
     end
 
     # @see the `==` method
@@ -277,7 +287,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [context, dont_link_email_to_search, email_as_link, filter_distribution_center_oid, filter_to_items_in_container_oid, format, hide_bill_to_address, hide_price_information, link_file_attachments, show_contact_info, show_in_merchant_currency, show_internal_information, show_merchant_notes, show_non_sensitive_payment_info, show_payment_info, translate].hash
+      [context, dont_link_email_to_search, email_as_link, filter_distribution_center_oid, filter_to_items_in_container_oid, format, hide_bill_to_address, hide_price_information, link_file_attachments, show_contact_info, show_in_merchant_currency, show_internal_information, show_merchant_notes, show_non_sensitive_payment_info, show_payment_info, translate, use_phone_number_web_component].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.73'
+  VERSION = '4.1.76'
 end

data/lib/ultracart_api.rb

@@ -45,6 +45,7 @@ require 'ultracart_api/models/auto_order_addon_item_option'
 require 'ultracart_api/models/auto_order_addon_items_update_request'
 require 'ultracart_api/models/auto_order_consolidate'
 require 'ultracart_api/models/auto_order_item'
+require 'ultracart_api/models/auto_order_item_cancel_request'
 require 'ultracart_api/models/auto_order_item_future_schedule'
 require 'ultracart_api/models/auto_order_item_option'
 require 'ultracart_api/models/auto_order_item_simple_schedule'
@@ -167,6 +168,7 @@ require 'ultracart_api/models/conversation_department_member'
 require 'ultracart_api/models/conversation_department_members_response'
 require 'ultracart_api/models/conversation_department_response'
 require 'ultracart_api/models/conversation_departments_response'
+require 'ultracart_api/models/conversation_embed_pbx_auth_response'
 require 'ultracart_api/models/conversation_engagement'
 require 'ultracart_api/models/conversation_engagement_equation'
 require 'ultracart_api/models/conversation_engagement_equation_function'
@@ -976,6 +978,7 @@ require 'ultracart_api/api/auto_order_api'
 require 'ultracart_api/api/channel_partner_api'
 require 'ultracart_api/api/checkout_api'
 require 'ultracart_api/api/conversation_api'
+require 'ultracart_api/api/conversation_embed_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
 require 'ultracart_api/api/datawarehouse_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.73
+  version: 4.1.76
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-13 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -91,6 +91,7 @@ files:
 - docs/AutoOrderApi.md
 - docs/AutoOrderConsolidate.md
 - docs/AutoOrderItem.md
+- docs/AutoOrderItemCancelRequest.md
 - docs/AutoOrderItemFutureSchedule.md
 - docs/AutoOrderItemOption.md
 - docs/AutoOrderItemSimpleSchedule.md
@@ -216,6 +217,8 @@ files:
 - docs/ConversationDepartmentMembersResponse.md
 - docs/ConversationDepartmentResponse.md
 - docs/ConversationDepartmentsResponse.md
+- docs/ConversationEmbedApi.md
+- docs/ConversationEmbedPbxAuthResponse.md
 - docs/ConversationEngagement.md
 - docs/ConversationEngagementEquation.md
 - docs/ConversationEngagementEquationFunction.md
@@ -1040,6 +1043,7 @@ files:
 - lib/ultracart_api/api/channel_partner_api.rb
 - lib/ultracart_api/api/checkout_api.rb
 - lib/ultracart_api/api/conversation_api.rb
+- lib/ultracart_api/api/conversation_embed_api.rb
 - lib/ultracart_api/api/coupon_api.rb
 - lib/ultracart_api/api/customer_api.rb
 - lib/ultracart_api/api/datawarehouse_api.rb
@@ -1086,6 +1090,7 @@ files:
 - lib/ultracart_api/models/auto_order_addon_items_update_request.rb
 - lib/ultracart_api/models/auto_order_consolidate.rb
 - lib/ultracart_api/models/auto_order_item.rb
+- lib/ultracart_api/models/auto_order_item_cancel_request.rb
 - lib/ultracart_api/models/auto_order_item_future_schedule.rb
 - lib/ultracart_api/models/auto_order_item_option.rb
 - lib/ultracart_api/models/auto_order_item_simple_schedule.rb
@@ -1208,6 +1213,7 @@ files:
 - lib/ultracart_api/models/conversation_department_members_response.rb
 - lib/ultracart_api/models/conversation_department_response.rb
 - lib/ultracart_api/models/conversation_departments_response.rb
+- lib/ultracart_api/models/conversation_embed_pbx_auth_response.rb
 - lib/ultracart_api/models/conversation_engagement.rb
 - lib/ultracart_api/models/conversation_engagement_equation.rb
 - lib/ultracart_api/models/conversation_engagement_equation_function.rb