smplkit 3.0.7 → 3.0.9

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_preview_attributes.rb

@@ -0,0 +1,390 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::App
+  # Projected totals and per-change breakdown for a hypothetical change.
+  class SubscriptionPreviewAttributes < ApiModelBase
+    # Projected sum of item monthly list prices after the change.
+    attr_accessor :projected_subtotal_cents
+
+    # Projected discount percentage that will apply after the change.
+    attr_accessor :projected_discount_pct
+
+    # `VOLUME` when the projected discount comes from the multi-product schedule; `OVERRIDE` when an administrator's discount applies.
+    attr_accessor :projected_discount_source
+
+    # Projected discount amount in cents after the change.
+    attr_accessor :projected_discount_amount_cents
+
+    # Projected final monthly total in cents after the change.
+    attr_accessor :projected_total_cents
+
+    attr_accessor :projected_next_tier
+
+    # Per-product breakdown of changes the desired state would produce. Products that would remain unchanged are omitted.
+    attr_accessor :changes
+
+    # Total amount that would be charged at confirmation time, in cents. The sum of `prorated_charge_today_cents` across `IMMEDIATE` changes.
+    attr_accessor :total_charge_today_cents
+
+    # Projected total of the next monthly invoice in cents, after all scheduled changes have taken effect.
+    attr_accessor :next_invoice_total_cents
+
+    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
+      {
+        :'projected_subtotal_cents' => :'projected_subtotal_cents',
+        :'projected_discount_pct' => :'projected_discount_pct',
+        :'projected_discount_source' => :'projected_discount_source',
+        :'projected_discount_amount_cents' => :'projected_discount_amount_cents',
+        :'projected_total_cents' => :'projected_total_cents',
+        :'projected_next_tier' => :'projected_next_tier',
+        :'changes' => :'changes',
+        :'total_charge_today_cents' => :'total_charge_today_cents',
+        :'next_invoice_total_cents' => :'next_invoice_total_cents'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'projected_subtotal_cents' => :'Integer',
+        :'projected_discount_pct' => :'Integer',
+        :'projected_discount_source' => :'String',
+        :'projected_discount_amount_cents' => :'Integer',
+        :'projected_total_cents' => :'Integer',
+        :'projected_next_tier' => :'NextTierResponse',
+        :'changes' => :'Array<SubscriptionChangeProjection>',
+        :'total_charge_today_cents' => :'Integer',
+        :'next_invoice_total_cents' => :'Integer'
+      }
+    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 `SmplkitGeneratedClient::App::SubscriptionPreviewAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::SubscriptionPreviewAttributes`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'projected_subtotal_cents')
+        self.projected_subtotal_cents = attributes[:'projected_subtotal_cents']
+      else
+        self.projected_subtotal_cents = nil
+      end
+
+      if attributes.key?(:'projected_discount_pct')
+        self.projected_discount_pct = attributes[:'projected_discount_pct']
+      else
+        self.projected_discount_pct = nil
+      end
+
+      if attributes.key?(:'projected_discount_source')
+        self.projected_discount_source = attributes[:'projected_discount_source']
+      else
+        self.projected_discount_source = nil
+      end
+
+      if attributes.key?(:'projected_discount_amount_cents')
+        self.projected_discount_amount_cents = attributes[:'projected_discount_amount_cents']
+      else
+        self.projected_discount_amount_cents = nil
+      end
+
+      if attributes.key?(:'projected_total_cents')
+        self.projected_total_cents = attributes[:'projected_total_cents']
+      else
+        self.projected_total_cents = nil
+      end
+
+      if attributes.key?(:'projected_next_tier')
+        self.projected_next_tier = attributes[:'projected_next_tier']
+      end
+
+      if attributes.key?(:'changes')
+        if (value = attributes[:'changes']).is_a?(Array)
+          self.changes = value
+        end
+      else
+        self.changes = nil
+      end
+
+      if attributes.key?(:'total_charge_today_cents')
+        self.total_charge_today_cents = attributes[:'total_charge_today_cents']
+      else
+        self.total_charge_today_cents = nil
+      end
+
+      if attributes.key?(:'next_invoice_total_cents')
+        self.next_invoice_total_cents = attributes[:'next_invoice_total_cents']
+      else
+        self.next_invoice_total_cents = nil
+      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 @projected_subtotal_cents.nil?
+        invalid_properties.push('invalid value for "projected_subtotal_cents", projected_subtotal_cents cannot be nil.')
+      end
+
+      if @projected_discount_pct.nil?
+        invalid_properties.push('invalid value for "projected_discount_pct", projected_discount_pct cannot be nil.')
+      end
+
+      if @projected_discount_source.nil?
+        invalid_properties.push('invalid value for "projected_discount_source", projected_discount_source cannot be nil.')
+      end
+
+      if @projected_discount_amount_cents.nil?
+        invalid_properties.push('invalid value for "projected_discount_amount_cents", projected_discount_amount_cents cannot be nil.')
+      end
+
+      if @projected_total_cents.nil?
+        invalid_properties.push('invalid value for "projected_total_cents", projected_total_cents cannot be nil.')
+      end
+
+      if @changes.nil?
+        invalid_properties.push('invalid value for "changes", changes cannot be nil.')
+      end
+
+      if @total_charge_today_cents.nil?
+        invalid_properties.push('invalid value for "total_charge_today_cents", total_charge_today_cents cannot be nil.')
+      end
+
+      if @next_invoice_total_cents.nil?
+        invalid_properties.push('invalid value for "next_invoice_total_cents", next_invoice_total_cents 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 @projected_subtotal_cents.nil?
+      return false if @projected_discount_pct.nil?
+      return false if @projected_discount_source.nil?
+      projected_discount_source_validator = EnumAttributeValidator.new('String', ["VOLUME", "OVERRIDE"])
+      return false unless projected_discount_source_validator.valid?(@projected_discount_source)
+      return false if @projected_discount_amount_cents.nil?
+      return false if @projected_total_cents.nil?
+      return false if @changes.nil?
+      return false if @total_charge_today_cents.nil?
+      return false if @next_invoice_total_cents.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] projected_subtotal_cents Value to be assigned
+    def projected_subtotal_cents=(projected_subtotal_cents)
+      if projected_subtotal_cents.nil?
+        fail ArgumentError, 'projected_subtotal_cents cannot be nil'
+      end
+
+      @projected_subtotal_cents = projected_subtotal_cents
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] projected_discount_pct Value to be assigned
+    def projected_discount_pct=(projected_discount_pct)
+      if projected_discount_pct.nil?
+        fail ArgumentError, 'projected_discount_pct cannot be nil'
+      end
+
+      @projected_discount_pct = projected_discount_pct
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] projected_discount_source Object to be assigned
+    def projected_discount_source=(projected_discount_source)
+      validator = EnumAttributeValidator.new('String', ["VOLUME", "OVERRIDE"])
+      unless validator.valid?(projected_discount_source)
+        fail ArgumentError, "invalid value for \"projected_discount_source\", must be one of #{validator.allowable_values}."
+      end
+      @projected_discount_source = projected_discount_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] projected_discount_amount_cents Value to be assigned
+    def projected_discount_amount_cents=(projected_discount_amount_cents)
+      if projected_discount_amount_cents.nil?
+        fail ArgumentError, 'projected_discount_amount_cents cannot be nil'
+      end
+
+      @projected_discount_amount_cents = projected_discount_amount_cents
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] projected_total_cents Value to be assigned
+    def projected_total_cents=(projected_total_cents)
+      if projected_total_cents.nil?
+        fail ArgumentError, 'projected_total_cents cannot be nil'
+      end
+
+      @projected_total_cents = projected_total_cents
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] changes Value to be assigned
+    def changes=(changes)
+      if changes.nil?
+        fail ArgumentError, 'changes cannot be nil'
+      end
+
+      @changes = changes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_charge_today_cents Value to be assigned
+    def total_charge_today_cents=(total_charge_today_cents)
+      if total_charge_today_cents.nil?
+        fail ArgumentError, 'total_charge_today_cents cannot be nil'
+      end
+
+      @total_charge_today_cents = total_charge_today_cents
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] next_invoice_total_cents Value to be assigned
+    def next_invoice_total_cents=(next_invoice_total_cents)
+      if next_invoice_total_cents.nil?
+        fail ArgumentError, 'next_invoice_total_cents cannot be nil'
+      end
+
+      @next_invoice_total_cents = next_invoice_total_cents
+    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 &&
+          projected_subtotal_cents == o.projected_subtotal_cents &&
+          projected_discount_pct == o.projected_discount_pct &&
+          projected_discount_source == o.projected_discount_source &&
+          projected_discount_amount_cents == o.projected_discount_amount_cents &&
+          projected_total_cents == o.projected_total_cents &&
+          projected_next_tier == o.projected_next_tier &&
+          changes == o.changes &&
+          total_charge_today_cents == o.total_charge_today_cents &&
+          next_invoice_total_cents == o.next_invoice_total_cents
+    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
+      [projected_subtotal_cents, projected_discount_pct, projected_discount_source, projected_discount_amount_cents, projected_total_cents, projected_next_tier, changes, total_charge_today_cents, next_invoice_total_cents].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
+
+    # 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
+
+  end
+
+end

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_preview_resource.rb

@@ -0,0 +1,241 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::App
+  # JSON:API resource object for a subscription preview.
+  class SubscriptionPreviewResource < ApiModelBase
+    # Always `preview`.
+    attr_accessor :id
+
+    # JSON:API resource type.
+    attr_accessor :type
+
+    attr_accessor :attributes
+
+    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
+      {
+        :'id' => :'id',
+        :'type' => :'type',
+        :'attributes' => :'attributes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'type' => :'String',
+        :'attributes' => :'SubscriptionPreviewAttributes'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+      ])
+    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 `SmplkitGeneratedClient::App::SubscriptionPreviewResource` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::SubscriptionPreviewResource`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = 'preview'
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      else
+        self.attributes = nil
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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'
+      id_validator = EnumAttributeValidator.new('String', ["preview"])
+      return false unless id_validator.valid?(@id)
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["subscription_preview"])
+      return false unless type_validator.valid?(@type)
+      return false if @attributes.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] id Object to be assigned
+    def id=(id)
+      validator = EnumAttributeValidator.new('String', ["preview"])
+      unless validator.valid?(id)
+        fail ArgumentError, "invalid value for \"id\", must be one of #{validator.allowable_values}."
+      end
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["subscription_preview"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attributes Value to be assigned
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'attributes cannot be nil'
+      end
+
+      @attributes = attributes
+    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 &&
+          type == o.type &&
+          attributes == o.attributes
+    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, type, attributes].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
+
+    # 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
+
+  end
+
+end