license_manager 0.1.1 → 0.3.0

data/lib/license_manager/models/license_subscription.rb

@@ -0,0 +1,388 @@
+=begin
+#LicenseManager API
+
+#Public API. Authenticate with an organization API key, or with a token scoped to a customer, license or machine on the endpoints that accept one.  ## Conventions  - **Errors** answer `{ \"error\": { \"code\", \"message\" } }`. Branch on `code`, which is stable, not on `message`. Each response lists the codes it can return, except `404`, which answers `not_found` unless it says otherwise. Unexpected errors answer `500` with `internal_error`. - **Validation** errors answer `422`, not `400`, with the `validation_error` code and an `issues` array giving the `path` and `message` of each invalid value. - **Unknown body fields are ignored**, not rejected: sending a field an endpoint doesn't accept, like `policyId` to `updateLicense`, changes nothing and doesn't fail. - **Strings** are trimmed before they're validated and stored. Emails are stored lower cased. - **Updates** only change the fields that are sent. A field sent as `null` is cleared, when it can be. - **Dates** can be sent with any offset, and are always returned in UTC, like `2026-01-15T09:30:00.000Z`. Calendar months and days are counted in UTC. - **Ids** are 8 letters and digits, after `test_` for test products and their resources. - **Lists** are paginated with `page` and `pageSize`. Items with the same value for the `sort` field are ordered by id, so pages are stable, but items created or deleted between two requests shift the pages. Items without a value for the `sort` field come last in ascending order, and first in descending order, unless the endpoint says otherwise. - **Test products** are sandboxes of a live product. Test API keys only reach test products, live API keys only live ones: the others answer `404`, as if they didn't exist. Sessions and tokens reach both.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'date'
+require 'time'
+
+module LicenseManager
+  # The Stripe subscription keeping the license valid, `null` when it isn't a subscription license. The license expires when it stops being paid, includes every update, and can't be canceled during a money back guarantee.
+  class LicenseSubscription < ApiModelBase
+    attr_accessor :stripe_subscription_id
+
+    # Status of the subscription in Stripe: `active`, `trialing`, `past_due` while a failed payment is retried, `canceled`, `unpaid`, `paused`, `incomplete` or `incomplete_expired`.
+    attr_accessor :status
+
+    attr_accessor :interval
+
+    # Number of intervals between payments.
+    attr_accessor :interval_count
+
+    # Units subscribed, multiplying the policy's machines.
+    attr_accessor :quantity
+
+    # Price of one unit for one period, before taxes.
+    attr_accessor :price
+
+    # End of the paid period, when the subscription renews or ends.
+    attr_accessor :current_period_end
+
+    # Whether the subscription ends at the end of the period.
+    attr_accessor :cancel_at_period_end
+
+    attr_accessor :ended_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
+      {
+        :'stripe_subscription_id' => :'stripeSubscriptionId',
+        :'status' => :'status',
+        :'interval' => :'interval',
+        :'interval_count' => :'intervalCount',
+        :'quantity' => :'quantity',
+        :'price' => :'price',
+        :'current_period_end' => :'currentPeriodEnd',
+        :'cancel_at_period_end' => :'cancelAtPeriodEnd',
+        :'ended_at' => :'endedAt'
+      }
+    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
+      {
+        :'stripe_subscription_id' => :'String',
+        :'status' => :'String',
+        :'interval' => :'String',
+        :'interval_count' => :'Integer',
+        :'quantity' => :'Integer',
+        :'price' => :'Price',
+        :'current_period_end' => :'Time',
+        :'cancel_at_period_end' => :'Boolean',
+        :'ended_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'price',
+        :'ended_at'
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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 `LicenseManager::LicenseSubscription` 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 `LicenseManager::LicenseSubscription`. 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?(:'stripe_subscription_id')
+        self.stripe_subscription_id = attributes[:'stripe_subscription_id']
+      else
+        self.stripe_subscription_id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'interval')
+        self.interval = attributes[:'interval']
+      else
+        self.interval = nil
+      end
+
+      if attributes.key?(:'interval_count')
+        self.interval_count = attributes[:'interval_count']
+      else
+        self.interval_count = nil
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      else
+        self.quantity = nil
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      else
+        self.price = nil
+      end
+
+      if attributes.key?(:'current_period_end')
+        self.current_period_end = attributes[:'current_period_end']
+      else
+        self.current_period_end = nil
+      end
+
+      if attributes.key?(:'cancel_at_period_end')
+        self.cancel_at_period_end = attributes[:'cancel_at_period_end']
+      else
+        self.cancel_at_period_end = nil
+      end
+
+      if attributes.key?(:'ended_at')
+        self.ended_at = attributes[:'ended_at']
+      else
+        self.ended_at = 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 @stripe_subscription_id.nil?
+        invalid_properties.push('invalid value for "stripe_subscription_id", stripe_subscription_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @interval.nil?
+        invalid_properties.push('invalid value for "interval", interval cannot be nil.')
+      end
+
+      if @interval_count.nil?
+        invalid_properties.push('invalid value for "interval_count", interval_count cannot be nil.')
+      end
+
+      if @quantity.nil?
+        invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
+      end
+
+      if @current_period_end.nil?
+        invalid_properties.push('invalid value for "current_period_end", current_period_end cannot be nil.')
+      end
+
+      if @cancel_at_period_end.nil?
+        invalid_properties.push('invalid value for "cancel_at_period_end", cancel_at_period_end 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 @stripe_subscription_id.nil?
+      return false if @status.nil?
+      return false if @interval.nil?
+      interval_validator = EnumAttributeValidator.new('String', ["day", "week", "month", "year", "unknown_default_open_api"])
+      return false unless interval_validator.valid?(@interval)
+      return false if @interval_count.nil?
+      return false if @quantity.nil?
+      return false if @current_period_end.nil?
+      return false if @cancel_at_period_end.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] stripe_subscription_id Value to be assigned
+    def stripe_subscription_id=(stripe_subscription_id)
+      if stripe_subscription_id.nil?
+        fail ArgumentError, 'stripe_subscription_id cannot be nil'
+      end
+
+      @stripe_subscription_id = stripe_subscription_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] interval Object to be assigned
+    def interval=(interval)
+      validator = EnumAttributeValidator.new('String', ["day", "week", "month", "year", "unknown_default_open_api"])
+      unless validator.valid?(interval)
+        fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}."
+      end
+      @interval = interval
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] interval_count Value to be assigned
+    def interval_count=(interval_count)
+      if interval_count.nil?
+        fail ArgumentError, 'interval_count cannot be nil'
+      end
+
+      @interval_count = interval_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quantity Value to be assigned
+    def quantity=(quantity)
+      if quantity.nil?
+        fail ArgumentError, 'quantity cannot be nil'
+      end
+
+      @quantity = quantity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] current_period_end Value to be assigned
+    def current_period_end=(current_period_end)
+      if current_period_end.nil?
+        fail ArgumentError, 'current_period_end cannot be nil'
+      end
+
+      @current_period_end = current_period_end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cancel_at_period_end Value to be assigned
+    def cancel_at_period_end=(cancel_at_period_end)
+      if cancel_at_period_end.nil?
+        fail ArgumentError, 'cancel_at_period_end cannot be nil'
+      end
+
+      @cancel_at_period_end = cancel_at_period_end
+    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 &&
+          stripe_subscription_id == o.stripe_subscription_id &&
+          status == o.status &&
+          interval == o.interval &&
+          interval_count == o.interval_count &&
+          quantity == o.quantity &&
+          price == o.price &&
+          current_period_end == o.current_period_end &&
+          cancel_at_period_end == o.cancel_at_period_end &&
+          ended_at == o.ended_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
+      [stripe_subscription_id, status, interval, interval_count, quantity, price, current_period_end, cancel_at_period_end, ended_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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[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 = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_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/license_manager/models/machine.rb

@@ -26,12 +26,15 @@ module LicenseManager
 
     attr_accessor :name
 
-    # Whether the machine counts as using the license.
+    # Whether the machine counts as using the license. A `locked` machine doesn't, and its validations are refused with `machine_locked`: it overrode a machine that came back. See `validateKey`.
     attr_accessor :status
 
     # Version of the application last validated on the machine.
     attr_accessor :version
 
+    # For a machine deactivated or locked by automatic machine changes, the machine that took its place. Validating the key on a deactivated machine that has one takes its place back. `null` otherwise.
+    attr_accessor :overridden_by_machine_id
+
     # When the license was last validated on the machine.
     attr_accessor :last_validated_at
 
@@ -71,6 +74,7 @@ module LicenseManager
         :'name' => :'name',
         :'status' => :'status',
         :'version' => :'version',
+        :'overridden_by_machine_id' => :'overriddenByMachineId',
         :'last_validated_at' => :'lastValidatedAt',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt'
@@ -97,6 +101,7 @@ module LicenseManager
         :'name' => :'String',
         :'status' => :'String',
         :'version' => :'String',
+        :'overridden_by_machine_id' => :'String',
         :'last_validated_at' => :'Time',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
@@ -109,6 +114,7 @@ module LicenseManager
         :'platform',
         :'name',
         :'version',
+        :'overridden_by_machine_id',
         :'last_validated_at',
       ])
     end
@@ -181,6 +187,12 @@ module LicenseManager
         self.version = nil
       end
 
+      if attributes.key?(:'overridden_by_machine_id')
+        self.overridden_by_machine_id = attributes[:'overridden_by_machine_id']
+      else
+        self.overridden_by_machine_id = nil
+      end
+
       if attributes.key?(:'last_validated_at')
         self.last_validated_at = attributes[:'last_validated_at']
       else
@@ -240,7 +252,7 @@ module LicenseManager
       return false if @license_id.nil?
       return false if @fingerprint.nil?
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["active", "deactivated", "unknown_default_open_api"])
+      status_validator = EnumAttributeValidator.new('String', ["active", "deactivated", "locked", "unknown_default_open_api"])
       return false unless status_validator.valid?(@status)
       return false if @created_at.nil?
       return false if @updated_at.nil?
@@ -280,7 +292,7 @@ module LicenseManager
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["active", "deactivated", "unknown_default_open_api"])
+      validator = EnumAttributeValidator.new('String', ["active", "deactivated", "locked", "unknown_default_open_api"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -319,6 +331,7 @@ module LicenseManager
           name == o.name &&
           status == o.status &&
           version == o.version &&
+          overridden_by_machine_id == o.overridden_by_machine_id &&
           last_validated_at == o.last_validated_at &&
           created_at == o.created_at &&
           updated_at == o.updated_at
@@ -333,7 +346,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, license_id, fingerprint, platform, name, status, version, last_validated_at, created_at, updated_at].hash
+      [id, license_id, fingerprint, platform, name, status, version, overridden_by_machine_id, last_validated_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash