voucherify 8.0.2 → 8.0.3

data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb

@@ -0,0 +1,286 @@
+=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
+  # Response body schema for **GET** `/loyalties/{campaignId}/pending-points`.
+  class LoyaltiesPendingPointsListResponseBody
+    # The type of the object represented by JSON.
+    attr_accessor :object
+
+    # Identifies the name of the attribute that contains the array of pending point objects.
+    attr_accessor :data_ref
+
+    # A dictionary that contains an array of pending point entries. Each entry in the array is a separate pending point object.
+    attr_accessor :data
+
+    # 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
+
+    # Returns an ID that can be used to return another page of results. Use the pending point entry ID in the `starting_after_id` query parameter to display another page of the results starting after the entry with that ID.
+    attr_accessor :more_starting_after
+
+    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
+      {
+        :'object' => :'object',
+        :'data_ref' => :'data_ref',
+        :'data' => :'data',
+        :'has_more' => :'has_more',
+        :'more_starting_after' => :'more_starting_after'
+      }
+    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
+      {
+        :'object' => :'String',
+        :'data_ref' => :'String',
+        :'data' => :'Array<LoyaltyPendingPoints>',
+        :'has_more' => :'Boolean',
+        :'more_starting_after' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'object',
+        :'data_ref',
+        :'data',
+        :'has_more',
+        :'more_starting_after'
+      ])
+    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?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = 'list'
+      end
+
+      if attributes.key?(:'data_ref')
+        self.data_ref = attributes[:'data_ref']
+      else
+        self.data_ref = 'data'
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
+      end
+
+      if attributes.key?(:'more_starting_after')
+        self.more_starting_after = attributes[:'more_starting_after']
+      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'
+      object_validator = EnumAttributeValidator.new('String', ["list"])
+      return false unless object_validator.valid?(@object)
+      data_ref_validator = EnumAttributeValidator.new('String', ["data"])
+      return false unless data_ref_validator.valid?(@data_ref)
+      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 &&
+          object == o.object &&
+          data_ref == o.data_ref &&
+          data == o.data &&
+          has_more == o.has_more &&
+          more_starting_after == o.more_starting_after
+    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
+      [object, data_ref, data, has_more, more_starting_after].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/loyalties_update_campaign_request_body.rb

@@ -44,6 +44,8 @@ module VoucherifySdk
     # Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`.
     attr_accessor :category_id
 
+    attr_accessor :access_settings
+
     # Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.
     attr_accessor :activity_duration_after_publishing
 
@@ -95,6 +97,7 @@ module VoucherifySdk
         :'metadata' => :'metadata',
         :'unset_metadata_fields' => :'unset_metadata_fields',
         :'category_id' => :'category_id',
+        :'access_settings' => :'access_settings',
         :'activity_duration_after_publishing' => :'activity_duration_after_publishing',
         :'join_once' => :'join_once',
         :'auto_join' => :'auto_join',
@@ -122,6 +125,7 @@ module VoucherifySdk
         :'metadata' => :'Object',
         :'unset_metadata_fields' => :'Array<String>',
         :'category_id' => :'String',
+        :'access_settings' => :'AccessSettings',
         :'activity_duration_after_publishing' => :'String',
         :'join_once' => :'Boolean',
         :'auto_join' => :'Boolean',
@@ -201,6 +205,10 @@ module VoucherifySdk
         self.category_id = attributes[:'category_id']
       end
 
+      if attributes.key?(:'access_settings')
+        self.access_settings = attributes[:'access_settings']
+      end
+
       if attributes.key?(:'activity_duration_after_publishing')
         self.activity_duration_after_publishing = attributes[:'activity_duration_after_publishing']
       end
@@ -258,6 +266,7 @@ module VoucherifySdk
           metadata == o.metadata &&
           unset_metadata_fields == o.unset_metadata_fields &&
           category_id == o.category_id &&
+          access_settings == o.access_settings &&
           activity_duration_after_publishing == o.activity_duration_after_publishing &&
           join_once == o.join_once &&
           auto_join == o.auto_join &&
@@ -275,7 +284,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, description, category, metadata, unset_metadata_fields, category_id, activity_duration_after_publishing, join_once, auto_join, type, loyalty_tiers_expiration, options].hash
+      [start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, description, category, metadata, unset_metadata_fields, category_id, access_settings, activity_duration_after_publishing, join_once, auto_join, type, loyalty_tiers_expiration, options].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb

@@ -36,6 +36,10 @@ module VoucherifySdk
 
     attr_accessor :event_schema
 
+    attr_accessor :holder_loyalty_tier
+
+    attr_accessor :pending_points
+
     attr_accessor :reward
 
     attr_accessor :source_voucher
@@ -55,6 +59,8 @@ module VoucherifySdk
         :'rollback' => :'rollback',
         :'custom_event' => :'custom_event',
         :'event_schema' => :'event_schema',
+        :'holder_loyalty_tier' => :'holder_loyalty_tier',
+        :'pending_points' => :'pending_points',
         :'reward' => :'reward',
         :'source_voucher' => :'source_voucher',
         :'destination_voucher' => :'destination_voucher'
@@ -79,6 +85,8 @@ module VoucherifySdk
         :'rollback' => :'LoyaltyCardTransactionDetailsRollback',
         :'custom_event' => :'LoyaltyCardTransactionDetailsCustomEvent',
         :'event_schema' => :'LoyaltyCardTransactionDetailsEventSchema',
+        :'holder_loyalty_tier' => :'LoyaltyCardTransactionDetailsHolderLoyaltyTier',
+        :'pending_points' => :'LoyaltyPendingPoints',
         :'reward' => :'LoyaltyCardTransactionDetailsReward',
         :'source_voucher' => :'SimpleVoucher',
         :'destination_voucher' => :'SimpleVoucher'
@@ -97,6 +105,7 @@ module VoucherifySdk
         :'rollback',
         :'custom_event',
         :'event_schema',
+        :'holder_loyalty_tier',
         :'reward',
       ])
     end
@@ -149,6 +158,14 @@ module VoucherifySdk
         self.event_schema = attributes[:'event_schema']
       end
 
+      if attributes.key?(:'holder_loyalty_tier')
+        self.holder_loyalty_tier = attributes[:'holder_loyalty_tier']
+      end
+
+      if attributes.key?(:'pending_points')
+        self.pending_points = attributes[:'pending_points']
+      end
+
       if attributes.key?(:'reward')
         self.reward = attributes[:'reward']
       end
@@ -192,6 +209,8 @@ module VoucherifySdk
           rollback == o.rollback &&
           custom_event == o.custom_event &&
           event_schema == o.event_schema &&
+          holder_loyalty_tier == o.holder_loyalty_tier &&
+          pending_points == o.pending_points &&
           reward == o.reward &&
           source_voucher == o.source_voucher &&
           destination_voucher == o.destination_voucher
@@ -206,7 +225,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [balance, order, event, earning_rule, segment, loyalty_tier, redemption, rollback, custom_event, event_schema, reward, source_voucher, destination_voucher].hash
+      [balance, order, event, earning_rule, segment, loyalty_tier, redemption, rollback, custom_event, event_schema, holder_loyalty_tier, pending_points, reward, source_voucher, destination_voucher].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb

@@ -16,7 +16,7 @@ require 'time'
 module VoucherifySdk
   # Contains information about the earning rule.
   class LoyaltyCardTransactionDetailsEarningRule
-    # Unique earning rule ID.
+    # Unique identifier of an earning rule, assigned by Voucherify.
     attr_accessor :id
 
     attr_accessor :source

data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb

@@ -0,0 +1,221 @@
+=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
+  # Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed.
+  class LoyaltyCardTransactionDetailsHolderLoyaltyTier
+    # Unique identifier of the loyalty tier, assigned by Voucherify.
+    attr_accessor :id
+
+    # User-defined name of the loyalty tier.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    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'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+        :'name'
+      ])
+    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
+    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'
+      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
+    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].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/loyalty_card_transaction_details_loyalty_tier.rb

@@ -14,10 +14,12 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  # Contains information about the loyalty tier.
+  # Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction.
   class LoyaltyCardTransactionDetailsLoyaltyTier
+    # Unique identifier of the loyalty tier, assigned by Voucherify.
     attr_accessor :id
 
+    # User-defined name of the loyalty tier.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb

@@ -15,6 +15,7 @@ require 'time'
 
 module VoucherifySdk
   class LoyaltyCardTransactionsType
+    PENDING_ACTIVATION = "POINTS_PENDING_ACTIVATION".freeze
     ACCRUAL = "POINTS_ACCRUAL".freeze
     REDEMPTION = "POINTS_REDEMPTION".freeze
     REFUND = "POINTS_REFUND".freeze
@@ -25,7 +26,7 @@ module VoucherifySdk
     TRANSFER_OUT = "POINTS_TRANSFER_OUT".freeze
 
     def self.all_vars
-      @all_vars ||= [ACCRUAL, REDEMPTION, REFUND, ADDITION, REMOVAL, EXPIRATION, TRANSFER_IN, TRANSFER_OUT].freeze
+      @all_vars ||= [PENDING_ACTIVATION, ACCRUAL, REDEMPTION, REFUND, ADDITION, REMOVAL, EXPIRATION, TRANSFER_IN, TRANSFER_OUT].freeze
     end
 
     # Builds the enum from string