ultracart_api 4.1.101 → 4.1.103

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.103'
 end

data/lib/ultracart_api.rb

@@ -29,6 +29,8 @@ require 'ultracart_api/models/activity'
 require 'ultracart_api/models/add_library_item_request'
 require 'ultracart_api/models/adjust_internal_certificate_request'
 require 'ultracart_api/models/adjust_internal_certificate_response'
+require 'ultracart_api/models/affiliate'
+require 'ultracart_api/models/affiliate_attribute'
 require 'ultracart_api/models/affiliate_click'
 require 'ultracart_api/models/affiliate_click_query'
 require 'ultracart_api/models/affiliate_clicks_response'
@@ -36,6 +38,11 @@ require 'ultracart_api/models/affiliate_ledger'
 require 'ultracart_api/models/affiliate_ledger_query'
 require 'ultracart_api/models/affiliate_ledgers_response'
 require 'ultracart_api/models/affiliate_link'
+require 'ultracart_api/models/affiliate_marketing_strategy'
+require 'ultracart_api/models/affiliate_query'
+require 'ultracart_api/models/affiliate_response'
+require 'ultracart_api/models/affiliate_tier_relationship'
+require 'ultracart_api/models/affiliates_response'
 require 'ultracart_api/models/agent_summary'
 require 'ultracart_api/models/api_user_application_profile'
 require 'ultracart_api/models/apply_library_item_request'
@@ -483,6 +490,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.103
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-10 00:00:00.000000000 Z
+date: 2026-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -73,7 +73,9 @@ files:
 - docs/AddLibraryItemRequest.md
 - docs/AdjustInternalCertificateRequest.md
 - docs/AdjustInternalCertificateResponse.md
+- docs/Affiliate.md
 - docs/AffiliateApi.md
+- docs/AffiliateAttribute.md
 - docs/AffiliateClick.md
 - docs/AffiliateClickQuery.md
 - docs/AffiliateClicksResponse.md
@@ -81,6 +83,11 @@ files:
 - docs/AffiliateLedgerQuery.md
 - docs/AffiliateLedgersResponse.md
 - docs/AffiliateLink.md
+- docs/AffiliateMarketingStrategy.md
+- docs/AffiliateQuery.md
+- docs/AffiliateResponse.md
+- docs/AffiliateTierRelationship.md
+- docs/AffiliatesResponse.md
 - docs/AgentSummary.md
 - docs/ApiUserApplicationProfile.md
 - docs/ApplyLibraryItemRequest.md
@@ -536,6 +543,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
@@ -1126,6 +1135,8 @@ files:
 - lib/ultracart_api/models/add_library_item_request.rb
 - lib/ultracart_api/models/adjust_internal_certificate_request.rb
 - lib/ultracart_api/models/adjust_internal_certificate_response.rb
+- lib/ultracart_api/models/affiliate.rb
+- lib/ultracart_api/models/affiliate_attribute.rb
 - lib/ultracart_api/models/affiliate_click.rb
 - lib/ultracart_api/models/affiliate_click_query.rb
 - lib/ultracart_api/models/affiliate_clicks_response.rb
@@ -1133,6 +1144,11 @@ files:
 - lib/ultracart_api/models/affiliate_ledger_query.rb
 - lib/ultracart_api/models/affiliate_ledgers_response.rb
 - lib/ultracart_api/models/affiliate_link.rb
+- lib/ultracart_api/models/affiliate_marketing_strategy.rb
+- lib/ultracart_api/models/affiliate_query.rb
+- lib/ultracart_api/models/affiliate_response.rb
+- lib/ultracart_api/models/affiliate_tier_relationship.rb
+- lib/ultracart_api/models/affiliates_response.rb
 - lib/ultracart_api/models/agent_summary.rb
 - lib/ultracart_api/models/api_user_application_profile.rb
 - lib/ultracart_api/models/apply_library_item_request.rb
@@ -1580,6 +1596,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