ultracart_api 4.1.101 → 4.1.102

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c7729cd8cce0aa31c5e610db0089f913d0c07f58c5764e9b284942af573e79
-  data.tar.gz: b56629ffebfadf049f8e21bd77766a83315cc318e7db2352162ace4a12fca03a
+  metadata.gz: 1e184ae5eeb45aff50611924cb65b7dbd38f294c3e605d4264b063766d30e126
+  data.tar.gz: ba150f5a4d0f43f6eea1a35cdcec19482a47197cb7bff3331d7dffe98f104b6d
 SHA512:
-  metadata.gz: fd80a1cb0fb6cbc5e2bd7e611aa29711837df3d8d4643eb452bd1ef48394efcb03dc2e6f876117fa25117b22136830fe746b6fa8d7e20d4d226a9d3f72c71f5d
-  data.tar.gz: 9cc03da203bc501c68128e6c32b3678177d61e38742255afe9a71c44adb6e14abc4dc68635dbd504a704c80bf06085e91969c376b3229cf6e4f8fc559d47815b
+  metadata.gz: 42348e40659cecc10047f1f828ba071e126346a4c12889694bc873f70d232b01d47a233fdbec636f2ed3892869622930045fc976743a166ca02fc36974e8c128
+  data.tar.gz: e2931485d637b353c6af89f22fd3158bd01b2ce0386867283b8c702c738efa649ad9bec9ce3e804c73f36975a666605c67c3ca658194e6d883ab46882168ab88

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.101
+- Package version: 4.1.102
 - 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.101'
+gem 'ultracart_api', '4.1.102'
 ```
 
 install:
@@ -481,6 +481,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**delete_screen_recording_segment**](docs/StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment
 *UltracartClient::StorefrontApi* | [**delete_twilio_account**](docs/StorefrontApi.md#delete_twilio_account) | **DELETE** /storefront/twilio/accounts/{esp_twilio_uuid} | delete Twilio account
 *UltracartClient::StorefrontApi* | [**duplicate_library_item**](docs/StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
+*UltracartClient::StorefrontApi* | [**enroll_commseq_customer**](docs/StorefrontApi.md#enroll_commseq_customer) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/enroll | Enroll a customer into a communication sequence
 *UltracartClient::StorefrontApi* | [**favorite_screen_recording**](docs/StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
 *UltracartClient::StorefrontApi* | [**geocode_address**](docs/StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
 *UltracartClient::StorefrontApi* | [**get_countries**](docs/StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
@@ -1162,6 +1163,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailCommseqEmailSendTestResponse](docs/EmailCommseqEmailSendTestResponse.md)
  - [UltracartClient::EmailCommseqEmailsRequest](docs/EmailCommseqEmailsRequest.md)
  - [UltracartClient::EmailCommseqEmailsResponse](docs/EmailCommseqEmailsResponse.md)
+ - [UltracartClient::EmailCommseqEnrollmentRequest](docs/EmailCommseqEnrollmentRequest.md)
+ - [UltracartClient::EmailCommseqEnrollmentResponse](docs/EmailCommseqEnrollmentResponse.md)
  - [UltracartClient::EmailCommseqPostcard](docs/EmailCommseqPostcard.md)
  - [UltracartClient::EmailCommseqPostcardResponse](docs/EmailCommseqPostcardResponse.md)
  - [UltracartClient::EmailCommseqPostcardSendTestRequest](docs/EmailCommseqPostcardSendTestRequest.md)
@@ -1777,6 +1780,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.102 | 06/17/2026 | storefront communications - new single email enrollment method |
 | 4.1.101 | 06/10/2026 | conversation pbx call notes fields |
 | 4.1.100 | 06/05/2026 | webhook log summary filtering |
 | 4.1.99 | 06/05/2026 | added webhook name and merchant_comments |

data/docs/AutoOrderItem.md

@@ -13,6 +13,8 @@
 | **arbitrary_unit_cost_remaining_orders** | **Integer** | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. | [optional] |
 | **auto_order_item_oid** | **Integer** | Primary key of AutoOrderItem | [optional] |
 | **calculated_next_shipment_dts** | **String** | Calculated Date/time that this item is scheduled to rebill.  Will be null if no more shipments are going to occur on this item | [optional] |
+| **cancel_dts** | **String** | Date/time this item was cancelled (companion to cancel_reason).  On update, null leaves the existing value unchanged; pass an empty string to clear it. | [optional] |
+| **cancel_reason** | **String** | Reason this item was cancelled, captured when the item was cancelled by the customer or merchant.  On update, null leaves the existing value unchanged; pass an empty string to clear it. | [optional] |
 | **first_order_dts** | **String** | Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet. | [optional] |
 | **frequency** | **String** | Frequency of the rebill if not a fixed schedule | [optional] |
 | **future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional] |
@@ -50,6 +52,8 @@ instance = UltracartClient::AutoOrderItem.new(
   arbitrary_unit_cost_remaining_orders: null,
   auto_order_item_oid: null,
   calculated_next_shipment_dts: null,
+  cancel_dts: null,
+  cancel_reason: null,
   first_order_dts: null,
   frequency: null,
   future_schedules: null,

data/docs/EmailCommseqEnrollmentRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::EmailCommseqEnrollmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address of the customer to enroll | [optional] |
+| **esp_commseq_uuid** | **String** | Communication sequence UUID | [optional] |
+| **name** | **String** | Optional name of the customer to enroll | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqEnrollmentRequest.new(
+  email: null,
+  esp_commseq_uuid: null,
+  name: null
+)
+```
+

data/docs/EmailCommseqEnrollmentResponse.md

@@ -0,0 +1,30 @@
+# UltracartClient::EmailCommseqEnrollmentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **already_enrolled** | **Boolean** | True if the customer was already enrolled and therefore not enrolled again | [optional] |
+| **enrolled** | **Boolean** | True if the customer was newly enrolled into the sequence | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **esp_customer_uuid** | **String** | The resolved ESP customer UUID for the enrolled email | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqEnrollmentResponse.new(
+  already_enrolled: null,
+  enrolled: null,
+  error: null,
+  esp_customer_uuid: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/StorefrontApi.md

@@ -32,6 +32,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**delete_screen_recording_segment**](StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment |
 | [**delete_twilio_account**](StorefrontApi.md#delete_twilio_account) | **DELETE** /storefront/twilio/accounts/{esp_twilio_uuid} | delete Twilio account |
 | [**duplicate_library_item**](StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item. |
+| [**enroll_commseq_customer**](StorefrontApi.md#enroll_commseq_customer) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/enroll | Enroll a customer into a communication sequence |
 | [**favorite_screen_recording**](StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording |
 | [**geocode_address**](StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address |
 | [**get_countries**](StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries |
@@ -1667,6 +1668,61 @@ end
 - **Accept**: application/json
 
 
+## enroll_commseq_customer
+
+> <EmailCommseqEnrollmentResponse> enroll_commseq_customer(storefront_oid, commseq_uuid, email_commseq_enrollment_request)
+
+Enroll a customer into a communication sequence
+
+Enrolls a single real customer (by email) into the communication sequence.  A customer who is already enrolled will not be enrolled a second time. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the enroll_commseq_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailCommseqEnrollmentResponse>, Integer, Hash)> enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request)
+
+```ruby
+begin
+  # Enroll a customer into a communication sequence
+  data, status_code, headers = api_instance.enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailCommseqEnrollmentResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->enroll_commseq_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **commseq_uuid** | **String** |  |  |
+| **email_commseq_enrollment_request** | [**EmailCommseqEnrollmentRequest**](EmailCommseqEnrollmentRequest.md) | Commseq enrollment request |  |
+
+### Return type
+
+[**EmailCommseqEnrollmentResponse**](EmailCommseqEnrollmentResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## favorite_screen_recording
 
 > favorite_screen_recording(storefront_oid, screen_recording_uuid)

data/lib/ultracart_api/api/storefront_api.rb

@@ -1932,6 +1932,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Enroll a customer into a communication sequence
+    # Enrolls a single real customer (by email) into the communication sequence.  A customer who is already enrolled will not be enrolled a second time. 
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param email_commseq_enrollment_request [EmailCommseqEnrollmentRequest] Commseq enrollment request
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEnrollmentResponse]
+    def enroll_commseq_customer(storefront_oid, commseq_uuid, email_commseq_enrollment_request, opts = {})
+      data, _status_code, _headers = enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request, opts)
+      data
+    end
+
+    # Enroll a customer into a communication sequence
+    # Enrolls a single real customer (by email) into the communication sequence.  A customer who is already enrolled will not be enrolled a second time. 
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param email_commseq_enrollment_request [EmailCommseqEnrollmentRequest] Commseq enrollment request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEnrollmentResponse, Integer, Hash)>] EmailCommseqEnrollmentResponse data, response status code and response headers
+    def enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.enroll_commseq_customer ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.enroll_commseq_customer"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.enroll_commseq_customer"
+      end
+      # verify the required parameter 'email_commseq_enrollment_request' is set
+      if @api_client.config.client_side_validation && email_commseq_enrollment_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_commseq_enrollment_request' when calling StorefrontApi.enroll_commseq_customer"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/enroll'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_enrollment_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCommseqEnrollmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.enroll_commseq_customer",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#enroll_commseq_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update favorite flag on screen recording
     # Update favorite flag on screen recording 
     # @param storefront_oid [Integer] 

data/lib/ultracart_api/models/auto_order_item.rb

@@ -42,6 +42,12 @@ module UltracartClient
     # Calculated Date/time that this item is scheduled to rebill.  Will be null if no more shipments are going to occur on this item
     attr_accessor :calculated_next_shipment_dts
 
+    # Date/time this item was cancelled (companion to cancel_reason).  On update, null leaves the existing value unchanged; pass an empty string to clear it.
+    attr_accessor :cancel_dts
+
+    # Reason this item was cancelled, captured when the item was cancelled by the customer or merchant.  On update, null leaves the existing value unchanged; pass an empty string to clear it.
+    attr_accessor :cancel_reason
+
     # Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet.
     attr_accessor :first_order_dts
 
@@ -138,6 +144,8 @@ module UltracartClient
         :'arbitrary_unit_cost_remaining_orders' => :'arbitrary_unit_cost_remaining_orders',
         :'auto_order_item_oid' => :'auto_order_item_oid',
         :'calculated_next_shipment_dts' => :'calculated_next_shipment_dts',
+        :'cancel_dts' => :'cancel_dts',
+        :'cancel_reason' => :'cancel_reason',
         :'first_order_dts' => :'first_order_dts',
         :'frequency' => :'frequency',
         :'future_schedules' => :'future_schedules',
@@ -179,6 +187,8 @@ module UltracartClient
         :'arbitrary_unit_cost_remaining_orders' => :'Integer',
         :'auto_order_item_oid' => :'Integer',
         :'calculated_next_shipment_dts' => :'String',
+        :'cancel_dts' => :'String',
+        :'cancel_reason' => :'String',
         :'first_order_dts' => :'String',
         :'frequency' => :'String',
         :'future_schedules' => :'Array<AutoOrderItemFutureSchedule>',
@@ -262,6 +272,14 @@ module UltracartClient
         self.calculated_next_shipment_dts = attributes[:'calculated_next_shipment_dts']
       end
 
+      if attributes.key?(:'cancel_dts')
+        self.cancel_dts = attributes[:'cancel_dts']
+      end
+
+      if attributes.key?(:'cancel_reason')
+        self.cancel_reason = attributes[:'cancel_reason']
+      end
+
       if attributes.key?(:'first_order_dts')
         self.first_order_dts = attributes[:'first_order_dts']
       end
@@ -392,6 +410,8 @@ module UltracartClient
           arbitrary_unit_cost_remaining_orders == o.arbitrary_unit_cost_remaining_orders &&
           auto_order_item_oid == o.auto_order_item_oid &&
           calculated_next_shipment_dts == o.calculated_next_shipment_dts &&
+          cancel_dts == o.cancel_dts &&
+          cancel_reason == o.cancel_reason &&
           first_order_dts == o.first_order_dts &&
           frequency == o.frequency &&
           future_schedules == o.future_schedules &&
@@ -424,7 +444,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_ons, arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, calculated_next_shipment_dts, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_item_id, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, properties, rebill_value, remaining_repeat_count, simple_schedule].hash
+      [add_ons, arbitrary_item_id, arbitrary_percentage_discount, arbitrary_quantity, arbitrary_schedule_days, arbitrary_unit_cost, arbitrary_unit_cost_remaining_orders, auto_order_item_oid, calculated_next_shipment_dts, cancel_dts, cancel_reason, first_order_dts, frequency, future_schedules, last_order_dts, life_time_value, next_item_id, next_preshipment_notice_dts, next_shipment_dts, no_order_after_dts, number_of_rebills, options, original_item_id, original_quantity, paused, paypal_payer_id, paypal_recurring_payment_profile_id, preshipment_notice_sent, properties, rebill_value, remaining_repeat_count, simple_schedule].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/email_commseq_enrollment_request.rb

@@ -0,0 +1,240 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailCommseqEnrollmentRequest
+    # Email address of the customer to enroll
+    attr_accessor :email
+
+    # Communication sequence UUID
+    attr_accessor :esp_commseq_uuid
+
+    # Optional name of the customer to enroll
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'esp_commseq_uuid' => :'esp_commseq_uuid',
+        :'name' => :'name'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email' => :'String',
+        :'esp_commseq_uuid' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailCommseqEnrollmentRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailCommseqEnrollmentRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'esp_commseq_uuid')
+        self.esp_commseq_uuid = attributes[:'esp_commseq_uuid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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 &&
+          email == o.email &&
+          esp_commseq_uuid == o.esp_commseq_uuid &&
+          name == o.name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [email, esp_commseq_uuid, name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/models/email_commseq_enrollment_response.rb

@@ -0,0 +1,277 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailCommseqEnrollmentResponse
+    # True if the customer was already enrolled and therefore not enrolled again
+    attr_accessor :already_enrolled
+
+    # True if the customer was newly enrolled into the sequence
+    attr_accessor :enrolled
+
+    attr_accessor :error
+
+    # The resolved ESP customer UUID for the enrolled email
+    attr_accessor :esp_customer_uuid
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'already_enrolled' => :'already_enrolled',
+        :'enrolled' => :'enrolled',
+        :'error' => :'error',
+        :'esp_customer_uuid' => :'esp_customer_uuid',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'already_enrolled' => :'Boolean',
+        :'enrolled' => :'Boolean',
+        :'error' => :'Error',
+        :'esp_customer_uuid' => :'String',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailCommseqEnrollmentResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailCommseqEnrollmentResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'already_enrolled')
+        self.already_enrolled = attributes[:'already_enrolled']
+      end
+
+      if attributes.key?(:'enrolled')
+        self.enrolled = attributes[:'enrolled']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'esp_customer_uuid')
+        self.esp_customer_uuid = attributes[:'esp_customer_uuid']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          already_enrolled == o.already_enrolled &&
+          enrolled == o.enrolled &&
+          error == o.error &&
+          esp_customer_uuid == o.esp_customer_uuid &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [already_enrolled, enrolled, error, esp_customer_uuid, metadata, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/models/webhook.rb

@@ -270,6 +270,14 @@ module UltracartClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@merchant_comments.nil? && @merchant_comments.to_s.length > 2000
+        invalid_properties.push('invalid value for "merchant_comments", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 80
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 80.')
+      end
+
       invalid_properties
     end
 
@@ -280,6 +288,8 @@ module UltracartClient
       return false unless api_version_validator.valid?(@api_version)
       authentication_type_validator = EnumAttributeValidator.new('String', ["none", "basic", "api user", "aws iam"])
       return false unless authentication_type_validator.valid?(@authentication_type)
+      return false if !@merchant_comments.nil? && @merchant_comments.to_s.length > 2000
+      return false if !@name.nil? && @name.to_s.length > 80
       true
     end
 
@@ -303,6 +313,26 @@ module UltracartClient
       @authentication_type = authentication_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] merchant_comments Value to be assigned
+    def merchant_comments=(merchant_comments)
+      if !merchant_comments.nil? && merchant_comments.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "merchant_comments", the character length must be smaller than or equal to 2000.'
+      end
+
+      @merchant_comments = merchant_comments
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 80
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 80.'
+      end
+
+      @name = name
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.101'
+  VERSION = '4.1.102'
 end

data/lib/ultracart_api.rb

@@ -483,6 +483,8 @@ require 'ultracart_api/models/email_commseq_email_send_test_request'
 require 'ultracart_api/models/email_commseq_email_send_test_response'
 require 'ultracart_api/models/email_commseq_emails_request'
 require 'ultracart_api/models/email_commseq_emails_response'
+require 'ultracart_api/models/email_commseq_enrollment_request'
+require 'ultracart_api/models/email_commseq_enrollment_response'
 require 'ultracart_api/models/email_commseq_postcard'
 require 'ultracart_api/models/email_commseq_postcard_response'
 require 'ultracart_api/models/email_commseq_postcard_send_test_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.101
+  version: 4.1.102
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-10 00:00:00.000000000 Z
+date: 2026-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -536,6 +536,8 @@ files:
 - docs/EmailCommseqEmailSendTestResponse.md
 - docs/EmailCommseqEmailsRequest.md
 - docs/EmailCommseqEmailsResponse.md
+- docs/EmailCommseqEnrollmentRequest.md
+- docs/EmailCommseqEnrollmentResponse.md
 - docs/EmailCommseqPostcard.md
 - docs/EmailCommseqPostcardResponse.md
 - docs/EmailCommseqPostcardSendTestRequest.md
@@ -1580,6 +1582,8 @@ files:
 - lib/ultracart_api/models/email_commseq_email_send_test_response.rb
 - lib/ultracart_api/models/email_commseq_emails_request.rb
 - lib/ultracart_api/models/email_commseq_emails_response.rb
+- lib/ultracart_api/models/email_commseq_enrollment_request.rb
+- lib/ultracart_api/models/email_commseq_enrollment_response.rb
 - lib/ultracart_api/models/email_commseq_postcard.rb
 - lib/ultracart_api/models/email_commseq_postcard_response.rb
 - lib/ultracart_api/models/email_commseq_postcard_send_test_request.rb