ultracart_api 3.11.27 → 3.11.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e0974216f56310e0cb0191b1ca87bd7ac4afc5955357929666aa76e85650787
-  data.tar.gz: 4c0ecbded1164a3d001b3fd617859fe9380e26a10f84c975cb9567c5ddfde286
+  metadata.gz: 2e2b4677a03b2103fa194b40ebb76de6d6a3e1f73f8fdba966fb3933746d7be4
+  data.tar.gz: e8e4d31945bfd34d06c080aad8fa06a441f2d4f2c9818bd7ec094815676d97ea
 SHA512:
-  metadata.gz: 74bf842cb8d67ab5fd58255a9d6387ad119ffe987d2f772698c2363863379f8acd378f58a746bd3070291e5a1a16be4f97fd8531cf04ef7aefa11d82b38a6487
-  data.tar.gz: 63788204c264bc77dcaaece2136b8c3306defb614a6f807a5c5976b39551a296ff38805a19c50b4d26c1e00a0a38a4da552ac4c699e9957127573f4827158377
+  metadata.gz: 9186c2fe6a2abf34ca8e44c79486d50c19273158b0a72cbdda7e484a8aae6bc1a3c5a84c2004580c23532aba8e1c02051880551ac4ee7c33a606eb08ff2145c7
+  data.tar.gz: 600e0b573b33e0116ddf9a7d7e963dcdbb5f0bd070123b6141870db6c8d2b6f45f0f7d22bd11ab557ab7833f7fb613d0cf1cb40bb5f2a961fd3665f8b3f67936

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.11.27
+- Package version: 3.11.28
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.27.gem
+gem install ./ultracart_api-3.11.28.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.27.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.28.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.11.27'
+    gem 'ultracart_api', '~> 3.11.28'
 
 ### Install from Git
 
@@ -343,6 +343,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
 *UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
 *UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
+*UltracartClient::OrderApi* | [**assign_to_affiliate**](docs/OrderApi.md#assign_to_affiliate) | **POST** /order/orders/{order_id}/assignToAffiliate | Assigns an order to an affiliate
 *UltracartClient::OrderApi* | [**block_refund_on_order**](docs/OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
 *UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
@@ -1270,6 +1271,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::Order](docs/Order.md)
  - [UltracartClient::OrderAffiliate](docs/OrderAffiliate.md)
  - [UltracartClient::OrderAffiliateLedger](docs/OrderAffiliateLedger.md)
+ - [UltracartClient::OrderAssignToAffiliateRequest](docs/OrderAssignToAffiliateRequest.md)
  - [UltracartClient::OrderAutoOrder](docs/OrderAutoOrder.md)
  - [UltracartClient::OrderBilling](docs/OrderBilling.md)
  - [UltracartClient::OrderBuysafe](docs/OrderBuysafe.md)
@@ -1589,6 +1591,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.28 | 11/07/2025 | OrderApi.assignToAffiliate |
 | 3.11.27 | 11/06/2025 | conversation ai knowledge base changes |
 | 3.11.26 | 10/20/2025 | conversation api bug fixes |
 | 3.11.25 | 10/20/2025 | conversation api bug fix for bad url on agent profile kb upload |

data/docs/OrderApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
+[**assign_to_affiliate**](OrderApi.md#assign_to_affiliate) | **POST** /order/orders/{order_id}/assignToAffiliate | Assigns an order to an affiliate
 [**block_refund_on_order**](OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
 [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
@@ -89,6 +90,63 @@ Name | Type | Description  | Notes
 
 
 
+# **assign_to_affiliate**
+> OrderResponse assign_to_affiliate(order_id, assign_to_affiliate_request, opts)
+
+Assigns an order to an affiliate
+
+Assigns an order to an affiliate. 
+
+### 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::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to assign to the affiliate.
+
+assign_to_affiliate_request = UltracartClient::OrderAssignToAffiliateRequest.new # OrderAssignToAffiliateRequest | Assign to affiliate request
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Assigns an order to an affiliate
+  result = api_instance.assign_to_affiliate(order_id, assign_to_affiliate_request, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->assign_to_affiliate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to assign to the affiliate. | 
+ **assign_to_affiliate_request** | [**OrderAssignToAffiliateRequest**](OrderAssignToAffiliateRequest.md)| Assign to affiliate request | 
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **block_refund_on_order**
 > block_refund_on_order(order_id, opts)
 

data/docs/OrderAssignToAffiliateRequest.md

@@ -0,0 +1,10 @@
+# UltracartClient::OrderAssignToAffiliateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**affiliate_email** | **String** | Affiliate email to associate with the order | [optional] 
+**affiliate_id** | **Integer** | Affiliate id to associate with the order | [optional] 
+**affiliate_sub_id** | **String** | Affiliate sub id to associate with the order | [optional] 
+
+

data/lib/ultracart_api/api/order_api.rb

@@ -93,6 +93,70 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Assigns an order to an affiliate
+    # Assigns an order to an affiliate. 
+    # @param order_id The order id to assign to the affiliate.
+    # @param assign_to_affiliate_request Assign to affiliate request
+    # @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 assign_to_affiliate(order_id, assign_to_affiliate_request, opts = {})
+      data, _status_code, _headers = assign_to_affiliate_with_http_info(order_id, assign_to_affiliate_request, opts)
+      data
+    end
+
+    # Assigns an order to an affiliate
+    # Assigns an order to an affiliate. 
+    # @param order_id The order id to assign to the affiliate.
+    # @param assign_to_affiliate_request Assign to affiliate request
+    # @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 assign_to_affiliate_with_http_info(order_id, assign_to_affiliate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.assign_to_affiliate ...'
+      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.assign_to_affiliate"
+      end
+      # verify the required parameter 'assign_to_affiliate_request' is set
+      if @api_client.config.client_side_validation && assign_to_affiliate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'assign_to_affiliate_request' when calling OrderApi.assign_to_affiliate"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/assignToAffiliate'.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'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(assign_to_affiliate_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, 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#assign_to_affiliate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Set a refund block on an order
     # Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
     # @param order_id The order id to block a refund on.

data/lib/ultracart_api/models/order_assign_to_affiliate_request.rb

@@ -0,0 +1,220 @@
+=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 OrderAssignToAffiliateRequest
+    # Affiliate email to associate with the order
+    attr_accessor :affiliate_email
+
+    # Affiliate id to associate with the order
+    attr_accessor :affiliate_id
+
+    # Affiliate sub id to associate with the order
+    attr_accessor :affiliate_sub_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'affiliate_email' => :'affiliate_email',
+        :'affiliate_id' => :'affiliate_id',
+        :'affiliate_sub_id' => :'affiliate_sub_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'affiliate_email' => :'String',
+        :'affiliate_id' => :'Integer',
+        :'affiliate_sub_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?(:'affiliate_email')
+        self.affiliate_email = attributes[:'affiliate_email']
+      end
+
+      if attributes.has_key?(:'affiliate_id')
+        self.affiliate_id = attributes[:'affiliate_id']
+      end
+
+      if attributes.has_key?(:'affiliate_sub_id')
+        self.affiliate_sub_id = attributes[:'affiliate_sub_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
+      if !@affiliate_sub_id.nil? && @affiliate_sub_id.to_s.length > 50
+        invalid_properties.push('invalid value for "affiliate_sub_id", the character length must be smaller than or equal to 50.')
+      end
+
+      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?
+      return false if !@affiliate_sub_id.nil? && @affiliate_sub_id.to_s.length > 50
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] affiliate_sub_id Value to be assigned
+    def affiliate_sub_id=(affiliate_sub_id)
+      if !affiliate_sub_id.nil? && affiliate_sub_id.to_s.length > 50
+        fail ArgumentError, 'invalid value for "affiliate_sub_id", the character length must be smaller than or equal to 50.'
+      end
+
+      @affiliate_sub_id = affiliate_sub_id
+    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 &&
+          affiliate_email == o.affiliate_email &&
+          affiliate_id == o.affiliate_id &&
+          affiliate_sub_id == o.affiliate_sub_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
+      [affiliate_email, affiliate_id, affiliate_sub_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

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -669,6 +669,7 @@ require 'ultracart_api/models/oauth_token_response'
 require 'ultracart_api/models/order'
 require 'ultracart_api/models/order_affiliate'
 require 'ultracart_api/models/order_affiliate_ledger'
+require 'ultracart_api/models/order_assign_to_affiliate_request'
 require 'ultracart_api/models/order_auto_order'
 require 'ultracart_api/models/order_billing'
 require 'ultracart_api/models/order_buysafe'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.27
+  version: 3.11.28
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-06 00:00:00.000000000 Z
+date: 2025-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -887,6 +887,7 @@ files:
 - docs/OrderAffiliate.md
 - docs/OrderAffiliateLedger.md
 - docs/OrderApi.md
+- docs/OrderAssignToAffiliateRequest.md
 - docs/OrderAutoOrder.md
 - docs/OrderBilling.md
 - docs/OrderBuysafe.md
@@ -1817,6 +1818,7 @@ files:
 - lib/ultracart_api/models/order.rb
 - lib/ultracart_api/models/order_affiliate.rb
 - lib/ultracart_api/models/order_affiliate_ledger.rb
+- lib/ultracart_api/models/order_assign_to_affiliate_request.rb
 - lib/ultracart_api/models/order_auto_order.rb
 - lib/ultracart_api/models/order_billing.rb
 - lib/ultracart_api/models/order_buysafe.rb