voucherify 7.0.0 → 8.0.1

data/lib/VoucherifySdk/models/vouchers_create_request_body.rb

@@ -0,0 +1,431 @@
+=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
+  class VouchersCreateRequestBody
+    # Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the `code_config` object to set the rules that the Voucherify API will use to create a random code, or don't pass any code and Voucherify will generate a random code.
+    attr_accessor :code
+
+    # Identifies the voucher's parent campaign using a unique campaign name.
+    attr_accessor :campaign
+
+    # Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API.
+    attr_accessor :campaign_id
+
+    # The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.
+    attr_accessor :category
+
+    # Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.
+    attr_accessor :category_id
+
+    # Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is *inactive before* this date.
+    attr_accessor :start_date
+
+    # Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format.  Voucher is *inactive after* this date.
+    attr_accessor :expiration_date
+
+    attr_accessor :validity_timeframe
+
+    # Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday
+    attr_accessor :validity_day_of_week
+
+    attr_accessor :validity_hours
+
+    # A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher
+    attr_accessor :active
+
+    # An optional field to keep any extra textual information about the code such as a code description and details.
+    attr_accessor :additional_info
+
+    # The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
+    attr_accessor :metadata
+
+    # Array containing the ID of the validation rule associated with the voucher.
+    attr_accessor :validation_rules
+
+    attr_accessor :redemption
+
+    attr_accessor :type
+
+    attr_accessor :loyalty_card
+
+    attr_accessor :code_config
+
+    attr_accessor :gift
+
+    attr_accessor :discount
+
+    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
+      {
+        :'code' => :'code',
+        :'campaign' => :'campaign',
+        :'campaign_id' => :'campaign_id',
+        :'category' => :'category',
+        :'category_id' => :'category_id',
+        :'start_date' => :'start_date',
+        :'expiration_date' => :'expiration_date',
+        :'validity_timeframe' => :'validity_timeframe',
+        :'validity_day_of_week' => :'validity_day_of_week',
+        :'validity_hours' => :'validity_hours',
+        :'active' => :'active',
+        :'additional_info' => :'additional_info',
+        :'metadata' => :'metadata',
+        :'validation_rules' => :'validation_rules',
+        :'redemption' => :'redemption',
+        :'type' => :'type',
+        :'loyalty_card' => :'loyalty_card',
+        :'code_config' => :'code_config',
+        :'gift' => :'gift',
+        :'discount' => :'discount'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'campaign' => :'String',
+        :'campaign_id' => :'String',
+        :'category' => :'String',
+        :'category_id' => :'String',
+        :'start_date' => :'Time',
+        :'expiration_date' => :'Time',
+        :'validity_timeframe' => :'ValidityTimeframe',
+        :'validity_day_of_week' => :'Array<Integer>',
+        :'validity_hours' => :'ValidityHours',
+        :'active' => :'Boolean',
+        :'additional_info' => :'String',
+        :'metadata' => :'Object',
+        :'validation_rules' => :'Array<String>',
+        :'redemption' => :'VouchersCreateRequestBodyRedemption',
+        :'type' => :'String',
+        :'loyalty_card' => :'SimpleLoyaltyCard',
+        :'code_config' => :'CodeConfig',
+        :'gift' => :'Gift',
+        :'discount' => :'Discount'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'code',
+        :'campaign',
+        :'campaign_id',
+        :'category',
+        :'category_id',
+        :'start_date',
+        :'expiration_date',
+        :'active',
+        :'additional_info',
+        :'metadata',
+        :'validation_rules',
+        :'redemption',
+        :'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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'campaign')
+        self.campaign = attributes[:'campaign']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'category_id')
+        self.category_id = attributes[:'category_id']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'validity_timeframe')
+        self.validity_timeframe = attributes[:'validity_timeframe']
+      end
+
+      if attributes.key?(:'validity_day_of_week')
+        if (value = attributes[:'validity_day_of_week']).is_a?(Array)
+          self.validity_day_of_week = value
+        end
+      end
+
+      if attributes.key?(:'validity_hours')
+        self.validity_hours = attributes[:'validity_hours']
+      end
+
+      if attributes.key?(:'active')
+        self.active = attributes[:'active']
+      end
+
+      if attributes.key?(:'additional_info')
+        self.additional_info = attributes[:'additional_info']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'validation_rules')
+        if (value = attributes[:'validation_rules']).is_a?(Array)
+          self.validation_rules = value
+        end
+      end
+
+      if attributes.key?(:'redemption')
+        self.redemption = attributes[:'redemption']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'loyalty_card')
+        self.loyalty_card = attributes[:'loyalty_card']
+      end
+
+      if attributes.key?(:'code_config')
+        self.code_config = attributes[:'code_config']
+      end
+
+      if attributes.key?(:'gift')
+        self.gift = attributes[:'gift']
+      end
+
+      if attributes.key?(:'discount')
+        self.discount = attributes[:'discount']
+      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', ["LOYALTY_CARD", "GIFT_VOUCHER", "DISCOUNT_VOUCHER"])
+      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 &&
+          code == o.code &&
+          campaign == o.campaign &&
+          campaign_id == o.campaign_id &&
+          category == o.category &&
+          category_id == o.category_id &&
+          start_date == o.start_date &&
+          expiration_date == o.expiration_date &&
+          validity_timeframe == o.validity_timeframe &&
+          validity_day_of_week == o.validity_day_of_week &&
+          validity_hours == o.validity_hours &&
+          active == o.active &&
+          additional_info == o.additional_info &&
+          metadata == o.metadata &&
+          validation_rules == o.validation_rules &&
+          redemption == o.redemption &&
+          type == o.type &&
+          loyalty_card == o.loyalty_card &&
+          code_config == o.code_config &&
+          gift == o.gift &&
+          discount == o.discount
+    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
+      [code, campaign, campaign_id, category, category_id, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, active, additional_info, metadata, validation_rules, redemption, type, loyalty_card, code_config, gift, discount].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/{exports_get_response_body_parameters_filters.rb → vouchers_create_request_body_redemption.rb}

@@ -14,44 +14,14 @@ require 'date'
 require 'time'
 
 module VoucherifySdk
-  class ExportsGetResponseBodyParametersFilters
-    attr_accessor :junction
-
-    attr_accessor :campaign_id
-
-    attr_accessor :voucher_id
-
-    attr_accessor :created_at
-
-    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
+  class VouchersCreateRequestBodyRedemption
+    # How many times a voucher can be redeemed. A `null` value means unlimited.
+    attr_accessor :quantity
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'junction' => :'junction',
-        :'campaign_id' => :'campaign_id',
-        :'voucher_id' => :'voucher_id',
-        :'created_at' => :'created_at'
+        :'quantity' => :'quantity'
       }
     end
 
@@ -63,16 +33,14 @@ module VoucherifySdk
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'junction' => :'Junction',
-        :'campaign_id' => :'FieldConditions',
-        :'voucher_id' => :'FieldConditions',
-        :'created_at' => :'FieldConditions'
+        :'quantity' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'quantity'
       ])
     end
 
@@ -84,20 +52,8 @@ module VoucherifySdk
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'junction')
-        self.junction = attributes[:'junction']
-      end
-
-      if attributes.key?(:'campaign_id')
-        self.campaign_id = attributes[:'campaign_id']
-      end
-
-      if attributes.key?(:'voucher_id')
-        self.voucher_id = attributes[:'voucher_id']
-      end
-
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
       end
     end
 
@@ -121,10 +77,7 @@ module VoucherifySdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          junction == o.junction &&
-          campaign_id == o.campaign_id &&
-          voucher_id == o.voucher_id &&
-          created_at == o.created_at
+          quantity == o.quantity
     end
 
     # @see the `==` method
@@ -136,7 +89,7 @@ module VoucherifySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [junction, campaign_id, voucher_id, created_at].hash
+      [quantity].hash
     end
 
     # Builds the object from hash

data/lib/VoucherifySdk/models/vouchers_create_with_specific_code_request_body.rb

@@ -46,6 +46,7 @@ module VoucherifySdk
     # An optional field to keep any extra textual information about the code such as a code description and details.
     attr_accessor :additional_info
 
+    # The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
     attr_accessor :metadata
 
     # Array containing the ID of the validation rule associated with the voucher.

data/lib/VoucherifySdk/models/vouchers_import_create_item_request_body.rb

@@ -23,6 +23,7 @@ module VoucherifySdk
     # A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher
     attr_accessor :active
 
+    # The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
     attr_accessor :metadata
 
     # Tag defining the category that this voucher belongs to. Useful when listing vouchers using the [List Vouchers](ref:list-vouchers) endpoint.

data/lib/VoucherifySdk/models/vouchers_update_request_body.rb

@@ -40,6 +40,7 @@ module VoucherifySdk
     # An optional field to keep any extra textual information about the code such as a code description and details.
     attr_accessor :additional_info
 
+    # The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
     attr_accessor :metadata
 
     attr_accessor :type

data/lib/VoucherifySdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.0.1
 =end
 
 module VoucherifySdk
-  VERSION = '7.0.0'
+  VERSION = '8.0.1'
 end

data/lib/VoucherifySdk.rb

@@ -145,6 +145,7 @@ require 'VoucherifySdk/models/customers_update_response_body'
 require 'VoucherifySdk/models/customers_update_response_body_address'
 require 'VoucherifySdk/models/customers_update_response_body_assets'
 require 'VoucherifySdk/models/discount'
+require 'VoucherifySdk/models/discount_product'
 require 'VoucherifySdk/models/discount_unit_multiple_one_unit'
 require 'VoucherifySdk/models/earning_rule'
 require 'VoucherifySdk/models/earning_rule_custom_event'
@@ -173,20 +174,16 @@ require 'VoucherifySdk/models/export'
 require 'VoucherifySdk/models/export_order_fields'
 require 'VoucherifySdk/models/export_order_order'
 require 'VoucherifySdk/models/export_parameters'
-require 'VoucherifySdk/models/export_parameters_filters'
 require 'VoucherifySdk/models/export_result'
 require 'VoucherifySdk/models/export_voucher_transactions_fields'
 require 'VoucherifySdk/models/export_voucher_transactions_filters'
 require 'VoucherifySdk/models/export_voucher_transactions_order'
 require 'VoucherifySdk/models/exports_create_request_body'
 require 'VoucherifySdk/models/exports_create_request_body_parameters'
-require 'VoucherifySdk/models/exports_create_request_body_parameters_filters'
 require 'VoucherifySdk/models/exports_create_response_body'
 require 'VoucherifySdk/models/exports_create_response_body_parameters'
-require 'VoucherifySdk/models/exports_create_response_body_parameters_filters'
 require 'VoucherifySdk/models/exports_get_response_body'
 require 'VoucherifySdk/models/exports_get_response_body_parameters'
-require 'VoucherifySdk/models/exports_get_response_body_parameters_filters'
 require 'VoucherifySdk/models/exports_get_response_body_result'
 require 'VoucherifySdk/models/exports_list_response_body'
 require 'VoucherifySdk/models/field_conditions'
@@ -1103,6 +1100,8 @@ require 'VoucherifySdk/models/voucher_with_categories_redemption'
 require 'VoucherifySdk/models/vouchers_balance_update_request_body'
 require 'VoucherifySdk/models/vouchers_balance_update_response_body'
 require 'VoucherifySdk/models/vouchers_balance_update_response_body_related_object'
+require 'VoucherifySdk/models/vouchers_create_request_body'
+require 'VoucherifySdk/models/vouchers_create_request_body_redemption'
 require 'VoucherifySdk/models/vouchers_create_response_body'
 require 'VoucherifySdk/models/vouchers_create_response_body_gift'
 require 'VoucherifySdk/models/vouchers_create_response_body_loyalty_card'