ultracart_api 4.1.16 → 4.1.17

data/lib/ultracart_api/models/custom_reports_execution_response.rb

@@ -0,0 +1,269 @@
+=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 CustomReportsExecutionResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :parameters
+
+    attr_accessor :reports
+
+    # 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
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'parameters' => :'parameters',
+        :'reports' => :'reports',
+        :'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
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'parameters' => :'Array<CustomReportExecutionParameter>',
+        :'reports' => :'Array<CustomReportsExecutionReportData>',
+        :'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::CustomReportsExecutionResponse` 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::CustomReportsExecutionResponse`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'parameters')
+        if (value = attributes[:'parameters']).is_a?(Array)
+          self.parameters = value
+        end
+      end
+
+      if attributes.key?(:'reports')
+        if (value = attributes[:'reports']).is_a?(Array)
+          self.reports = value
+        end
+      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 &&
+          error == o.error &&
+          metadata == o.metadata &&
+          parameters == o.parameters &&
+          reports == o.reports &&
+          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
+      [error, metadata, parameters, reports, 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/email_editor_values_response.rb

@@ -0,0 +1,258 @@
+=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 EmailEditorValuesResponse
+    attr_accessor :error
+
+    attr_accessor :loyalty_tiers
+
+    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
+      {
+        :'error' => :'error',
+        :'loyalty_tiers' => :'loyalty_tiers',
+        :'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
+      {
+        :'error' => :'Error',
+        :'loyalty_tiers' => :'Array<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::EmailEditorValuesResponse` 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::EmailEditorValuesResponse`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'loyalty_tiers')
+        if (value = attributes[:'loyalty_tiers']).is_a?(Array)
+          self.loyalty_tiers = value
+        end
+      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 &&
+          error == o.error &&
+          loyalty_tiers == o.loyalty_tiers &&
+          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
+      [error, loyalty_tiers, 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/version.rb

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

data/lib/ultracart_api.rb

@@ -321,16 +321,25 @@ require 'ultracart_api/models/coupon_type'
 require 'ultracart_api/models/coupons_request'
 require 'ultracart_api/models/coupons_response'
 require 'ultracart_api/models/currency'
+require 'ultracart_api/models/custom_dashboard'
+require 'ultracart_api/models/custom_dashboard_page'
+require 'ultracart_api/models/custom_dashboard_page_report'
+require 'ultracart_api/models/custom_dashboard_response'
+require 'ultracart_api/models/custom_dashboards_response'
 require 'ultracart_api/models/custom_report'
 require 'ultracart_api/models/custom_report_account_config'
 require 'ultracart_api/models/custom_report_account_config_response'
 require 'ultracart_api/models/custom_report_execution_parameter'
 require 'ultracart_api/models/custom_report_execution_request'
+require 'ultracart_api/models/custom_report_execution_response'
 require 'ultracart_api/models/custom_report_parameter'
 require 'ultracart_api/models/custom_report_parameter_option'
 require 'ultracart_api/models/custom_report_query'
 require 'ultracart_api/models/custom_report_response'
 require 'ultracart_api/models/custom_report_tooltip'
+require 'ultracart_api/models/custom_reports_execution_report_data'
+require 'ultracart_api/models/custom_reports_execution_request'
+require 'ultracart_api/models/custom_reports_execution_response'
 require 'ultracart_api/models/custom_reports_response'
 require 'ultracart_api/models/customer'
 require 'ultracart_api/models/customer_activity'
@@ -414,6 +423,7 @@ require 'ultracart_api/models/email_dashboard_activity_response'
 require 'ultracart_api/models/email_dashboard_stats_response'
 require 'ultracart_api/models/email_domain'
 require 'ultracart_api/models/email_editor_token_response'
+require 'ultracart_api/models/email_editor_values_response'
 require 'ultracart_api/models/email_flow'
 require 'ultracart_api/models/email_flow_back_populate_request'
 require 'ultracart_api/models/email_flow_back_populate_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.16
+  version: 4.1.17
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-28 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -372,16 +372,25 @@ files:
 - docs/CouponsRequest.md
 - docs/CouponsResponse.md
 - docs/Currency.md
+- docs/CustomDashboard.md
+- docs/CustomDashboardPage.md
+- docs/CustomDashboardPageReport.md
+- docs/CustomDashboardResponse.md
+- docs/CustomDashboardsResponse.md
 - docs/CustomReport.md
 - docs/CustomReportAccountConfig.md
 - docs/CustomReportAccountConfigResponse.md
 - docs/CustomReportExecutionParameter.md
 - docs/CustomReportExecutionRequest.md
+- docs/CustomReportExecutionResponse.md
 - docs/CustomReportParameter.md
 - docs/CustomReportParameterOption.md
 - docs/CustomReportQuery.md
 - docs/CustomReportResponse.md
 - docs/CustomReportTooltip.md
+- docs/CustomReportsExecutionReportData.md
+- docs/CustomReportsExecutionRequest.md
+- docs/CustomReportsExecutionResponse.md
 - docs/CustomReportsResponse.md
 - docs/Customer.md
 - docs/CustomerActivity.md
@@ -467,6 +476,7 @@ files:
 - docs/EmailDashboardStatsResponse.md
 - docs/EmailDomain.md
 - docs/EmailEditorTokenResponse.md
+- docs/EmailEditorValuesResponse.md
 - docs/EmailFlow.md
 - docs/EmailFlowBackPopulateRequest.md
 - docs/EmailFlowBackPopulateResponse.md
@@ -1286,16 +1296,25 @@ files:
 - lib/ultracart_api/models/coupons_request.rb
 - lib/ultracart_api/models/coupons_response.rb
 - lib/ultracart_api/models/currency.rb
+- lib/ultracart_api/models/custom_dashboard.rb
+- lib/ultracart_api/models/custom_dashboard_page.rb
+- lib/ultracart_api/models/custom_dashboard_page_report.rb
+- lib/ultracart_api/models/custom_dashboard_response.rb
+- lib/ultracart_api/models/custom_dashboards_response.rb
 - lib/ultracart_api/models/custom_report.rb
 - lib/ultracart_api/models/custom_report_account_config.rb
 - lib/ultracart_api/models/custom_report_account_config_response.rb
 - lib/ultracart_api/models/custom_report_execution_parameter.rb
 - lib/ultracart_api/models/custom_report_execution_request.rb
+- lib/ultracart_api/models/custom_report_execution_response.rb
 - lib/ultracart_api/models/custom_report_parameter.rb
 - lib/ultracart_api/models/custom_report_parameter_option.rb
 - lib/ultracart_api/models/custom_report_query.rb
 - lib/ultracart_api/models/custom_report_response.rb
 - lib/ultracart_api/models/custom_report_tooltip.rb
+- lib/ultracart_api/models/custom_reports_execution_report_data.rb
+- lib/ultracart_api/models/custom_reports_execution_request.rb
+- lib/ultracart_api/models/custom_reports_execution_response.rb
 - lib/ultracart_api/models/custom_reports_response.rb
 - lib/ultracart_api/models/customer.rb
 - lib/ultracart_api/models/customer_activity.rb
@@ -1379,6 +1398,7 @@ files:
 - lib/ultracart_api/models/email_dashboard_stats_response.rb
 - lib/ultracart_api/models/email_domain.rb
 - lib/ultracart_api/models/email_editor_token_response.rb
+- lib/ultracart_api/models/email_editor_values_response.rb
 - lib/ultracart_api/models/email_flow.rb
 - lib/ultracart_api/models/email_flow_back_populate_request.rb
 - lib/ultracart_api/models/email_flow_back_populate_response.rb