smplkit 3.0.7 → 3.0.9

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

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{subscription_attributes.rb → subscription_item_response.rb}

@@ -14,39 +14,35 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # A subscription that grants the account access to a product on a plan.
-  class SubscriptionAttributes < ApiModelBase
-    # Product key the subscription is for, e.g. `flags`.
+  # One product enrollment as exposed in subscription responses.
+  class SubscriptionItemResponse < ApiModelBase
+    # Unique identifier for this enrollment.
+    attr_accessor :id
+
+    # Product key (e.g. `audit`, `config`, `flags`, `logging`).
     attr_accessor :product
 
-    # Plan key the subscription is on, e.g. `pro`.
+    # Current plan for this product (e.g. `STANDARD`, `PRO`).
     attr_accessor :plan
 
-    # Lifecycle state of the subscription, e.g. `active`, `trialing`, `past_due`, `canceled`.
-    attr_accessor :status
-
-    # When `true`, the subscription is complimentary and is not billed through the billing provider.
-    attr_accessor :comped
+    # Monthly list price for this enrollment, in cents. This value is locked at the time the enrollment was created or last had its plan changed; subsequent changes to the public price list do not affect this enrollment until the customer themselves changes their plan.
+    attr_accessor :price_monthly_cents
 
-    # When `true`, the subscription is billed through Stripe; otherwise it is a free or complimentary subscription that does not produce invoices.
-    attr_accessor :stripe_managed
+    # When a plan change is scheduled for the end of the current billing period, this is the plan that will take effect. Otherwise `null`. The value `FREE` indicates the enrollment will be dropped.
+    attr_accessor :pending_plan_change
 
-    # End of the current billing period (ISO 8601 timestamp).
-    attr_accessor :current_period_end
-
-    # Stripe payment intent client secret returned when a subscription create requires additional authentication (3DS). Returned only on create.
-    attr_accessor :client_secret
+    # ISO-8601 timestamp at which the pending plan change takes effect. Matches the subscription's `current_period_end`.
+    attr_accessor :scheduled_change_effective_at
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'product' => :'product',
         :'plan' => :'plan',
-        :'status' => :'status',
-        :'comped' => :'comped',
-        :'stripe_managed' => :'stripe_managed',
-        :'current_period_end' => :'current_period_end',
-        :'client_secret' => :'client_secret'
+        :'price_monthly_cents' => :'price_monthly_cents',
+        :'pending_plan_change' => :'pending_plan_change',
+        :'scheduled_change_effective_at' => :'scheduled_change_effective_at'
       }
     end
 
@@ -63,22 +59,20 @@ module SmplkitGeneratedClient::App
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
         :'product' => :'String',
         :'plan' => :'String',
-        :'status' => :'String',
-        :'comped' => :'Boolean',
-        :'stripe_managed' => :'Boolean',
-        :'current_period_end' => :'String',
-        :'client_secret' => :'String'
+        :'price_monthly_cents' => :'Integer',
+        :'pending_plan_change' => :'String',
+        :'scheduled_change_effective_at' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'status',
-        :'current_period_end',
-        :'client_secret'
+        :'pending_plan_change',
+        :'scheduled_change_effective_at'
       ])
     end
 
@@ -86,18 +80,24 @@ 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::SubscriptionAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::SubscriptionItemResponse` 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::SubscriptionAttributes`. 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::SubscriptionItemResponse`. 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 = nil
+      end
+
       if attributes.key?(:'product')
         self.product = attributes[:'product']
       else
@@ -110,28 +110,18 @@ module SmplkitGeneratedClient::App
         self.plan = nil
       end
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
-
-      if attributes.key?(:'comped')
-        self.comped = attributes[:'comped']
-      else
-        self.comped = nil
-      end
-
-      if attributes.key?(:'stripe_managed')
-        self.stripe_managed = attributes[:'stripe_managed']
+      if attributes.key?(:'price_monthly_cents')
+        self.price_monthly_cents = attributes[:'price_monthly_cents']
       else
-        self.stripe_managed = nil
+        self.price_monthly_cents = nil
       end
 
-      if attributes.key?(:'current_period_end')
-        self.current_period_end = attributes[:'current_period_end']
+      if attributes.key?(:'pending_plan_change')
+        self.pending_plan_change = attributes[:'pending_plan_change']
       end
 
-      if attributes.key?(:'client_secret')
-        self.client_secret = attributes[:'client_secret']
+      if attributes.key?(:'scheduled_change_effective_at')
+        self.scheduled_change_effective_at = attributes[:'scheduled_change_effective_at']
       end
     end
 
@@ -140,6 +130,10 @@ module SmplkitGeneratedClient::App
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
       if @product.nil?
         invalid_properties.push('invalid value for "product", product cannot be nil.')
       end
@@ -148,12 +142,8 @@ module SmplkitGeneratedClient::App
         invalid_properties.push('invalid value for "plan", plan cannot be nil.')
       end
 
-      if @comped.nil?
-        invalid_properties.push('invalid value for "comped", comped cannot be nil.')
-      end
-
-      if @stripe_managed.nil?
-        invalid_properties.push('invalid value for "stripe_managed", stripe_managed cannot be nil.')
+      if @price_monthly_cents.nil?
+        invalid_properties.push('invalid value for "price_monthly_cents", price_monthly_cents cannot be nil.')
       end
 
       invalid_properties
@@ -163,13 +153,23 @@ module SmplkitGeneratedClient::App
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
       return false if @product.nil?
       return false if @plan.nil?
-      return false if @comped.nil?
-      return false if @stripe_managed.nil?
+      return false if @price_monthly_cents.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] product Value to be assigned
     def product=(product)
@@ -191,23 +191,13 @@ module SmplkitGeneratedClient::App
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] comped Value to be assigned
-    def comped=(comped)
-      if comped.nil?
-        fail ArgumentError, 'comped cannot be nil'
-      end
-
-      @comped = comped
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] stripe_managed Value to be assigned
-    def stripe_managed=(stripe_managed)
-      if stripe_managed.nil?
-        fail ArgumentError, 'stripe_managed cannot be nil'
+    # @param [Object] price_monthly_cents Value to be assigned
+    def price_monthly_cents=(price_monthly_cents)
+      if price_monthly_cents.nil?
+        fail ArgumentError, 'price_monthly_cents cannot be nil'
       end
 
-      @stripe_managed = stripe_managed
+      @price_monthly_cents = price_monthly_cents
     end
 
     # Checks equality by comparing each attribute.
@@ -215,13 +205,12 @@ module SmplkitGeneratedClient::App
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
           product == o.product &&
           plan == o.plan &&
-          status == o.status &&
-          comped == o.comped &&
-          stripe_managed == o.stripe_managed &&
-          current_period_end == o.current_period_end &&
-          client_secret == o.client_secret
+          price_monthly_cents == o.price_monthly_cents &&
+          pending_plan_change == o.pending_plan_change &&
+          scheduled_change_effective_at == o.scheduled_change_effective_at
     end
 
     # @see the `==` method
@@ -233,7 +222,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [product, plan, status, comped, stripe_managed, current_period_end, client_secret].hash
+      [id, product, plan, price_monthly_cents, pending_plan_change, scheduled_change_effective_at].hash
     end
 
     # Builds the object from hash