ultracart_api 3.11.34 → 3.11.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d9dd10c57529f46db1e3e6c20255aee480d66195a0ed8d4533e99ecdb4c2298
-  data.tar.gz: 8169e071cd3d7e95be459369a881d4e78fff82c25673a742a7bc31e9acda09b0
+  metadata.gz: 74fd0a3b8e29bca5d8137de15d5dbf25af8aa34c49b6fa876256fc02b26d6dcc
+  data.tar.gz: 2caec0dcab300c7e0b5cfa04107a1216b4142e623962823040cbb7abd3d3e116
 SHA512:
-  metadata.gz: 77b9ffadcd36162a43caef78eb0b3f50a156da820c90359b649278f6e36e97e701273e24f0e1d5e76755527cf39c6f0171861df115d259ba76893e824e198893
-  data.tar.gz: faa2cccfb8b349e20d84aca8e3cf888336674fbff25a718e9df3c6460e6e51dee32283611128ccd53166d2d677be01a51e9769f366d454f6dfac08d054fd82fc
+  metadata.gz: 0b0bf20b37350ecad56f6485bf7173e88d48c0b9449074b5396a2c73d3e1012acd31d0e8baeeafab5f8136038e0b4c40647111304a97b5d6f7c96f7a1e9e46ac
+  data.tar.gz: 66f75317d45561cf712e2d2d3b317d3c462b43620165ac4e74e174626b58ff8c5ec2cc9848484726822aa4b6f2058e024ffe077bd182a2680932ca39fa2d2817

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.34
+- Package version: 3.11.35
 - 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.34.gem
+gem install ./ultracart_api-3.11.35.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.34.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.35.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.34'
+    gem 'ultracart_api', '~> 3.11.35'
 
 ### Install from Git
 
@@ -270,6 +270,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CustomerApi* | [**insert_wish_list_item**](docs/CustomerApi.md#insert_wish_list_item) | **POST** /customer/customers/{customer_profile_oid}/wishlist | Insert a customer wishlist item
 *UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
 *UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
+*UltracartClient::CustomerApi* | [**search_customers**](docs/CustomerApi.md#search_customers) | **GET** /customer/customers/search | Search for customers
 *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
 *UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
 *UltracartClient::CustomerApi* | [**update_wish_list_item**](docs/CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
@@ -1601,6 +1602,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
 | 3.11.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
 | 3.11.33 | 11/26/2025 | conversation - AI agent profile fields |
 | 3.11.32 | 11/20/2025 | conversion api bug fix on incorrect signature |

data/docs/CustomerApi.md

@@ -24,6 +24,7 @@ Method | HTTP request | Description
 [**insert_wish_list_item**](CustomerApi.md#insert_wish_list_item) | **POST** /customer/customers/{customer_profile_oid}/wishlist | Insert a customer wishlist item
 [**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
 [**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
+[**search_customers**](CustomerApi.md#search_customers) | **GET** /customer/customers/search | Search for customers
 [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
 [**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
 [**update_wish_list_item**](CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
@@ -1128,6 +1129,71 @@ Name | Type | Description  | Notes
 
 
 
+# **search_customers**
+> CustomersResponse search_customers(opts)
+
+Search for customers
+
+Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+
+### 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::CustomerApi.new_using_api_key(simple_key, false, false)
+
+
+opts = { 
+  search_string: 'search_string_example', # String | Search
+  signup_dts_start: 'signup_dts_start_example', # String | Signup date start
+  signup_dts_end: 'signup_dts_end_example', # String | Signup date end
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
+  _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
+  _sort: '_sort_example', # String | The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Search for customers
+  result = api_instance.search_customers(opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->search_customers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search_string** | **String**| Search | [optional] 
+ **signup_dts_start** | **String**| Signup date start | [optional] 
+ **signup_dts_end** | **String**| Signup date end | [optional] 
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+ **_since** | **String**| Fetch customers that have been created/modified since this date/time. | [optional] 
+ **_sort** | **String**| The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] 
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+[**CustomersResponse**](CustomersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_customer**
 > CustomerResponse update_customer(customer, customer_profile_oid, opts)
 

data/docs/CustomerQuery.md

@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **pricing_tier_name** | **String** | Pricing tier name | [optional] 
 **pricing_tier_oid** | **Integer** | Pricing tier oid | [optional] 
 **qb_class** | **String** | QuickBooks class to import this customer as | [optional] 
+**query_target** | **String** | Query Target | [optional] 
 **quickbooks_code** | **String** | QuickBooks name to import this customer as | [optional] 
 **shipping_city** | **String** | Billing city | [optional] 
 **shipping_company** | **String** | Billing company | [optional] 

data/docs/EmailCommseqEmail.md

@@ -3,6 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**ai_generation** | **BOOLEAN** |  | [optional] 
+**ai_generation_prompt** | **String** |  | [optional] 
+**ai_generation_user_id** | **Integer** |  | [optional] 
 **deleted** | **BOOLEAN** | Deleted | [optional] 
 **edited_by_user** | **String** | Edited by user | [optional] 
 **email_communication_sequence_email_uuid** | **String** | Email communication sequence email uuid | [optional] 

data/lib/ultracart_api/api/customer_api.rb

@@ -1271,6 +1271,79 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Search for customers
+    # Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :search_string Search
+    # @option opts [String] :signup_dts_start Signup date start
+    # @option opts [String] :signup_dts_end Signup date end
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [CustomersResponse]
+    def search_customers(opts = {})
+      data, _status_code, _headers = search_customers_with_http_info(opts)
+      data
+    end
+
+    # Search for customers
+    # Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :search_string Search
+    # @option opts [String] :signup_dts_start Signup date start
+    # @option opts [String] :signup_dts_end Signup date end
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Max 200)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_since Fetch customers that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(CustomersResponse, Fixnum, Hash)>] CustomersResponse data, response status code and response headers
+    def search_customers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.search_customers ...'
+      end
+      # resource path
+      local_var_path = '/customer/customers/search'
+
+      # query parameters
+      query_params = {}
+      query_params[:'search_string'] = opts[:'search_string'] if !opts[:'search_string'].nil?
+      query_params[:'signup_dts_start'] = opts[:'signup_dts_start'] if !opts[:'signup_dts_start'].nil?
+      query_params[:'signup_dts_end'] = opts[:'signup_dts_end'] if !opts[:'signup_dts_end'].nil?
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      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 = 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 => 'CustomersResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#search_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a customer
     # Update a customer on the UltraCart account. 
     # @param customer Customer to update

data/lib/ultracart_api/models/customer_query.rb

@@ -68,6 +68,9 @@ module UltracartClient
     # QuickBooks class to import this customer as
     attr_accessor :qb_class
 
+    # Query Target
+    attr_accessor :query_target
+
     # QuickBooks name to import this customer as
     attr_accessor :quickbooks_code
 
@@ -104,6 +107,28 @@ module UltracartClient
     # Signup date start
     attr_accessor :signup_dts_start
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -125,6 +150,7 @@ module UltracartClient
         :'pricing_tier_name' => :'pricing_tier_name',
         :'pricing_tier_oid' => :'pricing_tier_oid',
         :'qb_class' => :'qb_class',
+        :'query_target' => :'query_target',
         :'quickbooks_code' => :'quickbooks_code',
         :'shipping_city' => :'shipping_city',
         :'shipping_company' => :'shipping_company',
@@ -161,6 +187,7 @@ module UltracartClient
         :'pricing_tier_name' => :'String',
         :'pricing_tier_oid' => :'Integer',
         :'qb_class' => :'String',
+        :'query_target' => :'String',
         :'quickbooks_code' => :'String',
         :'shipping_city' => :'String',
         :'shipping_company' => :'String',
@@ -262,6 +289,10 @@ module UltracartClient
         self.qb_class = attributes[:'qb_class']
       end
 
+      if attributes.has_key?(:'query_target')
+        self.query_target = attributes[:'query_target']
+      end
+
       if attributes.has_key?(:'quickbooks_code')
         self.quickbooks_code = attributes[:'quickbooks_code']
       end
@@ -407,6 +438,8 @@ module UltracartClient
       return false if !@billing_postal_code.nil? && @billing_postal_code.to_s.length > 20
       return false if !@billing_state.nil? && @billing_state.to_s.length > 32
       return false if !@pricing_tier_name.nil? && @pricing_tier_name.to_s.length > 50
+      query_target_validator = EnumAttributeValidator.new('String', ['origin', 'cache'])
+      return false unless query_target_validator.valid?(@query_target)
       return false if !@shipping_city.nil? && @shipping_city.to_s.length > 32
       return false if !@shipping_company.nil? && @shipping_company.to_s.length > 50
       return false if !@shipping_country_code.nil? && @shipping_country_code.to_s.length > 2
@@ -519,6 +552,16 @@ module UltracartClient
       @pricing_tier_name = pricing_tier_name
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] query_target Object to be assigned
+    def query_target=(query_target)
+      validator = EnumAttributeValidator.new('String', ['origin', 'cache'])
+      unless validator.valid?(query_target)
+        fail ArgumentError, 'invalid value for "query_target", must be one of #{validator.allowable_values}.'
+      end
+      @query_target = query_target
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] shipping_city Value to be assigned
     def shipping_city=(shipping_city)
@@ -632,6 +675,7 @@ module UltracartClient
           pricing_tier_name == o.pricing_tier_name &&
           pricing_tier_oid == o.pricing_tier_oid &&
           qb_class == o.qb_class &&
+          query_target == o.query_target &&
           quickbooks_code == o.quickbooks_code &&
           shipping_city == o.shipping_city &&
           shipping_company == o.shipping_company &&
@@ -655,7 +699,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [all_tags, any_tags, billing_city, billing_company, billing_country_code, billing_day_phone, billing_evening_phone, billing_first_name, billing_last_name, billing_postal_code, billing_state, email, emails, last_modified_dts_end, last_modified_dts_start, pricing_tier_name, pricing_tier_oid, qb_class, quickbooks_code, shipping_city, shipping_company, shipping_country_code, shipping_day_phone, shipping_evening_phone, shipping_first_name, shipping_last_name, shipping_postal_code, shipping_state, signup_dts_end, signup_dts_start].hash
+      [all_tags, any_tags, billing_city, billing_company, billing_country_code, billing_day_phone, billing_evening_phone, billing_first_name, billing_last_name, billing_postal_code, billing_state, email, emails, last_modified_dts_end, last_modified_dts_start, pricing_tier_name, pricing_tier_oid, qb_class, query_target, quickbooks_code, shipping_city, shipping_company, shipping_country_code, shipping_day_phone, shipping_evening_phone, shipping_first_name, shipping_last_name, shipping_postal_code, shipping_state, signup_dts_end, signup_dts_start].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_email.rb

@@ -14,6 +14,12 @@ require 'date'
 
 module UltracartClient
   class EmailCommseqEmail
+    attr_accessor :ai_generation
+
+    attr_accessor :ai_generation_prompt
+
+    attr_accessor :ai_generation_user_id
+
     # Deleted
     attr_accessor :deleted
 
@@ -111,6 +117,9 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'ai_generation' => :'ai_generation',
+        :'ai_generation_prompt' => :'ai_generation_prompt',
+        :'ai_generation_user_id' => :'ai_generation_user_id',
         :'deleted' => :'deleted',
         :'edited_by_user' => :'edited_by_user',
         :'email_communication_sequence_email_uuid' => :'email_communication_sequence_email_uuid',
@@ -151,6 +160,9 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'ai_generation' => :'BOOLEAN',
+        :'ai_generation_prompt' => :'String',
+        :'ai_generation_user_id' => :'Integer',
         :'deleted' => :'BOOLEAN',
         :'edited_by_user' => :'String',
         :'email_communication_sequence_email_uuid' => :'String',
@@ -196,6 +208,18 @@ 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?(:'ai_generation')
+        self.ai_generation = attributes[:'ai_generation']
+      end
+
+      if attributes.has_key?(:'ai_generation_prompt')
+        self.ai_generation_prompt = attributes[:'ai_generation_prompt']
+      end
+
+      if attributes.has_key?(:'ai_generation_user_id')
+        self.ai_generation_user_id = attributes[:'ai_generation_user_id']
+      end
+
       if attributes.has_key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -351,6 +375,9 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          ai_generation == o.ai_generation &&
+          ai_generation_prompt == o.ai_generation_prompt &&
+          ai_generation_user_id == o.ai_generation_user_id &&
           deleted == o.deleted &&
           edited_by_user == o.edited_by_user &&
           email_communication_sequence_email_uuid == o.email_communication_sequence_email_uuid &&
@@ -396,7 +423,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, external_generation, external_generation_authentication, external_generation_basic_password, external_generation_basic_username, external_generation_header_name, external_generation_header_value, external_generation_id, external_generation_url, filter_profile_equation_json, individually_render, library_item_oid, magic_link, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].hash
+      [ai_generation, ai_generation_prompt, ai_generation_user_id, deleted, edited_by_user, email_communication_sequence_email_uuid, email_communication_sequence_uuid, email_container_cjson, email_container_cjson_last_modified_dts, email_template_vm_path, external_generation, external_generation_authentication, external_generation_basic_password, external_generation_basic_username, external_generation_header_name, external_generation_header_value, external_generation_id, external_generation_url, filter_profile_equation_json, individually_render, library_item_oid, magic_link, merchant_id, pending_review, preview_text, rejected, requires_review, screenshot_large_full_url, screenshot_large_viewport_url, screenshot_small_full_url, screenshot_small_viewport_url, smart_sending, storefront_oid, subject, suspended_for_spam, transactional_email, version].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.34'
+  VERSION = '3.11.35'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.34
+  version: 3.11.35
 platform: ruby
 authors:
 - UltraCart