voucherify 8.1.0 → 8.2.0

data/lib/VoucherifySdk/models/program_validity_hours.rb

@@ -0,0 +1,247 @@
+=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
+  # Validity hours configuration of the program.
+  class ProgramValidityHours
+    # Validity hours mode.
+    attr_accessor :type
+
+    # Daily validity windows. Present only when `type` is `DAILY`.
+    attr_accessor :daily
+
+    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
+      {
+        :'type' => :'type',
+        :'daily' => :'daily'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'daily' => :'Array<ProgramValidityDailyHours>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'type',
+        :'daily'
+      ])
+    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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'daily')
+        if (value = attributes[:'daily']).is_a?(Array)
+          self.daily = 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
+      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'
+      type_validator = EnumAttributeValidator.new('String', ["DAILY", "ANY_TIME"])
+      return false unless type_validator.valid?(@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 &&
+          type == o.type &&
+          daily == o.daily
+    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
+      [type, daily].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/promotion_tier_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb

@@ -32,7 +32,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/publications_list_response_body.rb

@@ -22,7 +22,7 @@ module VoucherifySdk
     # Identifies the name of the attribute that contains the array of publications.
     attr_accessor :data_ref
 
-    # Response schema model for publishing vouchers to a specific customer.
+    # Contains array of publication objects, voucher object will be simplified.
     attr_accessor :publications
 
     # Total number of publications.

data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb

@@ -31,7 +31,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb

@@ -38,7 +38,7 @@ module VoucherifySdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'exchange_ratio' => :'Integer',
+        :'exchange_ratio' => :'Float',
         :'points_ratio' => :'Integer'
       }
     end

data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb

@@ -31,7 +31,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb

@@ -31,7 +31,7 @@ module VoucherifySdk
 
     attr_accessor :validity_hours
 
-    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
+    # A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
     attr_accessor :active
 
     # Unique category ID that this campaign belongs to.

data/lib/VoucherifySdk/models/redemptions_redeem_request_body.rb

@@ -18,6 +18,7 @@ module VoucherifySdk
   class RedemptionsRedeemRequestBody
     attr_accessor :options
 
+    # An array of redeemables. You can combine `voucher`(s) and `promotion_tier`(s). Alternatively, send one unique`promotion_stack` in the array. Each unique redeemable can be sent in one request only once.
     attr_accessor :redeemables
 
     attr_accessor :order
@@ -117,6 +118,14 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@redeemables.nil? && @redeemables.length > 30
+        invalid_properties.push('invalid value for "redeemables", number of items must be less than or equal to 30.')
+      end
+
+      if !@redeemables.nil? && @redeemables.length < 1
+        invalid_properties.push('invalid value for "redeemables", number of items must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -124,6 +133,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@redeemables.nil? && @redeemables.length > 30
+      return false if !@redeemables.nil? && @redeemables.length < 1
       true
     end
 

data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb

@@ -14,11 +14,14 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Configure parameters returned in the response.
+  # Configure response expansion and the language of custom validation-rule error messages.
   class RedemptionsRedeemRequestBodyOptions
     # Expand array lets you configure params included in the response. Depending on the strings included in the array, the response will contain different details.   | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br />- Order data with calculated discounts are listed in each child redeemable object.<br />- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br />- Includes `metadata` for each discount type. | | [\"redeemable\", \"redemption\", \"category\"] | - Returns each discount type's `metadata` in each child redemption object.<br />- Returns redemption object `metadata`.<br />- Returns an expanded `categories` object, showing details about the category. |
     attr_accessor :expand
 
+    # Selects the language for the custom validation-rule error message. Returns the message in this language when a validation rule fails. Falls back to the Error Message Library default language when omitted or when the requested language has no message. Omits the custom error when no message can be resolved.
+    attr_accessor :language
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -44,7 +47,8 @@ module VoucherifySdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'expand' => :'expand'
+        :'expand' => :'expand',
+        :'language' => :'language'
       }
     end
 
@@ -56,14 +60,16 @@ module VoucherifySdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'expand' => :'Array<String>'
+        :'expand' => :'Array<String>',
+        :'language' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'expand'
+        :'expand',
+        :'language'
       ])
     end
 
@@ -80,6 +86,10 @@ module VoucherifySdk
           self.expand = value
         end
       end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -87,6 +97,15 @@ module VoucherifySdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@language.nil? && @language.to_s.length > 100
+        invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 100.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]{2,3}(-[a-zA-Z]{2,4})?$/)
+      if !@language.nil? && @language !~ pattern
+        invalid_properties.push("invalid value for \"language\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
@@ -94,6 +113,8 @@ module VoucherifySdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@language.nil? && @language.to_s.length > 100
+      return false if !@language.nil? && @language !~ Regexp.new(/^[a-zA-Z]{2,3}(-[a-zA-Z]{2,4})?$/)
       true
     end
 
@@ -102,7 +123,8 @@ module VoucherifySdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          expand == o.expand
+          expand == o.expand &&
+          language == o.language
     end
 
     # @see the `==` method
@@ -114,7 +136,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [expand].hash
+      [expand, language].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/referrals_members_holders_list_response_body.rb

@@ -25,7 +25,7 @@ module VoucherifySdk
     # A dictionary that contains an array of holders.
     attr_accessor :data
 
-    # Total number of holders assigned to the redeemable.
+    # Total number of results returned on this page.
     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 `starting_after_id` query or a different limit to get more records returned in the results.