ultracart_api 4.1.229 → 4.1.231

data/lib/ultracart_api/models/item_auto_order.rb

@@ -45,6 +45,15 @@ module UltracartClient
     # List of downgrade items presented to customer service representatives
     attr_accessor :auto_order_downgrade_items
 
+    # Day counts (1 to 365, at most 20) a customer may switch this auto-enrolled item to from MyAccount, for example [30, 60, 90].  Requires the advanced auto order settings to be enabled on the account.  Omit to leave unchanged; send an empty array to clear.
+    attr_accessor :auto_order_myaccount_frequency_day_counts
+
+    # True if the MyAccount frequency change is only offered once the item is on its last auto order step.  If auto_order_myaccount_frequency_schedules or auto_order_myaccount_frequency_day_counts is sent without this property, it is set to false; if none of the three are sent, it is left unchanged.
+    attr_accessor :auto_order_myaccount_frequency_last_step_only
+
+    # Standard schedules a customer may switch this auto-enrolled item to from MyAccount.  Requires the advanced auto order settings to be enabled on the account.  Omit to leave unchanged; send an empty array to clear.
+    attr_accessor :auto_order_myaccount_frequency_schedules
+
     # True if the rebill processing of this item is paused
     attr_accessor :auto_order_paused
 
@@ -94,6 +103,9 @@ module UltracartClient
         :'auto_order_cancel_minimum_rebill_count' => :'auto_order_cancel_minimum_rebill_count',
         :'auto_order_cancel_minimum_rebill_value' => :'auto_order_cancel_minimum_rebill_value',
         :'auto_order_downgrade_items' => :'auto_order_downgrade_items',
+        :'auto_order_myaccount_frequency_day_counts' => :'auto_order_myaccount_frequency_day_counts',
+        :'auto_order_myaccount_frequency_last_step_only' => :'auto_order_myaccount_frequency_last_step_only',
+        :'auto_order_myaccount_frequency_schedules' => :'auto_order_myaccount_frequency_schedules',
         :'auto_order_paused' => :'auto_order_paused',
         :'auto_order_prohibit_expiring_cards' => :'auto_order_prohibit_expiring_cards',
         :'auto_order_schedules' => :'auto_order_schedules',
@@ -127,6 +139,9 @@ module UltracartClient
         :'auto_order_cancel_minimum_rebill_count' => :'Integer',
         :'auto_order_cancel_minimum_rebill_value' => :'Float',
         :'auto_order_downgrade_items' => :'Array<String>',
+        :'auto_order_myaccount_frequency_day_counts' => :'Array<Integer>',
+        :'auto_order_myaccount_frequency_last_step_only' => :'Boolean',
+        :'auto_order_myaccount_frequency_schedules' => :'Array<String>',
         :'auto_order_paused' => :'Boolean',
         :'auto_order_prohibit_expiring_cards' => :'Integer',
         :'auto_order_schedules' => :'Array<String>',
@@ -205,6 +220,22 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'auto_order_myaccount_frequency_day_counts')
+        if (value = attributes[:'auto_order_myaccount_frequency_day_counts']).is_a?(Array)
+          self.auto_order_myaccount_frequency_day_counts = value
+        end
+      end
+
+      if attributes.key?(:'auto_order_myaccount_frequency_last_step_only')
+        self.auto_order_myaccount_frequency_last_step_only = attributes[:'auto_order_myaccount_frequency_last_step_only']
+      end
+
+      if attributes.key?(:'auto_order_myaccount_frequency_schedules')
+        if (value = attributes[:'auto_order_myaccount_frequency_schedules']).is_a?(Array)
+          self.auto_order_myaccount_frequency_schedules = value
+        end
+      end
+
       if attributes.key?(:'auto_order_paused')
         self.auto_order_paused = attributes[:'auto_order_paused']
       end
@@ -303,6 +334,9 @@ module UltracartClient
           auto_order_cancel_minimum_rebill_count == o.auto_order_cancel_minimum_rebill_count &&
           auto_order_cancel_minimum_rebill_value == o.auto_order_cancel_minimum_rebill_value &&
           auto_order_downgrade_items == o.auto_order_downgrade_items &&
+          auto_order_myaccount_frequency_day_counts == o.auto_order_myaccount_frequency_day_counts &&
+          auto_order_myaccount_frequency_last_step_only == o.auto_order_myaccount_frequency_last_step_only &&
+          auto_order_myaccount_frequency_schedules == o.auto_order_myaccount_frequency_schedules &&
           auto_order_paused == o.auto_order_paused &&
           auto_order_prohibit_expiring_cards == o.auto_order_prohibit_expiring_cards &&
           auto_order_schedules == o.auto_order_schedules &&
@@ -326,7 +360,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auth_future_amount, auth_test_amount, auto_order_cancel_charge_minimum_balance, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_cancel_minimum_life_time_count, auto_order_cancel_minimum_life_time_value, auto_order_cancel_minimum_rebill_count, auto_order_cancel_minimum_rebill_value, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
+      [auth_future_amount, auth_test_amount, auto_order_cancel_charge_minimum_balance, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_cancel_minimum_life_time_count, auto_order_cancel_minimum_life_time_value, auto_order_cancel_minimum_rebill_count, auto_order_cancel_minimum_rebill_value, auto_order_downgrade_items, auto_order_myaccount_frequency_day_counts, auto_order_myaccount_frequency_last_step_only, auto_order_myaccount_frequency_schedules, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_approval_create_request.rb

@@ -46,6 +46,8 @@ module UltracartClient
 
     attr_accessor :tracking_provider
 
+    attr_accessor :transactional_email
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -83,7 +85,8 @@ module UltracartClient
         :'segment_update' => :'segment_update',
         :'site_seo' => :'site_seo',
         :'smart_attribution' => :'smart_attribution',
-        :'tracking_provider' => :'tracking_provider'
+        :'tracking_provider' => :'tracking_provider',
+        :'transactional_email' => :'transactional_email'
       }
     end
 
@@ -107,7 +110,8 @@ module UltracartClient
         :'segment_update' => :'SfvbCommsSegmentWriteRequest',
         :'site_seo' => :'SfvbSiteSeoRequest',
         :'smart_attribution' => :'SfvbSmartAttributionRequest',
-        :'tracking_provider' => :'SfvbTrackingProviderRequest'
+        :'tracking_provider' => :'SfvbTrackingProviderRequest',
+        :'transactional_email' => :'SfvbTransactionalEmailUpdateRequest'
       }
     end
 
@@ -187,6 +191,10 @@ module UltracartClient
       if attributes.key?(:'tracking_provider')
         self.tracking_provider = attributes[:'tracking_provider']
       end
+
+      if attributes.key?(:'transactional_email')
+        self.transactional_email = attributes[:'transactional_email']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -199,7 +207,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change"])
+      action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update"])
       return false unless action_validator.valid?(@action)
       true
     end
@@ -207,7 +215,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] action Object to be assigned
     def action=(action)
-      validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change"])
+      validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update"])
       unless validator.valid?(action)
         fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
       end
@@ -231,7 +239,8 @@ module UltracartClient
           segment_update == o.segment_update &&
           site_seo == o.site_seo &&
           smart_attribution == o.smart_attribution &&
-          tracking_provider == o.tracking_provider
+          tracking_provider == o.tracking_provider &&
+          transactional_email == o.transactional_email
     end
 
     # @see the `==` method
@@ -243,7 +252,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, affiliate_network, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider].hash
+      [action, affiliate_network, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider, transactional_email].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_campaign.rb

@@ -66,6 +66,9 @@ module UltracartClient
     # The part of the from address before the at sign.  Defaults to the storefront's marketing setting.
     attr_accessor :sending_user
 
+    # The number this campaign's SMS steps send from.  Without one, every SMS step skips every customer, whatever the account's SMS settings say.
+    attr_accessor :sms_phone_number
+
     # The status, such as draft, scheduled, sending, sent or archived.
     attr_accessor :status
 
@@ -92,6 +95,7 @@ module UltracartClient
         :'sending_domain_uuid' => :'sending_domain_uuid',
         :'sending_name' => :'sending_name',
         :'sending_user' => :'sending_user',
+        :'sms_phone_number' => :'sms_phone_number',
         :'status' => :'status',
         :'status_dts' => :'status_dts'
       }
@@ -122,6 +126,7 @@ module UltracartClient
         :'sending_domain_uuid' => :'String',
         :'sending_name' => :'String',
         :'sending_user' => :'String',
+        :'sms_phone_number' => :'String',
         :'status' => :'String',
         :'status_dts' => :'String'
       }
@@ -224,6 +229,10 @@ module UltracartClient
         self.sending_user = attributes[:'sending_user']
       end
 
+      if attributes.key?(:'sms_phone_number')
+        self.sms_phone_number = attributes[:'sms_phone_number']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -268,6 +277,7 @@ module UltracartClient
           sending_domain_uuid == o.sending_domain_uuid &&
           sending_name == o.sending_name &&
           sending_user == o.sending_user &&
+          sms_phone_number == o.sms_phone_number &&
           status == o.status &&
           status_dts == o.status_dts
     end
@@ -281,7 +291,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_uuid, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, hash_sha256, live, memberships, name, notes, postcards, scheduled_dts, sending_domain_uuid, sending_name, sending_user, status, status_dts].hash
+      [campaign_uuid, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, hash_sha256, live, memberships, name, notes, postcards, scheduled_dts, sending_domain_uuid, sending_name, sending_user, sms_phone_number, status, status_dts].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_comms_folder.rb

@@ -0,0 +1,270 @@
+=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 SfvbCommsFolder
+    # The folder uuid.
+    attr_accessor :folder_uuid
+
+    # The hash of the name.  Send it as If-Match to rename or delete the folder.
+    attr_accessor :hash_sha256
+
+    # How many lists are filed in it.
+    attr_accessor :list_count
+
+    # The folder name.
+    attr_accessor :name
+
+    # How many segments are filed in it.
+    attr_accessor :segment_count
+
+    # True for a folder the admin manages, which can't be renamed or deleted here.
+    attr_accessor :system_generated
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'folder_uuid' => :'folder_uuid',
+        :'hash_sha256' => :'hash_sha256',
+        :'list_count' => :'list_count',
+        :'name' => :'name',
+        :'segment_count' => :'segment_count',
+        :'system_generated' => :'system_generated'
+      }
+    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
+      {
+        :'folder_uuid' => :'String',
+        :'hash_sha256' => :'String',
+        :'list_count' => :'Integer',
+        :'name' => :'String',
+        :'segment_count' => :'Integer',
+        :'system_generated' => :'Boolean'
+      }
+    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::SfvbCommsFolder` 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::SfvbCommsFolder`. 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?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'list_count')
+        self.list_count = attributes[:'list_count']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'segment_count')
+        self.segment_count = attributes[:'segment_count']
+      end
+
+      if attributes.key?(:'system_generated')
+        self.system_generated = attributes[:'system_generated']
+      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 &&
+          folder_uuid == o.folder_uuid &&
+          hash_sha256 == o.hash_sha256 &&
+          list_count == o.list_count &&
+          name == o.name &&
+          segment_count == o.segment_count &&
+          system_generated == o.system_generated
+    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
+      [folder_uuid, hash_sha256, list_count, name, segment_count, system_generated].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