ultracart_api 4.1.34 → 4.1.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e4cf39d82bc3f1b8995a91ca73bfaeaeb118b0fbeac5b550be2bf71e0dcaa1'
-  data.tar.gz: 34b74e14c0e7c3a5fff9964e0621470e0060678b652bc527adee4e5316548930
+  metadata.gz: 261a7f783b8e6549fc4e3bdf2dc2a11f4fd01a1b6fdf2ce06ca62d6057fe0847
+  data.tar.gz: '0168bf2bfbbac4dd6c3265823c02ad35fb909ec40d3a12e5667830bdadcf71ec'
 SHA512:
-  metadata.gz: 9b44d6c9d7d94ccf480ba5d5f6de45f923344268343422e949fc7919d1042899edb7325b0ccfd4aa9bc69d72e9470d14557ff82ea9f16186344fb47558f2ebdb
-  data.tar.gz: 97271a58f51d6db11cf0c7421ed4db574867f2f6eb946008cdec1e81fa727bd73a1968d249a3700ccadf563db0aa0b7098a5a349cfd1daa5b731f6aeb5e2e5f8
+  metadata.gz: f447501c910811d3bc63fa4559a6bfa4f5bf15ead6b661afb1ccdbf4f918d64857b89476981cde1efa14e7aeb597771e853d745e1aa2b719a051234a48bef76c
+  data.tar.gz: 5632695b743338ece4f79f0264094c436f98b68243735bf4ba157a9dc78e83d4e1a36f8fe2641cb0c7de8b1c1fb171de9e2f85e551b6088ac99e045eeaf178b9

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.34
+- Package version: 4.1.35
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.34'
+gem 'ultracart_api', '4.1.35'
 ```
 
 install:
@@ -266,6 +266,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
@@ -1599,6 +1600,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
 | 4.1.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
 | 4.1.33 | 11/26/2025 | conversation - AI agent profile fields |
 | 4.1.32 | 11/20/2025 | conversion api bug fix on incorrect signature |

data/docs/CustomerApi.md

@@ -24,6 +24,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
@@ -2181,6 +2182,66 @@ end
 - **Accept**: application/json
 
 
+## 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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the search_customers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomersResponse>, Integer, Hash)> search_customers_with_http_info(opts)
+
+```ruby
+begin
+  # Search for customers
+  data, status_code, headers = api_instance.search_customers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomersResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling CustomerApi->search_customers_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## update_customer
 
 > <CustomerResponse> update_customer(customer_profile_oid, customer, opts)

data/docs/CustomerQuery.md

@@ -22,6 +22,7 @@
 | **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] |
@@ -59,6 +60,7 @@ instance = UltracartClient::CustomerQuery.new(
   pricing_tier_name: null,
   pricing_tier_oid: null,
   qb_class: null,
+  query_target: null,
   quickbooks_code: null,
   shipping_city: null,
   shipping_company: null,

data/docs/EmailCommseqEmail.md

@@ -4,6 +4,9 @@
 
 | 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] |
@@ -45,6 +48,9 @@
 require 'ultracart_api'
 
 instance = UltracartClient::EmailCommseqEmail.new(
+  ai_generation: null,
+  ai_generation_prompt: null,
+  ai_generation_user_id: null,
   deleted: null,
   edited_by_user: null,
   email_communication_sequence_email_uuid: null,

data/lib/ultracart_api/api/customer_api.rb

@@ -1494,6 +1494,88 @@ module UltracartClient
       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) (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 [Array<(CustomersResponse, Integer, 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 = opts[: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 = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"CustomerApi.search_customers",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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_profile_oid [Integer] The customer_profile_oid to update.

data/lib/ultracart_api/models/customer_query.rb

@@ -69,6 +69,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
 
@@ -105,6 +108,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
       {
@@ -126,6 +151,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',
@@ -167,6 +193,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',
@@ -281,6 +308,10 @@ module UltracartClient
         self.qb_class = attributes[:'qb_class']
       end
 
+      if attributes.key?(:'query_target')
+        self.query_target = attributes[:'query_target']
+      end
+
       if attributes.key?(:'quickbooks_code')
         self.quickbooks_code = attributes[:'quickbooks_code']
       end
@@ -426,6 +457,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
@@ -538,6 +571,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)
@@ -651,6 +694,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 &&
@@ -674,7 +718,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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

@@ -15,6 +15,12 @@ require 'time'
 
 module UltracartClient
   class EmailCommseqEmail
+    attr_accessor :ai_generation
+
+    attr_accessor :ai_generation_prompt
+
+    attr_accessor :ai_generation_user_id
+
     # Deleted
     attr_accessor :deleted
 
@@ -112,6 +118,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',
@@ -157,6 +166,9 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_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',
@@ -215,6 +227,18 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'ai_generation')
+        self.ai_generation = attributes[:'ai_generation']
+      end
+
+      if attributes.key?(:'ai_generation_prompt')
+        self.ai_generation_prompt = attributes[:'ai_generation_prompt']
+      end
+
+      if attributes.key?(:'ai_generation_user_id')
+        self.ai_generation_user_id = attributes[:'ai_generation_user_id']
+      end
+
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -370,6 +394,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 &&
@@ -415,7 +442,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.34'
+  VERSION = '4.1.35'
 end

metadata

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