license_manager 0.1.0 → 0.2.0

data/lib/license_manager/models/cancellation_stats_by_reason_inner.rb

@@ -0,0 +1,225 @@
+=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 CancellationStatsByReasonInner < ApiModelBase
+    attr_accessor :reason
+
+    attr_accessor :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
+      {
+        :'reason' => :'reason',
+        :'count' => :'count'
+      }
+    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
+      {
+        :'reason' => :'CancellationReason',
+        :'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::CancellationStatsByReasonInner` 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::CancellationStatsByReasonInner`. 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?(:'reason')
+        self.reason = attributes[:'reason']
+      else
+        self.reason = nil
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      else
+        self.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 @reason.nil?
+        invalid_properties.push('invalid value for "reason", reason cannot be nil.')
+      end
+
+      if @count.nil?
+        invalid_properties.push('invalid value for "count", 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 @reason.nil?
+      return false if @count.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reason Value to be assigned
+    def reason=(reason)
+      if reason.nil?
+        fail ArgumentError, 'reason cannot be nil'
+      end
+
+      @reason = reason
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] count Value to be assigned
+    def count=(count)
+      if count.nil?
+        fail ArgumentError, 'count cannot be nil'
+      end
+
+      @count = 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 &&
+          reason == o.reason &&
+          count == o.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
+      [reason, 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/connect_stripe.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module LicenseManager
   class ConnectStripe < ApiModelBase
-    # Restricted API key of the Stripe account (`rk_live_…` for live products, `rk_test_…` for test products), with the `requiredPermissions` of `getStripeIntegration`. A secret key works too, but gives the app more access than it needs.
+    # Restricted API key of the Stripe account (`rk_live_…` for live products, `rk_test_…` for test products), with the `requiredPermissions` of `getStripeIntegration`. Without the optional ones, it connects with what they're for turned off. A secret key works too, but gives the app more access than it needs.
     attr_accessor :api_key
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/license_manager/models/create_license.rb

@@ -40,6 +40,9 @@ module LicenseManager
 
     attr_accessor :max_version
 
+    # 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. Defaults to the creation date plus the policy's `moneyBackGuaranteeDays`, or `null` when it has none.
+    attr_accessor :cancellable_until
+
     # `true` emails the key to the customer once the license is created, like `sendLicenseKeys`. Sent in the background: a failed email doesn't fail the creation. In test products, it's only sent when the customer's email is a member's of the organization. Defaults to `false`.
     attr_accessor :send_key
 
@@ -55,6 +58,7 @@ module LicenseManager
         :'max_offline_duration_seconds' => :'maxOfflineDurationSeconds',
         :'price' => :'price',
         :'max_version' => :'maxVersion',
+        :'cancellable_until' => :'cancellableUntil',
         :'send_key' => :'sendKey'
       }
     end
@@ -81,6 +85,7 @@ module LicenseManager
         :'max_offline_duration_seconds' => :'Integer',
         :'price' => :'PriceInput',
         :'max_version' => :'LicenseMaxVersionInput',
+        :'cancellable_until' => :'Time',
         :'send_key' => :'Boolean'
       }
     end
@@ -92,6 +97,7 @@ module LicenseManager
         :'meta',
         :'max_machines',
         :'price',
+        :'cancellable_until',
       ])
     end
 
@@ -161,6 +167,10 @@ module LicenseManager
         self.max_version = attributes[:'max_version']
       end
 
+      if attributes.key?(:'cancellable_until')
+        self.cancellable_until = attributes[:'cancellable_until']
+      end
+
       if attributes.key?(:'send_key')
         self.send_key = attributes[:'send_key']
       end
@@ -299,6 +309,7 @@ module LicenseManager
           max_offline_duration_seconds == o.max_offline_duration_seconds &&
           price == o.price &&
           max_version == o.max_version &&
+          cancellable_until == o.cancellable_until &&
           send_key == o.send_key
     end
 
@@ -311,7 +322,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, key, policy_id, expires_at, meta, max_machines, max_offline_duration_seconds, price, max_version, send_key].hash
+      [email, key, policy_id, expires_at, meta, max_machines, max_offline_duration_seconds, price, max_version, cancellable_until, send_key].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/create_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
 
@@ -133,6 +139,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?
@@ -181,6 +191,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
 
@@ -198,6 +216,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
 
@@ -274,6 +294,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)
@@ -285,7 +319,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
@@ -297,7 +332,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/create_product_with_policy.rb

@@ -22,7 +22,7 @@ module LicenseManager
 
     attr_accessor :default_policy
 
-    # Creates a test product: a sandbox of this live product of the organization, starting with copies of its policies, releases and portal settings.
+    # Creates a test product: a sandbox of this live product of the organization, starting with copies of its policies, releases, portal settings and `autoMachineChange`.
     attr_accessor :is_test_from_product_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/license_manager/models/create_token.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module LicenseManager
   class CreateToken < ApiModelBase
-    # Permissions of the token. A write permission implies the matching read one. A token creating a token can only give the permissions it has.
+    # Permissions of the token. A write permission implies the other ones of its resource, like the read one: `license:write` implies `license:read` and `license:cancel`. A token creating a token can only give the permissions it has.
     attr_accessor :scope
 
     # How long the token works, in seconds, from 60 (1 minute) to 31536000 (365 days). Defaults to 900 (15 minutes). A token creating a token can't give it a later expiration than its own: it's shortened to it.

data/lib/license_manager/models/event_type.rb

@@ -21,11 +21,14 @@ module LicenseManager
     LICENSE_UPDATED = "license.updated".freeze
     LICENSE_VALIDATED = "license.validated".freeze
     LICENSE_VALIDATION_FAILED = "license.validation_failed".freeze
+    LICENSE_CANCELED = "license.canceled".freeze
+    LICENSE_REFUNDED = "license.refunded".freeze
+    LICENSE_REFUND_FAILED = "license.refund_failed".freeze
     MACHINE_DEACTIVATED = "machine.deactivated".freeze
     UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
 
     def self.all_vars
-      @all_vars ||= [POLICY_CREATED, POLICY_UPDATED, LICENSE_CREATED, LICENSE_UPDATED, LICENSE_VALIDATED, LICENSE_VALIDATION_FAILED, MACHINE_DEACTIVATED, UNKNOWN_DEFAULT_OPEN_API].freeze
+      @all_vars ||= [POLICY_CREATED, POLICY_UPDATED, LICENSE_CREATED, LICENSE_UPDATED, LICENSE_VALIDATED, LICENSE_VALIDATION_FAILED, LICENSE_CANCELED, LICENSE_REFUNDED, LICENSE_REFUND_FAILED, MACHINE_DEACTIVATED, UNKNOWN_DEFAULT_OPEN_API].freeze
     end
 
     # Builds the enum from string

data/lib/license_manager/models/integration.rb

@@ -42,6 +42,12 @@ module LicenseManager
     # Last time it received an event from the provider.
     attr_accessor :last_event_at
 
+    # Whether canceling a license bought through Stripe refunds its payment. On by default, always off when `canRefund` is false.
+    attr_accessor :auto_refund
+
+    # Whether the API key has the optional Refunds: Write permission, checked when connecting and every day. Without it, canceled licenses aren't refunded: refund their payments from Stripe.
+    attr_accessor :can_refund
+
     attr_accessor :created_at
 
     class EnumAttributeValidator
@@ -79,6 +85,8 @@ module LicenseManager
         :'status_reason' => :'statusReason',
         :'last_checked_at' => :'lastCheckedAt',
         :'last_event_at' => :'lastEventAt',
+        :'auto_refund' => :'autoRefund',
+        :'can_refund' => :'canRefund',
         :'created_at' => :'createdAt'
       }
     end
@@ -106,6 +114,8 @@ module LicenseManager
         :'status_reason' => :'String',
         :'last_checked_at' => :'Time',
         :'last_event_at' => :'Time',
+        :'auto_refund' => :'Boolean',
+        :'can_refund' => :'Boolean',
         :'created_at' => :'Time'
       }
     end
@@ -206,6 +216,18 @@ module LicenseManager
         self.last_event_at = nil
       end
 
+      if attributes.key?(:'auto_refund')
+        self.auto_refund = attributes[:'auto_refund']
+      else
+        self.auto_refund = nil
+      end
+
+      if attributes.key?(:'can_refund')
+        self.can_refund = attributes[:'can_refund']
+      else
+        self.can_refund = nil
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -242,6 +264,14 @@ module LicenseManager
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
+      if @auto_refund.nil?
+        invalid_properties.push('invalid value for "auto_refund", auto_refund cannot be nil.')
+      end
+
+      if @can_refund.nil?
+        invalid_properties.push('invalid value for "can_refund", can_refund cannot be nil.')
+      end
+
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -261,6 +291,8 @@ module LicenseManager
       return false if @api_key_hint.nil?
       return false if @webhook_url.nil?
       return false if @status.nil?
+      return false if @auto_refund.nil?
+      return false if @can_refund.nil?
       return false if @created_at.nil?
       true
     end
@@ -325,6 +357,26 @@ module LicenseManager
       @status = status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] auto_refund Value to be assigned
+    def auto_refund=(auto_refund)
+      if auto_refund.nil?
+        fail ArgumentError, 'auto_refund cannot be nil'
+      end
+
+      @auto_refund = auto_refund
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] can_refund Value to be assigned
+    def can_refund=(can_refund)
+      if can_refund.nil?
+        fail ArgumentError, 'can_refund cannot be nil'
+      end
+
+      @can_refund = can_refund
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -350,6 +402,8 @@ module LicenseManager
           status_reason == o.status_reason &&
           last_checked_at == o.last_checked_at &&
           last_event_at == o.last_event_at &&
+          auto_refund == o.auto_refund &&
+          can_refund == o.can_refund &&
           created_at == o.created_at
     end
 
@@ -362,7 +416,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, provider, livemode, account_name, api_key_hint, webhook_url, status, status_reason, last_checked_at, last_event_at, created_at].hash
+      [id, provider, livemode, account_name, api_key_hint, webhook_url, status, status_reason, last_checked_at, last_event_at, auto_refund, can_refund, created_at].hash
     end
 
     # Builds the object from hash