smplkit 2.0.13 → 2.0.14

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

@@ -14,22 +14,30 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Attributes for a saved card payment method.  ``default`` is the API-facing name; the underlying column is ``is_default`` per ADR-013 (reserved-word exception) and ADR-014 (unprefixed API fields).
+  # A saved card on file for the account, used to charge subscription invoices.  The default payment method is changed via the `set_default` action rather than by updating this field through PUT.
   class PaymentMethod < ApiModelBase
+    # Card network brand, e.g. `visa`, `mastercard`, `amex`.
     attr_accessor :brand
 
+    # Last four digits of the card number.
     attr_accessor :last4
 
+    # Expiry month (1-12).
     attr_accessor :exp_month
 
+    # Expiry year (four-digit).
     attr_accessor :exp_year
 
+    # Whether this payment method is the account's default for subscription charges. Use the `set_default` action to change which payment method is default — this field is not writable via PUT.
     attr_accessor :default
 
+    # Billing details (name, email, phone, address) associated with the card.
     attr_accessor :billing_details
 
+    # When the payment method was registered.
     attr_accessor :created_at
 
+    # When the payment method was last modified.
     attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for payment methods.
   class PaymentMethodListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -0,0 +1,165 @@
+=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 request envelope for updating a payment method.
+  class PaymentMethodRequest < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'PaymentMethodResource'
+      }
+    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::PaymentMethodRequest` 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::PaymentMethodRequest`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          data == o.data
+    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
+      [data].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/payment_method_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a payment method.  `id` must not be specified for create requests (the server assigns it).
   class PaymentMethodResource < ApiModelBase
     attr_accessor :id
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for a payment method.
   class PaymentMethodResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # A plan tier offered across smplkit products.
   class Plan < ApiModelBase
+    # Human-readable plan name.
     attr_accessor :display_name
 
+    # Long-form plan description.
     attr_accessor :description
 
+    # Order in which the plan should be shown in customer-facing lists. Lower values sort first.
     attr_accessor :sort_order
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Body for the subscription upgrade and downgrade actions.
   class PlanChangeRequest < ApiModelBase
+    # Plan key to change the subscription to.
     attr_accessor :plan
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Per-plan pricing and limits for a product.
   class PlanDefinition < ApiModelBase
+    # Monthly list price in cents. `0` for free plans.
     attr_accessor :price_monthly_cents
 
+    # Map of limit key to the cap that applies on this plan. `-1` indicates an unlimited cap.
     attr_accessor :limits
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for plan tiers.
   class PlanListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a plan tier.
   class PlanResource < ApiModelBase
     attr_accessor :id
 

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

@@ -14,19 +14,27 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # A smplkit product, with its plans, metered limits, and marketing copy.
   class Product < ApiModelBase
+    # Human-readable product name.
     attr_accessor :display_name
 
+    # Long-form product description.
     attr_accessor :description
 
+    # Short marketing tagline shown on plan-selection surfaces.
     attr_accessor :tagline
 
+    # Bullet-list feature highlights for the product.
     attr_accessor :features
 
+    # When `true`, the product is listed but not yet available for subscription.
     attr_accessor :coming_soon
 
+    # Map of limit key to limit definition for this product.
     attr_accessor :limits
 
+    # Map of plan key to plan definition for this product.
     attr_accessor :plans
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for products.
   class ProductListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a product catalog entry.
   class ProductResource < ApiModelBase
     attr_accessor :id
 

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

@@ -14,12 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Body for the email + password registration endpoint.
   class RegisterRequest < ApiModelBase
+    # Email address that becomes the new user's login identifier.
     attr_accessor :email
 
+    # Password for the new account. Must be at least 8 characters.
     attr_accessor :password
 
-    # Registration entry point. Allowed: LOGIN, GET_STARTED, LIVE_DEMO, UNKNOWN. Defaults to UNKNOWN when omitted. Case-insensitive.
+    # How the customer arrived at the registration page. Allowed values: `LOGIN`, `GET_STARTED`, `LIVE_DEMO`, `UNKNOWN`. Defaults to `UNKNOWN` when omitted. Case-insensitive on input.
     attr_accessor :entry_point
 
     class EnumAttributeValidator

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

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # A service that contexts can be evaluated against — for example, a backend application or microservice in the customer's stack.
   class Service < ApiModelBase
+    # Human-readable name for the service.
     attr_accessor :name
 
+    # When the service was created.
     attr_accessor :created_at
 
+    # When the service was last modified.
     attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for services.
   class ServiceListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -0,0 +1,165 @@
+=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 request envelope for creating or updating a service.
+  class ServiceRequest < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'ServiceResource'
+      }
+    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::ServiceRequest` 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::ServiceRequest`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          data == o.data
+    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
+      [data].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/service_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a service.  `id` must not be specified for create requests (the server assigns it).
   class ServiceResource < ApiModelBase
     attr_accessor :id
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for a service.
   class ServiceResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Result of executing the setup-intent function.
   class SetupIntentAttributes < ApiModelBase
+    # Client secret to pass to Stripe Elements so the customer can complete payment-method setup in the browser.
     attr_accessor :client_secret
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for a setup-intent result.
   class SetupIntentResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,19 +14,27 @@ 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`.
     attr_accessor :product
 
+    # Plan key the subscription is on, e.g. `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
 
+    # 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
 
+    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,16 +14,21 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Discount and totals summary attached to GET /api/v1/subscriptions.
+  # Discount and totals summary attached to a subscription collection response.
   class SubscriptionListMeta < ApiModelBase
+    # Sum of list prices across all subscriptions in cents.
     attr_accessor :subtotal_cents
 
+    # Effective discount percentage applied.
     attr_accessor :discount_pct
 
+    # Discount amount in cents.
     attr_accessor :discount_amount_cents
 
+    # Source of the discount. `VOLUME` indicates the standard volume-discount schedule; `OVERRIDE` indicates a custom discount set on the account.
     attr_accessor :discount_source
 
+    # Final monthly total in cents after the discount.
     attr_accessor :total_cents
 
     attr_accessor :next_tier

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for subscriptions.
   class SubscriptionListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a subscription.  `id` must not be specified for create requests (the server assigns it).
   class SubscriptionResource < ApiModelBase
     attr_accessor :id
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for a subscription.
   class SubscriptionResponse < ApiModelBase
     attr_accessor :data