license_manager 0.1.0

data/lib/license_manager/models/product_stats.rb

@@ -0,0 +1,682 @@
+=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
+  class ProductStats < ApiModelBase
+    # Number of licenses of the product.
+    attr_accessor :license_count
+
+    # Number of licenses that haven't expired, and that a machine validated in the last 90 days.
+    attr_accessor :active_license_count
+
+    # Number of licenses created in the last 30 days, today included, in UTC.
+    attr_accessor :new_license_count
+
+    # Number of licenses expiring in the next 30 days.
+    attr_accessor :expiring_license_count
+
+    # Number of licenses that expired in the last 30 days.
+    attr_accessor :expired_license_count
+
+    # Number of active machines of the licenses of the product.
+    attr_accessor :active_machine_count
+
+    # Number of licenses with at least one active machine.
+    attr_accessor :in_use_license_count
+
+    # Sum of the maximum numbers of machines of the licenses that haven't expired. Licenses without a maximum are left out.
+    attr_accessor :seat_count
+
+    # Number of active machines of the licenses counted in `seatCount`, at most their maximum number of machines each.
+    attr_accessor :used_seat_count
+
+    # Number of licenses counted in `seatCount` active on their maximum number of machines.
+    attr_accessor :full_license_count
+
+    # The 30 days covered by the daily stats, from the oldest one, in UTC.
+    attr_accessor :days
+
+    # The 12 months covered by the monthly stats, from the oldest one, in UTC.
+    attr_accessor :months
+
+    # Number of licenses created each day, aligned on `days`.
+    attr_accessor :new_licenses_by_day
+
+    # Number of licenses created each month, aligned on `months`.
+    attr_accessor :new_licenses_by_month
+
+    # Number of licenses of each policy created each day and each month, for the policies with licenses created over the covered months.
+    attr_accessor :new_licenses_by_policy
+
+    # Revenue in each currency licenses were sold in, from the one with the most licenses sold. Amounts aren't converted between currencies.
+    attr_accessor :revenue
+
+    # Successful activations of the licenses of the product each day, per version of the application, from the most recent one.
+    attr_accessor :activations_by_version
+
+    # Number of active machines running each version of the application, from the most recent one.
+    attr_accessor :active_machines_by_version
+
+    # Number of active machines on each platform, from the one with the most machines.
+    attr_accessor :active_machines_by_platform
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'license_count' => :'licenseCount',
+        :'active_license_count' => :'activeLicenseCount',
+        :'new_license_count' => :'newLicenseCount',
+        :'expiring_license_count' => :'expiringLicenseCount',
+        :'expired_license_count' => :'expiredLicenseCount',
+        :'active_machine_count' => :'activeMachineCount',
+        :'in_use_license_count' => :'inUseLicenseCount',
+        :'seat_count' => :'seatCount',
+        :'used_seat_count' => :'usedSeatCount',
+        :'full_license_count' => :'fullLicenseCount',
+        :'days' => :'days',
+        :'months' => :'months',
+        :'new_licenses_by_day' => :'newLicensesByDay',
+        :'new_licenses_by_month' => :'newLicensesByMonth',
+        :'new_licenses_by_policy' => :'newLicensesByPolicy',
+        :'revenue' => :'revenue',
+        :'activations_by_version' => :'activationsByVersion',
+        :'active_machines_by_version' => :'activeMachinesByVersion',
+        :'active_machines_by_platform' => :'activeMachinesByPlatform'
+      }
+    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
+      {
+        :'license_count' => :'Integer',
+        :'active_license_count' => :'Integer',
+        :'new_license_count' => :'Integer',
+        :'expiring_license_count' => :'Integer',
+        :'expired_license_count' => :'Integer',
+        :'active_machine_count' => :'Integer',
+        :'in_use_license_count' => :'Integer',
+        :'seat_count' => :'Integer',
+        :'used_seat_count' => :'Integer',
+        :'full_license_count' => :'Integer',
+        :'days' => :'Array<Date>',
+        :'months' => :'Array<String>',
+        :'new_licenses_by_day' => :'Array<Integer>',
+        :'new_licenses_by_month' => :'Array<Integer>',
+        :'new_licenses_by_policy' => :'Array<ProductStatsNewLicensesByPolicyInner>',
+        :'revenue' => :'Array<Revenue>',
+        :'activations_by_version' => :'Array<ProductStatsActivationsByVersionInner>',
+        :'active_machines_by_version' => :'Array<ProductStatsActiveMachinesByVersionInner>',
+        :'active_machines_by_platform' => :'Array<ProductStatsActiveMachinesByPlatformInner>'
+      }
+    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::ProductStats` 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::ProductStats`. 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?(:'license_count')
+        self.license_count = attributes[:'license_count']
+      else
+        self.license_count = nil
+      end
+
+      if attributes.key?(:'active_license_count')
+        self.active_license_count = attributes[:'active_license_count']
+      else
+        self.active_license_count = nil
+      end
+
+      if attributes.key?(:'new_license_count')
+        self.new_license_count = attributes[:'new_license_count']
+      else
+        self.new_license_count = nil
+      end
+
+      if attributes.key?(:'expiring_license_count')
+        self.expiring_license_count = attributes[:'expiring_license_count']
+      else
+        self.expiring_license_count = nil
+      end
+
+      if attributes.key?(:'expired_license_count')
+        self.expired_license_count = attributes[:'expired_license_count']
+      else
+        self.expired_license_count = nil
+      end
+
+      if attributes.key?(:'active_machine_count')
+        self.active_machine_count = attributes[:'active_machine_count']
+      else
+        self.active_machine_count = nil
+      end
+
+      if attributes.key?(:'in_use_license_count')
+        self.in_use_license_count = attributes[:'in_use_license_count']
+      else
+        self.in_use_license_count = nil
+      end
+
+      if attributes.key?(:'seat_count')
+        self.seat_count = attributes[:'seat_count']
+      else
+        self.seat_count = nil
+      end
+
+      if attributes.key?(:'used_seat_count')
+        self.used_seat_count = attributes[:'used_seat_count']
+      else
+        self.used_seat_count = nil
+      end
+
+      if attributes.key?(:'full_license_count')
+        self.full_license_count = attributes[:'full_license_count']
+      else
+        self.full_license_count = nil
+      end
+
+      if attributes.key?(:'days')
+        if (value = attributes[:'days']).is_a?(Array)
+          self.days = value
+        end
+      else
+        self.days = nil
+      end
+
+      if attributes.key?(:'months')
+        if (value = attributes[:'months']).is_a?(Array)
+          self.months = value
+        end
+      else
+        self.months = nil
+      end
+
+      if attributes.key?(:'new_licenses_by_day')
+        if (value = attributes[:'new_licenses_by_day']).is_a?(Array)
+          self.new_licenses_by_day = value
+        end
+      else
+        self.new_licenses_by_day = nil
+      end
+
+      if attributes.key?(:'new_licenses_by_month')
+        if (value = attributes[:'new_licenses_by_month']).is_a?(Array)
+          self.new_licenses_by_month = value
+        end
+      else
+        self.new_licenses_by_month = nil
+      end
+
+      if attributes.key?(:'new_licenses_by_policy')
+        if (value = attributes[:'new_licenses_by_policy']).is_a?(Array)
+          self.new_licenses_by_policy = value
+        end
+      else
+        self.new_licenses_by_policy = nil
+      end
+
+      if attributes.key?(:'revenue')
+        if (value = attributes[:'revenue']).is_a?(Array)
+          self.revenue = value
+        end
+      else
+        self.revenue = nil
+      end
+
+      if attributes.key?(:'activations_by_version')
+        if (value = attributes[:'activations_by_version']).is_a?(Array)
+          self.activations_by_version = value
+        end
+      else
+        self.activations_by_version = nil
+      end
+
+      if attributes.key?(:'active_machines_by_version')
+        if (value = attributes[:'active_machines_by_version']).is_a?(Array)
+          self.active_machines_by_version = value
+        end
+      else
+        self.active_machines_by_version = nil
+      end
+
+      if attributes.key?(:'active_machines_by_platform')
+        if (value = attributes[:'active_machines_by_platform']).is_a?(Array)
+          self.active_machines_by_platform = value
+        end
+      else
+        self.active_machines_by_platform = 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 @license_count.nil?
+        invalid_properties.push('invalid value for "license_count", license_count cannot be nil.')
+      end
+
+      if @active_license_count.nil?
+        invalid_properties.push('invalid value for "active_license_count", active_license_count cannot be nil.')
+      end
+
+      if @new_license_count.nil?
+        invalid_properties.push('invalid value for "new_license_count", new_license_count cannot be nil.')
+      end
+
+      if @expiring_license_count.nil?
+        invalid_properties.push('invalid value for "expiring_license_count", expiring_license_count cannot be nil.')
+      end
+
+      if @expired_license_count.nil?
+        invalid_properties.push('invalid value for "expired_license_count", expired_license_count cannot be nil.')
+      end
+
+      if @active_machine_count.nil?
+        invalid_properties.push('invalid value for "active_machine_count", active_machine_count cannot be nil.')
+      end
+
+      if @in_use_license_count.nil?
+        invalid_properties.push('invalid value for "in_use_license_count", in_use_license_count cannot be nil.')
+      end
+
+      if @seat_count.nil?
+        invalid_properties.push('invalid value for "seat_count", seat_count cannot be nil.')
+      end
+
+      if @used_seat_count.nil?
+        invalid_properties.push('invalid value for "used_seat_count", used_seat_count cannot be nil.')
+      end
+
+      if @full_license_count.nil?
+        invalid_properties.push('invalid value for "full_license_count", full_license_count cannot be nil.')
+      end
+
+      if @days.nil?
+        invalid_properties.push('invalid value for "days", days cannot be nil.')
+      end
+
+      if @months.nil?
+        invalid_properties.push('invalid value for "months", months cannot be nil.')
+      end
+
+      if @new_licenses_by_day.nil?
+        invalid_properties.push('invalid value for "new_licenses_by_day", new_licenses_by_day cannot be nil.')
+      end
+
+      if @new_licenses_by_month.nil?
+        invalid_properties.push('invalid value for "new_licenses_by_month", new_licenses_by_month cannot be nil.')
+      end
+
+      if @new_licenses_by_policy.nil?
+        invalid_properties.push('invalid value for "new_licenses_by_policy", new_licenses_by_policy cannot be nil.')
+      end
+
+      if @revenue.nil?
+        invalid_properties.push('invalid value for "revenue", revenue cannot be nil.')
+      end
+
+      if @activations_by_version.nil?
+        invalid_properties.push('invalid value for "activations_by_version", activations_by_version cannot be nil.')
+      end
+
+      if @active_machines_by_version.nil?
+        invalid_properties.push('invalid value for "active_machines_by_version", active_machines_by_version cannot be nil.')
+      end
+
+      if @active_machines_by_platform.nil?
+        invalid_properties.push('invalid value for "active_machines_by_platform", active_machines_by_platform 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 @license_count.nil?
+      return false if @active_license_count.nil?
+      return false if @new_license_count.nil?
+      return false if @expiring_license_count.nil?
+      return false if @expired_license_count.nil?
+      return false if @active_machine_count.nil?
+      return false if @in_use_license_count.nil?
+      return false if @seat_count.nil?
+      return false if @used_seat_count.nil?
+      return false if @full_license_count.nil?
+      return false if @days.nil?
+      return false if @months.nil?
+      return false if @new_licenses_by_day.nil?
+      return false if @new_licenses_by_month.nil?
+      return false if @new_licenses_by_policy.nil?
+      return false if @revenue.nil?
+      return false if @activations_by_version.nil?
+      return false if @active_machines_by_version.nil?
+      return false if @active_machines_by_platform.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] license_count Value to be assigned
+    def license_count=(license_count)
+      if license_count.nil?
+        fail ArgumentError, 'license_count cannot be nil'
+      end
+
+      @license_count = license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_license_count Value to be assigned
+    def active_license_count=(active_license_count)
+      if active_license_count.nil?
+        fail ArgumentError, 'active_license_count cannot be nil'
+      end
+
+      @active_license_count = active_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_license_count Value to be assigned
+    def new_license_count=(new_license_count)
+      if new_license_count.nil?
+        fail ArgumentError, 'new_license_count cannot be nil'
+      end
+
+      @new_license_count = new_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expiring_license_count Value to be assigned
+    def expiring_license_count=(expiring_license_count)
+      if expiring_license_count.nil?
+        fail ArgumentError, 'expiring_license_count cannot be nil'
+      end
+
+      @expiring_license_count = expiring_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expired_license_count Value to be assigned
+    def expired_license_count=(expired_license_count)
+      if expired_license_count.nil?
+        fail ArgumentError, 'expired_license_count cannot be nil'
+      end
+
+      @expired_license_count = expired_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_machine_count Value to be assigned
+    def active_machine_count=(active_machine_count)
+      if active_machine_count.nil?
+        fail ArgumentError, 'active_machine_count cannot be nil'
+      end
+
+      @active_machine_count = active_machine_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] in_use_license_count Value to be assigned
+    def in_use_license_count=(in_use_license_count)
+      if in_use_license_count.nil?
+        fail ArgumentError, 'in_use_license_count cannot be nil'
+      end
+
+      @in_use_license_count = in_use_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] seat_count Value to be assigned
+    def seat_count=(seat_count)
+      if seat_count.nil?
+        fail ArgumentError, 'seat_count cannot be nil'
+      end
+
+      @seat_count = seat_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] used_seat_count Value to be assigned
+    def used_seat_count=(used_seat_count)
+      if used_seat_count.nil?
+        fail ArgumentError, 'used_seat_count cannot be nil'
+      end
+
+      @used_seat_count = used_seat_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] full_license_count Value to be assigned
+    def full_license_count=(full_license_count)
+      if full_license_count.nil?
+        fail ArgumentError, 'full_license_count cannot be nil'
+      end
+
+      @full_license_count = full_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] days Value to be assigned
+    def days=(days)
+      if days.nil?
+        fail ArgumentError, 'days cannot be nil'
+      end
+
+      @days = days
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] months Value to be assigned
+    def months=(months)
+      if months.nil?
+        fail ArgumentError, 'months cannot be nil'
+      end
+
+      @months = months
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_licenses_by_day Value to be assigned
+    def new_licenses_by_day=(new_licenses_by_day)
+      if new_licenses_by_day.nil?
+        fail ArgumentError, 'new_licenses_by_day cannot be nil'
+      end
+
+      @new_licenses_by_day = new_licenses_by_day
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_licenses_by_month Value to be assigned
+    def new_licenses_by_month=(new_licenses_by_month)
+      if new_licenses_by_month.nil?
+        fail ArgumentError, 'new_licenses_by_month cannot be nil'
+      end
+
+      @new_licenses_by_month = new_licenses_by_month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_licenses_by_policy Value to be assigned
+    def new_licenses_by_policy=(new_licenses_by_policy)
+      if new_licenses_by_policy.nil?
+        fail ArgumentError, 'new_licenses_by_policy cannot be nil'
+      end
+
+      @new_licenses_by_policy = new_licenses_by_policy
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] revenue Value to be assigned
+    def revenue=(revenue)
+      if revenue.nil?
+        fail ArgumentError, 'revenue cannot be nil'
+      end
+
+      @revenue = revenue
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] activations_by_version Value to be assigned
+    def activations_by_version=(activations_by_version)
+      if activations_by_version.nil?
+        fail ArgumentError, 'activations_by_version cannot be nil'
+      end
+
+      @activations_by_version = activations_by_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_machines_by_version Value to be assigned
+    def active_machines_by_version=(active_machines_by_version)
+      if active_machines_by_version.nil?
+        fail ArgumentError, 'active_machines_by_version cannot be nil'
+      end
+
+      @active_machines_by_version = active_machines_by_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_machines_by_platform Value to be assigned
+    def active_machines_by_platform=(active_machines_by_platform)
+      if active_machines_by_platform.nil?
+        fail ArgumentError, 'active_machines_by_platform cannot be nil'
+      end
+
+      @active_machines_by_platform = active_machines_by_platform
+    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 &&
+          license_count == o.license_count &&
+          active_license_count == o.active_license_count &&
+          new_license_count == o.new_license_count &&
+          expiring_license_count == o.expiring_license_count &&
+          expired_license_count == o.expired_license_count &&
+          active_machine_count == o.active_machine_count &&
+          in_use_license_count == o.in_use_license_count &&
+          seat_count == o.seat_count &&
+          used_seat_count == o.used_seat_count &&
+          full_license_count == o.full_license_count &&
+          days == o.days &&
+          months == o.months &&
+          new_licenses_by_day == o.new_licenses_by_day &&
+          new_licenses_by_month == o.new_licenses_by_month &&
+          new_licenses_by_policy == o.new_licenses_by_policy &&
+          revenue == o.revenue &&
+          activations_by_version == o.activations_by_version &&
+          active_machines_by_version == o.active_machines_by_version &&
+          active_machines_by_platform == o.active_machines_by_platform
+    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
+      [license_count, active_license_count, new_license_count, expiring_license_count, expired_license_count, active_machine_count, in_use_license_count, seat_count, used_seat_count, full_license_count, days, months, new_licenses_by_day, new_licenses_by_month, new_licenses_by_policy, revenue, activations_by_version, active_machines_by_version, active_machines_by_platform].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