ultracart_api 4.1.231 → 4.1.232

data/lib/ultracart_api/models/sfvb_comms_plan.rb

@@ -0,0 +1,460 @@
+=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 SfvbCommsPlan
+    # Customers being mailed now.
+    attr_accessor :active_customers
+
+    # True when the account may import lists from another email provider.
+    attr_accessor :allow_list_import
+
+    # True when shipment tracking emails are allowed.
+    attr_accessor :allow_tracking_emails
+
+    # Emails bounced.
+    attr_accessor :bounce_count
+
+    # The bounce percentage.
+    attr_accessor :bounce_percentage
+
+    # Emails delivered.
+    attr_accessor :delivered_count
+
+    # The starting sending limit for a new account.
+    attr_accessor :initial_sending_limits
+
+    # The most customers the plan mails.
+    attr_accessor :max_active_customers
+
+    # The daily sending cap.
+    attr_accessor :max_emails_per_day
+
+    # The hourly sending cap.
+    attr_accessor :max_emails_per_hour
+
+    # The monthly sending cap.
+    attr_accessor :max_emails_per_month
+
+    # True when sending is paused for spam complaints.
+    attr_accessor :paused_for_spam
+
+    # Customers the plan covers.
+    attr_accessor :plan_customers
+
+    # Emails a month the plan covers.
+    attr_accessor :plan_emails
+
+    # The plan, such as small.
+    attr_accessor :plan_name
+
+    # The plan's display name.
+    attr_accessor :plan_name_formatted
+
+    # When set, only customers who ordered within this many days are mailed.
+    attr_accessor :require_order_within_last_days
+
+    # Emails sent in the last day.
+    attr_accessor :sent_emails_per_day
+
+    # Emails sent in the last hour.
+    attr_accessor :sent_emails_per_hour
+
+    # Emails sent in the last month.
+    attr_accessor :sent_emails_per_month
+
+    # Spam complaints.
+    attr_accessor :spam_count
+
+    # The spam complaint percentage at which sending pauses.
+    attr_accessor :spam_percent_limit
+
+    # The spam complaint percentage.
+    attr_accessor :spam_percentage
+
+    # Customers allowed in all.
+    attr_accessor :total_customers
+
+    # Emails a month allowed in all.
+    attr_accessor :total_emails
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'active_customers' => :'active_customers',
+        :'allow_list_import' => :'allow_list_import',
+        :'allow_tracking_emails' => :'allow_tracking_emails',
+        :'bounce_count' => :'bounce_count',
+        :'bounce_percentage' => :'bounce_percentage',
+        :'delivered_count' => :'delivered_count',
+        :'initial_sending_limits' => :'initial_sending_limits',
+        :'max_active_customers' => :'max_active_customers',
+        :'max_emails_per_day' => :'max_emails_per_day',
+        :'max_emails_per_hour' => :'max_emails_per_hour',
+        :'max_emails_per_month' => :'max_emails_per_month',
+        :'paused_for_spam' => :'paused_for_spam',
+        :'plan_customers' => :'plan_customers',
+        :'plan_emails' => :'plan_emails',
+        :'plan_name' => :'plan_name',
+        :'plan_name_formatted' => :'plan_name_formatted',
+        :'require_order_within_last_days' => :'require_order_within_last_days',
+        :'sent_emails_per_day' => :'sent_emails_per_day',
+        :'sent_emails_per_hour' => :'sent_emails_per_hour',
+        :'sent_emails_per_month' => :'sent_emails_per_month',
+        :'spam_count' => :'spam_count',
+        :'spam_percent_limit' => :'spam_percent_limit',
+        :'spam_percentage' => :'spam_percentage',
+        :'total_customers' => :'total_customers',
+        :'total_emails' => :'total_emails'
+      }
+    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
+      {
+        :'active_customers' => :'Integer',
+        :'allow_list_import' => :'Boolean',
+        :'allow_tracking_emails' => :'Boolean',
+        :'bounce_count' => :'Integer',
+        :'bounce_percentage' => :'Float',
+        :'delivered_count' => :'Integer',
+        :'initial_sending_limits' => :'Integer',
+        :'max_active_customers' => :'Integer',
+        :'max_emails_per_day' => :'Integer',
+        :'max_emails_per_hour' => :'Integer',
+        :'max_emails_per_month' => :'Integer',
+        :'paused_for_spam' => :'Boolean',
+        :'plan_customers' => :'Integer',
+        :'plan_emails' => :'Integer',
+        :'plan_name' => :'String',
+        :'plan_name_formatted' => :'String',
+        :'require_order_within_last_days' => :'Integer',
+        :'sent_emails_per_day' => :'Integer',
+        :'sent_emails_per_hour' => :'Integer',
+        :'sent_emails_per_month' => :'Integer',
+        :'spam_count' => :'Integer',
+        :'spam_percent_limit' => :'Integer',
+        :'spam_percentage' => :'Float',
+        :'total_customers' => :'Integer',
+        :'total_emails' => :'Integer'
+      }
+    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::SfvbCommsPlan` 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::SfvbCommsPlan`. 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?(:'active_customers')
+        self.active_customers = attributes[:'active_customers']
+      end
+
+      if attributes.key?(:'allow_list_import')
+        self.allow_list_import = attributes[:'allow_list_import']
+      end
+
+      if attributes.key?(:'allow_tracking_emails')
+        self.allow_tracking_emails = attributes[:'allow_tracking_emails']
+      end
+
+      if attributes.key?(:'bounce_count')
+        self.bounce_count = attributes[:'bounce_count']
+      end
+
+      if attributes.key?(:'bounce_percentage')
+        self.bounce_percentage = attributes[:'bounce_percentage']
+      end
+
+      if attributes.key?(:'delivered_count')
+        self.delivered_count = attributes[:'delivered_count']
+      end
+
+      if attributes.key?(:'initial_sending_limits')
+        self.initial_sending_limits = attributes[:'initial_sending_limits']
+      end
+
+      if attributes.key?(:'max_active_customers')
+        self.max_active_customers = attributes[:'max_active_customers']
+      end
+
+      if attributes.key?(:'max_emails_per_day')
+        self.max_emails_per_day = attributes[:'max_emails_per_day']
+      end
+
+      if attributes.key?(:'max_emails_per_hour')
+        self.max_emails_per_hour = attributes[:'max_emails_per_hour']
+      end
+
+      if attributes.key?(:'max_emails_per_month')
+        self.max_emails_per_month = attributes[:'max_emails_per_month']
+      end
+
+      if attributes.key?(:'paused_for_spam')
+        self.paused_for_spam = attributes[:'paused_for_spam']
+      end
+
+      if attributes.key?(:'plan_customers')
+        self.plan_customers = attributes[:'plan_customers']
+      end
+
+      if attributes.key?(:'plan_emails')
+        self.plan_emails = attributes[:'plan_emails']
+      end
+
+      if attributes.key?(:'plan_name')
+        self.plan_name = attributes[:'plan_name']
+      end
+
+      if attributes.key?(:'plan_name_formatted')
+        self.plan_name_formatted = attributes[:'plan_name_formatted']
+      end
+
+      if attributes.key?(:'require_order_within_last_days')
+        self.require_order_within_last_days = attributes[:'require_order_within_last_days']
+      end
+
+      if attributes.key?(:'sent_emails_per_day')
+        self.sent_emails_per_day = attributes[:'sent_emails_per_day']
+      end
+
+      if attributes.key?(:'sent_emails_per_hour')
+        self.sent_emails_per_hour = attributes[:'sent_emails_per_hour']
+      end
+
+      if attributes.key?(:'sent_emails_per_month')
+        self.sent_emails_per_month = attributes[:'sent_emails_per_month']
+      end
+
+      if attributes.key?(:'spam_count')
+        self.spam_count = attributes[:'spam_count']
+      end
+
+      if attributes.key?(:'spam_percent_limit')
+        self.spam_percent_limit = attributes[:'spam_percent_limit']
+      end
+
+      if attributes.key?(:'spam_percentage')
+        self.spam_percentage = attributes[:'spam_percentage']
+      end
+
+      if attributes.key?(:'total_customers')
+        self.total_customers = attributes[:'total_customers']
+      end
+
+      if attributes.key?(:'total_emails')
+        self.total_emails = attributes[:'total_emails']
+      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 &&
+          active_customers == o.active_customers &&
+          allow_list_import == o.allow_list_import &&
+          allow_tracking_emails == o.allow_tracking_emails &&
+          bounce_count == o.bounce_count &&
+          bounce_percentage == o.bounce_percentage &&
+          delivered_count == o.delivered_count &&
+          initial_sending_limits == o.initial_sending_limits &&
+          max_active_customers == o.max_active_customers &&
+          max_emails_per_day == o.max_emails_per_day &&
+          max_emails_per_hour == o.max_emails_per_hour &&
+          max_emails_per_month == o.max_emails_per_month &&
+          paused_for_spam == o.paused_for_spam &&
+          plan_customers == o.plan_customers &&
+          plan_emails == o.plan_emails &&
+          plan_name == o.plan_name &&
+          plan_name_formatted == o.plan_name_formatted &&
+          require_order_within_last_days == o.require_order_within_last_days &&
+          sent_emails_per_day == o.sent_emails_per_day &&
+          sent_emails_per_hour == o.sent_emails_per_hour &&
+          sent_emails_per_month == o.sent_emails_per_month &&
+          spam_count == o.spam_count &&
+          spam_percent_limit == o.spam_percent_limit &&
+          spam_percentage == o.spam_percentage &&
+          total_customers == o.total_customers &&
+          total_emails == o.total_emails
+    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
+      [active_customers, allow_list_import, allow_tracking_emails, bounce_count, bounce_percentage, delivered_count, initial_sending_limits, max_active_customers, max_emails_per_day, max_emails_per_hour, max_emails_per_month, paused_for_spam, plan_customers, plan_emails, plan_name, plan_name_formatted, require_order_within_last_days, sent_emails_per_day, sent_emails_per_hour, sent_emails_per_month, spam_count, spam_percent_limit, spam_percentage, total_customers, total_emails].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/sfvb_comms_plan_response.rb

@@ -0,0 +1,231 @@
+=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 SfvbCommsPlanResponse
+    # What stands out, such as a paused account or a cap nearly reached.
+    attr_accessor :notes
+
+    attr_accessor :plan
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'notes' => :'notes',
+        :'plan' => :'plan'
+      }
+    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
+      {
+        :'notes' => :'Array<String>',
+        :'plan' => :'SfvbCommsPlan'
+      }
+    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::SfvbCommsPlanResponse` 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::SfvbCommsPlanResponse`. 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?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'plan')
+        self.plan = attributes[:'plan']
+      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 &&
+          notes == o.notes &&
+          plan == o.plan
+    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
+      [notes, plan].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