ultracart_api 4.1.232 → 4.1.234

data/lib/ultracart_api/models/sfvb_approval_create_request.rb

@@ -29,6 +29,8 @@ module UltracartClient
 
     attr_accessor :experiment_start
 
+    attr_accessor :flow_backfill
+
     # For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256.  UltraCart keeps only their hash.
     attr_accessor :item_attribute_rows
 
@@ -85,6 +87,7 @@ module UltracartClient
         :'comms_settings' => :'comms_settings',
         :'content' => :'content',
         :'experiment_start' => :'experiment_start',
+        :'flow_backfill' => :'flow_backfill',
         :'item_attribute_rows' => :'item_attribute_rows',
         :'item_pricing' => :'item_pricing',
         :'params' => :'params',
@@ -113,6 +116,7 @@ module UltracartClient
         :'comms_settings' => :'SfvbCommsSettingsUpdateRequest',
         :'content' => :'String',
         :'experiment_start' => :'SfvbExperimentStartRequest',
+        :'flow_backfill' => :'SfvbFlowBackfillRequest',
         :'item_attribute_rows' => :'Array<SfvbItemAttributeBatchRow>',
         :'item_pricing' => :'SfvbItemPricingRequest',
         :'params' => :'SfvbApprovalParams',
@@ -172,6 +176,10 @@ module UltracartClient
         self.experiment_start = attributes[:'experiment_start']
       end
 
+      if attributes.key?(:'flow_backfill')
+        self.flow_backfill = attributes[:'flow_backfill']
+      end
+
       if attributes.key?(:'item_attribute_rows')
         if (value = attributes[:'item_attribute_rows']).is_a?(Array)
           self.item_attribute_rows = value
@@ -231,7 +239,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", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail"])
+      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", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
       return false unless action_validator.valid?(@action)
       true
     end
@@ -239,7 +247,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", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail"])
+      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", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
       unless validator.valid?(action)
         fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
       end
@@ -257,6 +265,7 @@ module UltracartClient
           comms_settings == o.comms_settings &&
           content == o.content &&
           experiment_start == o.experiment_start &&
+          flow_backfill == o.flow_backfill &&
           item_attribute_rows == o.item_attribute_rows &&
           item_pricing == o.item_pricing &&
           params == o.params &&
@@ -279,7 +288,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, affiliate_network, comms_list_import, comms_settings, content, experiment_start, item_attribute_rows, item_pricing, params, postcard_test_mail, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider, transactional_email].hash
+      [action, affiliate_network, comms_list_import, comms_settings, content, experiment_start, flow_backfill, item_attribute_rows, item_pricing, params, postcard_test_mail, 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_approval_params.rb

@@ -75,7 +75,7 @@ module UltracartClient
     # The step to remove, for sequence_step.delete, to move, for sequence_step.move, or to turn on, for sequence_step.enable_postcard.
     attr_accessor :step_uuid
 
-    # The tracking provider key, for tracking_provider.change.
+    # The tracking provider key, for tracking_provider.change and tracking_provider.clear.
     attr_accessor :tracking_provider
 
     # For upsell.enable, what to switch on.

data/lib/ultracart_api/models/sfvb_campaign.rb

@@ -36,6 +36,12 @@ module UltracartClient
     # True when a customer leaves the campaign once they buy from any source.
     attr_accessor :end_once_customer_purchases_anywhere
 
+    # That folder's name.
+    attr_accessor :folder_name
+
+    # The campaign folder it is filed in, or none.
+    attr_accessor :folder_uuid
+
     # Send this as If-Match when changing or archiving the campaign.
     attr_accessor :hash_sha256
 
@@ -85,6 +91,8 @@ module UltracartClient
         :'emails' => :'emails',
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
         :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
+        :'folder_name' => :'folder_name',
+        :'folder_uuid' => :'folder_uuid',
         :'hash_sha256' => :'hash_sha256',
         :'live' => :'live',
         :'memberships' => :'memberships',
@@ -116,6 +124,8 @@ module UltracartClient
         :'emails' => :'Array<SfvbCommsEmail>',
         :'end_once_customer_purchases' => :'Boolean',
         :'end_once_customer_purchases_anywhere' => :'Boolean',
+        :'folder_name' => :'String',
+        :'folder_uuid' => :'String',
         :'hash_sha256' => :'String',
         :'live' => :'Boolean',
         :'memberships' => :'Array<SfvbCampaignMembership>',
@@ -183,6 +193,14 @@ module UltracartClient
         self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
       end
 
+      if attributes.key?(:'folder_name')
+        self.folder_name = attributes[:'folder_name']
+      end
+
+      if attributes.key?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
       if attributes.key?(:'hash_sha256')
         self.hash_sha256 = attributes[:'hash_sha256']
       end
@@ -267,6 +285,8 @@ module UltracartClient
           emails == o.emails &&
           end_once_customer_purchases == o.end_once_customer_purchases &&
           end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
+          folder_name == o.folder_name &&
+          folder_uuid == o.folder_uuid &&
           hash_sha256 == o.hash_sha256 &&
           live == o.live &&
           memberships == o.memberships &&
@@ -291,7 +311,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, sms_phone_number, status, status_dts].hash
+      [campaign_uuid, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, folder_name, folder_uuid, 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_campaign_write_request.rb

@@ -21,6 +21,9 @@ module UltracartClient
     # True to end the campaign for a customer once they buy from any source.
     attr_accessor :end_once_customer_purchases_anywhere
 
+    # File it in this campaign folder.  An empty value takes it out of its folder.
+    attr_accessor :folder_uuid
+
     # The lists and segments it sends to or leaves out.  Replaces the whole set.  An empty array clears it.
     attr_accessor :memberships
 
@@ -44,6 +47,7 @@ module UltracartClient
       {
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
         :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
+        :'folder_uuid' => :'folder_uuid',
         :'memberships' => :'memberships',
         :'name' => :'name',
         :'scheduled_dts' => :'scheduled_dts',
@@ -63,6 +67,7 @@ module UltracartClient
       {
         :'end_once_customer_purchases' => :'Boolean',
         :'end_once_customer_purchases_anywhere' => :'Boolean',
+        :'folder_uuid' => :'String',
         :'memberships' => :'Array<SfvbCampaignMembership>',
         :'name' => :'String',
         :'scheduled_dts' => :'String',
@@ -101,6 +106,10 @@ module UltracartClient
         self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
       end
 
+      if attributes.key?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
       if attributes.key?(:'memberships')
         if (value = attributes[:'memberships']).is_a?(Array)
           self.memberships = value
@@ -148,6 +157,7 @@ module UltracartClient
       self.class == o.class &&
           end_once_customer_purchases == o.end_once_customer_purchases &&
           end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
+          folder_uuid == o.folder_uuid &&
           memberships == o.memberships &&
           name == o.name &&
           scheduled_dts == o.scheduled_dts &&
@@ -165,7 +175,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [end_once_customer_purchases, end_once_customer_purchases_anywhere, memberships, name, scheduled_dts, sending_domain_uuid, sending_name, sending_user].hash
+      [end_once_customer_purchases, end_once_customer_purchases_anywhere, folder_uuid, memberships, name, scheduled_dts, sending_domain_uuid, sending_name, sending_user].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_comms_lookup_owner.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 SfvbCommsLookupOwner
+    # True when the campaign or flow is archived.  It sends nothing, and 'sf comms flows list' or 'campaigns list' shows it only with --include-deleted.
+    attr_accessor :archived
+
+    # True when it is sending now, by the same rule the sequence read uses.
+    attr_accessor :live
+
+    # Its name.
+    attr_accessor :name
+
+    # Its status as stored.
+    attr_accessor :status
+
+    # campaign or flow.
+    attr_accessor :type
+
+    # The campaign or flow uuid.
+    attr_accessor :uuid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'archived' => :'archived',
+        :'live' => :'live',
+        :'name' => :'name',
+        :'status' => :'status',
+        :'type' => :'type',
+        :'uuid' => :'uuid'
+      }
+    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
+      {
+        :'archived' => :'Boolean',
+        :'live' => :'Boolean',
+        :'name' => :'String',
+        :'status' => :'String',
+        :'type' => :'String',
+        :'uuid' => :'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::SfvbCommsLookupOwner` 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::SfvbCommsLookupOwner`. 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?(:'archived')
+        self.archived = attributes[:'archived']
+      end
+
+      if attributes.key?(:'live')
+        self.live = attributes[:'live']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      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 &&
+          archived == o.archived &&
+          live == o.live &&
+          name == o.name &&
+          status == o.status &&
+          type == o.type &&
+          uuid == o.uuid
+    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
+      [archived, live, name, status, type, uuid].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