ultracart_api 3.11.57 → 3.11.58

data/lib/ultracart_api/api/order_api.rb

@@ -949,6 +949,70 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get Order Upsell Cart
+    # Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to 
+    # @param upsell_cart_request Request for the upsell cart
+    # @param order_id The order id to base things on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [OrderResponse]
+    def get_order_upsell_cart(upsell_cart_request, order_id, opts = {})
+      data, _status_code, _headers = get_order_upsell_cart_with_http_info(upsell_cart_request, order_id, opts)
+      data
+    end
+
+    # Get Order Upsell Cart
+    # Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to 
+    # @param upsell_cart_request Request for the upsell cart
+    # @param order_id The order id to base things on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    def get_order_upsell_cart_with_http_info(upsell_cart_request, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_order_upsell_cart ...'
+      end
+      # verify the required parameter 'upsell_cart_request' is set
+      if @api_client.config.client_side_validation && upsell_cart_request.nil?
+        fail ArgumentError, "Missing the required parameter 'upsell_cart_request' when calling OrderApi.get_order_upsell_cart"
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_upsell_cart"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/upsell_with_cart'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(upsell_cart_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#get_order_upsell_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve orders
     # Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/email_commseq_postcard.rb

@@ -44,7 +44,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/models/{item_inventory_update_request.rb → order_upsell_cart_request.rb}

@@ -13,21 +13,28 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 require 'date'
 
 module UltracartClient
-  class ItemInventoryUpdateRequest
-    # Inventory updates array
-    attr_accessor :inventory_updates
+  class OrderUpsellCartRequest
+    attr_accessor :checkout_url
+
+    attr_accessor :coupon_codes
+
+    attr_accessor :items
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'inventory_updates' => :'inventory_updates'
+        :'checkout_url' => :'checkout_url',
+        :'coupon_codes' => :'coupon_codes',
+        :'items' => :'items'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'inventory_updates' => :'Array<ItemInventoryUpdate>'
+        :'checkout_url' => :'String',
+        :'coupon_codes' => :'Array<String>',
+        :'items' => :'Array<CartItem>'
       }
     end
 
@@ -39,9 +46,19 @@ module UltracartClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'inventory_updates')
-        if (value = attributes[:'inventory_updates']).is_a?(Array)
-          self.inventory_updates = value
+      if attributes.has_key?(:'checkout_url')
+        self.checkout_url = attributes[:'checkout_url']
+      end
+
+      if attributes.has_key?(:'coupon_codes')
+        if (value = attributes[:'coupon_codes']).is_a?(Array)
+          self.coupon_codes = value
+        end
+      end
+
+      if attributes.has_key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
         end
       end
     end
@@ -64,7 +81,9 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          inventory_updates == o.inventory_updates
+          checkout_url == o.checkout_url &&
+          coupon_codes == o.coupon_codes &&
+          items == o.items
     end
 
     # @see the `==` method
@@ -76,7 +95,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [inventory_updates].hash
+      [checkout_url, coupon_codes, items].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -640,8 +640,6 @@ require 'ultracart_api/models/item_internal'
 require 'ultracart_api/models/item_inventory_snapshot'
 require 'ultracart_api/models/item_inventory_snapshot_distribution_center'
 require 'ultracart_api/models/item_inventory_snapshot_response'
-require 'ultracart_api/models/item_inventory_update'
-require 'ultracart_api/models/item_inventory_update_request'
 require 'ultracart_api/models/item_kit_component'
 require 'ultracart_api/models/item_kit_definition'
 require 'ultracart_api/models/item_option'
@@ -673,7 +671,6 @@ require 'ultracart_api/models/item_shipping_case'
 require 'ultracart_api/models/item_shipping_destination_markup'
 require 'ultracart_api/models/item_shipping_destination_restriction'
 require 'ultracart_api/models/item_shipping_distribution_center'
-require 'ultracart_api/models/item_shipping_distribution_center_response'
 require 'ultracart_api/models/item_shipping_method'
 require 'ultracart_api/models/item_shipping_package_requirement'
 require 'ultracart_api/models/item_tag'
@@ -779,6 +776,7 @@ 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/order_upsell_cart_request'
 require 'ultracart_api/models/order_utm'
 require 'ultracart_api/models/order_validation_request'
 require 'ultracart_api/models/order_validation_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.57
+  version: 3.11.58
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-03 00:00:00.000000000 Z
+date: 2026-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -856,8 +856,6 @@ files:
 - docs/ItemInventorySnapshot.md
 - docs/ItemInventorySnapshotDistributionCenter.md
 - docs/ItemInventorySnapshotResponse.md
-- docs/ItemInventoryUpdate.md
-- docs/ItemInventoryUpdateRequest.md
 - docs/ItemKitComponent.md
 - docs/ItemKitDefinition.md
 - docs/ItemOption.md
@@ -889,7 +887,6 @@ files:
 - docs/ItemShippingDestinationMarkup.md
 - docs/ItemShippingDestinationRestriction.md
 - docs/ItemShippingDistributionCenter.md
-- docs/ItemShippingDistributionCenterResponse.md
 - docs/ItemShippingMethod.md
 - docs/ItemShippingPackageRequirement.md
 - docs/ItemTag.md
@@ -997,6 +994,7 @@ files:
 - docs/OrderTrackingNumberDetail.md
 - docs/OrderTrackingNumberDetails.md
 - docs/OrderTransactionalMerchantNote.md
+- docs/OrderUpsellCartRequest.md
 - docs/OrderUtm.md
 - docs/OrderValidationRequest.md
 - docs/OrderValidationResponse.md
@@ -1833,8 +1831,6 @@ files:
 - lib/ultracart_api/models/item_inventory_snapshot.rb
 - lib/ultracart_api/models/item_inventory_snapshot_distribution_center.rb
 - lib/ultracart_api/models/item_inventory_snapshot_response.rb
-- lib/ultracart_api/models/item_inventory_update.rb
-- lib/ultracart_api/models/item_inventory_update_request.rb
 - lib/ultracart_api/models/item_kit_component.rb
 - lib/ultracart_api/models/item_kit_definition.rb
 - lib/ultracart_api/models/item_option.rb
@@ -1866,7 +1862,6 @@ files:
 - lib/ultracart_api/models/item_shipping_destination_markup.rb
 - lib/ultracart_api/models/item_shipping_destination_restriction.rb
 - lib/ultracart_api/models/item_shipping_distribution_center.rb
-- lib/ultracart_api/models/item_shipping_distribution_center_response.rb
 - lib/ultracart_api/models/item_shipping_method.rb
 - lib/ultracart_api/models/item_shipping_package_requirement.rb
 - lib/ultracart_api/models/item_tag.rb
@@ -1972,6 +1967,7 @@ files:
 - 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/order_upsell_cart_request.rb
 - lib/ultracart_api/models/order_utm.rb
 - lib/ultracart_api/models/order_validation_request.rb
 - lib/ultracart_api/models/order_validation_response.rb

data/docs/ItemInventoryUpdate.md

@@ -1,10 +0,0 @@
-# UltracartClient::ItemInventoryUpdate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**distribution_center_code** | **String** | Distribution center code | [optional] 
-**inventory_level** | **Float** | Inventory level | [optional] 
-**merchant_item_id** | **String** | Merchant Item ID | [optional] 
-
-

data/docs/ItemInventoryUpdateRequest.md

@@ -1,8 +0,0 @@
-# UltracartClient::ItemInventoryUpdateRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**inventory_updates** | [**Array<ItemInventoryUpdate>**](ItemInventoryUpdate.md) | Inventory updates array | [optional] 
-
-

data/docs/ItemShippingDistributionCenterResponse.md

@@ -1,12 +0,0 @@
-# UltracartClient::ItemShippingDistributionCenterResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**Error**](Error.md) |  | [optional] 
-**item_shipping_distribution_center** | [**ItemShippingDistributionCenter**](ItemShippingDistributionCenter.md) |  | [optional] 
-**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
-**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
-**warning** | [**Warning**](Warning.md) |  | [optional] 
-
-

data/lib/ultracart_api/models/item_inventory_update.rb

@@ -1,205 +0,0 @@
-=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 ItemInventoryUpdate
-    # Distribution center code
-    attr_accessor :distribution_center_code
-
-    # Inventory level
-    attr_accessor :inventory_level
-
-    # Merchant Item ID
-    attr_accessor :merchant_item_id
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'distribution_center_code' => :'distribution_center_code',
-        :'inventory_level' => :'inventory_level',
-        :'merchant_item_id' => :'merchant_item_id'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'distribution_center_code' => :'String',
-        :'inventory_level' => :'Float',
-        :'merchant_item_id' => :'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?(:'distribution_center_code')
-        self.distribution_center_code = attributes[:'distribution_center_code']
-      end
-
-      if attributes.has_key?(:'inventory_level')
-        self.inventory_level = attributes[:'inventory_level']
-      end
-
-      if attributes.has_key?(:'merchant_item_id')
-        self.merchant_item_id = attributes[:'merchant_item_id']
-      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 &&
-          distribution_center_code == o.distribution_center_code &&
-          inventory_level == o.inventory_level &&
-          merchant_item_id == o.merchant_item_id
-    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
-      [distribution_center_code, inventory_level, merchant_item_id].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