voucherify 8.0.2 → 8.1.0

data/lib/VoucherifySdk/models/application_details_item.rb

@@ -0,0 +1,284 @@
+=begin
+#Voucherify API
+
+#Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.
+
+The version of the OpenAPI document: v2018-08-01
+Contact: support@voucherify.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module VoucherifySdk
+  # Object representing item replacement.
+  class ApplicationDetailsItem
+    # Index number of the source item that is replaced. The enumeration starts from `0`, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, `source_index` equals `3`.
+    attr_accessor :source_index
+
+    # Number of source units that are replaced.
+    attr_accessor :source_applied_quantity
+
+    # Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity.
+    attr_accessor :source_applied_quantity_amount
+
+    # Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, `target_index` equals `3`, as enumeration starts from `0`.
+    attr_accessor :target_index
+
+    # Number of added target units that are replacements.
+    attr_accessor :target_applied_quantity
+
+    # Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity.
+    attr_accessor :target_applied_quantity_amount
+
+    # Discount amount applied to the target item with regard to the replacement. Equals the `target_applied_quantity_amount` minus `source_applied_quantity_amount`.
+    attr_accessor :target_applied_discount_amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source_index' => :'source_index',
+        :'source_applied_quantity' => :'source_applied_quantity',
+        :'source_applied_quantity_amount' => :'source_applied_quantity_amount',
+        :'target_index' => :'target_index',
+        :'target_applied_quantity' => :'target_applied_quantity',
+        :'target_applied_quantity_amount' => :'target_applied_quantity_amount',
+        :'target_applied_discount_amount' => :'target_applied_discount_amount'
+      }
+    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
+      {
+        :'source_index' => :'Integer',
+        :'source_applied_quantity' => :'Integer',
+        :'source_applied_quantity_amount' => :'Integer',
+        :'target_index' => :'Integer',
+        :'target_applied_quantity' => :'Integer',
+        :'target_applied_quantity_amount' => :'Integer',
+        :'target_applied_discount_amount' => :'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 = {})
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'source_index')
+        self.source_index = attributes[:'source_index']
+      end
+
+      if attributes.key?(:'source_applied_quantity')
+        self.source_applied_quantity = attributes[:'source_applied_quantity']
+      end
+
+      if attributes.key?(:'source_applied_quantity_amount')
+        self.source_applied_quantity_amount = attributes[:'source_applied_quantity_amount']
+      end
+
+      if attributes.key?(:'target_index')
+        self.target_index = attributes[:'target_index']
+      end
+
+      if attributes.key?(:'target_applied_quantity')
+        self.target_applied_quantity = attributes[:'target_applied_quantity']
+      end
+
+      if attributes.key?(:'target_applied_quantity_amount')
+        self.target_applied_quantity_amount = attributes[:'target_applied_quantity_amount']
+      end
+
+      if attributes.key?(:'target_applied_discount_amount')
+        self.target_applied_discount_amount = attributes[:'target_applied_discount_amount']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@source_index.nil? && @source_index < 0
+        invalid_properties.push('invalid value for "source_index", must be greater than or equal to 0.')
+      end
+
+      if !@source_applied_quantity.nil? && @source_applied_quantity > -1
+        invalid_properties.push('invalid value for "source_applied_quantity", must be smaller than or equal to -1.')
+      end
+
+      if !@source_applied_quantity_amount.nil? && @source_applied_quantity_amount > 0
+        invalid_properties.push('invalid value for "source_applied_quantity_amount", must be smaller than or equal to 0.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@source_index.nil? && @source_index < 0
+      return false if !@source_applied_quantity.nil? && @source_applied_quantity > -1
+      return false if !@source_applied_quantity_amount.nil? && @source_applied_quantity_amount > 0
+      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 &&
+          source_index == o.source_index &&
+          source_applied_quantity == o.source_applied_quantity &&
+          source_applied_quantity_amount == o.source_applied_quantity_amount &&
+          target_index == o.target_index &&
+          target_applied_quantity == o.target_applied_quantity &&
+          target_applied_quantity_amount == o.target_applied_quantity_amount &&
+          target_applied_discount_amount == o.target_applied_discount_amount
+    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
+      [source_index, source_applied_quantity, source_applied_quantity_amount, target_index, target_applied_quantity, target_applied_quantity_amount, target_applied_discount_amount].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = VoucherifySdk.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/VoucherifySdk/models/area_store_campaign_assignment.rb

@@ -22,6 +22,9 @@ module VoucherifySdk
     # Unique identifier of the area to which the campaign is assigned.
     attr_accessor :area_id
 
+    # Determines if the campaign is assigned to all of the stores in the area, i.e. if an area ID is passed in the `access_settings.assign.area_all_stores_ids` in the request.
+    attr_accessor :all_stores
+
     # Unique identifier of the store to which the campaign is assigned.
     attr_accessor :area_store_id
 
@@ -58,6 +61,7 @@ module VoucherifySdk
       {
         :'id' => :'id',
         :'area_id' => :'area_id',
+        :'all_stores' => :'all_stores',
         :'area_store_id' => :'area_store_id',
         :'created_at' => :'created_at',
         :'object' => :'object'
@@ -74,6 +78,7 @@ module VoucherifySdk
       {
         :'id' => :'String',
         :'area_id' => :'String',
+        :'all_stores' => :'Boolean',
         :'area_store_id' => :'String',
         :'created_at' => :'Time',
         :'object' => :'String'
@@ -85,6 +90,7 @@ module VoucherifySdk
       Set.new([
         :'id',
         :'area_id',
+        :'all_stores',
         :'area_store_id',
         :'created_at',
         :'object'
@@ -107,6 +113,10 @@ module VoucherifySdk
         self.area_id = attributes[:'area_id']
       end
 
+      if attributes.key?(:'all_stores')
+        self.all_stores = attributes[:'all_stores']
+      end
+
       if attributes.key?(:'area_store_id')
         self.area_store_id = attributes[:'area_store_id']
       end
@@ -146,6 +156,7 @@ module VoucherifySdk
       self.class == o.class &&
           id == o.id &&
           area_id == o.area_id &&
+          all_stores == o.all_stores &&
           area_store_id == o.area_store_id &&
           created_at == o.created_at &&
           object == o.object
@@ -160,7 +171,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, area_id, area_store_id, created_at, object].hash
+      [id, area_id, all_stores, area_store_id, created_at, object].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/async_actions_list_response_body.rb

@@ -24,6 +24,9 @@ module VoucherifySdk
 
     attr_accessor :async_actions
 
+    # As query results are always limited by parameters, the `has_more` flag indicates if there are more records available. This lets you know if you can run another request to get more records returned in the results.
+    attr_accessor :has_more
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +54,8 @@ module VoucherifySdk
       {
         :'object' => :'object',
         :'data_ref' => :'data_ref',
-        :'async_actions' => :'async_actions'
+        :'async_actions' => :'async_actions',
+        :'has_more' => :'has_more'
       }
     end
 
@@ -65,7 +69,8 @@ module VoucherifySdk
       {
         :'object' => :'String',
         :'data_ref' => :'String',
-        :'async_actions' => :'Array<AsyncActionBase>'
+        :'async_actions' => :'Array<AsyncActionBase>',
+        :'has_more' => :'Boolean'
       }
     end
 
@@ -74,7 +79,8 @@ module VoucherifySdk
       Set.new([
         :'object',
         :'data_ref',
-        :'async_actions'
+        :'async_actions',
+        :'has_more'
       ])
     end
 
@@ -103,6 +109,10 @@ module VoucherifySdk
           self.async_actions = value
         end
       end
+
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,7 +141,8 @@ module VoucherifySdk
       self.class == o.class &&
           object == o.object &&
           data_ref == o.data_ref &&
-          async_actions == o.async_actions
+          async_actions == o.async_actions &&
+          has_more == o.has_more
     end
 
     # @see the `==` method
@@ -143,7 +154,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [object, data_ref, async_actions].hash
+      [object, data_ref, async_actions, has_more].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/bundle.rb

@@ -0,0 +1,267 @@
+=begin
+#Voucherify API
+
+#Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.
+
+The version of the OpenAPI document: v2018-08-01
+Contact: support@voucherify.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module VoucherifySdk
+  # Determines how the bundle conditions are met by the customer's order items. The items in the order meet the bundle condition in the following way: SKU, then product, then collection.
+  class Bundle
+    # Determines how many bundles are qualified. If there are missing bundle products, the value is `0`. If the bundle is qualified, the value is `1`. The maximum number of identified bundles can equal the number set in `limit`. Also defines the multiplier of the discount for `AMOUNT`, `PERCENT`, and `UNIT` discount types. To inform end-customers that more products can be added to meet additional bundles, compare this parameter with `limit`.
+    attr_accessor :quantity
+
+    # Determines the maximum number of identified bundles. This also defines the maximum multiplier of the bundle discount.
+    attr_accessor :limit
+
+    # Determines products from the customer's order items that meet bundle conditions. SKUs meet the conditions for their product that is used in the bundle. Returns only the products and their quantity that meet the bundle.
+    attr_accessor :identified
+
+    # Determines products, SKUs, or collections from the bundle that are missing in the customer's order items. Determines also the missing quantity. For collections, this means that order items do not include a sufficient number of items that belong to the collection. Not returned when all required bundle items are in the order.
+    attr_accessor :missing
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'quantity' => :'quantity',
+        :'limit' => :'limit',
+        :'identified' => :'identified',
+        :'missing' => :'missing'
+      }
+    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
+      {
+        :'quantity' => :'Integer',
+        :'limit' => :'Integer',
+        :'identified' => :'Array<BundleIdentifiedItem>',
+        :'missing' => :'Array<BundleMissingItem>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'quantity',
+        :'limit',
+        :'identified',
+        :'missing'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'identified')
+        if (value = attributes[:'identified']).is_a?(Array)
+          self.identified = value
+        end
+      end
+
+      if attributes.key?(:'missing')
+        if (value = attributes[:'missing']).is_a?(Array)
+          self.missing = value
+        end
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@quantity.nil? && @quantity > 100
+        invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 100.')
+      end
+
+      if !@quantity.nil? && @quantity < 0
+        invalid_properties.push('invalid value for "quantity", must be greater than or equal to 0.')
+      end
+
+      if !@limit.nil? && @limit > 100
+        invalid_properties.push('invalid value for "limit", must be smaller than or equal to 100.')
+      end
+
+      if !@limit.nil? && @limit < 1
+        invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@quantity.nil? && @quantity > 100
+      return false if !@quantity.nil? && @quantity < 0
+      return false if !@limit.nil? && @limit > 100
+      return false if !@limit.nil? && @limit < 1
+      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 &&
+          quantity == o.quantity &&
+          limit == o.limit &&
+          identified == o.identified &&
+          missing == o.missing
+    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
+      [quantity, limit, identified, missing].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = VoucherifySdk.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