solifyn 1.0.0

data/lib/solifyn/models/product_create.rb

@@ -0,0 +1,527 @@
+=begin
+#Solifyn API
+
+#Welcome to the Solifyn API Reference. Leverage our secure endpoints to manage products and issue, validate, and manage software license keys programmatically.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Solifyn
+  class ProductCreate
+    # Product display name.
+    attr_accessor :name
+
+    # A description of the product.
+    attr_accessor :description
+
+    # Price value.
+    attr_accessor :price
+
+    # Product pricing currency.
+    attr_accessor :currency
+
+    # URL of the product cover image.
+    attr_accessor :image_url
+
+    # Tax classification.
+    attr_accessor :tax_category
+
+    # Percentage or flat rate discount.
+    attr_accessor :discount
+
+    # Whether to automatically issue license keys upon successful orders.
+    attr_accessor :has_license_key
+
+    # Whether the purchase includes downloadable files.
+    attr_accessor :has_digital_delivery
+
+    # Whether tax is included in the base price.
+    attr_accessor :is_tax_inclusive
+
+    # Maximum concurrent activated instances allowed per license key.
+    attr_accessor :activation_limit
+
+    # Brand id for the product, if not provided will default to primary brand.
+    attr_accessor :brand_id
+
+    # Billing period in days (for Subscription products).
+    attr_accessor :billing_period
+
+    # Trial duration in days.
+    attr_accessor :trial_period_days
+
+    # Subscription expiration duration in days.
+    attr_accessor :expiration_days
+
+    # Custom billing descriptor.
+    attr_accessor :statement_descriptor
+
+    # Allow pay-what-you-want pricing.
+    attr_accessor :pay_what_you_want
+
+    # Developer key-value metadata pairs.
+    attr_accessor :metadata
+
+    # Form field configurations to gather during checkout.
+    attr_accessor :custom_fields
+
+    # Initial stock quantity limit.
+    attr_accessor :stock
+
+    # Whether the product is publicly visible.
+    attr_accessor :is_listed
+
+    # Whether the product is free of charge.
+    attr_accessor :is_free
+
+    # Product addons configurations.
+    attr_accessor :addons
+
+    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
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'price' => :'price',
+        :'currency' => :'currency',
+        :'image_url' => :'imageUrl',
+        :'tax_category' => :'taxCategory',
+        :'discount' => :'discount',
+        :'has_license_key' => :'hasLicenseKey',
+        :'has_digital_delivery' => :'hasDigitalDelivery',
+        :'is_tax_inclusive' => :'isTaxInclusive',
+        :'activation_limit' => :'activationLimit',
+        :'brand_id' => :'brandId',
+        :'billing_period' => :'billingPeriod',
+        :'trial_period_days' => :'trialPeriodDays',
+        :'expiration_days' => :'expirationDays',
+        :'statement_descriptor' => :'statementDescriptor',
+        :'pay_what_you_want' => :'payWhatYouWant',
+        :'metadata' => :'metadata',
+        :'custom_fields' => :'customFields',
+        :'stock' => :'stock',
+        :'is_listed' => :'isListed',
+        :'is_free' => :'isFree',
+        :'addons' => :'addons'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'price' => :'Float',
+        :'currency' => :'String',
+        :'image_url' => :'String',
+        :'tax_category' => :'String',
+        :'discount' => :'Float',
+        :'has_license_key' => :'Boolean',
+        :'has_digital_delivery' => :'Boolean',
+        :'is_tax_inclusive' => :'Boolean',
+        :'activation_limit' => :'Integer',
+        :'brand_id' => :'String',
+        :'billing_period' => :'Integer',
+        :'trial_period_days' => :'Integer',
+        :'expiration_days' => :'Integer',
+        :'statement_descriptor' => :'String',
+        :'pay_what_you_want' => :'Boolean',
+        :'metadata' => :'Hash<String, String>',
+        :'custom_fields' => :'Array<ProductCreateCustomFieldsInner>',
+        :'stock' => :'Integer',
+        :'is_listed' => :'Boolean',
+        :'is_free' => :'Boolean',
+        :'addons' => :'Array<ProductCreateAddonsInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Solifyn::ProductCreate` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Solifyn::ProductCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      else
+        self.price = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 'USD'
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'tax_category')
+        self.tax_category = attributes[:'tax_category']
+      else
+        self.tax_category = nil
+      end
+
+      if attributes.key?(:'discount')
+        self.discount = attributes[:'discount']
+      end
+
+      if attributes.key?(:'has_license_key')
+        self.has_license_key = attributes[:'has_license_key']
+      else
+        self.has_license_key = false
+      end
+
+      if attributes.key?(:'has_digital_delivery')
+        self.has_digital_delivery = attributes[:'has_digital_delivery']
+      else
+        self.has_digital_delivery = false
+      end
+
+      if attributes.key?(:'is_tax_inclusive')
+        self.is_tax_inclusive = attributes[:'is_tax_inclusive']
+      else
+        self.is_tax_inclusive = false
+      end
+
+      if attributes.key?(:'activation_limit')
+        self.activation_limit = attributes[:'activation_limit']
+      end
+
+      if attributes.key?(:'brand_id')
+        self.brand_id = attributes[:'brand_id']
+      end
+
+      if attributes.key?(:'billing_period')
+        self.billing_period = attributes[:'billing_period']
+      end
+
+      if attributes.key?(:'trial_period_days')
+        self.trial_period_days = attributes[:'trial_period_days']
+      end
+
+      if attributes.key?(:'expiration_days')
+        self.expiration_days = attributes[:'expiration_days']
+      end
+
+      if attributes.key?(:'statement_descriptor')
+        self.statement_descriptor = attributes[:'statement_descriptor']
+      end
+
+      if attributes.key?(:'pay_what_you_want')
+        self.pay_what_you_want = attributes[:'pay_what_you_want']
+      else
+        self.pay_what_you_want = false
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'custom_fields')
+        if (value = attributes[:'custom_fields']).is_a?(Array)
+          self.custom_fields = value
+        end
+      end
+
+      if attributes.key?(:'stock')
+        self.stock = attributes[:'stock']
+      end
+
+      if attributes.key?(:'is_listed')
+        self.is_listed = attributes[:'is_listed']
+      else
+        self.is_listed = true
+      end
+
+      if attributes.key?(:'is_free')
+        self.is_free = attributes[:'is_free']
+      else
+        self.is_free = false
+      end
+
+      if attributes.key?(:'addons')
+        if (value = attributes[:'addons']).is_a?(Array)
+          self.addons = 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
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @price.nil?
+        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @tax_category.nil?
+        invalid_properties.push('invalid value for "tax_category", tax_category 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
+      return false if @price.nil?
+      return false if @currency.nil?
+      currency_validator = EnumAttributeValidator.new('String', ["USD", "SGD", "INR", "AUD", "BRL", "CAD", "DKK", "EUR", "NOK", "GBP", "SEK", "CHF", "HKD", "HUF", "JPY", "MXN", "MYR", "PLN", "CZK", "NZD", "AED", "COP", "RON", "THB", "BGN", "IDR", "DOP", "PHP", "TRY", "KRW", "TWD", "VND", "PKR", "CLP", "UYU", "ARS", "ZAR", "DZD", "TND", "MAD", "KES", "KWD", "JOD", "ALL", "XCD", "AMD", "BSD", "BHD", "BOB", "BAM", "KHR", "CRC", "XOF", "EGP", "ETB", "GMD", "GHS", "GTQ", "GYD", "ILS", "JMD", "MOP", "MGA", "MUR", "MDL", "MNT", "NAD", "NGN", "MKD", "OMR", "PYG", "PEN", "QAR", "RWF", "SAR", "RSD", "LKR", "TZS", "TTD", "UZS", "RUB", "CNY"])
+      return false unless currency_validator.valid?(@currency)
+      return false if @tax_category.nil?
+      tax_category_validator = EnumAttributeValidator.new('String', ["digital_products", "saas", "physical_products", "service"])
+      return false unless tax_category_validator.valid?(@tax_category)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] currency Object to be assigned
+    def currency=(currency)
+      validator = EnumAttributeValidator.new('String', ["USD", "SGD", "INR", "AUD", "BRL", "CAD", "DKK", "EUR", "NOK", "GBP", "SEK", "CHF", "HKD", "HUF", "JPY", "MXN", "MYR", "PLN", "CZK", "NZD", "AED", "COP", "RON", "THB", "BGN", "IDR", "DOP", "PHP", "TRY", "KRW", "TWD", "VND", "PKR", "CLP", "UYU", "ARS", "ZAR", "DZD", "TND", "MAD", "KES", "KWD", "JOD", "ALL", "XCD", "AMD", "BSD", "BHD", "BOB", "BAM", "KHR", "CRC", "XOF", "EGP", "ETB", "GMD", "GHS", "GTQ", "GYD", "ILS", "JMD", "MOP", "MGA", "MUR", "MDL", "MNT", "NAD", "NGN", "MKD", "OMR", "PYG", "PEN", "QAR", "RWF", "SAR", "RSD", "LKR", "TZS", "TTD", "UZS", "RUB", "CNY"])
+      unless validator.valid?(currency)
+        fail ArgumentError, "invalid value for \"currency\", must be one of #{validator.allowable_values}."
+      end
+      @currency = currency
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tax_category Object to be assigned
+    def tax_category=(tax_category)
+      validator = EnumAttributeValidator.new('String', ["digital_products", "saas", "physical_products", "service"])
+      unless validator.valid?(tax_category)
+        fail ArgumentError, "invalid value for \"tax_category\", must be one of #{validator.allowable_values}."
+      end
+      @tax_category = tax_category
+    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 &&
+          name == o.name &&
+          description == o.description &&
+          price == o.price &&
+          currency == o.currency &&
+          image_url == o.image_url &&
+          tax_category == o.tax_category &&
+          discount == o.discount &&
+          has_license_key == o.has_license_key &&
+          has_digital_delivery == o.has_digital_delivery &&
+          is_tax_inclusive == o.is_tax_inclusive &&
+          activation_limit == o.activation_limit &&
+          brand_id == o.brand_id &&
+          billing_period == o.billing_period &&
+          trial_period_days == o.trial_period_days &&
+          expiration_days == o.expiration_days &&
+          statement_descriptor == o.statement_descriptor &&
+          pay_what_you_want == o.pay_what_you_want &&
+          metadata == o.metadata &&
+          custom_fields == o.custom_fields &&
+          stock == o.stock &&
+          is_listed == o.is_listed &&
+          is_free == o.is_free &&
+          addons == o.addons
+    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
+      [name, description, price, currency, image_url, tax_category, discount, has_license_key, has_digital_delivery, is_tax_inclusive, activation_limit, brand_id, billing_period, trial_period_days, expiration_days, statement_descriptor, pay_what_you_want, metadata, custom_fields, stock, is_listed, is_free, addons].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 = Solifyn.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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