license_manager 0.1.1 → 0.2.0

data/lib/license_manager/models/revenue.rb

@@ -14,17 +14,23 @@ require 'date'
 require 'time'
 
 module LicenseManager
-  # Revenue of the licenses sold in one currency, each license counting on the day it was created. Licenses without a price are left out.
+  # Revenue of the licenses sold in one currency, each license counting on the day it was created. Licenses without a price are left out, and so are canceled ones, but in `canceledLicenseCount` and `canceledTotal`.
   class Revenue < ApiModelBase
     # ISO 4217 code of the currency of the revenue.
     attr_accessor :currency
 
-    # Number of licenses sold in the currency, free ones included.
+    # Number of licenses sold in the currency, free ones included, canceled ones left out.
     attr_accessor :license_count
 
-    # Sum of the prices of the licenses sold in the currency, in major units.
+    # Sum of the prices of the licenses sold in the currency, in major units, canceled ones left out.
     attr_accessor :total
 
+    # Number of canceled licenses sold in the currency.
+    attr_accessor :canceled_license_count
+
+    # Sum of the prices of the canceled licenses sold in the currency, in major units: revenue lost to cancellations.
+    attr_accessor :canceled_total
+
     # Revenue of the current month, in UTC.
     attr_accessor :this_month
 
@@ -49,6 +55,8 @@ module LicenseManager
         :'currency' => :'currency',
         :'license_count' => :'licenseCount',
         :'total' => :'total',
+        :'canceled_license_count' => :'canceledLicenseCount',
+        :'canceled_total' => :'canceledTotal',
         :'this_month' => :'thisMonth',
         :'last_month' => :'lastMonth',
         :'last30_days' => :'last30Days',
@@ -74,6 +82,8 @@ module LicenseManager
         :'currency' => :'String',
         :'license_count' => :'Integer',
         :'total' => :'Float',
+        :'canceled_license_count' => :'Integer',
+        :'canceled_total' => :'Float',
         :'this_month' => :'Float',
         :'last_month' => :'Float',
         :'last30_days' => :'Float',
@@ -133,6 +143,18 @@ module LicenseManager
         self.total = nil
       end
 
+      if attributes.key?(:'canceled_license_count')
+        self.canceled_license_count = attributes[:'canceled_license_count']
+      else
+        self.canceled_license_count = nil
+      end
+
+      if attributes.key?(:'canceled_total')
+        self.canceled_total = attributes[:'canceled_total']
+      else
+        self.canceled_total = nil
+      end
+
       if attributes.key?(:'this_month')
         self.this_month = attributes[:'this_month']
       else
@@ -193,6 +215,14 @@ module LicenseManager
         invalid_properties.push('invalid value for "total", total cannot be nil.')
       end
 
+      if @canceled_license_count.nil?
+        invalid_properties.push('invalid value for "canceled_license_count", canceled_license_count cannot be nil.')
+      end
+
+      if @canceled_total.nil?
+        invalid_properties.push('invalid value for "canceled_total", canceled_total cannot be nil.')
+      end
+
       if @this_month.nil?
         invalid_properties.push('invalid value for "this_month", this_month cannot be nil.')
       end
@@ -227,6 +257,8 @@ module LicenseManager
       return false if @currency.nil?
       return false if @license_count.nil?
       return false if @total.nil?
+      return false if @canceled_license_count.nil?
+      return false if @canceled_total.nil?
       return false if @this_month.nil?
       return false if @last_month.nil?
       return false if @last30_days.nil?
@@ -266,6 +298,26 @@ module LicenseManager
       @total = total
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] canceled_license_count Value to be assigned
+    def canceled_license_count=(canceled_license_count)
+      if canceled_license_count.nil?
+        fail ArgumentError, 'canceled_license_count cannot be nil'
+      end
+
+      @canceled_license_count = canceled_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] canceled_total Value to be assigned
+    def canceled_total=(canceled_total)
+      if canceled_total.nil?
+        fail ArgumentError, 'canceled_total cannot be nil'
+      end
+
+      @canceled_total = canceled_total
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] this_month Value to be assigned
     def this_month=(this_month)
@@ -334,6 +386,8 @@ module LicenseManager
           currency == o.currency &&
           license_count == o.license_count &&
           total == o.total &&
+          canceled_license_count == o.canceled_license_count &&
+          canceled_total == o.canceled_total &&
           this_month == o.this_month &&
           last_month == o.last_month &&
           last30_days == o.last30_days &&
@@ -351,7 +405,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [currency, license_count, total, this_month, last_month, last30_days, by_day, by_month, by_policy].hash
+      [currency, license_count, total, canceled_license_count, canceled_total, this_month, last_month, last30_days, by_day, by_month, by_policy].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/stripe_integration.rb

@@ -21,7 +21,7 @@ module LicenseManager
     # Whether Stripe can reach the API's webhook URL. A local URL can't be: set `WEBHOOK_URL` on the server, like to a tunnel in development.
     attr_accessor :webhook_url_reachable
 
-    # Permissions the restricted API key needs, and why. Every other permission can stay `None`.
+    # Permissions the restricted API key needs, and why, the `optional` ones included. Every other permission can stay `None`.
     attr_accessor :required_permissions
 
     # The organization's Stripe connection in this mode, `null` when there's none.

data/lib/license_manager/models/stripe_permission.rb

@@ -21,6 +21,9 @@ module LicenseManager
 
     attr_accessor :reason
 
+    # Whether the key can connect without it, losing what it's for, explained by `reason`.
+    attr_accessor :optional
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,7 +51,8 @@ module LicenseManager
       {
         :'resource' => :'resource',
         :'access' => :'access',
-        :'reason' => :'reason'
+        :'reason' => :'reason',
+        :'optional' => :'optional'
       }
     end
 
@@ -67,7 +71,8 @@ module LicenseManager
       {
         :'resource' => :'String',
         :'access' => :'String',
-        :'reason' => :'String'
+        :'reason' => :'String',
+        :'optional' => :'Boolean'
       }
     end
 
@@ -120,6 +125,12 @@ module LicenseManager
       else
         self.reason = nil
       end
+
+      if attributes.key?(:'optional')
+        self.optional = attributes[:'optional']
+      else
+        self.optional = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,6 +150,10 @@ module LicenseManager
         invalid_properties.push('invalid value for "reason", reason cannot be nil.')
       end
 
+      if @optional.nil?
+        invalid_properties.push('invalid value for "optional", optional cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -151,6 +166,7 @@ module LicenseManager
       access_validator = EnumAttributeValidator.new('String', ["Read", "Write", "unknown_default_open_api"])
       return false unless access_validator.valid?(@access)
       return false if @reason.nil?
+      return false if @optional.nil?
       true
     end
 
@@ -184,6 +200,16 @@ module LicenseManager
       @reason = reason
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] optional Value to be assigned
+    def optional=(optional)
+      if optional.nil?
+        fail ArgumentError, 'optional cannot be nil'
+      end
+
+      @optional = optional
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -191,7 +217,8 @@ module LicenseManager
       self.class == o.class &&
           resource == o.resource &&
           access == o.access &&
-          reason == o.reason
+          reason == o.reason &&
+          optional == o.optional
     end
 
     # @see the `==` method
@@ -203,7 +230,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [resource, access, reason].hash
+      [resource, access, reason, optional].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/update_integration.rb

@@ -0,0 +1,161 @@
+=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 UpdateIntegration < ApiModelBase
+    # Whether canceling a license bought through Stripe refunds its payment. Can only be turned on when the integration's `canRefund` is true: the API key has the Refunds: Write permission.
+    attr_accessor :auto_refund
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'auto_refund' => :'autoRefund'
+      }
+    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
+      {
+        :'auto_refund' => :'Boolean'
+      }
+    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::UpdateIntegration` 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::UpdateIntegration`. 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?(:'auto_refund')
+        self.auto_refund = attributes[:'auto_refund']
+      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
+      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'
+      true
+    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 &&
+          auto_refund == o.auto_refund
+    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
+      [auto_refund].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/update_license.rb

@@ -32,6 +32,9 @@ module LicenseManager
 
     attr_accessor :price
 
+    # End of the money back guarantee: until then, the customer can cancel the license from the customer portal, or with a token. `null` to not let them.
+    attr_accessor :cancellable_until
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +43,8 @@ module LicenseManager
         :'max_machines' => :'maxMachines',
         :'max_offline_duration_seconds' => :'maxOfflineDurationSeconds',
         :'max_version' => :'maxVersion',
-        :'price' => :'price'
+        :'price' => :'price',
+        :'cancellable_until' => :'cancellableUntil'
       }
     end
 
@@ -62,7 +66,8 @@ module LicenseManager
         :'max_machines' => :'Integer',
         :'max_offline_duration_seconds' => :'Integer',
         :'max_version' => :'LicenseMaxVersionInput',
-        :'price' => :'PriceInput'
+        :'price' => :'PriceInput',
+        :'cancellable_until' => :'Time'
       }
     end
 
@@ -72,7 +77,8 @@ module LicenseManager
         :'expires_at',
         :'meta',
         :'max_machines',
-        :'price'
+        :'price',
+        :'cancellable_until'
       ])
     end
 
@@ -127,6 +133,10 @@ module LicenseManager
       if attributes.key?(:'price')
         self.price = attributes[:'price']
       end
+
+      if attributes.key?(:'cancellable_until')
+        self.cancellable_until = attributes[:'cancellable_until']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -206,7 +216,8 @@ module LicenseManager
           max_machines == o.max_machines &&
           max_offline_duration_seconds == o.max_offline_duration_seconds &&
           max_version == o.max_version &&
-          price == o.price
+          price == o.price &&
+          cancellable_until == o.cancellable_until
     end
 
     # @see the `==` method
@@ -218,7 +229,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [expires_at, meta, max_machines, max_offline_duration_seconds, max_version, price].hash
+      [expires_at, meta, max_machines, max_offline_duration_seconds, max_version, price, cancellable_until].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/update_policy.rb

@@ -33,6 +33,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`, 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
       {
@@ -42,7 +45,8 @@ module LicenseManager
         :'duration' => :'duration',
         :'max_machines' => :'maxMachines',
         :'max_offline_duration_seconds' => :'maxOfflineDurationSeconds',
-        :'max_version' => :'maxVersion'
+        :'max_version' => :'maxVersion',
+        :'money_back_guarantee_days' => :'moneyBackGuaranteeDays'
       }
     end
 
@@ -65,7 +69,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
 
@@ -74,7 +79,8 @@ module LicenseManager
       Set.new([
         :'duration',
         :'max_machines',
-        :'max_version'
+        :'max_version',
+        :'money_back_guarantee_days'
       ])
     end
 
@@ -131,6 +137,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?
@@ -175,6 +185,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
 
@@ -191,6 +209,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
 
@@ -267,6 +287,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)
@@ -278,7 +312,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
@@ -290,7 +325,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, slug, is_default, duration, max_machines, max_offline_duration_seconds, max_version].hash
+      [name, slug, is_default, 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/update_product.rb

@@ -22,12 +22,16 @@ 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'slug' => :'slug',
-        :'portal' => :'portal'
+        :'portal' => :'portal',
+        :'auto_machine_change' => :'autoMachineChange'
       }
     end
 
@@ -46,7 +50,8 @@ module LicenseManager
       {
         :'name' => :'String',
         :'slug' => :'String',
-        :'portal' => :'UpdateProductPortal'
+        :'portal' => :'UpdateProductPortal',
+        :'auto_machine_change' => :'Boolean'
       }
     end
 
@@ -93,6 +98,10 @@ module LicenseManager
       if attributes.key?(:'portal')
         self.portal = attributes[:'portal']
       end
+
+      if attributes.key?(:'auto_machine_change')
+        self.auto_machine_change = attributes[:'auto_machine_change']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -184,7 +193,8 @@ module LicenseManager
       self.class == o.class &&
           name == o.name &&
           slug == o.slug &&
-          portal == o.portal
+          portal == o.portal &&
+          auto_machine_change == o.auto_machine_change
     end
 
     # @see the `==` method
@@ -196,7 +206,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, slug, portal].hash
+      [name, slug, portal, auto_machine_change].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.26.0
 =end
 
 module LicenseManager
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/license_manager.rb

@@ -18,6 +18,10 @@ require 'license_manager/version'
 require 'license_manager/configuration'
 
 # Models
+require 'license_manager/models/cancel_license'
+require 'license_manager/models/cancellation_reason'
+require 'license_manager/models/cancellation_stats'
+require 'license_manager/models/cancellation_stats_by_reason_inner'
 require 'license_manager/models/connect_stripe'
 require 'license_manager/models/create_customer'
 require 'license_manager/models/create_integration_mapping'
@@ -101,6 +105,7 @@ require 'license_manager/models/stripe_permission'
 require 'license_manager/models/stripe_price'
 require 'license_manager/models/token'
 require 'license_manager/models/update_customer'
+require 'license_manager/models/update_integration'
 require 'license_manager/models/update_integration_mapping'
 require 'license_manager/models/update_license'
 require 'license_manager/models/update_policy'