ultracart_api 4.1.120 → 4.1.121

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e0115af7e8d302af84a2c278cac48c326c4e13390347d71aa265803aacbd47
-  data.tar.gz: 3ae9c97257ae86408ccc20f2256183169092a8db5513ef0be6a876b1e6ad6e52
+  metadata.gz: 2d5d871e0bb19eab14c055ac6a5c89c7ced3ca2c9127aab28c17c15721f51e22
+  data.tar.gz: 8fba28391554e4fe29d510482bd37805a01d3c313d94c50e6f4818df9cd91425
 SHA512:
-  metadata.gz: 438cc0b421fb1283e591bbaf003b2ee6120f1a19d8ddf290d9e768f6633e8b3dc96702c1bcd3d206f62ea0a528922d6616907462e79d8e0c6fc8e0370567d0e6
-  data.tar.gz: 9277e584d2df1df1ab4d2e81557e7ec09d3f1dac7e0a49655bfdc1d683d2e331d57cb6111d289c3209f9e02525e821c943431330f6f6e900e49d00af18c4bc3d
+  metadata.gz: 1294d57bcd66fae30a395c4306a060acc3d68f61657363453222cf5e797cd03667f737e2889c23f452357784978e69e75439c0850f6f0299ddf1b97f1f492ef6
+  data.tar.gz: 281ca6e2d950f6eab70a5cc311fffa540c105b074238a3e9c29114414f3c90e1e4dca0f7e3700fe69a5c15c3598bbd2b14f890ea301b8798544ecde9abb17a14

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.120
+- Package version: 4.1.121
 - 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.120'
+gem 'ultracart_api', '4.1.121'
 ```
 
 install:
@@ -1825,6 +1825,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.121 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.120 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |
 | 4.1.118 | 07/14/2026 | affiliate - send welcome letter method |

data/docs/EmailDispatchLog.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **detail** | **String** | Dispatch detail text (free-form log of how the customer moved through the step) | [optional] |
 | **email** | **String** | Customer email, resolved from the customer UUID for the page | [optional] |
 | **esp_commseq_step_uuid** | **String** | Communication sequence step UUID | [optional] |
 | **esp_commseq_uuid** | **String** | Communication sequence (flow/campaign) UUID | [optional] |
@@ -16,6 +17,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::EmailDispatchLog.new(
+  detail: null,
   email: null,
   esp_commseq_step_uuid: null,
   esp_commseq_uuid: null,

data/docs/StorefrontApi.md

@@ -2993,6 +2993,7 @@ end
 | **page_number** | **Integer** |  | [optional] |
 | **page_size** | **Integer** |  | [optional] |
 | **scan_forward** | **Boolean** |  | [optional] |
+| **include_detail** | **Boolean** |  | [optional] |
 
 ### Return type
 
@@ -5086,7 +5087,7 @@ end
 
 Get a paginated, date-boundable dispatch-log feed for a step
 
-Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
 
 
 ### Examples
@@ -5124,6 +5125,7 @@ end
 | **_until** | **String** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **page_size** | **Integer** |  | [optional] |
+| **include_detail** | **Boolean** |  | [optional] |
 
 ### Return type
 

data/lib/ultracart_api/api/storefront_api.rb

@@ -3611,6 +3611,7 @@ module UltracartClient
     # @option opts [Integer] :page_number 
     # @option opts [Integer] :page_size 
     # @option opts [Boolean] :scan_forward 
+    # @option opts [Boolean] :include_detail 
     # @return [EmailDispatchLogsResponse]
     def get_email_customer_dispatch_logs(storefront_oid, email_customer_uuid, opts = {})
       data, _status_code, _headers = get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts)
@@ -3627,6 +3628,7 @@ module UltracartClient
     # @option opts [Integer] :page_number 
     # @option opts [Integer] :page_size 
     # @option opts [Boolean] :scan_forward 
+    # @option opts [Boolean] :include_detail 
     # @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
     def get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts = {})
       if @api_client.config.debugging
@@ -3650,6 +3652,7 @@ module UltracartClient
       query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
       query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'scanForward'] = opts[:'scan_forward'] if !opts[:'scan_forward'].nil?
+      query_params[:'includeDetail'] = opts[:'include_detail'] if !opts[:'include_detail'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -6338,7 +6341,7 @@ module UltracartClient
     end
 
     # Get a paginated, date-boundable dispatch-log feed for a step
-    # Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+    # Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
     # @param storefront_oid [Integer] 
     # @param commseq_uuid [String] 
     # @param commseq_step_uuid [String] 
@@ -6347,6 +6350,7 @@ module UltracartClient
     # @option opts [String] :_until 
     # @option opts [Integer] :page_number 
     # @option opts [Integer] :page_size 
+    # @option opts [Boolean] :include_detail 
     # @return [EmailDispatchLogsResponse]
     def get_email_step_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
       data, _status_code, _headers = get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
@@ -6354,7 +6358,7 @@ module UltracartClient
     end
 
     # Get a paginated, date-boundable dispatch-log feed for a step
-    # Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row&#39;s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response &#39;more&#39; flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+    # Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row&#39;s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response &#39;more&#39; flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
     # @param storefront_oid [Integer] 
     # @param commseq_uuid [String] 
     # @param commseq_step_uuid [String] 
@@ -6363,6 +6367,7 @@ module UltracartClient
     # @option opts [String] :_until 
     # @option opts [Integer] :page_number 
     # @option opts [Integer] :page_size 
+    # @option opts [Boolean] :include_detail 
     # @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
     def get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
       if @api_client.config.debugging
@@ -6389,6 +6394,7 @@ module UltracartClient
       query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
       query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
       query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'includeDetail'] = opts[:'include_detail'] if !opts[:'include_detail'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/ultracart_api/models/email_dispatch_log.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class EmailDispatchLog
+    # Dispatch detail text (free-form log of how the customer moved through the step)
+    attr_accessor :detail
+
     # Customer email, resolved from the customer UUID for the page
     attr_accessor :email
 
@@ -33,6 +36,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'detail' => :'detail',
         :'email' => :'email',
         :'esp_commseq_step_uuid' => :'esp_commseq_step_uuid',
         :'esp_commseq_uuid' => :'esp_commseq_uuid',
@@ -49,6 +53,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'detail' => :'String',
         :'email' => :'String',
         :'esp_commseq_step_uuid' => :'String',
         :'esp_commseq_uuid' => :'String',
@@ -78,6 +83,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
@@ -117,6 +126,7 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          detail == o.detail &&
           email == o.email &&
           esp_commseq_step_uuid == o.esp_commseq_step_uuid &&
           esp_commseq_uuid == o.esp_commseq_uuid &&
@@ -133,7 +143,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, esp_commseq_step_uuid, esp_commseq_uuid, esp_customer_uuid, log_dts].hash
+      [detail, email, esp_commseq_step_uuid, esp_commseq_uuid, esp_customer_uuid, log_dts].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.120'
+  VERSION = '4.1.121'
 end

metadata

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