voucherify 6.0.0 → 7.0.0

data/lib/VoucherifySdk/models/category_with_stacking_rules_type.rb

@@ -0,0 +1,309 @@
+=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
+  # Category object with `stacking_rules_type`
+  class CategoryWithStackingRulesType
+    # Unique category ID assigned by Voucherify.
+    attr_accessor :id
+
+    # Category name.
+    attr_accessor :name
+
+    # Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
+    attr_accessor :hierarchy
+
+    # The type of the object represented by the JSON. This object stores information about the category.
+    attr_accessor :object
+
+    # Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.
+    attr_accessor :created_at
+
+    # Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.
+    attr_accessor :updated_at
+
+    # The type of the stacking rule eligibility.
+    attr_accessor :stacking_rules_type
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'hierarchy' => :'hierarchy',
+        :'object' => :'object',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'stacking_rules_type' => :'stacking_rules_type'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'hierarchy' => :'Integer',
+        :'object' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'stacking_rules_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'name',
+        :'hierarchy',
+        :'object',
+        :'created_at',
+        :'updated_at',
+        :'stacking_rules_type'
+      ])
+    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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'hierarchy')
+        self.hierarchy = attributes[:'hierarchy']
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = 'category'
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'stacking_rules_type')
+        self.stacking_rules_type = attributes[:'stacking_rules_type']
+      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 !@hierarchy.nil? && @hierarchy < 0
+        invalid_properties.push('invalid value for "hierarchy", must be greater 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 !@hierarchy.nil? && @hierarchy < 0
+      object_validator = EnumAttributeValidator.new('String', ["category"])
+      return false unless object_validator.valid?(@object)
+      stacking_rules_type_validator = EnumAttributeValidator.new('String', ["JOINT", "EXCLUSIVE"])
+      return false unless stacking_rules_type_validator.valid?(@stacking_rules_type)
+      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 &&
+          id == o.id &&
+          name == o.name &&
+          hierarchy == o.hierarchy &&
+          object == o.object &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          stacking_rules_type == o.stacking_rules_type
+    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
+      [id, name, hierarchy, object, created_at, updated_at, stacking_rules_type].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/client_promotions_tiers_list_response_body.rb

@@ -28,7 +28,7 @@ module VoucherifySdk
     # Total number of promotion tiers.
     attr_accessor :total
 
-    # As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different page or a different start date filter) to get more records returned in the results.
+    # As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.
     attr_accessor :has_more
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Response body schema for POST `/validations`.
+  # Response body schema for **POST** `/validations`.
   class ClientValidationsValidateResponseBody
     # The result of the validation. It takes all of the redeemables into account and returns a `false` if at least one redeemable is inapplicable. Returns `true` if all redeemables are applicable.
     attr_accessor :valid

data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item.rb

@@ -88,7 +88,7 @@ module VoucherifySdk
         :'inapplicable_to' => :'InapplicableToResultList',
         :'result' => :'ClientValidationsValidateResponseBodyRedeemablesItemResult',
         :'metadata' => :'Object',
-        :'categories' => :'Array<Category>'
+        :'categories' => :'Array<CategoryWithStackingRulesType>'
       }
     end
 

data/lib/VoucherifySdk/models/customer_redeemable.rb

@@ -189,9 +189,9 @@ module VoucherifySdk
       warn '[DEPRECATED] the `valid?` method is obsolete'
       holder_role_validator = EnumAttributeValidator.new('String', ["OWNER", "REFERRER", "REFEREE"])
       return false unless holder_role_validator.valid?(@holder_role)
-      campaign_type_validator = EnumAttributeValidator.new('String', ["LOYALTY_PROGRAM", "GIFT_VOUCHERS", "DISCOUNT_COUPONS", "PROMOTION", "REFERRAL_PROGRAM", "LUCKY_DRAW"])
+      campaign_type_validator = EnumAttributeValidator.new('String', ["LOYALTY_PROGRAM", "GIFT_VOUCHERS", "DISCOUNT_COUPONS", "PROMOTION", "REFERRAL_PROGRAM"])
       return false unless campaign_type_validator.valid?(@campaign_type)
-      voucher_type_validator = EnumAttributeValidator.new('String', ["GIFT_VOUCHER", "DISCOUNT_VOUCHER", "LOYALTY_CARD", "LUCKY_DRAW_CODE"])
+      voucher_type_validator = EnumAttributeValidator.new('String', ["GIFT_VOUCHER", "DISCOUNT_VOUCHER", "LOYALTY_CARD"])
       return false unless voucher_type_validator.valid?(@voucher_type)
       true
     end

data/lib/VoucherifySdk/models/customers_activity_list_response_body.rb

@@ -28,7 +28,7 @@ module VoucherifySdk
     # As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results.
     attr_accessor :has_more
 
-    # Returns an ID that can be used to return another page of results. Use the event id in the `starting_after_id` query parameter to display another page of the results starting after the event with that ID.
+    # Returns an ID that can be used to return another page of results. Use the event ID in the `starting_after_id` query parameter to display another page of the results starting after the event with that ID.
     attr_accessor :more_starting_after
 
     class EnumAttributeValidator

data/lib/VoucherifySdk/models/error.rb

@@ -22,7 +22,7 @@ module VoucherifySdk
     # Short string describing the kind of error which occurred.
     attr_accessor :key
 
-    # A human-readable message providing a short description about the error.
+    # A human-readable message providing a short description of the error.
     attr_accessor :message
 
     # A human-readable message providing more details about the error.

data/lib/VoucherifySdk/models/{parameter_filters_list_customer_redeemables_created_at_conditions.rb → filter_conditions_date_time.rb}

@@ -15,7 +15,7 @@ require 'time'
 
 module VoucherifySdk
   # Data filters used to narrow down the data records to be returned in the result.
-  class ParameterFiltersListCustomerRedeemablesCreatedAtConditions
+  class FilterConditionsDateTime
     # Value is after this date. The value for this parameter is shown in the ISO 8601 format.
     attr_accessor :after
 

data/lib/VoucherifySdk/models/inapplicable_to.rb

@@ -15,13 +15,13 @@ require 'time'
 
 module VoucherifySdk
   class InapplicableTo
-    # This object stores information about the product collection.
+    # This object stores information about the resource to which the discount is applicable.
     attr_accessor :object
 
-    # Unique product collection ID assigned by Voucherify.
+    # Unique product collection, product, or SKU identifier assigned by Voucherify.
     attr_accessor :id
 
-    # The source ID from your inventory system.
+    # The source identifier from your inventory system.
     attr_accessor :source_id
 
     # Parent product's unique ID assigned by Voucherify.
@@ -52,12 +52,16 @@ module VoucherifySdk
     # Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)
     attr_accessor :aggregated_amount_limit
 
+    # Determines the order in which the discount is applied to the products or SKUs sent in the `order` object in the request. The counting begins from `0`.
     attr_accessor :order_item_indices
 
+    # Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item.
     attr_accessor :repeat
 
+    # Determines how many items are skipped before the discount is applied.
     attr_accessor :skip_initially
 
+    # Determines to which kinds of objects the discount is applicable. `\"ITEM\"` includes products and SKUs.
     attr_accessor :target
 
     class EnumAttributeValidator

data/lib/VoucherifySdk/models/{product_collections_create_response_body_filter.rb → location.rb}

@@ -14,32 +14,23 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type.
-  class ProductCollectionsCreateResponseBodyFilter
-    attr_accessor :junction
-
+  # This is an object representing a location.
+  class Location
+    # Unique location ID, assigned by the Voucherify API.
     attr_accessor :id
 
-    attr_accessor :product_id
-
-    attr_accessor :source_id
-
-    attr_accessor :name
-
-    attr_accessor :price
-
+    # The type of the object represented by JSON. This object stores information about a `location`.
     attr_accessor :object
 
-    attr_accessor :attributes
-
-    attr_accessor :metadata
-
-    attr_accessor :image_url
+    # Location name.
+    attr_accessor :name
 
-    attr_accessor :skus
+    attr_accessor :shape
 
+    # Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.
     attr_accessor :created_at
 
+    # Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.
     attr_accessor :updated_at
 
     class EnumAttributeValidator
@@ -67,17 +58,10 @@ module VoucherifySdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'junction' => :'junction',
         :'id' => :'id',
-        :'product_id' => :'product_id',
-        :'source_id' => :'source_id',
-        :'name' => :'name',
-        :'price' => :'price',
         :'object' => :'object',
-        :'attributes' => :'attributes',
-        :'metadata' => :'metadata',
-        :'image_url' => :'image_url',
-        :'skus' => :'skus',
+        :'name' => :'name',
+        :'shape' => :'shape',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -91,25 +75,24 @@ module VoucherifySdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'junction' => :'Junction',
-        :'id' => :'FieldConditions',
-        :'product_id' => :'FieldConditions',
-        :'source_id' => :'FieldConditions',
-        :'name' => :'FieldConditions',
-        :'price' => :'FieldConditions',
-        :'object' => :'FieldConditions',
-        :'attributes' => :'FieldConditions',
-        :'metadata' => :'FieldConditions',
-        :'image_url' => :'FieldConditions',
-        :'skus' => :'FieldConditions',
-        :'created_at' => :'FieldConditions',
-        :'updated_at' => :'FieldConditions'
+        :'id' => :'String',
+        :'object' => :'String',
+        :'name' => :'String',
+        :'shape' => :'LocationShape',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
+        :'object',
+        :'name',
+        :'shape',
+        :'created_at',
+        :'updated_at'
       ])
     end
 
@@ -121,50 +104,22 @@ module VoucherifySdk
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'junction')
-        self.junction = attributes[:'junction']
-      else
-        self.junction = nil
-      end
-
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'product_id')
-        self.product_id = attributes[:'product_id']
-      end
-
-      if attributes.key?(:'source_id')
-        self.source_id = attributes[:'source_id']
-      end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.key?(:'price')
-        self.price = attributes[:'price']
-      end
-
       if attributes.key?(:'object')
         self.object = attributes[:'object']
+      else
+        self.object = 'location'
       end
 
-      if attributes.key?(:'attributes')
-        self.attributes = attributes[:'attributes']
-      end
-
-      if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
-      end
-
-      if attributes.key?(:'image_url')
-        self.image_url = attributes[:'image_url']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'skus')
-        self.skus = attributes[:'skus']
+      if attributes.key?(:'shape')
+        self.shape = attributes[:'shape']
       end
 
       if attributes.key?(:'created_at')
@@ -181,10 +136,6 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @junction.nil?
-        invalid_properties.push('invalid value for "junction", junction cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -192,7 +143,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @junction.nil?
+      object_validator = EnumAttributeValidator.new('String', ["location"])
+      return false unless object_validator.valid?(@object)
       true
     end
 
@@ -201,17 +153,10 @@ module VoucherifySdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          junction == o.junction &&
           id == o.id &&
-          product_id == o.product_id &&
-          source_id == o.source_id &&
-          name == o.name &&
-          price == o.price &&
           object == o.object &&
-          attributes == o.attributes &&
-          metadata == o.metadata &&
-          image_url == o.image_url &&
-          skus == o.skus &&
+          name == o.name &&
+          shape == o.shape &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -225,7 +170,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [junction, id, product_id, source_id, name, price, object, attributes, metadata, image_url, skus, created_at, updated_at].hash
+      [id, object, name, shape, created_at, updated_at].hash
     end
 
     # Builds the object from hash