smplkit 3.0.8 → 3.0.9

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{next_tier_meta.rb → next_tier_response.rb}

@@ -14,15 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Information about the next volume-discount tier.
-  class NextTierMeta < ApiModelBase
-    # Number of additional subscribed products needed to reach the next tier.
+  # Hint describing how the customer could unlock a better discount.
+  class NextTierResponse < ApiModelBase
+    # Number of additional paid products required to reach the next discount tier.
     attr_accessor :products_needed
 
     # Discount percentage that would apply at the next tier.
     attr_accessor :discount_pct
 
-    # Additional monthly savings in cents at the next tier.
+    # Estimated additional monthly savings (in cents) at the next tier, compared to paying full list price for the added product.
     attr_accessor :additional_savings_cents
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -63,14 +63,14 @@ module SmplkitGeneratedClient::App
     # @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::NextTierMeta` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::NextTierResponse` 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::NextTierMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::NextTierResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

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

@@ -0,0 +1,321 @@
+=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
+  # Per-item projected effect of a subscription change.
+  class SubscriptionChangeProjection < ApiModelBase
+    # Product key affected by this change.
+    attr_accessor :product
+
+    # Current plan for this product, or `FREE` if it is being added.
+    attr_accessor :from_plan
+
+    # Plan the product will be on after the change. `FREE` indicates the enrollment will be dropped.
+    attr_accessor :to_plan
+
+    # Monthly cost in cents of this enrollment after the change. `0` when the enrollment will be dropped.
+    attr_accessor :monthly_cents
+
+    # `IMMEDIATE` when the change takes effect at confirmation time (and a prorated charge may apply today). `NEXT_PERIOD` when the change takes effect at the end of the current billing period.
+    attr_accessor :effect
+
+    # When `effect` is `IMMEDIATE`, the estimated prorated charge for the remainder of the current billing period in cents. Always `0` when `effect` is `NEXT_PERIOD`.
+    attr_accessor :prorated_charge_today_cents
+
+    # When `effect` is `NEXT_PERIOD`, the ISO-8601 timestamp at which the change takes effect. `null` when `effect` is `IMMEDIATE` (the change applies on confirmation).
+    attr_accessor :starts_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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'product' => :'product',
+        :'from_plan' => :'from_plan',
+        :'to_plan' => :'to_plan',
+        :'monthly_cents' => :'monthly_cents',
+        :'effect' => :'effect',
+        :'prorated_charge_today_cents' => :'prorated_charge_today_cents',
+        :'starts_at' => :'starts_at'
+      }
+    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
+      {
+        :'product' => :'String',
+        :'from_plan' => :'String',
+        :'to_plan' => :'String',
+        :'monthly_cents' => :'Integer',
+        :'effect' => :'String',
+        :'prorated_charge_today_cents' => :'Integer',
+        :'starts_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'starts_at'
+      ])
+    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::SubscriptionChangeProjection` 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::SubscriptionChangeProjection`. 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?(:'product')
+        self.product = attributes[:'product']
+      else
+        self.product = nil
+      end
+
+      if attributes.key?(:'from_plan')
+        self.from_plan = attributes[:'from_plan']
+      else
+        self.from_plan = nil
+      end
+
+      if attributes.key?(:'to_plan')
+        self.to_plan = attributes[:'to_plan']
+      else
+        self.to_plan = nil
+      end
+
+      if attributes.key?(:'monthly_cents')
+        self.monthly_cents = attributes[:'monthly_cents']
+      else
+        self.monthly_cents = nil
+      end
+
+      if attributes.key?(:'effect')
+        self.effect = attributes[:'effect']
+      else
+        self.effect = nil
+      end
+
+      if attributes.key?(:'prorated_charge_today_cents')
+        self.prorated_charge_today_cents = attributes[:'prorated_charge_today_cents']
+      else
+        self.prorated_charge_today_cents = 0
+      end
+
+      if attributes.key?(:'starts_at')
+        self.starts_at = attributes[:'starts_at']
+      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 @product.nil?
+        invalid_properties.push('invalid value for "product", product cannot be nil.')
+      end
+
+      if @from_plan.nil?
+        invalid_properties.push('invalid value for "from_plan", from_plan cannot be nil.')
+      end
+
+      if @to_plan.nil?
+        invalid_properties.push('invalid value for "to_plan", to_plan cannot be nil.')
+      end
+
+      if @monthly_cents.nil?
+        invalid_properties.push('invalid value for "monthly_cents", monthly_cents cannot be nil.')
+      end
+
+      if @effect.nil?
+        invalid_properties.push('invalid value for "effect", effect 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 @product.nil?
+      return false if @from_plan.nil?
+      return false if @to_plan.nil?
+      return false if @monthly_cents.nil?
+      return false if @effect.nil?
+      effect_validator = EnumAttributeValidator.new('String', ["IMMEDIATE", "NEXT_PERIOD"])
+      return false unless effect_validator.valid?(@effect)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product Value to be assigned
+    def product=(product)
+      if product.nil?
+        fail ArgumentError, 'product cannot be nil'
+      end
+
+      @product = product
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_plan Value to be assigned
+    def from_plan=(from_plan)
+      if from_plan.nil?
+        fail ArgumentError, 'from_plan cannot be nil'
+      end
+
+      @from_plan = from_plan
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to_plan Value to be assigned
+    def to_plan=(to_plan)
+      if to_plan.nil?
+        fail ArgumentError, 'to_plan cannot be nil'
+      end
+
+      @to_plan = to_plan
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] monthly_cents Value to be assigned
+    def monthly_cents=(monthly_cents)
+      if monthly_cents.nil?
+        fail ArgumentError, 'monthly_cents cannot be nil'
+      end
+
+      @monthly_cents = monthly_cents
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] effect Object to be assigned
+    def effect=(effect)
+      validator = EnumAttributeValidator.new('String', ["IMMEDIATE", "NEXT_PERIOD"])
+      unless validator.valid?(effect)
+        fail ArgumentError, "invalid value for \"effect\", must be one of #{validator.allowable_values}."
+      end
+      @effect = effect
+    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 &&
+          product == o.product &&
+          from_plan == o.from_plan &&
+          to_plan == o.to_plan &&
+          monthly_cents == o.monthly_cents &&
+          effect == o.effect &&
+          prorated_charge_today_cents == o.prorated_charge_today_cents &&
+          starts_at == o.starts_at
+    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
+      [product, from_plan, to_plan, monthly_cents, effect, prorated_charge_today_cents, starts_at].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/{create_subscription_attributes.rb → subscription_item_request.rb}

@@ -14,23 +14,19 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Attributes accepted when creating a new subscription.
-  class CreateSubscriptionAttributes < ApiModelBase
-    # Product key to subscribe to, e.g. `flags`.
+  # One product enrollment as supplied by the caller.  The caller supplies the *desired* (product, plan) pair for each product they want enrolled. Products absent from the request are interpreted as scheduled-for-drop at the end of the current billing period.
+  class SubscriptionItemRequest < ApiModelBase
+    # Product key (e.g. `audit`, `config`, `flags`, `logging`).
     attr_accessor :product
 
-    # Plan key to subscribe on, e.g. `pro`.
+    # Target plan for this product. Must be a paid plan such as `STANDARD` or `PRO`; the free plan is implicit when a product is not listed.
     attr_accessor :plan
 
-    # UUID of a payment method on file to bill against. If omitted, the account's default payment method is used.
-    attr_accessor :payment_method
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'product' => :'product',
-        :'plan' => :'plan',
-        :'payment_method' => :'payment_method'
+        :'plan' => :'plan'
       }
     end
 
@@ -48,15 +44,13 @@ module SmplkitGeneratedClient::App
     def self.openapi_types
       {
         :'product' => :'String',
-        :'plan' => :'String',
-        :'payment_method' => :'String'
+        :'plan' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'payment_method'
       ])
     end
 
@@ -64,14 +58,14 @@ module SmplkitGeneratedClient::App
     # @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::CreateSubscriptionAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::SubscriptionItemRequest` 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::CreateSubscriptionAttributes`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::SubscriptionItemRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -87,10 +81,6 @@ module SmplkitGeneratedClient::App
       else
         self.plan = nil
       end
-
-      if attributes.key?(:'payment_method')
-        self.payment_method = attributes[:'payment_method']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -144,8 +134,7 @@ module SmplkitGeneratedClient::App
       return true if self.equal?(o)
       self.class == o.class &&
           product == o.product &&
-          plan == o.plan &&
-          payment_method == o.payment_method
+          plan == o.plan
     end
 
     # @see the `==` method
@@ -157,7 +146,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [product, plan, payment_method].hash
+      [product, plan].hash
     end
 
     # Builds the object from hash