license_manager 0.1.1 → 0.3.0

data/lib/license_manager/models/mrr_by_policy_inner.rb

@@ -0,0 +1,229 @@
+=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 MrrByPolicyInner < ApiModelBase
+    attr_accessor :policy_id
+
+    attr_accessor :subscription_count
+
+    attr_accessor :mrr
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'policy_id' => :'policyId',
+        :'subscription_count' => :'subscriptionCount',
+        :'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
+      {
+        :'policy_id' => :'String',
+        :'subscription_count' => :'Integer',
+        :'mrr' => :'Float'
+      }
+    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::MrrByPolicyInner` 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::MrrByPolicyInner`. 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?(:'policy_id')
+        self.policy_id = attributes[:'policy_id']
+      else
+        self.policy_id = nil
+      end
+
+      if attributes.key?(:'subscription_count')
+        self.subscription_count = attributes[:'subscription_count']
+      else
+        self.subscription_count = nil
+      end
+
+      if attributes.key?(:'mrr')
+        self.mrr = attributes[:'mrr']
+      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 @policy_id.nil?
+        invalid_properties.push('invalid value for "policy_id", policy_id cannot be nil.')
+      end
+
+      if @subscription_count.nil?
+        invalid_properties.push('invalid value for "subscription_count", subscription_count 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 @policy_id.nil?
+      return false if @subscription_count.nil?
+      return false if @mrr.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] policy_id Value to be assigned
+    def policy_id=(policy_id)
+      if policy_id.nil?
+        fail ArgumentError, 'policy_id cannot be nil'
+      end
+
+      @policy_id = policy_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subscription_count Value to be assigned
+    def subscription_count=(subscription_count)
+      if subscription_count.nil?
+        fail ArgumentError, 'subscription_count cannot be nil'
+      end
+
+      @subscription_count = subscription_count
+    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 &&
+          policy_id == o.policy_id &&
+          subscription_count == o.subscription_count &&
+          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
+      [policy_id, subscription_count, 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

data/lib/license_manager/models/policy.rb

@@ -36,6 +36,9 @@ module LicenseManager
 
     attr_accessor :max_version
 
+    # Number of days after their creation during which customers can cancel the licenses created with this policy, from the customer portal or with `cancelLicense`. `null` when they can't.
+    attr_accessor :money_back_guarantee_days
+
     # Number of licenses following this policy.
     attr_accessor :license_count
 
@@ -55,6 +58,7 @@ module LicenseManager
         :'max_machines' => :'maxMachines',
         :'max_offline_duration_seconds' => :'maxOfflineDurationSeconds',
         :'max_version' => :'maxVersion',
+        :'money_back_guarantee_days' => :'moneyBackGuaranteeDays',
         :'license_count' => :'licenseCount',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt'
@@ -83,6 +87,7 @@ module LicenseManager
         :'max_machines' => :'Integer',
         :'max_offline_duration_seconds' => :'Integer',
         :'max_version' => :'PolicyMaxVersion',
+        :'money_back_guarantee_days' => :'Integer',
         :'license_count' => :'Integer',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
@@ -95,6 +100,7 @@ module LicenseManager
         :'duration',
         :'max_machines',
         :'max_version',
+        :'money_back_guarantee_days',
       ])
     end
 
@@ -178,6 +184,12 @@ module LicenseManager
         self.max_version = nil
       end
 
+      if attributes.key?(:'money_back_guarantee_days')
+        self.money_back_guarantee_days = attributes[:'money_back_guarantee_days']
+      else
+        self.money_back_guarantee_days = nil
+      end
+
       if attributes.key?(:'license_count')
         self.license_count = attributes[:'license_count']
       else
@@ -361,6 +373,7 @@ module LicenseManager
           max_machines == o.max_machines &&
           max_offline_duration_seconds == o.max_offline_duration_seconds &&
           max_version == o.max_version &&
+          money_back_guarantee_days == o.money_back_guarantee_days &&
           license_count == o.license_count &&
           created_at == o.created_at &&
           updated_at == o.updated_at
@@ -375,7 +388,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, product_id, slug, name, is_default, duration, max_machines, max_offline_duration_seconds, max_version, license_count, created_at, updated_at].hash
+      [id, product_id, slug, name, is_default, duration, max_machines, max_offline_duration_seconds, max_version, money_back_guarantee_days, license_count, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/policy_settings.rb

@@ -25,13 +25,17 @@ module LicenseManager
 
     attr_accessor :max_version
 
+    # Number of days after their creation during which customers can cancel the licenses created with this policy, from the customer portal or with `cancelLicense`, which refunds their Stripe payment. Each license keeps the end of its own period as `cancellableUntil`. `null` for no money back guarantee. Defaults to `null`.
+    attr_accessor :money_back_guarantee_days
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'duration' => :'duration',
         :'max_machines' => :'maxMachines',
         :'max_offline_duration_seconds' => :'maxOfflineDurationSeconds',
-        :'max_version' => :'maxVersion'
+        :'max_version' => :'maxVersion',
+        :'money_back_guarantee_days' => :'moneyBackGuaranteeDays'
       }
     end
 
@@ -51,7 +55,8 @@ module LicenseManager
         :'duration' => :'PolicySettingsDuration',
         :'max_machines' => :'Integer',
         :'max_offline_duration_seconds' => :'Integer',
-        :'max_version' => :'PolicySettingsMaxVersion'
+        :'max_version' => :'PolicySettingsMaxVersion',
+        :'money_back_guarantee_days' => :'Integer'
       }
     end
 
@@ -60,7 +65,8 @@ module LicenseManager
       Set.new([
         :'duration',
         :'max_machines',
-        :'max_version'
+        :'max_version',
+        :'money_back_guarantee_days'
       ])
     end
 
@@ -105,6 +111,10 @@ module LicenseManager
       if attributes.key?(:'max_version')
         self.max_version = attributes[:'max_version']
       end
+
+      if attributes.key?(:'money_back_guarantee_days')
+        self.money_back_guarantee_days = attributes[:'money_back_guarantee_days']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -128,6 +138,14 @@ module LicenseManager
         invalid_properties.push('invalid value for "max_offline_duration_seconds", must be greater than or equal to 3600.')
       end
 
+      if !@money_back_guarantee_days.nil? && @money_back_guarantee_days > 3650
+        invalid_properties.push('invalid value for "money_back_guarantee_days", must be smaller than or equal to 3650.')
+      end
+
+      if !@money_back_guarantee_days.nil? && @money_back_guarantee_days <= 0
+        invalid_properties.push('invalid value for "money_back_guarantee_days", must be greater than 0.')
+      end
+
       invalid_properties
     end
 
@@ -139,6 +157,8 @@ module LicenseManager
       return false if !@max_machines.nil? && @max_machines <= 0
       return false if !@max_offline_duration_seconds.nil? && @max_offline_duration_seconds > 2147483647
       return false if !@max_offline_duration_seconds.nil? && @max_offline_duration_seconds < 3600
+      return false if !@money_back_guarantee_days.nil? && @money_back_guarantee_days > 3650
+      return false if !@money_back_guarantee_days.nil? && @money_back_guarantee_days <= 0
       true
     end
 
@@ -174,6 +194,20 @@ module LicenseManager
       @max_offline_duration_seconds = max_offline_duration_seconds
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] money_back_guarantee_days Value to be assigned
+    def money_back_guarantee_days=(money_back_guarantee_days)
+      if !money_back_guarantee_days.nil? && money_back_guarantee_days > 3650
+        fail ArgumentError, 'invalid value for "money_back_guarantee_days", must be smaller than or equal to 3650.'
+      end
+
+      if !money_back_guarantee_days.nil? && money_back_guarantee_days <= 0
+        fail ArgumentError, 'invalid value for "money_back_guarantee_days", must be greater than 0.'
+      end
+
+      @money_back_guarantee_days = money_back_guarantee_days
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -182,7 +216,8 @@ module LicenseManager
           duration == o.duration &&
           max_machines == o.max_machines &&
           max_offline_duration_seconds == o.max_offline_duration_seconds &&
-          max_version == o.max_version
+          max_version == o.max_version &&
+          money_back_guarantee_days == o.money_back_guarantee_days
     end
 
     # @see the `==` method
@@ -194,7 +229,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [duration, max_machines, max_offline_duration_seconds, max_version].hash
+      [duration, max_machines, max_offline_duration_seconds, max_version, money_back_guarantee_days].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/portal_link.rb

@@ -18,7 +18,7 @@ module LicenseManager
     # Link to the customer portal, holding the token.
     attr_accessor :url
 
-    # Customer token in the link, with the `customer:read`, `license:read` and `machine:write` permissions.
+    # Customer token in the link, with the `customer:read`, `license:read`, `license:cancel` and `machine:write` permissions.
     attr_accessor :token
 
     # When the link stops working.

data/lib/license_manager/models/product.rb

@@ -29,6 +29,9 @@ module LicenseManager
 
     attr_accessor :portal
 
+    # Whether a new machine validating a license already on its max machines takes the place of the license's machine validated the longest ago, rather than being refused with `machine_limit_reached`. When the replaced machine is validated again, it takes its place back and the machine that replaced it is locked. See `validateKey`.
+    attr_accessor :auto_machine_change
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -42,6 +45,7 @@ module LicenseManager
         :'is_test_from_product_id' => :'isTestFromProductId',
         :'logo_url' => :'logoUrl',
         :'portal' => :'portal',
+        :'auto_machine_change' => :'autoMachineChange',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt'
       }
@@ -66,6 +70,7 @@ module LicenseManager
         :'is_test_from_product_id' => :'String',
         :'logo_url' => :'String',
         :'portal' => :'PortalSettings',
+        :'auto_machine_change' => :'Boolean',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
       }
@@ -141,6 +146,12 @@ module LicenseManager
         self.portal = nil
       end
 
+      if attributes.key?(:'auto_machine_change')
+        self.auto_machine_change = attributes[:'auto_machine_change']
+      else
+        self.auto_machine_change = nil
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -175,6 +186,10 @@ module LicenseManager
         invalid_properties.push('invalid value for "portal", portal cannot be nil.')
       end
 
+      if @auto_machine_change.nil?
+        invalid_properties.push('invalid value for "auto_machine_change", auto_machine_change cannot be nil.')
+      end
+
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -194,6 +209,7 @@ module LicenseManager
       return false if @slug.nil?
       return false if @name.nil?
       return false if @portal.nil?
+      return false if @auto_machine_change.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       true
@@ -239,6 +255,16 @@ module LicenseManager
       @portal = portal
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] auto_machine_change Value to be assigned
+    def auto_machine_change=(auto_machine_change)
+      if auto_machine_change.nil?
+        fail ArgumentError, 'auto_machine_change cannot be nil'
+      end
+
+      @auto_machine_change = auto_machine_change
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -270,6 +296,7 @@ module LicenseManager
           is_test_from_product_id == o.is_test_from_product_id &&
           logo_url == o.logo_url &&
           portal == o.portal &&
+          auto_machine_change == o.auto_machine_change &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -283,7 +310,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, slug, name, is_test_from_product_id, logo_url, portal, created_at, updated_at].hash
+      [id, slug, name, is_test_from_product_id, logo_url, portal, auto_machine_change, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/product_stats.rb

@@ -18,16 +18,16 @@ module LicenseManager
     # 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.
+    # Number of licenses that haven't expired nor were canceled, 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.
+    # Number of licenses expiring in the next 30 days, canceled ones left out.
     attr_accessor :expiring_license_count
 
-    # Number of licenses that expired in the last 30 days.
+    # Number of licenses that expired in the last 30 days, canceled ones left out.
     attr_accessor :expired_license_count
 
     # Number of active machines of the licenses of the product.
@@ -36,7 +36,7 @@ module LicenseManager
     # 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.
+    # Sum of the maximum numbers of machines of the licenses that haven't expired nor were canceled. 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.
@@ -60,6 +60,12 @@ module LicenseManager
     # 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
 
+    # Cancellations of the licenses with a money back guarantee. `null` when no license of the product has one.
+    attr_accessor :cancellation
+
+    # Subscriptions of the product. `null` when it has never had one.
+    attr_accessor :subscriptions
+
     # 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
 
@@ -90,6 +96,8 @@ module LicenseManager
         :'new_licenses_by_day' => :'newLicensesByDay',
         :'new_licenses_by_month' => :'newLicensesByMonth',
         :'new_licenses_by_policy' => :'newLicensesByPolicy',
+        :'cancellation' => :'cancellation',
+        :'subscriptions' => :'subscriptions',
         :'revenue' => :'revenue',
         :'activations_by_version' => :'activationsByVersion',
         :'active_machines_by_version' => :'activeMachinesByVersion',
@@ -125,6 +133,8 @@ module LicenseManager
         :'new_licenses_by_day' => :'Array<Integer>',
         :'new_licenses_by_month' => :'Array<Integer>',
         :'new_licenses_by_policy' => :'Array<ProductStatsNewLicensesByPolicyInner>',
+        :'cancellation' => :'CancellationStats',
+        :'subscriptions' => :'SubscriptionStats',
         :'revenue' => :'Array<Revenue>',
         :'activations_by_version' => :'Array<ProductStatsActivationsByVersionInner>',
         :'active_machines_by_version' => :'Array<ProductStatsActiveMachinesByVersionInner>',
@@ -135,6 +145,8 @@ module LicenseManager
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'cancellation',
+        :'subscriptions',
       ])
     end
 
@@ -264,6 +276,18 @@ module LicenseManager
         self.new_licenses_by_policy = nil
       end
 
+      if attributes.key?(:'cancellation')
+        self.cancellation = attributes[:'cancellation']
+      else
+        self.cancellation = nil
+      end
+
+      if attributes.key?(:'subscriptions')
+        self.subscriptions = attributes[:'subscriptions']
+      else
+        self.subscriptions = nil
+      end
+
       if attributes.key?(:'revenue')
         if (value = attributes[:'revenue']).is_a?(Array)
           self.revenue = value
@@ -617,6 +641,8 @@ module LicenseManager
           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 &&
+          cancellation == o.cancellation &&
+          subscriptions == o.subscriptions &&
           revenue == o.revenue &&
           activations_by_version == o.activations_by_version &&
           active_machines_by_version == o.active_machines_by_version &&
@@ -632,7 +658,7 @@ module LicenseManager
     # 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
+      [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, cancellation, subscriptions, revenue, activations_by_version, active_machines_by_version, active_machines_by_platform].hash
     end
 
     # Builds the object from hash