license_manager 0.2.0 → 0.3.0

data/lib/license_manager/models/stripe_price_recurring.rb

@@ -0,0 +1,228 @@
+=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
+  # Billing period of a recurring price, `null` for a one-time price.
+  class StripePriceRecurring < ApiModelBase
+    attr_accessor :interval
+
+    attr_accessor :interval_count
+
+    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
+      {
+        :'interval' => :'interval',
+        :'interval_count' => :'intervalCount'
+      }
+    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
+      {
+        :'interval' => :'String',
+        :'interval_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::StripePriceRecurring` 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::StripePriceRecurring`. 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?(:'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
+    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 @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
+
+      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 @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?
+      true
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          interval == o.interval &&
+          interval_count == o.interval_count
+    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
+      [interval, interval_count].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/subscription_stats.rb

@@ -0,0 +1,456 @@
+=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
+  # Subscriptions to recurring Stripe prices, each with its subscription license.
+  class SubscriptionStats < ApiModelBase
+    # Number of ongoing subscriptions: `active`, `trialing` or `past_due`.
+    attr_accessor :active_count
+
+    attr_accessor :trialing_count
+
+    # Number of them whose renewal failed, as Stripe retries it: their licenses stay valid for the integration's grace days.
+    attr_accessor :past_due_count
+
+    # Number of them set to end at the end of their period.
+    attr_accessor :canceling_count
+
+    # Number of subscriptions started in the last 30 days.
+    attr_accessor :new_count
+
+    # Number of subscriptions that ended in the last 30 days.
+    attr_accessor :ended_count
+
+    # Share of the subscriptions ongoing 30 days ago that ended since, from 0 to 1.
+    attr_accessor :churn_rate
+
+    # Number of subscriptions started each month, aligned on `months`.
+    attr_accessor :new_by_month
+
+    # Number of subscriptions that ended each month, aligned on `months`.
+    attr_accessor :ended_by_month
+
+    # Number of ongoing subscriptions at the end of each month, aligned on `months`, today for this month.
+    attr_accessor :active_by_month
+
+    # MRR in each currency, from the highest number of subscriptions. Amounts aren't converted between currencies.
+    attr_accessor :mrr
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'active_count' => :'activeCount',
+        :'trialing_count' => :'trialingCount',
+        :'past_due_count' => :'pastDueCount',
+        :'canceling_count' => :'cancelingCount',
+        :'new_count' => :'newCount',
+        :'ended_count' => :'endedCount',
+        :'churn_rate' => :'churnRate',
+        :'new_by_month' => :'newByMonth',
+        :'ended_by_month' => :'endedByMonth',
+        :'active_by_month' => :'activeByMonth',
+        :'mrr' => :'mrr'
+      }
+    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
+      {
+        :'active_count' => :'Integer',
+        :'trialing_count' => :'Integer',
+        :'past_due_count' => :'Integer',
+        :'canceling_count' => :'Integer',
+        :'new_count' => :'Integer',
+        :'ended_count' => :'Integer',
+        :'churn_rate' => :'Float',
+        :'new_by_month' => :'Array<Integer>',
+        :'ended_by_month' => :'Array<Integer>',
+        :'active_by_month' => :'Array<Integer>',
+        :'mrr' => :'Array<Mrr>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SubscriptionStats` 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::SubscriptionStats`. 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?(:'active_count')
+        self.active_count = attributes[:'active_count']
+      else
+        self.active_count = nil
+      end
+
+      if attributes.key?(:'trialing_count')
+        self.trialing_count = attributes[:'trialing_count']
+      else
+        self.trialing_count = nil
+      end
+
+      if attributes.key?(:'past_due_count')
+        self.past_due_count = attributes[:'past_due_count']
+      else
+        self.past_due_count = nil
+      end
+
+      if attributes.key?(:'canceling_count')
+        self.canceling_count = attributes[:'canceling_count']
+      else
+        self.canceling_count = nil
+      end
+
+      if attributes.key?(:'new_count')
+        self.new_count = attributes[:'new_count']
+      else
+        self.new_count = nil
+      end
+
+      if attributes.key?(:'ended_count')
+        self.ended_count = attributes[:'ended_count']
+      else
+        self.ended_count = nil
+      end
+
+      if attributes.key?(:'churn_rate')
+        self.churn_rate = attributes[:'churn_rate']
+      else
+        self.churn_rate = nil
+      end
+
+      if attributes.key?(:'new_by_month')
+        if (value = attributes[:'new_by_month']).is_a?(Array)
+          self.new_by_month = value
+        end
+      else
+        self.new_by_month = nil
+      end
+
+      if attributes.key?(:'ended_by_month')
+        if (value = attributes[:'ended_by_month']).is_a?(Array)
+          self.ended_by_month = value
+        end
+      else
+        self.ended_by_month = nil
+      end
+
+      if attributes.key?(:'active_by_month')
+        if (value = attributes[:'active_by_month']).is_a?(Array)
+          self.active_by_month = value
+        end
+      else
+        self.active_by_month = nil
+      end
+
+      if attributes.key?(:'mrr')
+        if (value = attributes[:'mrr']).is_a?(Array)
+          self.mrr = value
+        end
+      else
+        self.mrr = 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 @active_count.nil?
+        invalid_properties.push('invalid value for "active_count", active_count cannot be nil.')
+      end
+
+      if @trialing_count.nil?
+        invalid_properties.push('invalid value for "trialing_count", trialing_count cannot be nil.')
+      end
+
+      if @past_due_count.nil?
+        invalid_properties.push('invalid value for "past_due_count", past_due_count cannot be nil.')
+      end
+
+      if @canceling_count.nil?
+        invalid_properties.push('invalid value for "canceling_count", canceling_count cannot be nil.')
+      end
+
+      if @new_count.nil?
+        invalid_properties.push('invalid value for "new_count", new_count cannot be nil.')
+      end
+
+      if @ended_count.nil?
+        invalid_properties.push('invalid value for "ended_count", ended_count cannot be nil.')
+      end
+
+      if @churn_rate.nil?
+        invalid_properties.push('invalid value for "churn_rate", churn_rate cannot be nil.')
+      end
+
+      if @new_by_month.nil?
+        invalid_properties.push('invalid value for "new_by_month", new_by_month cannot be nil.')
+      end
+
+      if @ended_by_month.nil?
+        invalid_properties.push('invalid value for "ended_by_month", ended_by_month cannot be nil.')
+      end
+
+      if @active_by_month.nil?
+        invalid_properties.push('invalid value for "active_by_month", active_by_month cannot be nil.')
+      end
+
+      if @mrr.nil?
+        invalid_properties.push('invalid value for "mrr", mrr 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 @active_count.nil?
+      return false if @trialing_count.nil?
+      return false if @past_due_count.nil?
+      return false if @canceling_count.nil?
+      return false if @new_count.nil?
+      return false if @ended_count.nil?
+      return false if @churn_rate.nil?
+      return false if @new_by_month.nil?
+      return false if @ended_by_month.nil?
+      return false if @active_by_month.nil?
+      return false if @mrr.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_count Value to be assigned
+    def active_count=(active_count)
+      if active_count.nil?
+        fail ArgumentError, 'active_count cannot be nil'
+      end
+
+      @active_count = active_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] trialing_count Value to be assigned
+    def trialing_count=(trialing_count)
+      if trialing_count.nil?
+        fail ArgumentError, 'trialing_count cannot be nil'
+      end
+
+      @trialing_count = trialing_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] past_due_count Value to be assigned
+    def past_due_count=(past_due_count)
+      if past_due_count.nil?
+        fail ArgumentError, 'past_due_count cannot be nil'
+      end
+
+      @past_due_count = past_due_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] canceling_count Value to be assigned
+    def canceling_count=(canceling_count)
+      if canceling_count.nil?
+        fail ArgumentError, 'canceling_count cannot be nil'
+      end
+
+      @canceling_count = canceling_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_count Value to be assigned
+    def new_count=(new_count)
+      if new_count.nil?
+        fail ArgumentError, 'new_count cannot be nil'
+      end
+
+      @new_count = new_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ended_count Value to be assigned
+    def ended_count=(ended_count)
+      if ended_count.nil?
+        fail ArgumentError, 'ended_count cannot be nil'
+      end
+
+      @ended_count = ended_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] churn_rate Value to be assigned
+    def churn_rate=(churn_rate)
+      if churn_rate.nil?
+        fail ArgumentError, 'churn_rate cannot be nil'
+      end
+
+      @churn_rate = churn_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_by_month Value to be assigned
+    def new_by_month=(new_by_month)
+      if new_by_month.nil?
+        fail ArgumentError, 'new_by_month cannot be nil'
+      end
+
+      @new_by_month = new_by_month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ended_by_month Value to be assigned
+    def ended_by_month=(ended_by_month)
+      if ended_by_month.nil?
+        fail ArgumentError, 'ended_by_month cannot be nil'
+      end
+
+      @ended_by_month = ended_by_month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_by_month Value to be assigned
+    def active_by_month=(active_by_month)
+      if active_by_month.nil?
+        fail ArgumentError, 'active_by_month cannot be nil'
+      end
+
+      @active_by_month = active_by_month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mrr Value to be assigned
+    def mrr=(mrr)
+      if mrr.nil?
+        fail ArgumentError, 'mrr cannot be nil'
+      end
+
+      @mrr = mrr
+    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 &&
+          active_count == o.active_count &&
+          trialing_count == o.trialing_count &&
+          past_due_count == o.past_due_count &&
+          canceling_count == o.canceling_count &&
+          new_count == o.new_count &&
+          ended_count == o.ended_count &&
+          churn_rate == o.churn_rate &&
+          new_by_month == o.new_by_month &&
+          ended_by_month == o.ended_by_month &&
+          active_by_month == o.active_by_month &&
+          mrr == o.mrr
+    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
+      [active_count, trialing_count, past_due_count, canceling_count, new_count, ended_count, churn_rate, new_by_month, ended_by_month, active_by_month, mrr].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