ultracart_api 4.1.231 → 4.1.233

data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb

@@ -0,0 +1,257 @@
+=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 SfvbCommsSettingsUpdateRequest
+    # Check the change and show it without writing or using an approval.
+    attr_accessor :dry_run
+
+    attr_accessor :marketing_sender
+
+    attr_accessor :postcard_return_address
+
+    # The default SMS number, one of the account's Twilio numbers, or an empty string to clear it.
+    attr_accessor :sms_phone_number
+
+    attr_accessor :transactional_sender
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'dry_run' => :'dry_run',
+        :'marketing_sender' => :'marketing_sender',
+        :'postcard_return_address' => :'postcard_return_address',
+        :'sms_phone_number' => :'sms_phone_number',
+        :'transactional_sender' => :'transactional_sender'
+      }
+    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
+      {
+        :'dry_run' => :'Boolean',
+        :'marketing_sender' => :'SfvbCommsSenderUpdate',
+        :'postcard_return_address' => :'SfvbPostcardAddress',
+        :'sms_phone_number' => :'String',
+        :'transactional_sender' => :'SfvbCommsSenderUpdate'
+      }
+    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::SfvbCommsSettingsUpdateRequest` 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::SfvbCommsSettingsUpdateRequest`. 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?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
+      if attributes.key?(:'marketing_sender')
+        self.marketing_sender = attributes[:'marketing_sender']
+      end
+
+      if attributes.key?(:'postcard_return_address')
+        self.postcard_return_address = attributes[:'postcard_return_address']
+      end
+
+      if attributes.key?(:'sms_phone_number')
+        self.sms_phone_number = attributes[:'sms_phone_number']
+      end
+
+      if attributes.key?(:'transactional_sender')
+        self.transactional_sender = attributes[:'transactional_sender']
+      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 &&
+          dry_run == o.dry_run &&
+          marketing_sender == o.marketing_sender &&
+          postcard_return_address == o.postcard_return_address &&
+          sms_phone_number == o.sms_phone_number &&
+          transactional_sender == o.transactional_sender
+    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
+      [dry_run, marketing_sender, postcard_return_address, sms_phone_number, transactional_sender].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_stat.rb

@@ -0,0 +1,402 @@
+=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 SfvbCommsStat
+    # Permanent bounces.
+    attr_accessor :bounced
+
+    # email, sms, postcard, branch or sequence, or step for a step type that records no counts of its own, with every count named in not_measured.
+    attr_accessor :channel
+
+    # Clicks (for a postcard, scans of its QR code).
+    attr_accessor :clicked
+
+    # Conversions.
+    attr_accessor :conversions
+
+    # Customers who reached it (a branch side), or started (a whole sequence).
+    attr_accessor :customers
+
+    # Deliveries.
+    attr_accessor :delivered
+
+    # Customers who finished the sequence.
+    attr_accessor :finished
+
+    # Customers in the sequence now.
+    attr_accessor :in_progress
+
+    # Addresses the email validator refused.
+    attr_accessor :invalid
+
+    # The counts this channel doesn't record, left out above.
+    attr_accessor :not_measured
+
+    # Opens.
+    attr_accessor :opened
+
+    # Orders attributed.
+    attr_accessor :orders
+
+    # Profit attributed.
+    attr_accessor :profit
+
+    # Postcards returned to sender.
+    attr_accessor :returned_to_sender
+
+    # Revenue attributed.
+    attr_accessor :revenue
+
+    # Sends.
+    attr_accessor :sent
+
+    # Customers skipped.
+    attr_accessor :skipped
+
+    # Spam complaints.
+    attr_accessor :spam
+
+    # Unsubscribes.
+    attr_accessor :unsubscribed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bounced' => :'bounced',
+        :'channel' => :'channel',
+        :'clicked' => :'clicked',
+        :'conversions' => :'conversions',
+        :'customers' => :'customers',
+        :'delivered' => :'delivered',
+        :'finished' => :'finished',
+        :'in_progress' => :'in_progress',
+        :'invalid' => :'invalid',
+        :'not_measured' => :'not_measured',
+        :'opened' => :'opened',
+        :'orders' => :'orders',
+        :'profit' => :'profit',
+        :'returned_to_sender' => :'returned_to_sender',
+        :'revenue' => :'revenue',
+        :'sent' => :'sent',
+        :'skipped' => :'skipped',
+        :'spam' => :'spam',
+        :'unsubscribed' => :'unsubscribed'
+      }
+    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
+      {
+        :'bounced' => :'Integer',
+        :'channel' => :'String',
+        :'clicked' => :'Integer',
+        :'conversions' => :'Integer',
+        :'customers' => :'Integer',
+        :'delivered' => :'Integer',
+        :'finished' => :'Integer',
+        :'in_progress' => :'Integer',
+        :'invalid' => :'Integer',
+        :'not_measured' => :'Array<String>',
+        :'opened' => :'Integer',
+        :'orders' => :'Integer',
+        :'profit' => :'Float',
+        :'returned_to_sender' => :'Integer',
+        :'revenue' => :'Float',
+        :'sent' => :'Integer',
+        :'skipped' => :'Integer',
+        :'spam' => :'Integer',
+        :'unsubscribed' => :'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::SfvbCommsStat` 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::SfvbCommsStat`. 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?(:'bounced')
+        self.bounced = attributes[:'bounced']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'clicked')
+        self.clicked = attributes[:'clicked']
+      end
+
+      if attributes.key?(:'conversions')
+        self.conversions = attributes[:'conversions']
+      end
+
+      if attributes.key?(:'customers')
+        self.customers = attributes[:'customers']
+      end
+
+      if attributes.key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      end
+
+      if attributes.key?(:'finished')
+        self.finished = attributes[:'finished']
+      end
+
+      if attributes.key?(:'in_progress')
+        self.in_progress = attributes[:'in_progress']
+      end
+
+      if attributes.key?(:'invalid')
+        self.invalid = attributes[:'invalid']
+      end
+
+      if attributes.key?(:'not_measured')
+        if (value = attributes[:'not_measured']).is_a?(Array)
+          self.not_measured = value
+        end
+      end
+
+      if attributes.key?(:'opened')
+        self.opened = attributes[:'opened']
+      end
+
+      if attributes.key?(:'orders')
+        self.orders = attributes[:'orders']
+      end
+
+      if attributes.key?(:'profit')
+        self.profit = attributes[:'profit']
+      end
+
+      if attributes.key?(:'returned_to_sender')
+        self.returned_to_sender = attributes[:'returned_to_sender']
+      end
+
+      if attributes.key?(:'revenue')
+        self.revenue = attributes[:'revenue']
+      end
+
+      if attributes.key?(:'sent')
+        self.sent = attributes[:'sent']
+      end
+
+      if attributes.key?(:'skipped')
+        self.skipped = attributes[:'skipped']
+      end
+
+      if attributes.key?(:'spam')
+        self.spam = attributes[:'spam']
+      end
+
+      if attributes.key?(:'unsubscribed')
+        self.unsubscribed = attributes[:'unsubscribed']
+      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 &&
+          bounced == o.bounced &&
+          channel == o.channel &&
+          clicked == o.clicked &&
+          conversions == o.conversions &&
+          customers == o.customers &&
+          delivered == o.delivered &&
+          finished == o.finished &&
+          in_progress == o.in_progress &&
+          invalid == o.invalid &&
+          not_measured == o.not_measured &&
+          opened == o.opened &&
+          orders == o.orders &&
+          profit == o.profit &&
+          returned_to_sender == o.returned_to_sender &&
+          revenue == o.revenue &&
+          sent == o.sent &&
+          skipped == o.skipped &&
+          spam == o.spam &&
+          unsubscribed == o.unsubscribed
+    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
+      [bounced, channel, clicked, conversions, customers, delivered, finished, in_progress, invalid, not_measured, opened, orders, profit, returned_to_sender, revenue, sent, skipped, spam, unsubscribed].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