ultracart_api 4.1.19 → 4.1.21

data/lib/ultracart_api/models/custom_report_account_config.rb

@@ -34,6 +34,8 @@ module UltracartClient
     # Date/time that custom reporting was opted in to
     attr_accessor :opt_in_date
 
+    attr_accessor :read_only
+
     attr_accessor :sql_budget
 
     attr_accessor :sql_usage
@@ -48,6 +50,7 @@ module UltracartClient
         :'opt_in' => :'opt_in',
         :'opt_in_by_user' => :'opt_in_by_user',
         :'opt_in_date' => :'opt_in_date',
+        :'read_only' => :'read_only',
         :'sql_budget' => :'sql_budget',
         :'sql_usage' => :'sql_usage'
       }
@@ -68,6 +71,7 @@ module UltracartClient
         :'opt_in' => :'Boolean',
         :'opt_in_by_user' => :'String',
         :'opt_in_date' => :'String',
+        :'read_only' => :'Boolean',
         :'sql_budget' => :'Float',
         :'sql_usage' => :'Float'
       }
@@ -122,6 +126,10 @@ module UltracartClient
         self.opt_in_date = attributes[:'opt_in_date']
       end
 
+      if attributes.key?(:'read_only')
+        self.read_only = attributes[:'read_only']
+      end
+
       if attributes.key?(:'sql_budget')
         self.sql_budget = attributes[:'sql_budget']
       end
@@ -156,6 +164,7 @@ module UltracartClient
           opt_in == o.opt_in &&
           opt_in_by_user == o.opt_in_by_user &&
           opt_in_date == o.opt_in_date &&
+          read_only == o.read_only &&
           sql_budget == o.sql_budget &&
           sql_usage == o.sql_usage
     end
@@ -169,7 +178,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ai_budget, ai_usage, merchant_id, novice_sql_comments, opt_in, opt_in_by_user, opt_in_date, sql_budget, sql_usage].hash
+      [ai_budget, ai_usage, merchant_id, novice_sql_comments, opt_in, opt_in_by_user, opt_in_date, read_only, sql_budget, sql_usage].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/custom_report_analysis_request.rb

@@ -0,0 +1,228 @@
+=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 CustomReportAnalysisRequest
+    attr_accessor :png_url
+
+    attr_accessor :result_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'png_url' => :'png_url',
+        :'result_url' => :'result_url'
+      }
+    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
+      {
+        :'png_url' => :'String',
+        :'result_url' => :'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::CustomReportAnalysisRequest` 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::CustomReportAnalysisRequest`. 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?(:'png_url')
+        self.png_url = attributes[:'png_url']
+      end
+
+      if attributes.key?(:'result_url')
+        self.result_url = attributes[:'result_url']
+      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 &&
+          png_url == o.png_url &&
+          result_url == o.result_url
+    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
+      [png_url, result_url].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/{chargeback_dispute_response.rb → custom_report_analysis_response.rb}

@@ -14,11 +14,11 @@ require 'date'
 require 'time'
 
 module UltracartClient
-  class ChargebackDisputeResponse
-    attr_accessor :chargeback
-
+  class CustomReportAnalysisResponse
     attr_accessor :error
 
+    attr_accessor :html
+
     attr_accessor :metadata
 
     # Indicates if API call was successful
@@ -29,8 +29,8 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'chargeback' => :'chargeback',
         :'error' => :'error',
+        :'html' => :'html',
         :'metadata' => :'metadata',
         :'success' => :'success',
         :'warning' => :'warning'
@@ -45,8 +45,8 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'chargeback' => :'ChargebackDispute',
         :'error' => :'Error',
+        :'html' => :'String',
         :'metadata' => :'ResponseMetadata',
         :'success' => :'Boolean',
         :'warning' => :'Warning'
@@ -63,25 +63,25 @@ module UltracartClient
     # @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::ChargebackDisputeResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::CustomReportAnalysisResponse` 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::ChargebackDisputeResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::CustomReportAnalysisResponse`. 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?(:'chargeback')
-        self.chargeback = attributes[:'chargeback']
-      end
-
       if attributes.key?(:'error')
         self.error = attributes[:'error']
       end
 
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -113,8 +113,8 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          chargeback == o.chargeback &&
           error == o.error &&
+          html == o.html &&
           metadata == o.metadata &&
           success == o.success &&
           warning == o.warning
@@ -129,7 +129,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chargeback, error, metadata, success, warning].hash
+      [error, html, metadata, success, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb

@@ -0,0 +1,265 @@
+=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 CustomReportChartPngUploadResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :signed_download_url
+
+    attr_accessor :signed_upload_url
+
+    # 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',
+        :'signed_download_url' => :'signed_download_url',
+        :'signed_upload_url' => :'signed_upload_url',
+        :'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',
+        :'signed_download_url' => :'String',
+        :'signed_upload_url' => :'String',
+        :'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::CustomReportChartPngUploadResponse` 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::CustomReportChartPngUploadResponse`. 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?(:'signed_download_url')
+        self.signed_download_url = attributes[:'signed_download_url']
+      end
+
+      if attributes.key?(:'signed_upload_url')
+        self.signed_upload_url = attributes[:'signed_upload_url']
+      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 &&
+          signed_download_url == o.signed_download_url &&
+          signed_upload_url == o.signed_upload_url &&
+          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, signed_download_url, signed_upload_url, 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_campaign.rb

@@ -66,6 +66,12 @@ module UltracartClient
     # True if this campaign is prevented from sending at this time due to spam complaints.
     attr_accessor :prevent_sending_due_to_spam
 
+    # True if the campaign should repeat on a monthly basis
+    attr_accessor :repeat_monthly
+
+    # True if the campaign should repeat on a weekly basis
+    attr_accessor :repeat_weekly
+
     # Revenue associated with campaign
     attr_accessor :revenue_formatted
 
@@ -113,6 +119,8 @@ module UltracartClient
         :'name' => :'name',
         :'open_rate_formatted' => :'open_rate_formatted',
         :'prevent_sending_due_to_spam' => :'prevent_sending_due_to_spam',
+        :'repeat_monthly' => :'repeat_monthly',
+        :'repeat_weekly' => :'repeat_weekly',
         :'revenue_formatted' => :'revenue_formatted',
         :'revenue_per_customer_formatted' => :'revenue_per_customer_formatted',
         :'scheduled_dts' => :'scheduled_dts',
@@ -150,6 +158,8 @@ module UltracartClient
         :'name' => :'String',
         :'open_rate_formatted' => :'String',
         :'prevent_sending_due_to_spam' => :'Boolean',
+        :'repeat_monthly' => :'Boolean',
+        :'repeat_weekly' => :'Boolean',
         :'revenue_formatted' => :'String',
         :'revenue_per_customer_formatted' => :'String',
         :'scheduled_dts' => :'String',
@@ -253,6 +263,14 @@ module UltracartClient
         self.prevent_sending_due_to_spam = attributes[:'prevent_sending_due_to_spam']
       end
 
+      if attributes.key?(:'repeat_monthly')
+        self.repeat_monthly = attributes[:'repeat_monthly']
+      end
+
+      if attributes.key?(:'repeat_weekly')
+        self.repeat_weekly = attributes[:'repeat_weekly']
+      end
+
       if attributes.key?(:'revenue_formatted')
         self.revenue_formatted = attributes[:'revenue_formatted']
       end
@@ -340,6 +358,8 @@ module UltracartClient
           name == o.name &&
           open_rate_formatted == o.open_rate_formatted &&
           prevent_sending_due_to_spam == o.prevent_sending_due_to_spam &&
+          repeat_monthly == o.repeat_monthly &&
+          repeat_weekly == o.repeat_weekly &&
           revenue_formatted == o.revenue_formatted &&
           revenue_per_customer_formatted == o.revenue_per_customer_formatted &&
           scheduled_dts == o.scheduled_dts &&
@@ -360,7 +380,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid].hash
+      [click_rate_formatted, created_dts, deleted, email_campaign_uuid, email_communication_sequence_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, esp_campaign_folder_uuid, esp_domain_user, esp_domain_uuid, esp_friendly_name, library_item_oid, memberships, merchant_id, name, open_rate_formatted, prevent_sending_due_to_spam, repeat_monthly, repeat_weekly, revenue_formatted, revenue_per_customer_formatted, scheduled_dts, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/item_tag.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module UltracartClient
   class ItemTag
-    # tag_tpe
+    # tag_type
     attr_accessor :tag_type
 
     # tag_value