ultracart_api 4.1.222 → 4.1.224

data/lib/ultracart_api/models/oauth_token_response.rb

@@ -33,6 +33,9 @@ module UltracartClient
     # The refresh token that should be used to fetch a new access token when the expiration occurs
     attr_accessor :refresh_token
 
+    # Seconds until the refresh token expires.  Returned only by applications that rotate refresh tokens, which return a new refresh token on every refresh.
+    attr_accessor :refresh_token_expires_in
+
     # The scope of permissions associated with teh access token
     attr_accessor :scope
 
@@ -71,6 +74,7 @@ module UltracartClient
         :'expires_in' => :'expires_in',
         :'merchant_id' => :'merchant_id',
         :'refresh_token' => :'refresh_token',
+        :'refresh_token_expires_in' => :'refresh_token_expires_in',
         :'scope' => :'scope',
         :'token_type' => :'token_type'
       }
@@ -91,6 +95,7 @@ module UltracartClient
         :'expires_in' => :'String',
         :'merchant_id' => :'String',
         :'refresh_token' => :'String',
+        :'refresh_token_expires_in' => :'String',
         :'scope' => :'String',
         :'token_type' => :'String'
       }
@@ -145,6 +150,10 @@ module UltracartClient
         self.refresh_token = attributes[:'refresh_token']
       end
 
+      if attributes.key?(:'refresh_token_expires_in')
+        self.refresh_token_expires_in = attributes[:'refresh_token_expires_in']
+      end
+
       if attributes.key?(:'scope')
         self.scope = attributes[:'scope']
       end
@@ -191,6 +200,7 @@ module UltracartClient
           expires_in == o.expires_in &&
           merchant_id == o.merchant_id &&
           refresh_token == o.refresh_token &&
+          refresh_token_expires_in == o.refresh_token_expires_in &&
           scope == o.scope &&
           token_type == o.token_type
     end
@@ -204,7 +214,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [access_token, error, error_description, error_uri, expires_in, merchant_id, refresh_token, scope, token_type].hash
+      [access_token, error, error_description, error_uri, expires_in, merchant_id, refresh_token, refresh_token_expires_in, scope, token_type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_affiliate_network.rb

@@ -0,0 +1,478 @@
+=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 SfvbAffiliateNetwork
+    # The network's oid.  Smart Attribution names it as a platform's integration_id.
+    attr_accessor :affiliate_network_oid
+
+    # On a dry run, whether the real write needs an approved affiliate_network.change request.
+    attr_accessor :approval_needed
+
+    # The account's own affiliate that orders from this network are assigned to.  Null when none.
+    attr_accessor :assign_to_affiliate_oid
+
+    # On a write, what changed, or what would change on a dry run.  conversion_pixel shows its size and hash, not its content.
+    attr_accessor :changes
+
+    # A fixed commission amount, in the account's currency.  Null when not set.
+    attr_accessor :commission
+
+    # HTML for custom, or the postback URL for server_to_server, with the admin's order tokens.  Only on a read of one network and on a write.  Empty when not set.
+    attr_accessor :conversion_pixel
+
+    # The SHA-256 of conversion_pixel as UTF-8.
+    attr_accessor :conversion_pixel_sha256
+
+    # The size of conversion_pixel in UTF-8 bytes.
+    attr_accessor :conversion_pixel_size_bytes
+
+    # custom prints conversion_pixel into the receipt page.  commission_junction fires the account's Commission Junction setup instead and does not use conversion_pixel.  server_to_server has UltraCart's server request conversion_pixel as an https URL after the order.  A value stored by the admin that is none of these is shown as stored.
+    attr_accessor :conversion_type
+
+    # How long the visit is remembered, in days, 1 to 3650.
+    attr_accessor :cookie_lifetime_days
+
+    # On a write, true when nothing was saved.
+    attr_accessor :dry_run
+
+    # The share of this network's orders whose pixel fires, from 0 to 100.
+    attr_accessor :fire_percentage
+
+    # The hash of the network as stored.  Send it as If-Match on an update or delete.
+    attr_accessor :hash_sha256
+
+    # What UltraCart's own affiliate system does with an order whose pixel did not fire.  process handles it as usual, skip leaves it out, assign credits if_not_fired_affiliate_oid.
+    attr_accessor :if_not_fired
+
+    # For if_not_fired assign, the account's own affiliate to credit.
+    attr_accessor :if_not_fired_affiliate_oid
+
+    # The network's name, up to 50 characters.
+    attr_accessor :network_name
+
+    # The URL parameter that marks a visit from this network, up to 50 characters.  Compared without case.
+    attr_accessor :parameter_name
+
+    # The parameter's value for this network, up to 100 characters.  Compared without case.
+    attr_accessor :parameter_value
+
+    # The order custom field, 1 to 10, that records whether the pixel fired.
+    attr_accessor :record_fire_in_custom_field
+
+    # The order custom field, 1 to 10, that records the network's name.
+    attr_accessor :record_name_in_custom_field
+
+    # For server_to_server only, true to drop query parameters that are empty after the tokens are filled in.
+    attr_accessor :remove_empty_pixel_parameters
+
+    # True to replace another network's cookie.  False keeps the first network's.
+    attr_accessor :stomp_previous_cookie
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'affiliate_network_oid' => :'affiliate_network_oid',
+        :'approval_needed' => :'approval_needed',
+        :'assign_to_affiliate_oid' => :'assign_to_affiliate_oid',
+        :'changes' => :'changes',
+        :'commission' => :'commission',
+        :'conversion_pixel' => :'conversion_pixel',
+        :'conversion_pixel_sha256' => :'conversion_pixel_sha256',
+        :'conversion_pixel_size_bytes' => :'conversion_pixel_size_bytes',
+        :'conversion_type' => :'conversion_type',
+        :'cookie_lifetime_days' => :'cookie_lifetime_days',
+        :'dry_run' => :'dry_run',
+        :'fire_percentage' => :'fire_percentage',
+        :'hash_sha256' => :'hash_sha256',
+        :'if_not_fired' => :'if_not_fired',
+        :'if_not_fired_affiliate_oid' => :'if_not_fired_affiliate_oid',
+        :'network_name' => :'network_name',
+        :'parameter_name' => :'parameter_name',
+        :'parameter_value' => :'parameter_value',
+        :'record_fire_in_custom_field' => :'record_fire_in_custom_field',
+        :'record_name_in_custom_field' => :'record_name_in_custom_field',
+        :'remove_empty_pixel_parameters' => :'remove_empty_pixel_parameters',
+        :'stomp_previous_cookie' => :'stomp_previous_cookie'
+      }
+    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
+      {
+        :'affiliate_network_oid' => :'Integer',
+        :'approval_needed' => :'Boolean',
+        :'assign_to_affiliate_oid' => :'Integer',
+        :'changes' => :'Array<SfvbTrackingChange>',
+        :'commission' => :'Float',
+        :'conversion_pixel' => :'String',
+        :'conversion_pixel_sha256' => :'String',
+        :'conversion_pixel_size_bytes' => :'Integer',
+        :'conversion_type' => :'String',
+        :'cookie_lifetime_days' => :'Integer',
+        :'dry_run' => :'Boolean',
+        :'fire_percentage' => :'Float',
+        :'hash_sha256' => :'String',
+        :'if_not_fired' => :'String',
+        :'if_not_fired_affiliate_oid' => :'Integer',
+        :'network_name' => :'String',
+        :'parameter_name' => :'String',
+        :'parameter_value' => :'String',
+        :'record_fire_in_custom_field' => :'Integer',
+        :'record_name_in_custom_field' => :'Integer',
+        :'remove_empty_pixel_parameters' => :'Boolean',
+        :'stomp_previous_cookie' => :'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::SfvbAffiliateNetwork` 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::SfvbAffiliateNetwork`. 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?(:'affiliate_network_oid')
+        self.affiliate_network_oid = attributes[:'affiliate_network_oid']
+      end
+
+      if attributes.key?(:'approval_needed')
+        self.approval_needed = attributes[:'approval_needed']
+      end
+
+      if attributes.key?(:'assign_to_affiliate_oid')
+        self.assign_to_affiliate_oid = attributes[:'assign_to_affiliate_oid']
+      end
+
+      if attributes.key?(:'changes')
+        if (value = attributes[:'changes']).is_a?(Array)
+          self.changes = value
+        end
+      end
+
+      if attributes.key?(:'commission')
+        self.commission = attributes[:'commission']
+      end
+
+      if attributes.key?(:'conversion_pixel')
+        self.conversion_pixel = attributes[:'conversion_pixel']
+      end
+
+      if attributes.key?(:'conversion_pixel_sha256')
+        self.conversion_pixel_sha256 = attributes[:'conversion_pixel_sha256']
+      end
+
+      if attributes.key?(:'conversion_pixel_size_bytes')
+        self.conversion_pixel_size_bytes = attributes[:'conversion_pixel_size_bytes']
+      end
+
+      if attributes.key?(:'conversion_type')
+        self.conversion_type = attributes[:'conversion_type']
+      end
+
+      if attributes.key?(:'cookie_lifetime_days')
+        self.cookie_lifetime_days = attributes[:'cookie_lifetime_days']
+      end
+
+      if attributes.key?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
+      if attributes.key?(:'fire_percentage')
+        self.fire_percentage = attributes[:'fire_percentage']
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
+      if attributes.key?(:'if_not_fired')
+        self.if_not_fired = attributes[:'if_not_fired']
+      end
+
+      if attributes.key?(:'if_not_fired_affiliate_oid')
+        self.if_not_fired_affiliate_oid = attributes[:'if_not_fired_affiliate_oid']
+      end
+
+      if attributes.key?(:'network_name')
+        self.network_name = attributes[:'network_name']
+      end
+
+      if attributes.key?(:'parameter_name')
+        self.parameter_name = attributes[:'parameter_name']
+      end
+
+      if attributes.key?(:'parameter_value')
+        self.parameter_value = attributes[:'parameter_value']
+      end
+
+      if attributes.key?(:'record_fire_in_custom_field')
+        self.record_fire_in_custom_field = attributes[:'record_fire_in_custom_field']
+      end
+
+      if attributes.key?(:'record_name_in_custom_field')
+        self.record_name_in_custom_field = attributes[:'record_name_in_custom_field']
+      end
+
+      if attributes.key?(:'remove_empty_pixel_parameters')
+        self.remove_empty_pixel_parameters = attributes[:'remove_empty_pixel_parameters']
+      end
+
+      if attributes.key?(:'stomp_previous_cookie')
+        self.stomp_previous_cookie = attributes[:'stomp_previous_cookie']
+      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?
+      conversion_type_validator = EnumAttributeValidator.new('String', ["custom", "commission_junction", "server_to_server"])
+      return false unless conversion_type_validator.valid?(@conversion_type)
+      if_not_fired_validator = EnumAttributeValidator.new('String', ["process", "skip", "assign"])
+      return false unless if_not_fired_validator.valid?(@if_not_fired)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] conversion_type Object to be assigned
+    def conversion_type=(conversion_type)
+      validator = EnumAttributeValidator.new('String', ["custom", "commission_junction", "server_to_server"])
+      unless validator.valid?(conversion_type)
+        fail ArgumentError, "invalid value for \"conversion_type\", must be one of #{validator.allowable_values}."
+      end
+      @conversion_type = conversion_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] if_not_fired Object to be assigned
+    def if_not_fired=(if_not_fired)
+      validator = EnumAttributeValidator.new('String', ["process", "skip", "assign"])
+      unless validator.valid?(if_not_fired)
+        fail ArgumentError, "invalid value for \"if_not_fired\", must be one of #{validator.allowable_values}."
+      end
+      @if_not_fired = if_not_fired
+    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 &&
+          affiliate_network_oid == o.affiliate_network_oid &&
+          approval_needed == o.approval_needed &&
+          assign_to_affiliate_oid == o.assign_to_affiliate_oid &&
+          changes == o.changes &&
+          commission == o.commission &&
+          conversion_pixel == o.conversion_pixel &&
+          conversion_pixel_sha256 == o.conversion_pixel_sha256 &&
+          conversion_pixel_size_bytes == o.conversion_pixel_size_bytes &&
+          conversion_type == o.conversion_type &&
+          cookie_lifetime_days == o.cookie_lifetime_days &&
+          dry_run == o.dry_run &&
+          fire_percentage == o.fire_percentage &&
+          hash_sha256 == o.hash_sha256 &&
+          if_not_fired == o.if_not_fired &&
+          if_not_fired_affiliate_oid == o.if_not_fired_affiliate_oid &&
+          network_name == o.network_name &&
+          parameter_name == o.parameter_name &&
+          parameter_value == o.parameter_value &&
+          record_fire_in_custom_field == o.record_fire_in_custom_field &&
+          record_name_in_custom_field == o.record_name_in_custom_field &&
+          remove_empty_pixel_parameters == o.remove_empty_pixel_parameters &&
+          stomp_previous_cookie == o.stomp_previous_cookie
+    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
+      [affiliate_network_oid, approval_needed, assign_to_affiliate_oid, changes, commission, conversion_pixel, conversion_pixel_sha256, conversion_pixel_size_bytes, conversion_type, cookie_lifetime_days, dry_run, fire_percentage, hash_sha256, if_not_fired, if_not_fired_affiliate_oid, network_name, parameter_name, parameter_value, record_fire_in_custom_field, record_name_in_custom_field, remove_empty_pixel_parameters, stomp_previous_cookie].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