talon_one 1.4.0

data/lib/talon_one/models/campaign_analytics.rb

@@ -0,0 +1,489 @@
+=begin
+#Talon.One API
+
+#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class CampaignAnalytics
+    attr_accessor :date
+
+    # Amount of revenue in this campaign (for coupon or discount sessions).
+    attr_accessor :campaign_revenue
+
+    # Amount of revenue in this campaign since it began (for coupon or discount sessions).
+    attr_accessor :total_campaign_revenue
+
+    # Amount of refunds in this campaign (for coupon or discount sessions).
+    attr_accessor :campaign_refund
+
+    # Amount of refunds in this campaign since it began (for coupon or discount sessions).
+    attr_accessor :total_campaign_refund
+
+    # Amount of cost caused by discounts given in the campaign.
+    attr_accessor :campaign_discount_costs
+
+    # Amount of cost caused by discounts given in the campaign since it began.
+    attr_accessor :total_campaign_discount_costs
+
+    # Amount of discounts rolledback due to refund in the campaign.
+    attr_accessor :campaign_refunded_discounts
+
+    # Amount of discounts rolledback due to refund in the campaign since it began.
+    attr_accessor :total_campaign_refunded_discounts
+
+    # Amount of free items given in the campaign.
+    attr_accessor :campaign_free_items
+
+    # Amount of free items given in the campaign since it began.
+    attr_accessor :total_campaign_free_items
+
+    # Number of coupon redemptions in the campaign.
+    attr_accessor :coupon_redemptions
+
+    # Number of coupon redemptions in the campaign since it began.
+    attr_accessor :total_coupon_redemptions
+
+    # Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign.
+    attr_accessor :coupon_rolledback_redemptions
+
+    # Number of coupon redemptions that have been rolled back (due to canceling closed session) in the campaign since it began.
+    attr_accessor :total_coupon_rolledback_redemptions
+
+    # Number of referral redemptions in the campaign.
+    attr_accessor :referral_redemptions
+
+    # Number of referral redemptions in the campaign since it began.
+    attr_accessor :total_referral_redemptions
+
+    # Number of coupons created in the campaign by the rule engine.
+    attr_accessor :coupons_created
+
+    # Number of coupons created in the campaign by the rule engine since it began.
+    attr_accessor :total_coupons_created
+
+    # Number of referrals created in the campaign by the rule engine.
+    attr_accessor :referrals_created
+
+    # Number of referrals created in the campaign by the rule engine since it began.
+    attr_accessor :total_referrals_created
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'date' => :'date',
+        :'campaign_revenue' => :'campaignRevenue',
+        :'total_campaign_revenue' => :'totalCampaignRevenue',
+        :'campaign_refund' => :'campaignRefund',
+        :'total_campaign_refund' => :'totalCampaignRefund',
+        :'campaign_discount_costs' => :'campaignDiscountCosts',
+        :'total_campaign_discount_costs' => :'totalCampaignDiscountCosts',
+        :'campaign_refunded_discounts' => :'campaignRefundedDiscounts',
+        :'total_campaign_refunded_discounts' => :'totalCampaignRefundedDiscounts',
+        :'campaign_free_items' => :'campaignFreeItems',
+        :'total_campaign_free_items' => :'totalCampaignFreeItems',
+        :'coupon_redemptions' => :'couponRedemptions',
+        :'total_coupon_redemptions' => :'totalCouponRedemptions',
+        :'coupon_rolledback_redemptions' => :'couponRolledbackRedemptions',
+        :'total_coupon_rolledback_redemptions' => :'totalCouponRolledbackRedemptions',
+        :'referral_redemptions' => :'referralRedemptions',
+        :'total_referral_redemptions' => :'totalReferralRedemptions',
+        :'coupons_created' => :'couponsCreated',
+        :'total_coupons_created' => :'totalCouponsCreated',
+        :'referrals_created' => :'referralsCreated',
+        :'total_referrals_created' => :'totalReferralsCreated'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'date' => :'DateTime',
+        :'campaign_revenue' => :'Float',
+        :'total_campaign_revenue' => :'Float',
+        :'campaign_refund' => :'Float',
+        :'total_campaign_refund' => :'Float',
+        :'campaign_discount_costs' => :'Float',
+        :'total_campaign_discount_costs' => :'Float',
+        :'campaign_refunded_discounts' => :'Float',
+        :'total_campaign_refunded_discounts' => :'Float',
+        :'campaign_free_items' => :'Integer',
+        :'total_campaign_free_items' => :'Integer',
+        :'coupon_redemptions' => :'Integer',
+        :'total_coupon_redemptions' => :'Integer',
+        :'coupon_rolledback_redemptions' => :'Integer',
+        :'total_coupon_rolledback_redemptions' => :'Integer',
+        :'referral_redemptions' => :'Integer',
+        :'total_referral_redemptions' => :'Integer',
+        :'coupons_created' => :'Integer',
+        :'total_coupons_created' => :'Integer',
+        :'referrals_created' => :'Integer',
+        :'total_referrals_created' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.has_key?(:'campaignRevenue')
+        self.campaign_revenue = attributes[:'campaignRevenue']
+      end
+
+      if attributes.has_key?(:'totalCampaignRevenue')
+        self.total_campaign_revenue = attributes[:'totalCampaignRevenue']
+      end
+
+      if attributes.has_key?(:'campaignRefund')
+        self.campaign_refund = attributes[:'campaignRefund']
+      end
+
+      if attributes.has_key?(:'totalCampaignRefund')
+        self.total_campaign_refund = attributes[:'totalCampaignRefund']
+      end
+
+      if attributes.has_key?(:'campaignDiscountCosts')
+        self.campaign_discount_costs = attributes[:'campaignDiscountCosts']
+      end
+
+      if attributes.has_key?(:'totalCampaignDiscountCosts')
+        self.total_campaign_discount_costs = attributes[:'totalCampaignDiscountCosts']
+      end
+
+      if attributes.has_key?(:'campaignRefundedDiscounts')
+        self.campaign_refunded_discounts = attributes[:'campaignRefundedDiscounts']
+      end
+
+      if attributes.has_key?(:'totalCampaignRefundedDiscounts')
+        self.total_campaign_refunded_discounts = attributes[:'totalCampaignRefundedDiscounts']
+      end
+
+      if attributes.has_key?(:'campaignFreeItems')
+        self.campaign_free_items = attributes[:'campaignFreeItems']
+      end
+
+      if attributes.has_key?(:'totalCampaignFreeItems')
+        self.total_campaign_free_items = attributes[:'totalCampaignFreeItems']
+      end
+
+      if attributes.has_key?(:'couponRedemptions')
+        self.coupon_redemptions = attributes[:'couponRedemptions']
+      end
+
+      if attributes.has_key?(:'totalCouponRedemptions')
+        self.total_coupon_redemptions = attributes[:'totalCouponRedemptions']
+      end
+
+      if attributes.has_key?(:'couponRolledbackRedemptions')
+        self.coupon_rolledback_redemptions = attributes[:'couponRolledbackRedemptions']
+      end
+
+      if attributes.has_key?(:'totalCouponRolledbackRedemptions')
+        self.total_coupon_rolledback_redemptions = attributes[:'totalCouponRolledbackRedemptions']
+      end
+
+      if attributes.has_key?(:'referralRedemptions')
+        self.referral_redemptions = attributes[:'referralRedemptions']
+      end
+
+      if attributes.has_key?(:'totalReferralRedemptions')
+        self.total_referral_redemptions = attributes[:'totalReferralRedemptions']
+      end
+
+      if attributes.has_key?(:'couponsCreated')
+        self.coupons_created = attributes[:'couponsCreated']
+      end
+
+      if attributes.has_key?(:'totalCouponsCreated')
+        self.total_coupons_created = attributes[:'totalCouponsCreated']
+      end
+
+      if attributes.has_key?(:'referralsCreated')
+        self.referrals_created = attributes[:'referralsCreated']
+      end
+
+      if attributes.has_key?(:'totalReferralsCreated')
+        self.total_referrals_created = attributes[:'totalReferralsCreated']
+      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
+      invalid_properties = Array.new
+      if @date.nil?
+        invalid_properties.push('invalid value for "date", date cannot be nil.')
+      end
+
+      if @campaign_revenue.nil?
+        invalid_properties.push('invalid value for "campaign_revenue", campaign_revenue cannot be nil.')
+      end
+
+      if @total_campaign_revenue.nil?
+        invalid_properties.push('invalid value for "total_campaign_revenue", total_campaign_revenue cannot be nil.')
+      end
+
+      if @campaign_refund.nil?
+        invalid_properties.push('invalid value for "campaign_refund", campaign_refund cannot be nil.')
+      end
+
+      if @total_campaign_refund.nil?
+        invalid_properties.push('invalid value for "total_campaign_refund", total_campaign_refund cannot be nil.')
+      end
+
+      if @campaign_discount_costs.nil?
+        invalid_properties.push('invalid value for "campaign_discount_costs", campaign_discount_costs cannot be nil.')
+      end
+
+      if @total_campaign_discount_costs.nil?
+        invalid_properties.push('invalid value for "total_campaign_discount_costs", total_campaign_discount_costs cannot be nil.')
+      end
+
+      if @campaign_refunded_discounts.nil?
+        invalid_properties.push('invalid value for "campaign_refunded_discounts", campaign_refunded_discounts cannot be nil.')
+      end
+
+      if @total_campaign_refunded_discounts.nil?
+        invalid_properties.push('invalid value for "total_campaign_refunded_discounts", total_campaign_refunded_discounts cannot be nil.')
+      end
+
+      if @campaign_free_items.nil?
+        invalid_properties.push('invalid value for "campaign_free_items", campaign_free_items cannot be nil.')
+      end
+
+      if @total_campaign_free_items.nil?
+        invalid_properties.push('invalid value for "total_campaign_free_items", total_campaign_free_items cannot be nil.')
+      end
+
+      if @coupon_redemptions.nil?
+        invalid_properties.push('invalid value for "coupon_redemptions", coupon_redemptions cannot be nil.')
+      end
+
+      if @total_coupon_redemptions.nil?
+        invalid_properties.push('invalid value for "total_coupon_redemptions", total_coupon_redemptions cannot be nil.')
+      end
+
+      if @coupon_rolledback_redemptions.nil?
+        invalid_properties.push('invalid value for "coupon_rolledback_redemptions", coupon_rolledback_redemptions cannot be nil.')
+      end
+
+      if @total_coupon_rolledback_redemptions.nil?
+        invalid_properties.push('invalid value for "total_coupon_rolledback_redemptions", total_coupon_rolledback_redemptions cannot be nil.')
+      end
+
+      if @referral_redemptions.nil?
+        invalid_properties.push('invalid value for "referral_redemptions", referral_redemptions cannot be nil.')
+      end
+
+      if @total_referral_redemptions.nil?
+        invalid_properties.push('invalid value for "total_referral_redemptions", total_referral_redemptions cannot be nil.')
+      end
+
+      if @coupons_created.nil?
+        invalid_properties.push('invalid value for "coupons_created", coupons_created cannot be nil.')
+      end
+
+      if @total_coupons_created.nil?
+        invalid_properties.push('invalid value for "total_coupons_created", total_coupons_created cannot be nil.')
+      end
+
+      if @referrals_created.nil?
+        invalid_properties.push('invalid value for "referrals_created", referrals_created cannot be nil.')
+      end
+
+      if @total_referrals_created.nil?
+        invalid_properties.push('invalid value for "total_referrals_created", total_referrals_created cannot be nil.')
+      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?
+      return false if @date.nil?
+      return false if @campaign_revenue.nil?
+      return false if @total_campaign_revenue.nil?
+      return false if @campaign_refund.nil?
+      return false if @total_campaign_refund.nil?
+      return false if @campaign_discount_costs.nil?
+      return false if @total_campaign_discount_costs.nil?
+      return false if @campaign_refunded_discounts.nil?
+      return false if @total_campaign_refunded_discounts.nil?
+      return false if @campaign_free_items.nil?
+      return false if @total_campaign_free_items.nil?
+      return false if @coupon_redemptions.nil?
+      return false if @total_coupon_redemptions.nil?
+      return false if @coupon_rolledback_redemptions.nil?
+      return false if @total_coupon_rolledback_redemptions.nil?
+      return false if @referral_redemptions.nil?
+      return false if @total_referral_redemptions.nil?
+      return false if @coupons_created.nil?
+      return false if @total_coupons_created.nil?
+      return false if @referrals_created.nil?
+      return false if @total_referrals_created.nil?
+      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 &&
+          date == o.date &&
+          campaign_revenue == o.campaign_revenue &&
+          total_campaign_revenue == o.total_campaign_revenue &&
+          campaign_refund == o.campaign_refund &&
+          total_campaign_refund == o.total_campaign_refund &&
+          campaign_discount_costs == o.campaign_discount_costs &&
+          total_campaign_discount_costs == o.total_campaign_discount_costs &&
+          campaign_refunded_discounts == o.campaign_refunded_discounts &&
+          total_campaign_refunded_discounts == o.total_campaign_refunded_discounts &&
+          campaign_free_items == o.campaign_free_items &&
+          total_campaign_free_items == o.total_campaign_free_items &&
+          coupon_redemptions == o.coupon_redemptions &&
+          total_coupon_redemptions == o.total_coupon_redemptions &&
+          coupon_rolledback_redemptions == o.coupon_rolledback_redemptions &&
+          total_coupon_rolledback_redemptions == o.total_coupon_rolledback_redemptions &&
+          referral_redemptions == o.referral_redemptions &&
+          total_referral_redemptions == o.total_referral_redemptions &&
+          coupons_created == o.coupons_created &&
+          total_coupons_created == o.total_coupons_created &&
+          referrals_created == o.referrals_created &&
+          total_referrals_created == o.total_referrals_created
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [date, campaign_revenue, total_campaign_revenue, campaign_refund, total_campaign_refund, campaign_discount_costs, total_campaign_discount_costs, campaign_refunded_discounts, total_campaign_refunded_discounts, campaign_free_items, total_campaign_free_items, coupon_redemptions, total_coupon_redemptions, coupon_rolledback_redemptions, total_coupon_rolledback_redemptions, referral_redemptions, total_referral_redemptions, coupons_created, total_coupons_created, referrals_created, total_referrals_created].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = TalonOne.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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